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": "fb1892be-80e6-4b0a-ba8f-78010183ad9a",
"jobs_id": "dc073c3b-9ffc-4b6d-a904-bbf68ffe33a0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "29e014bc-80bb-4f18-9aeb-b0615d3fbeaa",
"_parent_id": "bab05b33-8762-4526-ba40-5bbf4e447bc7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "62577e23-ad7e-43ce-8c0e-e3916157d6fd",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7a0f1df4-dc9b-4087-b1d8-8c66a5f51a7c",
"_parent_id": "2e3135b3-9bf6-4b63-b166-df9d63cbef9e",
"root_parent_id": "0a8d9e35-308b-419c-96d9-7d9ac2dac714",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4c95efc1-4185-4a66-994b-2cf613869270",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8eec3696-535c-48a9-a0fe-64772e83593b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b94658ba-a51e-4c9a-bf89-6f126444766c",
"_parent_code": "sample string 6",
"sales_organization_id": "cfaa5471-db87-4d68-aa78-f15c67596977",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ee1129d5-9be7-41b6-bdeb-efda7d50aa0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef4e4a16-9677-48db-b38a-9372444728cc",
"db_currency_id": "d3ed6671-b123-46bc-868a-ce6fbcd4eb03",
"db_language_id": "3a588548-338b-4767-8aa2-9ea1af6f53a2",
"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": "2025-12-19T22:28:11.4606424+00:00"
},
"modified_dateutc": "2025-12-19T22:28:11.4606424+00:00"
},
"equipment_model_id": "f7dcd69d-d3c3-40b7-9fb4-667a954cf7f7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3ba53114-9d99-4cc1-b905-889162fa1ea8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ba7d800f-ac7b-4879-821f-5587e17d7a5d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e090a45b-1caa-4de1-99c4-198f418b1350",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c8f98b18-960d-4be7-b799-3fc9c8013d33",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ee1129d5-9be7-41b6-bdeb-efda7d50aa0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef4e4a16-9677-48db-b38a-9372444728cc",
"db_currency_id": "d3ed6671-b123-46bc-868a-ce6fbcd4eb03",
"db_language_id": "3a588548-338b-4767-8aa2-9ea1af6f53a2",
"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": "2025-12-19T22:28:11.4606424+00:00"
},
"modified_dateutc": "2025-12-19T22:28:11.4606424+00:00"
},
"equipment_family_id": "45ccb92f-3429-4ae7-a4e6-e0f80886c800",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8eec3696-535c-48a9-a0fe-64772e83593b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b94658ba-a51e-4c9a-bf89-6f126444766c",
"_parent_code": "sample string 6",
"sales_organization_id": "cfaa5471-db87-4d68-aa78-f15c67596977",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ee1129d5-9be7-41b6-bdeb-efda7d50aa0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef4e4a16-9677-48db-b38a-9372444728cc",
"db_currency_id": "d3ed6671-b123-46bc-868a-ce6fbcd4eb03",
"db_language_id": "3a588548-338b-4767-8aa2-9ea1af6f53a2",
"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": "2025-12-19T22:28:11.4606424+00:00"
},
"modified_dateutc": "2025-12-19T22:28:11.4606424+00:00"
},
"date_in_production_since": "2025-12-19T22:28:11.4606424+00:00",
"date_out_of_production_since": "2025-12-19T22:28:11.4606424+00:00",
"date_end_support": "2025-12-19T22:28:11.4606424+00:00",
"sales_organization_id": "12d7d2d3-8be4-4a06-85d6-0f3f12fff1ce",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ee1129d5-9be7-41b6-bdeb-efda7d50aa0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef4e4a16-9677-48db-b38a-9372444728cc",
"db_currency_id": "d3ed6671-b123-46bc-868a-ce6fbcd4eb03",
"db_language_id": "3a588548-338b-4767-8aa2-9ea1af6f53a2",
"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": "2025-12-19T22:28:11.4606424+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": "2025-12-19T22:28:11.4606424+00:00"
},
"project_status_id": "3a57ed14-1465-4e8f-9a41-2cafc2eaa67d",
"project_status_code": "sample string 10",
"project_status": {
"id": "8f9d18df-e00b-40cc-8280-2bdc7a1c5d9b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "23ba58b7-cbca-4272-b1b2-53c403fe2821",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ee1129d5-9be7-41b6-bdeb-efda7d50aa0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef4e4a16-9677-48db-b38a-9372444728cc",
"db_currency_id": "d3ed6671-b123-46bc-868a-ce6fbcd4eb03",
"db_language_id": "3a588548-338b-4767-8aa2-9ea1af6f53a2",
"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": "2025-12-19T22:28:11.4606424+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-19T22:28:11.4606424+00:00"
},
"company_id": "ac32c582-9a63-44b9-ae0a-067c51ac7b21",
"company_code": "sample string 12",
"db_address_id": "ad78205c-10d0-42cc-a54f-ebb7517fce2e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2c7fac6f-eedd-40f2-93e3-9a01f51939ae",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5fb49b06-9314-423f-944c-bf8613e76f30",
"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": "2025-12-19T22:28:11.4606424+00:00",
"date_create": "2025-12-19T22:28:11.4606424+00:00",
"date_update": "2025-12-19T22:28:11.4606424+00:00",
"updated_by_user_id": "b2eebc4c-23f8-44c1-970a-1ac3d62c4df9",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-19T22:28:11.4606424+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": "2025-12-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-19T22:28:11.4606424+00:00",
"date_last_job": "2025-12-19T22:28:11.4606424+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-19T22:28:11.4606424+00:00",
"modified_dateutc": "2025-12-19T22:28:11.4606424+00:00",
"is_mobile_installation": true
},
"job_type_id": "501c5b0d-0525-4854-902e-19053ecfef98",
"job_type_code": "sample string 7",
"job_type": {
"id": "417ceba8-e42e-46a3-8dcf-f3ad7b6b775f",
"name": "sample string 2",
"sales_organization_id": "d44a1d52-cea1-4876-93dd-92f5bce3b423",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-19T22:28:11.4606424+00:00",
"code": "sample string 7"
},
"job_priority_id": "bf01869a-dbda-49af-9926-ecd45d74fce4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "559accef-fe74-4264-9191-20e8695d8c60",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0ad3db98-c0c8-4049-ab46-8df1ab5bb547",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ee1129d5-9be7-41b6-bdeb-efda7d50aa0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef4e4a16-9677-48db-b38a-9372444728cc",
"db_currency_id": "d3ed6671-b123-46bc-868a-ce6fbcd4eb03",
"db_language_id": "3a588548-338b-4767-8aa2-9ea1af6f53a2",
"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": "2025-12-19T22:28:11.4606424+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-19T22:28:11.4606424+00:00"
},
"job_status_id": "6b99a6d9-d96b-4b23-b29d-aab065908a8b",
"job_status_code": "sample string 11",
"db_address_id": "b01d728c-b8f5-4a9f-885f-04fc383de40e",
"contact_id": "e93f78ce-8add-4fc4-931d-701c5dce7087",
"requested_by_company_id": "e15a97ea-9f10-4c5c-986f-f55b6df7d7c2",
"requested_by_contact_id": "9df3e1b1-a771-4761-aa23-cc8a9f5f9775",
"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": "2025-12-19T22:28:11.4606424+00:00",
"due_date": "2025-12-19T22:28:11.4606424+00:00",
"date_create": "2025-12-19T22:28:11.4606424+00:00",
"date_update": "2025-12-19T22:28:11.4606424+00:00",
"date_closed": "2025-12-19T22:28:11.4606424+00:00",
"suggested_user_id": "024bd8aa-70ec-4ee3-a5d2-28248ceac84f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8a638340-0480-4946-8dd8-a6e60faeff76",
"db_language_id": "7313b948-1d74-47ac-8407-5c42ea04e1f4",
"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": "2025-12-19T22:28:11.4606424+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8c4ab6b7-0d36-4aab-ac74-05b7144751e2",
"sales_organization": {
"id": "ee1129d5-9be7-41b6-bdeb-efda7d50aa0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef4e4a16-9677-48db-b38a-9372444728cc",
"db_currency_id": "d3ed6671-b123-46bc-868a-ce6fbcd4eb03",
"db_language_id": "3a588548-338b-4767-8aa2-9ea1af6f53a2",
"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": "2025-12-19T22:28:11.4606424+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "35057513-0432-433e-8b18-84f5380a7775",
"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": "394cd628-dc64-498d-bd4e-7fadc3fe105a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-19T22:28:11.4606424+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3bfbd822-b1d2-4fbe-a75a-ed843d26cc64"
},
"suggested_date_start": "2025-12-19T22:28:11.4606424+00:00",
"skill_id": "9344c53a-c6aa-4e57-ad63-2085d504d2a5",
"skill_code": "sample string 32",
"skill": {
"id": "a9f018d9-4b73-42f4-b28a-aedb64bc36f3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4dae5006-0c4c-4569-9b31-73eb0ab78e25",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ee1129d5-9be7-41b6-bdeb-efda7d50aa0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef4e4a16-9677-48db-b38a-9372444728cc",
"db_currency_id": "d3ed6671-b123-46bc-868a-ce6fbcd4eb03",
"db_language_id": "3a588548-338b-4767-8aa2-9ea1af6f53a2",
"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": "2025-12-19T22:28:11.4606424+00:00"
},
"modified_dateutc": "2025-12-19T22:28:11.4606424+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d2580e3f-cd8b-4315-ba43-b85d4ce24da3",
"date_reported_by_company": "2025-12-19T22:28:11.4606424+00:00",
"id2": 36,
"company_id": "e6aeffac-da3c-42df-82f6-cb47cdabe33d",
"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": "439674d1-7eb9-47d0-b86c-0e85744c87f4",
"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": "2025-12-19T22:28:11.4606424+00:00"
},
"work_instruction_details_id": "21d0ce01-b5c2-4034-aeb8-ff01819a185f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dfcbc48a-f778-46ca-831c-312f5a7ce4c0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dab66589-fc48-45a7-923c-6e899d0f4edd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-19T22:28:11.4606424+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": "35f07f9b-7899-4d8a-aa2c-edabfa2831b4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-19T22:28:11.4606424+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.