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": "9dcc05c8-df25-476c-8211-09f03708da77",
"jobs_id": "0b996c91-6e96-43d7-89d4-1a592dab8e9d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e19c9e14-bab2-475b-9701-75662b922f02",
"_parent_id": "83def852-5d3e-4456-a6fa-6ff54676bc09",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7da07012-a919-4ec4-b3e1-a55b4a5f9871",
"project_reference_back_office": "sample string 5",
"project": {
"id": "94e01f84-d819-45fb-a00b-6e98e28f1112",
"_parent_id": "8098937d-6569-466c-85c3-4afa1c4e04ac",
"root_parent_id": "813f9df4-9435-4526-b99c-036d9e53d1cc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "862654ac-42e9-44e8-9b78-64ced6680fb9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bb0131c5-1918-4f7a-835d-a79edf0d3617",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "25d80529-0041-4d31-8a56-991f087cb4c5",
"_parent_code": "sample string 6",
"sales_organization_id": "c3691284-3082-44ff-bca4-25374e2efc6b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2fb3346c-2de6-4c95-9ae9-89bf50a98f7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf838def-9356-4d56-a68a-27a27605752c",
"db_currency_id": "0d060a98-b20b-4f1f-953d-6d103d38603d",
"db_language_id": "27ba355b-33d0-4d4b-bbfa-360db916e719",
"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-31T14:52:02.6106953+00:00"
},
"modified_dateutc": "2026-10-31T14:52:02.6106953+00:00"
},
"equipment_model_id": "23f42b10-15fd-4499-a985-1c4ecd0c07a5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "986290f8-9005-456d-a403-bd1d927c4179",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7a386fbb-c299-4710-ac09-05365a200fa7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2689efb0-5a35-4adc-81b4-c5b332fe356c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "37b063c0-0a1d-42ab-a739-b50b635c1e7d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2fb3346c-2de6-4c95-9ae9-89bf50a98f7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf838def-9356-4d56-a68a-27a27605752c",
"db_currency_id": "0d060a98-b20b-4f1f-953d-6d103d38603d",
"db_language_id": "27ba355b-33d0-4d4b-bbfa-360db916e719",
"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-31T14:52:02.6106953+00:00"
},
"modified_dateutc": "2026-10-31T14:52:02.6106953+00:00"
},
"equipment_family_id": "9716044b-52ab-4612-b1c1-0b72e34f628d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bb0131c5-1918-4f7a-835d-a79edf0d3617",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "25d80529-0041-4d31-8a56-991f087cb4c5",
"_parent_code": "sample string 6",
"sales_organization_id": "c3691284-3082-44ff-bca4-25374e2efc6b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2fb3346c-2de6-4c95-9ae9-89bf50a98f7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf838def-9356-4d56-a68a-27a27605752c",
"db_currency_id": "0d060a98-b20b-4f1f-953d-6d103d38603d",
"db_language_id": "27ba355b-33d0-4d4b-bbfa-360db916e719",
"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-31T14:52:02.6106953+00:00"
},
"modified_dateutc": "2026-10-31T14:52:02.6106953+00:00"
},
"date_in_production_since": "2026-10-31T14:52:02.6106953+00:00",
"date_out_of_production_since": "2026-10-31T14:52:02.6106953+00:00",
"date_end_support": "2026-10-31T14:52:02.6106953+00:00",
"sales_organization_id": "5c101786-4a2e-4ffe-beed-d8d6f6dcb9df",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2fb3346c-2de6-4c95-9ae9-89bf50a98f7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf838def-9356-4d56-a68a-27a27605752c",
"db_currency_id": "0d060a98-b20b-4f1f-953d-6d103d38603d",
"db_language_id": "27ba355b-33d0-4d4b-bbfa-360db916e719",
"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-31T14:52:02.6106953+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-31T14:52:02.6106953+00:00"
},
"project_status_id": "0ea8b7a6-b048-45cd-9521-db25c14e1ad3",
"project_status_code": "sample string 10",
"project_status": {
"id": "9baed4c8-ac42-4f62-962b-a0db9ab90c3a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d8b60548-cf45-421f-bc78-f8917dd67bd0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2fb3346c-2de6-4c95-9ae9-89bf50a98f7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf838def-9356-4d56-a68a-27a27605752c",
"db_currency_id": "0d060a98-b20b-4f1f-953d-6d103d38603d",
"db_language_id": "27ba355b-33d0-4d4b-bbfa-360db916e719",
"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-31T14:52:02.6106953+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-31T14:52:02.6106953+00:00"
},
"company_id": "7cfc7874-cb8f-43f9-bcf1-a40e6bc2817e",
"company_code": "sample string 12",
"db_address_id": "e477c27a-7643-468f-9492-432e25ba388a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "95c85fc6-f699-416c-bd53-011431a9d0b8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a2a62224-dbab-49c3-9961-1930f1dd8291",
"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-31T14:52:02.6106953+00:00",
"date_create": "2026-10-31T14:52:02.6106953+00:00",
"date_update": "2026-10-31T14:52:02.6106953+00:00",
"updated_by_user_id": "dbf71c8d-13a8-474a-93b6-0182faedc050",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-31T14:52:02.6106953+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-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-31T14:52:02.6106953+00:00",
"date_last_job": "2026-10-31T14:52:02.6106953+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-31T14:52:02.6106953+00:00",
"modified_dateutc": "2026-10-31T14:52:02.6106953+00:00",
"is_mobile_installation": true
},
"job_type_id": "efb9fa97-8a8f-4e23-bc48-0a6a74d6ab8e",
"job_type_code": "sample string 7",
"job_type": {
"id": "20834d51-7dc7-4f41-bf98-d439cf1ce88d",
"name": "sample string 2",
"sales_organization_id": "26ad5bc6-1f1d-4b19-a513-9a23175dc171",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-31T14:52:02.6106953+00:00",
"code": "sample string 7"
},
"job_priority_id": "c09f3b3b-bb2c-4811-973f-c4b702bbd5fd",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fc0eeb5e-86b2-42be-a85f-ee46e66c0c69",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2f61be88-e58c-4235-ae64-9e15cb871eb4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2fb3346c-2de6-4c95-9ae9-89bf50a98f7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf838def-9356-4d56-a68a-27a27605752c",
"db_currency_id": "0d060a98-b20b-4f1f-953d-6d103d38603d",
"db_language_id": "27ba355b-33d0-4d4b-bbfa-360db916e719",
"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-31T14:52:02.6106953+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-31T14:52:02.6106953+00:00"
},
"job_status_id": "5d3a0d77-0de4-4b6d-8fef-1f42b66afd00",
"job_status_code": "sample string 11",
"db_address_id": "b8d191af-b8b4-4991-8dad-85f684bb033b",
"contact_id": "724e7f6d-d3d8-4fc8-b5f1-41fbe2e5d843",
"requested_by_company_id": "6c9fdf48-a10f-4caa-9b76-affd9f76b434",
"requested_by_contact_id": "3c05a1d9-b7c7-4183-a4ef-51e63d805296",
"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-31T14:52:02.6106953+00:00",
"due_date": "2026-10-31T14:52:02.6106953+00:00",
"date_create": "2026-10-31T14:52:02.6106953+00:00",
"date_update": "2026-10-31T14:52:02.6106953+00:00",
"date_closed": "2026-10-31T14:52:02.6106953+00:00",
"suggested_user_id": "1e303201-709b-4027-a9f1-3202c24aafe0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b9dcf4f4-1bfb-497b-b9b7-bc4add4521a2",
"db_language_id": "68136c59-b70e-42ce-9926-a89408e9307b",
"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-31T14:52:02.6106953+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8f887c0b-531a-430e-a691-299e1a97e06e",
"sales_organization": {
"id": "2fb3346c-2de6-4c95-9ae9-89bf50a98f7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf838def-9356-4d56-a68a-27a27605752c",
"db_currency_id": "0d060a98-b20b-4f1f-953d-6d103d38603d",
"db_language_id": "27ba355b-33d0-4d4b-bbfa-360db916e719",
"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-31T14:52:02.6106953+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d5fb9478-0be1-4fb5-9410-e6ee333ba91e",
"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": "3878fa43-61f8-4b45-adf5-4acda56b19f7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-31T14:52:02.6106953+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "252b80d2-03e1-425a-bea2-87dc6027933e"
},
"suggested_date_start": "2026-10-31T14:52:02.6106953+00:00",
"skill_id": "15a2682b-d9c2-4f98-9a67-22a7a3867cbc",
"skill_code": "sample string 32",
"skill": {
"id": "8945cd26-b32c-42a2-8329-c1141e6c00f6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "18579671-7e14-41b0-915a-ef42d2983963",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2fb3346c-2de6-4c95-9ae9-89bf50a98f7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf838def-9356-4d56-a68a-27a27605752c",
"db_currency_id": "0d060a98-b20b-4f1f-953d-6d103d38603d",
"db_language_id": "27ba355b-33d0-4d4b-bbfa-360db916e719",
"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-31T14:52:02.6106953+00:00"
},
"modified_dateutc": "2026-10-31T14:52:02.6106953+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ba33dc97-411b-48a9-b3d3-3ad6cc1d457c",
"date_reported_by_company": "2026-10-31T14:52:02.6106953+00:00",
"id2": 36,
"company_id": "48353222-7055-4b47-842c-11b8ee7579c4",
"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": "d776baca-0ab2-4e50-aaf1-4e644c71e394",
"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-31T14:52:02.6106953+00:00"
},
"work_instruction_details_id": "67819eaa-a02f-416e-ab40-23fbd2489206",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1288bbf3-405c-42d6-a6a6-4cbb33614b4c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "43a32f39-7033-4dbb-8936-3c3ef9c4d309",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-31T14:52:02.6106953+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": "58fc06ed-7bc9-4021-a8aa-e027e73934a4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-31T14:52:02.6235231+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.