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": "0ee1e35c-846b-4c8f-8125-8ea9dc808264",
"jobs_id": "a6200bd3-26ef-45d0-97e2-7e41e64fafa8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4569c60d-6257-4cf0-ac00-b5dc072f9752",
"_parent_id": "42f79bd8-1893-486c-8ffd-01850e4bc448",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f320b832-13b4-47db-aa07-13792c2a9344",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2479fe76-c5cd-4fc2-86a5-f1390ed3a43b",
"_parent_id": "2a4e739a-d696-46aa-8a5f-561c8f316189",
"root_parent_id": "c9edf291-e653-400c-b7aa-fd3c1bd61418",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c12d9628-c954-4710-9233-bf02f9d2c161",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "26d8cdba-335d-49b3-9b51-9ad4d18d899e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7a8ecbc7-479b-49ba-926c-0aa402d70880",
"_parent_code": "sample string 6",
"sales_organization_id": "d0245b02-7c21-4da8-a21c-2833e13ad099",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dbe4cb4b-3904-4c89-a3a8-a19421f1e4fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eaf6cd77-4c16-4aeb-9584-6ebb23272019",
"db_currency_id": "be7822c9-85f6-4999-a677-8aa5754487a3",
"db_language_id": "05b11e45-ad82-4c8d-9113-fa7208f46861",
"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-09-21T05:12:51.6185297+00:00"
},
"modified_dateutc": "2026-09-21T05:12:51.6185297+00:00"
},
"equipment_model_id": "6ecdf830-259d-487f-b705-28a630e71db6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a204f381-eec8-4c88-ba4e-efc19e21a560",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e8828953-30de-4b38-b14e-fea21d397e85",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6ab1b7c9-0f4a-4056-90ca-4bfb8af2c0e1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4adc6680-9668-42ef-88a4-2a73c8ccd5cb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dbe4cb4b-3904-4c89-a3a8-a19421f1e4fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eaf6cd77-4c16-4aeb-9584-6ebb23272019",
"db_currency_id": "be7822c9-85f6-4999-a677-8aa5754487a3",
"db_language_id": "05b11e45-ad82-4c8d-9113-fa7208f46861",
"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-09-21T05:12:51.6185297+00:00"
},
"modified_dateutc": "2026-09-21T05:12:51.6185297+00:00"
},
"equipment_family_id": "7979bffc-b3d0-415b-9378-f33ac31f5c22",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "26d8cdba-335d-49b3-9b51-9ad4d18d899e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7a8ecbc7-479b-49ba-926c-0aa402d70880",
"_parent_code": "sample string 6",
"sales_organization_id": "d0245b02-7c21-4da8-a21c-2833e13ad099",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dbe4cb4b-3904-4c89-a3a8-a19421f1e4fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eaf6cd77-4c16-4aeb-9584-6ebb23272019",
"db_currency_id": "be7822c9-85f6-4999-a677-8aa5754487a3",
"db_language_id": "05b11e45-ad82-4c8d-9113-fa7208f46861",
"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-09-21T05:12:51.6185297+00:00"
},
"modified_dateutc": "2026-09-21T05:12:51.6185297+00:00"
},
"date_in_production_since": "2026-09-21T05:12:51.6185297+00:00",
"date_out_of_production_since": "2026-09-21T05:12:51.6185297+00:00",
"date_end_support": "2026-09-21T05:12:51.6185297+00:00",
"sales_organization_id": "ebeb949c-17f4-48f2-96bf-b6931268ddac",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "dbe4cb4b-3904-4c89-a3a8-a19421f1e4fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eaf6cd77-4c16-4aeb-9584-6ebb23272019",
"db_currency_id": "be7822c9-85f6-4999-a677-8aa5754487a3",
"db_language_id": "05b11e45-ad82-4c8d-9113-fa7208f46861",
"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-09-21T05:12:51.6185297+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-09-21T05:12:51.6341432+00:00"
},
"project_status_id": "daa519cb-7b2a-4299-a2a6-c91468ed1091",
"project_status_code": "sample string 10",
"project_status": {
"id": "832aeff2-f4e7-4487-ab7e-3d518208ee08",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9ac1366b-6860-4c94-8845-2d27cac35ef5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dbe4cb4b-3904-4c89-a3a8-a19421f1e4fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eaf6cd77-4c16-4aeb-9584-6ebb23272019",
"db_currency_id": "be7822c9-85f6-4999-a677-8aa5754487a3",
"db_language_id": "05b11e45-ad82-4c8d-9113-fa7208f46861",
"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-09-21T05:12:51.6185297+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-21T05:12:51.6341432+00:00"
},
"company_id": "94089265-9896-418f-afeb-078433aa5fac",
"company_code": "sample string 12",
"db_address_id": "fd406556-ed0c-460f-8df0-63a01d8db517",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "493dec3d-2705-4fb1-b762-7df6b310b527",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "791c2edd-64d7-4c40-ac10-4a66627375f1",
"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-09-21T05:12:51.6341432+00:00",
"date_create": "2026-09-21T05:12:51.6341432+00:00",
"date_update": "2026-09-21T05:12:51.6341432+00:00",
"updated_by_user_id": "00b58eb4-876d-4d2d-a10f-839cc07c1cbd",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-21T05:12:51.6341432+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-09-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-21T05:12:51.6341432+00:00",
"date_last_job": "2026-09-21T05:12:51.6341432+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-21T05:12:51.6341432+00:00",
"modified_dateutc": "2026-09-21T05:12:51.6341432+00:00",
"is_mobile_installation": true
},
"job_type_id": "af0e893c-d839-460a-b1f5-e9065c85644b",
"job_type_code": "sample string 7",
"job_type": {
"id": "ae5eb662-b2d3-424c-86ea-50ff9640a8ef",
"name": "sample string 2",
"sales_organization_id": "a01548ae-c9d9-4935-9514-79e60fcc839a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-21T05:12:51.6341432+00:00",
"code": "sample string 7"
},
"job_priority_id": "63adda1c-851b-4098-be18-689975b8357b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "49feb4d0-d71f-4926-b47f-8bc14280be3d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9714de1d-5f64-4831-98f3-6c47452ef163",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dbe4cb4b-3904-4c89-a3a8-a19421f1e4fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eaf6cd77-4c16-4aeb-9584-6ebb23272019",
"db_currency_id": "be7822c9-85f6-4999-a677-8aa5754487a3",
"db_language_id": "05b11e45-ad82-4c8d-9113-fa7208f46861",
"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-09-21T05:12:51.6185297+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-21T05:12:51.6341432+00:00"
},
"job_status_id": "af0cbbf9-70be-4e29-a93a-8a3d969fc0e0",
"job_status_code": "sample string 11",
"db_address_id": "77080069-ab97-442c-a065-4701155566bd",
"contact_id": "5d017b41-00e1-477d-8bb5-244543cba2c4",
"requested_by_company_id": "20d097c2-1775-4ad1-8cbc-827a69ccd4b8",
"requested_by_contact_id": "b3417022-6dd5-477f-984e-338d1e30824c",
"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-09-21T05:12:51.6341432+00:00",
"due_date": "2026-09-21T05:12:51.6341432+00:00",
"date_create": "2026-09-21T05:12:51.6341432+00:00",
"date_update": "2026-09-21T05:12:51.6341432+00:00",
"date_closed": "2026-09-21T05:12:51.6341432+00:00",
"suggested_user_id": "9c580e0f-0e21-4501-8ea2-1a0216523b34",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "bd7140c9-a5ac-459f-b874-44805e2861f8",
"db_language_id": "2bd44e50-0c0c-43c8-bfb1-282343f43786",
"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-09-21T05:12:51.6341432+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b5808eb4-51f4-4a7b-9740-60b8056b93ab",
"sales_organization": {
"id": "dbe4cb4b-3904-4c89-a3a8-a19421f1e4fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eaf6cd77-4c16-4aeb-9584-6ebb23272019",
"db_currency_id": "be7822c9-85f6-4999-a677-8aa5754487a3",
"db_language_id": "05b11e45-ad82-4c8d-9113-fa7208f46861",
"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-09-21T05:12:51.6185297+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3ce50e98-c66d-4cbb-8172-fb45ea4db17e",
"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": "6500a409-66c2-4649-8149-c0cbdaf68be0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-21T05:12:51.6341432+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d0d00f63-1a2b-4366-b2e3-e5015b0b25af"
},
"suggested_date_start": "2026-09-21T05:12:51.6341432+00:00",
"skill_id": "0b1645d7-b07d-4fa5-9a70-d3174524f95a",
"skill_code": "sample string 32",
"skill": {
"id": "34a59ceb-43d0-4ebe-b0bb-54dc7fe5d0fd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5a6727b1-b1d5-4902-b9e2-9aaf02577235",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dbe4cb4b-3904-4c89-a3a8-a19421f1e4fd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eaf6cd77-4c16-4aeb-9584-6ebb23272019",
"db_currency_id": "be7822c9-85f6-4999-a677-8aa5754487a3",
"db_language_id": "05b11e45-ad82-4c8d-9113-fa7208f46861",
"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-09-21T05:12:51.6185297+00:00"
},
"modified_dateutc": "2026-09-21T05:12:51.6341432+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "56bea984-dbcc-4e68-acad-ace3b8675d1e",
"date_reported_by_company": "2026-09-21T05:12:51.6341432+00:00",
"id2": 36,
"company_id": "3233074c-5f96-43ac-ad91-aad9b02f9fb6",
"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": "bbbe44ea-04f1-4381-a59c-dfea9ecb37e3",
"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-09-21T05:12:51.6341432+00:00"
},
"work_instruction_details_id": "c17356a8-8ca5-486f-bb7c-082e2f27c1c5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "83d63830-ca59-4a44-a72b-2f19b9d31e32",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "33d812d3-12c1-42cb-bf26-d6399bccbc92",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-21T05:12:51.6341432+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": "9e1cc4a4-1f03-4244-96ec-2a4e05c83dd8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-21T05:12:51.6341432+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.