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": "6056ba76-fb60-49a3-8172-69b7cea1261f",
"jobs_id": "bb736a45-b524-4260-b239-77229eda7b4a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a94bbf85-daa9-44bb-ad5b-4c407f3be1a0",
"_parent_id": "c65b3c73-8030-4b6d-bc40-3333f2152b55",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7c7dfbfe-c88d-4a14-be3a-147220b75261",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0a9fe4ea-4032-431c-b347-4d4c63896639",
"_parent_id": "32070bd4-e020-43be-88ae-2d5884343ec0",
"root_parent_id": "fd19de61-445d-4402-ac54-a0fe277d91dc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b4c810c1-dc63-4dff-96c7-f8bd65e957c9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "61249547-5b7e-4a06-b39d-0d03c40f83d2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6b0a8420-7bf9-4045-a801-aa5a85171623",
"_parent_code": "sample string 6",
"sales_organization_id": "b6cb0031-2ec8-458b-98cf-3c86f6fc42dd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a445745f-c44f-43be-85c8-ec9c3aa23d80",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b72f3b3-0f16-4b6f-ad5c-63ee64b48ce9",
"db_currency_id": "77f10024-a8c6-4bab-b0e2-7b0ffc3596ce",
"db_language_id": "46d551e3-6dc6-409f-8b09-01f82cfb6110",
"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-14T22:55:50.8385682+00:00"
},
"modified_dateutc": "2026-08-14T22:55:50.8385682+00:00"
},
"equipment_model_id": "34d86b2a-5b8b-4a00-90b2-e19cef4c8d1d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a046fd8c-cfe0-4ad2-adad-05b80c6f9e09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c0bf00ef-c3cd-4ec9-90fa-0a6a6e3584de",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8a9f82ab-7896-47c6-8f9b-1db5587d4b10",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b19de156-e9ad-45e1-bac1-a6a4f262a286",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a445745f-c44f-43be-85c8-ec9c3aa23d80",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b72f3b3-0f16-4b6f-ad5c-63ee64b48ce9",
"db_currency_id": "77f10024-a8c6-4bab-b0e2-7b0ffc3596ce",
"db_language_id": "46d551e3-6dc6-409f-8b09-01f82cfb6110",
"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-14T22:55:50.8385682+00:00"
},
"modified_dateutc": "2026-08-14T22:55:50.8385682+00:00"
},
"equipment_family_id": "9c4ca3ee-96da-41a0-b22b-205fb7bf75e3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "61249547-5b7e-4a06-b39d-0d03c40f83d2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6b0a8420-7bf9-4045-a801-aa5a85171623",
"_parent_code": "sample string 6",
"sales_organization_id": "b6cb0031-2ec8-458b-98cf-3c86f6fc42dd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a445745f-c44f-43be-85c8-ec9c3aa23d80",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b72f3b3-0f16-4b6f-ad5c-63ee64b48ce9",
"db_currency_id": "77f10024-a8c6-4bab-b0e2-7b0ffc3596ce",
"db_language_id": "46d551e3-6dc6-409f-8b09-01f82cfb6110",
"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-14T22:55:50.8385682+00:00"
},
"modified_dateutc": "2026-08-14T22:55:50.8385682+00:00"
},
"date_in_production_since": "2026-08-14T22:55:50.8385682+00:00",
"date_out_of_production_since": "2026-08-14T22:55:50.8385682+00:00",
"date_end_support": "2026-08-14T22:55:50.8385682+00:00",
"sales_organization_id": "43b245c2-bce2-4c9d-ad70-d42581a193c4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a445745f-c44f-43be-85c8-ec9c3aa23d80",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b72f3b3-0f16-4b6f-ad5c-63ee64b48ce9",
"db_currency_id": "77f10024-a8c6-4bab-b0e2-7b0ffc3596ce",
"db_language_id": "46d551e3-6dc6-409f-8b09-01f82cfb6110",
"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-14T22:55:50.8385682+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-14T22:55:50.8385682+00:00"
},
"project_status_id": "88a57fab-55a0-4726-b478-9dd20906708e",
"project_status_code": "sample string 10",
"project_status": {
"id": "f4dc7f3d-ce59-4809-963c-95c6f62b5867",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c83da4c9-b12a-42f6-b245-0a252a7e32d3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a445745f-c44f-43be-85c8-ec9c3aa23d80",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b72f3b3-0f16-4b6f-ad5c-63ee64b48ce9",
"db_currency_id": "77f10024-a8c6-4bab-b0e2-7b0ffc3596ce",
"db_language_id": "46d551e3-6dc6-409f-8b09-01f82cfb6110",
"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-14T22:55:50.8385682+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-14T22:55:50.8385682+00:00"
},
"company_id": "1e3e3df5-3e90-419d-852f-89b7745a0978",
"company_code": "sample string 12",
"db_address_id": "94744b7c-015e-44f0-b7ba-72a49c85421e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b952b747-9ded-47cb-88e8-3d8c93f2fd42",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "50e6b309-ac61-4a9e-9ef9-2ef0abec79cb",
"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-14T22:55:50.8385682+00:00",
"date_create": "2026-08-14T22:55:50.8385682+00:00",
"date_update": "2026-08-14T22:55:50.8385682+00:00",
"updated_by_user_id": "a605ab00-0324-448b-a6f9-4b7581a1e8d8",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-14T22:55:50.8385682+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-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-14T22:55:50.8385682+00:00",
"date_last_job": "2026-08-14T22:55:50.8385682+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-14T22:55:50.8385682+00:00",
"modified_dateutc": "2026-08-14T22:55:50.8385682+00:00",
"is_mobile_installation": true
},
"job_type_id": "017afdfe-c832-4fe2-bba9-dcb7d8a09f29",
"job_type_code": "sample string 7",
"job_type": {
"id": "587b5b3f-40b4-4cef-9c35-9a89e819851d",
"name": "sample string 2",
"sales_organization_id": "053604ed-063b-4f6c-bb4c-8b3935facd0a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-14T22:55:50.8385682+00:00",
"code": "sample string 7"
},
"job_priority_id": "183b3e65-19bd-44e8-832f-fb29c4648dc2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5d2ebabd-68e4-4e1f-a098-017b0fdf787a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "125e72b5-6a02-4862-94df-b126ea978727",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a445745f-c44f-43be-85c8-ec9c3aa23d80",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b72f3b3-0f16-4b6f-ad5c-63ee64b48ce9",
"db_currency_id": "77f10024-a8c6-4bab-b0e2-7b0ffc3596ce",
"db_language_id": "46d551e3-6dc6-409f-8b09-01f82cfb6110",
"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-14T22:55:50.8385682+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-14T22:55:50.8385682+00:00"
},
"job_status_id": "506b5ea3-df96-4287-9360-5c097abd4876",
"job_status_code": "sample string 11",
"db_address_id": "da449577-f65b-48be-84fd-346bbd5b545c",
"contact_id": "a78b53e1-27f6-4805-b346-042aa0927e97",
"requested_by_company_id": "5fd5ed44-ef70-477d-8afe-cd21741a896d",
"requested_by_contact_id": "7a640179-c0e9-453e-aad4-019546155d4f",
"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-14T22:55:50.8385682+00:00",
"due_date": "2026-08-14T22:55:50.8385682+00:00",
"date_create": "2026-08-14T22:55:50.8385682+00:00",
"date_update": "2026-08-14T22:55:50.8385682+00:00",
"date_closed": "2026-08-14T22:55:50.8385682+00:00",
"suggested_user_id": "fb8507c9-3af0-4999-995d-b78e7562eac0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a1cbbfbb-b4b5-4cea-a857-638092ce496c",
"db_language_id": "0512a7c5-42fd-469e-9d29-4ff411383b0b",
"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-14T22:55:50.8385682+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "59b66703-5a5a-41bc-a8a7-cc3e1c86e2b5",
"sales_organization": {
"id": "a445745f-c44f-43be-85c8-ec9c3aa23d80",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b72f3b3-0f16-4b6f-ad5c-63ee64b48ce9",
"db_currency_id": "77f10024-a8c6-4bab-b0e2-7b0ffc3596ce",
"db_language_id": "46d551e3-6dc6-409f-8b09-01f82cfb6110",
"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-14T22:55:50.8385682+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a435f90d-9249-4459-bf1f-af378b559427",
"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": "9ee246df-0303-4f68-9329-f76dd82c72d8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-14T22:55:50.8385682+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "823a6b30-5581-419d-9cab-3f09b75cf4b7"
},
"suggested_date_start": "2026-08-14T22:55:50.8385682+00:00",
"skill_id": "91189bdb-bd81-45f0-87b3-271794c8bad4",
"skill_code": "sample string 32",
"skill": {
"id": "a8170f52-2409-4a9a-928b-3bf894f1be0c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e7dac675-39dd-476a-bb58-668ac05aa26e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a445745f-c44f-43be-85c8-ec9c3aa23d80",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b72f3b3-0f16-4b6f-ad5c-63ee64b48ce9",
"db_currency_id": "77f10024-a8c6-4bab-b0e2-7b0ffc3596ce",
"db_language_id": "46d551e3-6dc6-409f-8b09-01f82cfb6110",
"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-14T22:55:50.8385682+00:00"
},
"modified_dateutc": "2026-08-14T22:55:50.8385682+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "82662cff-23df-4047-9e9c-3d769a5f177a",
"date_reported_by_company": "2026-08-14T22:55:50.8385682+00:00",
"id2": 36,
"company_id": "1d1a4854-d1fe-4add-8f37-dafcbc87bd04",
"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": "7e0e3810-4d46-4107-b0ad-fc828b4e551f",
"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-14T22:55:50.8385682+00:00"
},
"work_instruction_details_id": "892b2d7d-c5ce-4ba3-bce2-c88cac2c6544",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fbac877c-3403-4a6e-b60f-0a05f11b41fa",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b0e8aecf-b83e-416a-8bae-f05686dd5979",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-14T22:55:50.8385682+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": "79e2cc8e-579a-434d-a022-64e72b73af42",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-14T22:55:50.8385682+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.