Updates the job work instruction list with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
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": "02bd2b53-72bc-4543-9bdb-3f5853c37760",
"jobs_id": "6084158d-c0fc-4daa-bbba-821387edaab6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a3a8e281-e676-423c-9eaf-531126b9f733",
"_parent_id": "b255673e-91aa-4e8d-a65c-80e55a8206bb",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "674c87e6-9ba4-4d9b-a162-46ffeed5c4b4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d1593d3b-61f1-4075-9b16-5d18f1a1ae4e",
"_parent_id": "f2d55162-e542-494f-9ee6-76dee4a477d3",
"root_parent_id": "e79c8b73-d7b4-4a12-a399-e5cadc002a83",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "951f09eb-bc95-476e-9590-875c81ad16e6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2e32436f-03dc-46ef-b2bf-8c65ad8c53ac",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e75c1022-bbeb-4a77-90e7-627f67917d79",
"_parent_code": "sample string 6",
"sales_organization_id": "c890cae8-8dc3-43ad-92bf-ecf635099804",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e28bc760-873d-4085-98b8-4933b2c1e77c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2290ac9f-a46c-4a76-bdbc-f66c59837000",
"db_currency_id": "4b58772d-5778-41b9-b856-483c2c39d5ae",
"db_language_id": "e6873720-b5b5-40b2-8f01-5bf788a7e4c5",
"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": "2026-10-07T20:08:07.3837317+00:00"
},
"modified_dateutc": "2026-10-07T20:08:07.3837317+00:00"
},
"equipment_model_id": "3a18318c-7d5e-4d17-8c66-21be4341179c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "87e9d79c-4215-410c-b3f4-79fd27bcbd3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f7889863-9a73-48ad-bb0c-f90301da4641",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9f1c6838-c836-4bd3-ac54-7d856927a4c9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bd5ea8d1-29b8-4231-b0be-73b5c5204235",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e28bc760-873d-4085-98b8-4933b2c1e77c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2290ac9f-a46c-4a76-bdbc-f66c59837000",
"db_currency_id": "4b58772d-5778-41b9-b856-483c2c39d5ae",
"db_language_id": "e6873720-b5b5-40b2-8f01-5bf788a7e4c5",
"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": "2026-10-07T20:08:07.3837317+00:00"
},
"modified_dateutc": "2026-10-07T20:08:07.3837317+00:00"
},
"equipment_family_id": "dfa91be1-8093-4dfe-81c7-939a7512933a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2e32436f-03dc-46ef-b2bf-8c65ad8c53ac",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e75c1022-bbeb-4a77-90e7-627f67917d79",
"_parent_code": "sample string 6",
"sales_organization_id": "c890cae8-8dc3-43ad-92bf-ecf635099804",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e28bc760-873d-4085-98b8-4933b2c1e77c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2290ac9f-a46c-4a76-bdbc-f66c59837000",
"db_currency_id": "4b58772d-5778-41b9-b856-483c2c39d5ae",
"db_language_id": "e6873720-b5b5-40b2-8f01-5bf788a7e4c5",
"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": "2026-10-07T20:08:07.3837317+00:00"
},
"modified_dateutc": "2026-10-07T20:08:07.3837317+00:00"
},
"date_in_production_since": "2026-10-07T20:08:07.3837317+00:00",
"date_out_of_production_since": "2026-10-07T20:08:07.3837317+00:00",
"date_end_support": "2026-10-07T20:08:07.3837317+00:00",
"sales_organization_id": "b83c6f49-c039-4b4b-9f07-8d85ff54b0a5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e28bc760-873d-4085-98b8-4933b2c1e77c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2290ac9f-a46c-4a76-bdbc-f66c59837000",
"db_currency_id": "4b58772d-5778-41b9-b856-483c2c39d5ae",
"db_language_id": "e6873720-b5b5-40b2-8f01-5bf788a7e4c5",
"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": "2026-10-07T20:08:07.3837317+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": "2026-10-07T20:08:07.3837317+00:00"
},
"project_status_id": "b469dea1-8c4f-46a1-9768-4a93fb824399",
"project_status_code": "sample string 10",
"project_status": {
"id": "ce45e27e-43e3-48b1-ac69-957b71ca776f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d4fdb6a6-318d-48e3-a238-aa7b88d90653",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e28bc760-873d-4085-98b8-4933b2c1e77c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2290ac9f-a46c-4a76-bdbc-f66c59837000",
"db_currency_id": "4b58772d-5778-41b9-b856-483c2c39d5ae",
"db_language_id": "e6873720-b5b5-40b2-8f01-5bf788a7e4c5",
"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": "2026-10-07T20:08:07.3837317+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-07T20:08:07.3837317+00:00"
},
"company_id": "56e28c6a-0813-4b94-b957-efcf440e4ff4",
"company_code": "sample string 12",
"db_address_id": "347b931a-b287-4a48-a4ac-cfb526e03904",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cd567bcd-fbd1-496e-bc32-e19abf758ce7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a3e89dfb-5bc2-49c3-91c5-50cea5eac05c",
"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": "2026-10-07T20:08:07.3993488+00:00",
"date_create": "2026-10-07T20:08:07.3993488+00:00",
"date_update": "2026-10-07T20:08:07.3993488+00:00",
"updated_by_user_id": "5bd4f41b-855f-4bcc-88f0-c1534719727d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-07T20:08:07.3993488+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": "2026-10-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-07T20:08:07.3993488+00:00",
"date_last_job": "2026-10-07T20:08:07.3993488+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-07T20:08:07.3993488+00:00",
"modified_dateutc": "2026-10-07T20:08:07.3993488+00:00",
"is_mobile_installation": true
},
"job_type_id": "70402fc1-599b-49e7-b516-dda10f1ec723",
"job_type_code": "sample string 7",
"job_type": {
"id": "49512820-a229-4ca5-8402-081e3e59f834",
"name": "sample string 2",
"sales_organization_id": "d770eef0-8947-4f9f-bc9a-042445370a1d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-07T20:08:07.3993488+00:00",
"code": "sample string 7"
},
"job_priority_id": "e7d4eeee-e4eb-4bbd-839e-eb17eefc47e2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7d9c0887-84ce-4e85-bdb4-c46166dbadfc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "17cf7c0f-5bbc-47b6-a503-729e7c7f4861",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e28bc760-873d-4085-98b8-4933b2c1e77c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2290ac9f-a46c-4a76-bdbc-f66c59837000",
"db_currency_id": "4b58772d-5778-41b9-b856-483c2c39d5ae",
"db_language_id": "e6873720-b5b5-40b2-8f01-5bf788a7e4c5",
"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": "2026-10-07T20:08:07.3837317+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-07T20:08:07.3993488+00:00"
},
"job_status_id": "f4019546-0acb-4c66-a247-f2107e30b37a",
"job_status_code": "sample string 11",
"db_address_id": "ac8181b1-8003-4095-86c7-cac86dddf875",
"contact_id": "84d9880a-2026-4ab0-9c9c-6d4d1d98330b",
"requested_by_company_id": "91538042-e79b-43f8-8d64-1db7834bd177",
"requested_by_contact_id": "987c8de5-ad0e-4ae6-9ef6-82476e749e33",
"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": "2026-10-07T20:08:07.3993488+00:00",
"due_date": "2026-10-07T20:08:07.3993488+00:00",
"date_create": "2026-10-07T20:08:07.3993488+00:00",
"date_update": "2026-10-07T20:08:07.3993488+00:00",
"date_closed": "2026-10-07T20:08:07.3993488+00:00",
"suggested_user_id": "df2877a4-2290-48b8-b27a-62c3dfcb71ca",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f8df7efd-385f-4937-83f2-808b3180d1cf",
"db_language_id": "ef360a7e-ca5e-422e-9c41-87f9f5274cbf",
"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": "2026-10-07T20:08:07.3993488+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e6c34c78-1321-4314-b090-df061a1706fc",
"sales_organization": {
"id": "e28bc760-873d-4085-98b8-4933b2c1e77c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2290ac9f-a46c-4a76-bdbc-f66c59837000",
"db_currency_id": "4b58772d-5778-41b9-b856-483c2c39d5ae",
"db_language_id": "e6873720-b5b5-40b2-8f01-5bf788a7e4c5",
"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": "2026-10-07T20:08:07.3837317+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7879213b-745a-4e86-9f1d-b23b8d9dee2a",
"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": "4b867686-da7c-4e58-acc4-714db1017150",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-07T20:08:07.3993488+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e5d62a52-8f0d-4bb0-b94f-b46d18b2c3ef"
},
"suggested_date_start": "2026-10-07T20:08:07.3993488+00:00",
"skill_id": "4cab12dc-b26c-4b57-a29f-54a19d1b8c2a",
"skill_code": "sample string 32",
"skill": {
"id": "67c98dc0-344c-4809-a281-17389d1d5115",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "27d4f8ff-70c0-4a3f-beaf-8388faa72a14",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e28bc760-873d-4085-98b8-4933b2c1e77c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2290ac9f-a46c-4a76-bdbc-f66c59837000",
"db_currency_id": "4b58772d-5778-41b9-b856-483c2c39d5ae",
"db_language_id": "e6873720-b5b5-40b2-8f01-5bf788a7e4c5",
"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": "2026-10-07T20:08:07.3837317+00:00"
},
"modified_dateutc": "2026-10-07T20:08:07.3993488+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "eabb07b9-d41a-421b-9e84-49e6bede7f90",
"date_reported_by_company": "2026-10-07T20:08:07.3993488+00:00",
"id2": 36,
"company_id": "922b5fbc-9935-43e8-a250-127ea2625639",
"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": "d0817851-bbd1-4a1f-99d1-6b27a0c03d64",
"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": "2026-10-07T20:08:07.3993488+00:00"
},
"work_instruction_details_id": "979b26ff-8f4d-46b0-a4e3-739f1419d5bc",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cfb6573a-f9a1-469b-8818-4eddad67f37d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "933e3aee-9712-410a-8e17-cb5e22ae06fe",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-07T20:08:07.3993488+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": "0232888b-46c3-4027-b947-09364cc8b422",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-07T20:08:07.4155416+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.