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": "40064c20-fc01-4984-be62-18b753d3ae4d",
"jobs_id": "14d20c64-c331-4e8b-a9c8-d2a512a70ab8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "98ff32c2-602b-432b-aa8f-7ac59fba9934",
"_parent_id": "f4f55b98-c46b-482f-85eb-addd514cc3ca",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "204ff83f-5ac1-4c3a-9ac5-62e8c045f439",
"project_reference_back_office": "sample string 5",
"project": {
"id": "15271f30-f1d2-4fe2-a42d-e199415e7920",
"_parent_id": "4450558f-caea-43db-b727-1d61ac7837e9",
"root_parent_id": "3a5efedc-3bc0-4e21-aaa5-47c118e8d213",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d0fcdfa1-895e-47d4-8111-7c39f431b7a8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cbe73572-7f37-4ad9-a8da-60d9cf770bf3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6563164c-d9d7-4f0f-abfb-cb3ec350a762",
"_parent_code": "sample string 6",
"sales_organization_id": "0dd33254-f658-4935-80f0-dab4e14bf9c8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2c09c8fe-13a7-46ac-bb6b-16ac298d7b8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d7cb732-14c1-4810-ac89-53f5fe9592a9",
"db_currency_id": "e1546574-e0e3-40e5-856b-f0836d61ff90",
"db_language_id": "cce0ddeb-e2df-4360-8ece-817517fe04fc",
"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-03-27T20:33:47.2508658+00:00"
},
"modified_dateutc": "2026-03-27T20:33:47.2508658+00:00"
},
"equipment_model_id": "9fa4cb0a-b445-45ba-9fb4-73bfed901e35",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "82fee5e5-357b-4604-81a1-30db5ec92872",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1306a49c-da21-4afd-af3d-86ba28f7f41b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "983cfc05-1f94-411d-bdb3-dd7a95ee9a01",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c8760cec-2caf-4f2c-b5ba-d21c6f0196bc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2c09c8fe-13a7-46ac-bb6b-16ac298d7b8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d7cb732-14c1-4810-ac89-53f5fe9592a9",
"db_currency_id": "e1546574-e0e3-40e5-856b-f0836d61ff90",
"db_language_id": "cce0ddeb-e2df-4360-8ece-817517fe04fc",
"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-03-27T20:33:47.2508658+00:00"
},
"modified_dateutc": "2026-03-27T20:33:47.2508658+00:00"
},
"equipment_family_id": "49a23c91-5266-4f71-ace6-ae32ee2eb683",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cbe73572-7f37-4ad9-a8da-60d9cf770bf3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6563164c-d9d7-4f0f-abfb-cb3ec350a762",
"_parent_code": "sample string 6",
"sales_organization_id": "0dd33254-f658-4935-80f0-dab4e14bf9c8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2c09c8fe-13a7-46ac-bb6b-16ac298d7b8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d7cb732-14c1-4810-ac89-53f5fe9592a9",
"db_currency_id": "e1546574-e0e3-40e5-856b-f0836d61ff90",
"db_language_id": "cce0ddeb-e2df-4360-8ece-817517fe04fc",
"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-03-27T20:33:47.2508658+00:00"
},
"modified_dateutc": "2026-03-27T20:33:47.2508658+00:00"
},
"date_in_production_since": "2026-03-27T20:33:47.2508658+00:00",
"date_out_of_production_since": "2026-03-27T20:33:47.2508658+00:00",
"date_end_support": "2026-03-27T20:33:47.2508658+00:00",
"sales_organization_id": "2137b452-7fd2-4136-b669-c5c9e959c390",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2c09c8fe-13a7-46ac-bb6b-16ac298d7b8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d7cb732-14c1-4810-ac89-53f5fe9592a9",
"db_currency_id": "e1546574-e0e3-40e5-856b-f0836d61ff90",
"db_language_id": "cce0ddeb-e2df-4360-8ece-817517fe04fc",
"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-03-27T20:33:47.2508658+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-03-27T20:33:47.2508658+00:00"
},
"project_status_id": "e4baedbb-b0a3-48a6-b479-895b0b155690",
"project_status_code": "sample string 10",
"project_status": {
"id": "cb66750a-3d4c-449c-846b-1b8a1be7a308",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a000ced1-a58f-4b6b-899c-a0a8e9ee0480",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2c09c8fe-13a7-46ac-bb6b-16ac298d7b8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d7cb732-14c1-4810-ac89-53f5fe9592a9",
"db_currency_id": "e1546574-e0e3-40e5-856b-f0836d61ff90",
"db_language_id": "cce0ddeb-e2df-4360-8ece-817517fe04fc",
"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-03-27T20:33:47.2508658+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-27T20:33:47.2665152+00:00"
},
"company_id": "fb12335d-123a-44f7-97fd-e43782bb3e01",
"company_code": "sample string 12",
"db_address_id": "dae058e7-f2ef-4dde-b0e2-ea0b9d82a9b0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1b1add1a-3842-4f86-9bf0-6cce28688a0b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c934c406-27d2-4c44-9cc1-e48e041349c4",
"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-03-27T20:33:47.2665152+00:00",
"date_create": "2026-03-27T20:33:47.2665152+00:00",
"date_update": "2026-03-27T20:33:47.2665152+00:00",
"updated_by_user_id": "73a6947f-deb8-442b-a0fb-368fb984e3f5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-27T20:33:47.2665152+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-03-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-27T20:33:47.2665152+00:00",
"date_last_job": "2026-03-27T20:33:47.2665152+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-27T20:33:47.2665152+00:00",
"modified_dateutc": "2026-03-27T20:33:47.2665152+00:00",
"is_mobile_installation": true
},
"job_type_id": "ec71b097-70d7-473b-a79f-f01ea254d93e",
"job_type_code": "sample string 7",
"job_type": {
"id": "7552c8fe-f207-4bf3-a420-c278e3a094fe",
"name": "sample string 2",
"sales_organization_id": "7ccae560-51b0-4160-b531-448bdaf75d61",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-27T20:33:47.2665152+00:00",
"code": "sample string 7"
},
"job_priority_id": "ab36ff7f-4391-4567-9fc5-8e9c5d574e89",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "75c36ff1-447a-4f0f-aec2-beeebd0bd464",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "302b9942-bfeb-474a-8d0d-9d7291337660",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2c09c8fe-13a7-46ac-bb6b-16ac298d7b8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d7cb732-14c1-4810-ac89-53f5fe9592a9",
"db_currency_id": "e1546574-e0e3-40e5-856b-f0836d61ff90",
"db_language_id": "cce0ddeb-e2df-4360-8ece-817517fe04fc",
"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-03-27T20:33:47.2508658+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-27T20:33:47.2665152+00:00"
},
"job_status_id": "8dc0e5ad-326c-4607-8428-a3bf49fe456a",
"job_status_code": "sample string 11",
"db_address_id": "c72039ef-2a0d-4b20-929c-28b884b94ae6",
"contact_id": "a87bd711-63e4-41e5-8d88-b18ba89298ef",
"requested_by_company_id": "461d016d-6a1f-4fdb-b6d5-c3a241aea44c",
"requested_by_contact_id": "ff07595e-19b8-42b2-8331-1ce6922f6b0d",
"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-03-27T20:33:47.2665152+00:00",
"due_date": "2026-03-27T20:33:47.2665152+00:00",
"date_create": "2026-03-27T20:33:47.2665152+00:00",
"date_update": "2026-03-27T20:33:47.2665152+00:00",
"date_closed": "2026-03-27T20:33:47.2665152+00:00",
"suggested_user_id": "9cbb2777-0b6e-4cb8-93ee-5c9ed6f13a08",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "92c5aa9e-dd80-4fe5-ab6b-a3333132a351",
"db_language_id": "56edc4a9-0cd1-47c6-9acd-9989eea21fc2",
"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-03-27T20:33:47.2665152+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "08cea618-8da8-4f86-8404-349b7c37fbd4",
"sales_organization": {
"id": "2c09c8fe-13a7-46ac-bb6b-16ac298d7b8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d7cb732-14c1-4810-ac89-53f5fe9592a9",
"db_currency_id": "e1546574-e0e3-40e5-856b-f0836d61ff90",
"db_language_id": "cce0ddeb-e2df-4360-8ece-817517fe04fc",
"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-03-27T20:33:47.2508658+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "39651e25-31d1-4565-a2fd-aa66f871b8da",
"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": "f5aa1637-e6de-4730-b6d2-72c7dc12506c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-27T20:33:47.2665152+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f7c23e33-abb0-4e2f-acc8-04cc6cbfcb47"
},
"suggested_date_start": "2026-03-27T20:33:47.2665152+00:00",
"skill_id": "303e25b6-89a5-4d53-80d5-5bbb274ea4ee",
"skill_code": "sample string 32",
"skill": {
"id": "53a214a0-233f-47be-8fcb-412197e710a4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3dceefde-4a60-437a-9a9c-0a4a85072a4c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2c09c8fe-13a7-46ac-bb6b-16ac298d7b8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d7cb732-14c1-4810-ac89-53f5fe9592a9",
"db_currency_id": "e1546574-e0e3-40e5-856b-f0836d61ff90",
"db_language_id": "cce0ddeb-e2df-4360-8ece-817517fe04fc",
"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-03-27T20:33:47.2508658+00:00"
},
"modified_dateutc": "2026-03-27T20:33:47.2665152+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "10d35c91-854f-48b3-ba42-7bad5c3e0d78",
"date_reported_by_company": "2026-03-27T20:33:47.2665152+00:00",
"id2": 36,
"company_id": "6afe138b-3ce1-4fa0-9172-d8488db93407",
"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": "dfc9ae5a-c87b-4794-856d-f687d0ca8443",
"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-03-27T20:33:47.2821142+00:00"
},
"work_instruction_details_id": "8de2c880-ff2e-4e3d-9dc3-474ee64bbef8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d40d1e38-d649-4ed3-9d96-9144731626e1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d36f8ee2-70a2-451c-90ca-103780c3293f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-27T20:33:47.2821142+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": "7ee7ddde-3d07-46b5-8f3d-a7337d5c397b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-27T20:33:47.2821142+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.