Creates a new job work instruction list.
Request Information
URI Parameters :
None.
Body Parameters :
job_work_instruction_list| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of the jobs |
globally unique identifier |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs_reference_back_office |
Embedded entity "jobs" using ERP PK when adding/updating |
string |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs |
Embedded entity "jobs" when adding/updating |
jobs |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| work_instruction_details_id |
work instruction details id |
globally unique identifier | |
| work_instruction_details_reference_back_office |
Embedded code "work instruction details" when adding/updating |
string | |
| work_instruction_details |
Embedded entity "work instruction details" when adding/updating |
work_instruction_details | |
| user_id |
Filled by the person that completed that item on the checklist |
globally unique identifier | |
| work_instruction_action_type |
Value from work_instruction_action_type.name |
string | |
| work_instruction_id |
work instruction id |
globally unique identifier |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction_reference_back_office |
Embedded code "work instruction" when adding/updating |
string |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction |
Embedded entity "work instruction" when adding/updating |
work_instruction |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| name |
The "on what" |
string |
Required Max length: 4000 |
| status |
Status can be Ok,NotOk,Replaced,NotApplicable |
string |
Max length: 50 |
| date_done |
Datetime filled when status goes to one valable status. |
date | |
| remark |
Additional remark from the technician. |
string |
Max length: 255 |
| advise |
Additional advice from the technician. |
string |
Max length: 255 |
| sequence |
To order it. |
integer | |
| reference_back_office |
The Id/Ref of the back office for this job work instruction. Used by Embedded entity |
string |
Max length: 255 |
| group_name |
Name of the group |
string |
Max length: 4000 |
| group_sequence |
Order of the group |
integer | |
| type |
One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default |
string | |
| instruction_document_count |
Specify how many documents/photos must be added if type is Picture |
integer | |
| db_report_type_id |
When type is Form, you must specify which db_report_type must be filled |
globally unique identifier | |
| db_report_type_name |
When type is Form, you must specify which db_report_type must be filled |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
Sample:
{
"id": "0f190e85-b5bb-46c0-84b8-570d1b9cf02e",
"jobs_id": "36cd8500-33a6-4c1d-ac89-65dc527b44cc",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "08975bb6-9c59-47ef-af69-02d78795c63d",
"_parent_id": "c975e30b-f209-41ad-af1e-d08fad0cdf9e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "42a10e29-d3ea-44cd-b4b9-317225d57a32",
"project_reference_back_office": "sample string 5",
"project": {
"id": "19d72fdc-9f44-45ff-9e18-08762a2224dd",
"_parent_id": "a4de318e-c820-42d4-8ed9-6030fcbcb27c",
"root_parent_id": "871777f2-746d-4d96-be04-f2d50a1bc902",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e78565bc-d849-4dcf-b2e4-4d7ec62e6786",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0d7d7fa2-dc10-46f8-af80-8b676adc38f5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "baaa6234-ce7e-47a6-8cd6-d33c29b60508",
"_parent_code": "sample string 6",
"sales_organization_id": "37ebc7df-b48f-46bd-af4a-7de136d31184",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6e4dd1f9-4567-46ef-add5-b8e0ffed5038",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29f06f87-f31a-4561-b41c-cd409836c1a4",
"db_currency_id": "0401f932-1f68-4e8f-8985-cdcf8e4faca6",
"db_language_id": "3dd5f25e-3bac-48ad-b2e0-b1b533fa5998",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00"
},
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00"
},
"equipment_model_id": "7311cda7-118e-46e0-842d-52585f545a90",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bece6c6e-bf99-4d7a-87cd-8459af2cf214",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a0c26d39-5d1f-4273-8b89-eb4ca4eaf862",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3ce3e8b1-dd52-42d8-b452-458b590ef2b8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b93dea6b-b1b2-4a59-b891-83bb0bba7cd3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6e4dd1f9-4567-46ef-add5-b8e0ffed5038",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29f06f87-f31a-4561-b41c-cd409836c1a4",
"db_currency_id": "0401f932-1f68-4e8f-8985-cdcf8e4faca6",
"db_language_id": "3dd5f25e-3bac-48ad-b2e0-b1b533fa5998",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00"
},
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00"
},
"equipment_family_id": "83e9f8fe-cb7b-4295-b6a9-d700911044c0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0d7d7fa2-dc10-46f8-af80-8b676adc38f5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "baaa6234-ce7e-47a6-8cd6-d33c29b60508",
"_parent_code": "sample string 6",
"sales_organization_id": "37ebc7df-b48f-46bd-af4a-7de136d31184",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6e4dd1f9-4567-46ef-add5-b8e0ffed5038",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29f06f87-f31a-4561-b41c-cd409836c1a4",
"db_currency_id": "0401f932-1f68-4e8f-8985-cdcf8e4faca6",
"db_language_id": "3dd5f25e-3bac-48ad-b2e0-b1b533fa5998",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00"
},
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00"
},
"date_in_production_since": "2024-07-26T18:51:55.6155387+00:00",
"date_out_of_production_since": "2024-07-26T18:51:55.6155387+00:00",
"date_end_support": "2024-07-26T18:51:55.6155387+00:00",
"sales_organization_id": "5b6ef592-c65c-48e5-a756-6da86c54543f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6e4dd1f9-4567-46ef-add5-b8e0ffed5038",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29f06f87-f31a-4561-b41c-cd409836c1a4",
"db_currency_id": "0401f932-1f68-4e8f-8985-cdcf8e4faca6",
"db_language_id": "3dd5f25e-3bac-48ad-b2e0-b1b533fa5998",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00"
},
"replacement_period_nb_months": 14,
"warranty_period_nb_months": 15,
"translations": [
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
},
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
}
],
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00"
},
"project_status_id": "aead2989-0935-40db-b64d-8a34a04c6696",
"project_status_code": "sample string 10",
"project_status": {
"id": "dd74c3f0-eadc-49b6-ac93-983546ce6397",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0914647f-d0f3-49ac-b22f-a0f4bb339ffb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6e4dd1f9-4567-46ef-add5-b8e0ffed5038",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29f06f87-f31a-4561-b41c-cd409836c1a4",
"db_currency_id": "0401f932-1f68-4e8f-8985-cdcf8e4faca6",
"db_language_id": "3dd5f25e-3bac-48ad-b2e0-b1b533fa5998",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00"
},
"company_id": "7136d3ca-49a8-4a42-8157-5dcc84dad8e9",
"company_code": "sample string 12",
"db_address_id": "ae59942b-84b4-49bd-9079-f32b593ca7a4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "df731081-c12a-492a-a5ac-401ab8ee8498",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4ffe5bea-6f34-4baa-83ae-d9c7cbd43d22",
"name": "sample string 19",
"description": "sample string 20",
"reference_back_office": "sample string 21",
"serial_number": "sample string 22",
"barcode": "sample string 23",
"date_start_production": "2024-07-26T18:51:55.6155387+00:00",
"date_create": "2024-07-26T18:51:55.6155387+00:00",
"date_update": "2024-07-26T18:51:55.6155387+00:00",
"updated_by_user_id": "c41051e0-fee2-4dca-9ae7-44be34f9c879",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-07-26T18:51:55.6155387+00:00",
"last_standard_result_score_1": "sample string 30",
"last_standard_result_score_2": "sample string 31",
"target_standard_result_score_1": "sample string 32",
"target_standard_result_score_2": "sample string 33",
"date_built": "2024-07-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-07-26T18:51:55.6155387+00:00",
"date_last_job": "2024-07-26T18:51:55.6155387+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-07-26T18:51:55.6155387+00:00",
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00",
"is_mobile_installation": true
},
"job_type_id": "98c5e602-cfde-48d8-a186-82ef87808747",
"job_type_code": "sample string 7",
"job_type": {
"id": "29064e67-91d1-4dad-8625-ddfe2f4b6311",
"name": "sample string 2",
"sales_organization_id": "267665ca-1719-44fd-abfd-a4598cf9df0d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00",
"code": "sample string 7"
},
"job_priority_id": "39ae41db-3715-47f1-b6dd-c98ea759eda2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "55aeda38-82ed-4d8a-8c91-65bdbeac9e3f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "da7d08d0-cb09-4c42-9840-f1a72837ddcc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6e4dd1f9-4567-46ef-add5-b8e0ffed5038",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29f06f87-f31a-4561-b41c-cd409836c1a4",
"db_currency_id": "0401f932-1f68-4e8f-8985-cdcf8e4faca6",
"db_language_id": "3dd5f25e-3bac-48ad-b2e0-b1b533fa5998",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00"
},
"job_status_id": "0ecea105-1f75-4e72-8af7-011ca186e920",
"job_status_code": "sample string 11",
"db_address_id": "4c58d840-98f7-4ff2-86ae-90e485dc1197",
"contact_id": "223a09bf-af3f-45ac-a9c5-f1db6fae51d6",
"requested_by_company_id": "27c59e92-d105-4a8f-94ed-8aecfae32745",
"requested_by_contact_id": "a5146d1f-6e14-4092-aaa1-9a9c4a3998c6",
"reference_back_office": "sample string 16",
"name": "sample string 17",
"description": "sample string 18",
"working_sequence": 19,
"internal_memo": "sample string 20",
"prejob_information": "sample string 21",
"estimated_time": 22,
"earliest_date_plannable": "2024-07-26T18:51:55.6155387+00:00",
"due_date": "2024-07-26T18:51:55.6155387+00:00",
"date_create": "2024-07-26T18:51:55.6155387+00:00",
"date_update": "2024-07-26T18:51:55.6155387+00:00",
"date_closed": "2024-07-26T18:51:55.6155387+00:00",
"suggested_user_id": "73e99edc-74fb-46ca-bb46-5c7dd7b902ba",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5c11933a-d06d-47a6-927a-48ba09798ee2",
"db_language_id": "909a9477-8265-4121-b231-0d252d749ad0",
"username": "sample string 3",
"firstname": "sample string 4",
"lastname": "sample string 5",
"code": "sample string 6",
"archived": true,
"disabled": true,
"emergency_contact": "sample string 9",
"bankaccount": "sample string 10",
"social_security": "sample string 11",
"place_of_birth": "sample string 12",
"nationality": "sample string 13",
"functions": "sample string 14",
"birthdate": "2024-07-26T18:51:55.6155387+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e8744bfb-eec0-472b-a38c-6d6044cbfccf",
"sales_organization": {
"id": "6e4dd1f9-4567-46ef-add5-b8e0ffed5038",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29f06f87-f31a-4561-b41c-cd409836c1a4",
"db_currency_id": "0401f932-1f68-4e8f-8985-cdcf8e4faca6",
"db_language_id": "3dd5f25e-3bac-48ad-b2e0-b1b533fa5998",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ab885bbb-897f-46b3-a91b-8686e6dfea1b",
"email": "sample string 22",
"phone": "sample string 23",
"fax": "sample string 24",
"mobile": "sample string 25",
"private_email": "sample string 26",
"private_phone": "sample string 27",
"private_fax": "sample string 28",
"private_mobile": "sample string 29",
"private_street": "sample string 30",
"private_street_number": "sample string 31",
"private_city": "sample string 32",
"private_zip": "sample string 33",
"private_db_country_id": "f85178ed-7644-445a-a6d0-bbe57a7a0491",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "12b05018-ed19-49c8-92b9-948b3bd18d75"
},
"suggested_date_start": "2024-07-26T18:51:55.6155387+00:00",
"skill_id": "e0c7547f-f402-4b1a-9ff2-e5df21140b39",
"skill_code": "sample string 32",
"skill": {
"id": "c604ff63-b511-4e9b-98f7-f79347ca691e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8c3d85e0-a38e-4e0e-a62e-d95770be237f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6e4dd1f9-4567-46ef-add5-b8e0ffed5038",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29f06f87-f31a-4561-b41c-cd409836c1a4",
"db_currency_id": "0401f932-1f68-4e8f-8985-cdcf8e4faca6",
"db_language_id": "3dd5f25e-3bac-48ad-b2e0-b1b533fa5998",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00"
},
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "58ef7089-b3d8-4fda-a9c6-9dc10d05d280",
"date_reported_by_company": "2024-07-26T18:51:55.6155387+00:00",
"id2": 36,
"company_id": "9a6ddd3e-e9b0-4d42-8d0d-06ded37ce628",
"company_code": "sample string 38",
"db_address_name": "sample string 39",
"db_address_street": "sample string 40",
"db_address_street2": "sample string 41",
"db_address_street_number": "sample string 42",
"db_address_city": "sample string 43",
"db_address_zip": "sample string 44",
"db_address_db_country_id": "219727f4-84aa-447c-a2c2-a8fd4fde90e4",
"db_address_db_country_code": "sample string 46",
"db_address_phone": "sample string 47",
"db_address_email": "sample string 48",
"db_address_latitude_decimal": 49.0,
"db_address_longitude_decimal": 50.0,
"estimated_quantity_remark": "sample string 51",
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00"
},
"work_instruction_details_id": "e15b845b-0e2c-4454-a998-a59d8039ab29",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a123077a-0dfa-4fcc-89fc-dfc0dc44256b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "23ff431e-4305-4f94-bfed-54246e12a795",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-07-26T18:51:55.6155387+00:00",
"remark": "sample string 13",
"advise": "sample string 14",
"sequence": 1,
"reference_back_office": "sample string 15",
"group_name": "sample string 16",
"group_sequence": 1,
"type": "sample string 17",
"instruction_document_count": 1,
"db_report_type_id": "5399c90c-c3f7-4937-90e0-670de8b4ab8e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-07-26T18:51:55.6155387+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.