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": "b9a9ca98-77ea-435a-9053-295bff960628",
"jobs_id": "a6e89839-262b-4a45-b915-023c99547245",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1fae5ae2-3c53-43d0-9b85-dc3690579072",
"_parent_id": "6060c3e6-cd0f-4b42-a20a-fef8d82db0c5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5cfe14b5-88c4-47b7-b0d3-55a66f06c8a3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9c8f9396-96af-4967-9122-a73219f5be13",
"_parent_id": "c48ba0fa-1fa7-48e8-845f-8df04f719cf0",
"root_parent_id": "f61e3e29-5efb-41ce-9592-9bd5944f20c9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "83a8e466-54ca-44e6-8956-8145b712881e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a5e15a47-3355-41ba-9074-d4f04b8b7876",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8b2794c2-b002-47c3-82d2-a0045d70d5a2",
"_parent_code": "sample string 6",
"sales_organization_id": "3614c4d6-ab6c-41bd-9c11-8d16e86491f4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "365c845e-f937-41a0-a69e-a48daa26c822",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40c7ad8b-c8d0-4fd1-89bb-aba89dce6891",
"db_currency_id": "9b3665f3-b024-4706-99db-e2d72457a3c8",
"db_language_id": "24544190-f60b-48e9-a885-253002a15b59",
"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-08-19T08:36:55.6315153+00:00"
},
"modified_dateutc": "2026-08-19T08:36:55.6315153+00:00"
},
"equipment_model_id": "cb465422-6f28-4659-95b9-8baf7f2315d8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6bbfde5a-0d10-4f63-914e-9b83f849b973",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fcc90ea3-aa86-4141-9c29-b2fc8c86f4a5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a76e036e-801c-4888-bd97-8a88ddc724e1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4b998aec-4be6-4e6a-ac9a-7662f979b573",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "365c845e-f937-41a0-a69e-a48daa26c822",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40c7ad8b-c8d0-4fd1-89bb-aba89dce6891",
"db_currency_id": "9b3665f3-b024-4706-99db-e2d72457a3c8",
"db_language_id": "24544190-f60b-48e9-a885-253002a15b59",
"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-08-19T08:36:55.6315153+00:00"
},
"modified_dateutc": "2026-08-19T08:36:55.6315153+00:00"
},
"equipment_family_id": "8c9d4c10-a984-474c-a708-0d2dd2e2f141",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a5e15a47-3355-41ba-9074-d4f04b8b7876",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8b2794c2-b002-47c3-82d2-a0045d70d5a2",
"_parent_code": "sample string 6",
"sales_organization_id": "3614c4d6-ab6c-41bd-9c11-8d16e86491f4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "365c845e-f937-41a0-a69e-a48daa26c822",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40c7ad8b-c8d0-4fd1-89bb-aba89dce6891",
"db_currency_id": "9b3665f3-b024-4706-99db-e2d72457a3c8",
"db_language_id": "24544190-f60b-48e9-a885-253002a15b59",
"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-08-19T08:36:55.6315153+00:00"
},
"modified_dateutc": "2026-08-19T08:36:55.6315153+00:00"
},
"date_in_production_since": "2026-08-19T08:36:55.6315153+00:00",
"date_out_of_production_since": "2026-08-19T08:36:55.6315153+00:00",
"date_end_support": "2026-08-19T08:36:55.6315153+00:00",
"sales_organization_id": "20ba3394-f9d2-4d8d-8cc8-0084de00c4f6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "365c845e-f937-41a0-a69e-a48daa26c822",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40c7ad8b-c8d0-4fd1-89bb-aba89dce6891",
"db_currency_id": "9b3665f3-b024-4706-99db-e2d72457a3c8",
"db_language_id": "24544190-f60b-48e9-a885-253002a15b59",
"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-08-19T08:36:55.6315153+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-08-19T08:36:55.6471386+00:00"
},
"project_status_id": "9504b162-072c-492b-a239-9d45d0ef592a",
"project_status_code": "sample string 10",
"project_status": {
"id": "f85e7be3-3c93-42ce-ba1f-607ec1e74636",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "03086c26-bc0d-4d11-8707-dbad157cbed8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "365c845e-f937-41a0-a69e-a48daa26c822",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40c7ad8b-c8d0-4fd1-89bb-aba89dce6891",
"db_currency_id": "9b3665f3-b024-4706-99db-e2d72457a3c8",
"db_language_id": "24544190-f60b-48e9-a885-253002a15b59",
"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-08-19T08:36:55.6315153+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-19T08:36:55.6471386+00:00"
},
"company_id": "4906bb26-4a3f-4092-98b4-0c8ecb9d9702",
"company_code": "sample string 12",
"db_address_id": "676e195b-5fe3-4627-93ac-5e817f32a9ad",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ce5d8919-8f52-46a5-8143-0b0db9c9cdba",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e34ac9da-1772-45fe-b515-0d2f3199a18b",
"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-08-19T08:36:55.6471386+00:00",
"date_create": "2026-08-19T08:36:55.6471386+00:00",
"date_update": "2026-08-19T08:36:55.6471386+00:00",
"updated_by_user_id": "0694bf02-b2b4-4409-8cbc-7b623a28e780",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-19T08:36:55.6471386+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-08-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-19T08:36:55.6471386+00:00",
"date_last_job": "2026-08-19T08:36:55.6471386+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-19T08:36:55.6471386+00:00",
"modified_dateutc": "2026-08-19T08:36:55.6471386+00:00",
"is_mobile_installation": true
},
"job_type_id": "38a10150-3662-416a-bc87-381634268972",
"job_type_code": "sample string 7",
"job_type": {
"id": "c3fdd14f-381d-4baa-862b-7e5b62c4aba7",
"name": "sample string 2",
"sales_organization_id": "26ee3ff6-7e08-4909-813f-742c7f787420",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-19T08:36:55.6471386+00:00",
"code": "sample string 7"
},
"job_priority_id": "1d7423b3-28fe-44d8-bd50-cbf495f8aaba",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6ca3f585-3f4e-40f7-b9f8-173aaa793902",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "595b8a6d-a19f-450e-b795-cba87da94279",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "365c845e-f937-41a0-a69e-a48daa26c822",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40c7ad8b-c8d0-4fd1-89bb-aba89dce6891",
"db_currency_id": "9b3665f3-b024-4706-99db-e2d72457a3c8",
"db_language_id": "24544190-f60b-48e9-a885-253002a15b59",
"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-08-19T08:36:55.6315153+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-19T08:36:55.6471386+00:00"
},
"job_status_id": "e3a715be-1339-489c-9086-d3c24d0b418d",
"job_status_code": "sample string 11",
"db_address_id": "64942dbd-03b9-4d6e-8647-529136dc2979",
"contact_id": "31b1eac6-c0e6-470d-91d3-3b4742dd1a09",
"requested_by_company_id": "77774a84-c6cd-4f10-8f7d-e9d87c369b5a",
"requested_by_contact_id": "3d09d6b1-59c9-4340-813a-ae84f5fb47bc",
"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-08-19T08:36:55.6471386+00:00",
"due_date": "2026-08-19T08:36:55.6471386+00:00",
"date_create": "2026-08-19T08:36:55.6471386+00:00",
"date_update": "2026-08-19T08:36:55.6471386+00:00",
"date_closed": "2026-08-19T08:36:55.6471386+00:00",
"suggested_user_id": "a4fa7b45-ed72-484e-9b8d-20ceb2a056fb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e5c09ac3-d143-4bd2-9603-08031c4e0087",
"db_language_id": "90bf0189-9e44-471a-8dce-d5fdfbc18214",
"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-08-19T08:36:55.6471386+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f9620e27-ba33-479e-a364-a6d1ff6f6fa9",
"sales_organization": {
"id": "365c845e-f937-41a0-a69e-a48daa26c822",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40c7ad8b-c8d0-4fd1-89bb-aba89dce6891",
"db_currency_id": "9b3665f3-b024-4706-99db-e2d72457a3c8",
"db_language_id": "24544190-f60b-48e9-a885-253002a15b59",
"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-08-19T08:36:55.6315153+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3bcf69a1-cf6b-4abd-b80d-ac65d9d284a8",
"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": "0a8b9b4d-19ac-4b09-a5d5-50e724340012",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-19T08:36:55.6471386+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0d5f6c69-8f44-4cc9-ab07-72db12478011"
},
"suggested_date_start": "2026-08-19T08:36:55.6471386+00:00",
"skill_id": "d6715d69-f742-4d82-8380-fbdaa9054394",
"skill_code": "sample string 32",
"skill": {
"id": "35279283-5000-41f9-bc3f-f16f70384e8e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cea1a31f-cd09-43fb-8ddb-0d03a3368c9f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "365c845e-f937-41a0-a69e-a48daa26c822",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40c7ad8b-c8d0-4fd1-89bb-aba89dce6891",
"db_currency_id": "9b3665f3-b024-4706-99db-e2d72457a3c8",
"db_language_id": "24544190-f60b-48e9-a885-253002a15b59",
"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-08-19T08:36:55.6315153+00:00"
},
"modified_dateutc": "2026-08-19T08:36:55.6471386+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0ed24f36-e126-4c32-bdd5-80da10681266",
"date_reported_by_company": "2026-08-19T08:36:55.6471386+00:00",
"id2": 36,
"company_id": "ae7d1348-e398-47a3-adc8-a8eb15ff5a4b",
"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": "a2747d87-0a79-4883-8e6b-c70426210914",
"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-08-19T08:36:55.6471386+00:00"
},
"work_instruction_details_id": "4be71c4c-d5eb-4168-9982-026a36d8a6f8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "eea1b898-aacd-4203-bcd5-726113e3a0f1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5cb18661-ac77-450c-a980-35a9f27efdcf",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-19T08:36:55.6471386+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": "564ce863-d201-44a6-9bb5-73b591a05910",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-19T08:36:55.6471386+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.