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": "fdcefa24-892a-4f16-95b6-68f36f30f4b6",
"jobs_id": "f7210e14-fefb-484c-a85e-d45ba8b77cd7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5b03d887-823a-4379-ae15-07817137cb6e",
"_parent_id": "05044711-0ccf-4312-b917-4aac604fa3c3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8d61e7c3-a557-4df2-92cf-600be46b570d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3da0cf4b-67cb-4785-9e10-ef14b8c58209",
"_parent_id": "8ddd4846-28bd-4702-9291-7b41b339d48b",
"root_parent_id": "6cf1659a-2c8f-4c6e-9e82-139362de5dc1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "71fcef9b-885c-4dd9-b777-10bc80cfb3c6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "99cd1172-975b-4896-8124-741e804997e9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "138f5aa9-642e-4073-9286-5a00e940fc95",
"_parent_code": "sample string 6",
"sales_organization_id": "1a376540-6733-46e2-b0ec-08f218a45a85",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2aedbe10-04e1-4de5-82e1-7adb5a9131a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8e23a20-4bc3-4854-9a53-c5b01374c219",
"db_currency_id": "c8872592-938f-4571-9b3e-02db52710f41",
"db_language_id": "81c27ca9-a63e-4c8d-9afd-878a7acd004e",
"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-07-28T17:02:43.4429823+00:00"
},
"modified_dateutc": "2026-07-28T17:02:43.4429823+00:00"
},
"equipment_model_id": "a08e8723-8a0a-4617-8a30-eed6f00a6903",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "284ec94b-8170-4dd0-9461-1f0aedc23058",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "937cb930-473b-4390-b633-0986b91dcab5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c5af70b8-3d98-4212-b79f-99f967a684ce",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "47f74faf-9621-4448-9e2e-53120f6fd895",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2aedbe10-04e1-4de5-82e1-7adb5a9131a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8e23a20-4bc3-4854-9a53-c5b01374c219",
"db_currency_id": "c8872592-938f-4571-9b3e-02db52710f41",
"db_language_id": "81c27ca9-a63e-4c8d-9afd-878a7acd004e",
"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-07-28T17:02:43.4429823+00:00"
},
"modified_dateutc": "2026-07-28T17:02:43.4429823+00:00"
},
"equipment_family_id": "5b0ee19e-a79d-455e-bb61-b55d10901758",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "99cd1172-975b-4896-8124-741e804997e9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "138f5aa9-642e-4073-9286-5a00e940fc95",
"_parent_code": "sample string 6",
"sales_organization_id": "1a376540-6733-46e2-b0ec-08f218a45a85",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2aedbe10-04e1-4de5-82e1-7adb5a9131a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8e23a20-4bc3-4854-9a53-c5b01374c219",
"db_currency_id": "c8872592-938f-4571-9b3e-02db52710f41",
"db_language_id": "81c27ca9-a63e-4c8d-9afd-878a7acd004e",
"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-07-28T17:02:43.4429823+00:00"
},
"modified_dateutc": "2026-07-28T17:02:43.4429823+00:00"
},
"date_in_production_since": "2026-07-28T17:02:43.4429823+00:00",
"date_out_of_production_since": "2026-07-28T17:02:43.4429823+00:00",
"date_end_support": "2026-07-28T17:02:43.4429823+00:00",
"sales_organization_id": "deada420-b9c6-4594-ac13-ec4a1da81ea2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2aedbe10-04e1-4de5-82e1-7adb5a9131a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8e23a20-4bc3-4854-9a53-c5b01374c219",
"db_currency_id": "c8872592-938f-4571-9b3e-02db52710f41",
"db_language_id": "81c27ca9-a63e-4c8d-9afd-878a7acd004e",
"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-07-28T17:02:43.4429823+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-07-28T17:02:43.4429823+00:00"
},
"project_status_id": "87e23052-cb79-41f5-a976-ba7955fb2e7d",
"project_status_code": "sample string 10",
"project_status": {
"id": "02b8996a-8d9c-4072-9129-a2e082213f1c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9d8184bc-66b5-47d3-b714-11cc5186e455",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2aedbe10-04e1-4de5-82e1-7adb5a9131a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8e23a20-4bc3-4854-9a53-c5b01374c219",
"db_currency_id": "c8872592-938f-4571-9b3e-02db52710f41",
"db_language_id": "81c27ca9-a63e-4c8d-9afd-878a7acd004e",
"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-07-28T17:02:43.4429823+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-28T17:02:43.4429823+00:00"
},
"company_id": "331df173-477d-470e-858d-66a185a9ed1d",
"company_code": "sample string 12",
"db_address_id": "5e76641b-2824-4a9d-a4c3-78b65fa5c07f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "dc178bca-8555-4569-9e6c-80f86f5a54f7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "548b2863-8ff4-4880-b194-91684282f511",
"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-07-28T17:02:43.4429823+00:00",
"date_create": "2026-07-28T17:02:43.4429823+00:00",
"date_update": "2026-07-28T17:02:43.4429823+00:00",
"updated_by_user_id": "8d6ed5ca-fdd5-4ec3-a987-573fa4ecd3e1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-28T17:02:43.4429823+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-07-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-28T17:02:43.4429823+00:00",
"date_last_job": "2026-07-28T17:02:43.4429823+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-28T17:02:43.4429823+00:00",
"modified_dateutc": "2026-07-28T17:02:43.4429823+00:00",
"is_mobile_installation": true
},
"job_type_id": "489ed84f-19ab-4f09-a79b-e7fc15fc06a6",
"job_type_code": "sample string 7",
"job_type": {
"id": "1aeffbda-6d90-499a-821e-0b2581f4796b",
"name": "sample string 2",
"sales_organization_id": "d16d2abc-5a50-46a7-acbd-15f8727dad49",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-28T17:02:43.4429823+00:00",
"code": "sample string 7"
},
"job_priority_id": "2fc4d98f-a769-411a-bffa-ae3c79313013",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "dd66e0a9-77d7-4096-9707-9e6c09f1ac43",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "00b37cfe-655e-4319-b357-f6ed2f876bea",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2aedbe10-04e1-4de5-82e1-7adb5a9131a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8e23a20-4bc3-4854-9a53-c5b01374c219",
"db_currency_id": "c8872592-938f-4571-9b3e-02db52710f41",
"db_language_id": "81c27ca9-a63e-4c8d-9afd-878a7acd004e",
"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-07-28T17:02:43.4429823+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-28T17:02:43.4429823+00:00"
},
"job_status_id": "36acbf82-6962-4280-af5e-051eccca2716",
"job_status_code": "sample string 11",
"db_address_id": "455ebfb4-a47a-4ea6-afc3-11f6e6e8c678",
"contact_id": "18f65921-17bc-4234-8f95-19b4fe178ebd",
"requested_by_company_id": "ead34250-5a25-470b-8c6b-0e0b0b8589c4",
"requested_by_contact_id": "82cc72e2-7dfc-49ac-8cf6-64d3358486a1",
"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-07-28T17:02:43.4429823+00:00",
"due_date": "2026-07-28T17:02:43.4429823+00:00",
"date_create": "2026-07-28T17:02:43.4429823+00:00",
"date_update": "2026-07-28T17:02:43.4429823+00:00",
"date_closed": "2026-07-28T17:02:43.4429823+00:00",
"suggested_user_id": "6224aba1-f687-43b0-a118-8ef9e1daa738",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "75b1b2fe-d531-4e9f-abf9-c0711d334a1d",
"db_language_id": "f66b05aa-45d6-46af-8101-179d28bff092",
"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-07-28T17:02:43.4429823+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "76de75c5-c378-4f12-8657-fb36ecae56e2",
"sales_organization": {
"id": "2aedbe10-04e1-4de5-82e1-7adb5a9131a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8e23a20-4bc3-4854-9a53-c5b01374c219",
"db_currency_id": "c8872592-938f-4571-9b3e-02db52710f41",
"db_language_id": "81c27ca9-a63e-4c8d-9afd-878a7acd004e",
"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-07-28T17:02:43.4429823+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7f3f614f-68bb-4ff2-b223-1b617d4ce998",
"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": "385519ad-88a8-4909-a071-f577a1d0e37d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-28T17:02:43.4429823+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "23c29b83-fb84-4b5a-9223-0b09aff350e8"
},
"suggested_date_start": "2026-07-28T17:02:43.4429823+00:00",
"skill_id": "e1ff3096-7907-485c-b5c9-aa74b938479f",
"skill_code": "sample string 32",
"skill": {
"id": "37053273-fe1f-4d87-bcc5-170ac8e2cc7a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c4b3f08c-79a6-4aa5-8e7f-ac1c436c9ac9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2aedbe10-04e1-4de5-82e1-7adb5a9131a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8e23a20-4bc3-4854-9a53-c5b01374c219",
"db_currency_id": "c8872592-938f-4571-9b3e-02db52710f41",
"db_language_id": "81c27ca9-a63e-4c8d-9afd-878a7acd004e",
"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-07-28T17:02:43.4429823+00:00"
},
"modified_dateutc": "2026-07-28T17:02:43.4429823+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5e47cd23-0bc2-4116-988d-82f10082916c",
"date_reported_by_company": "2026-07-28T17:02:43.4429823+00:00",
"id2": 36,
"company_id": "d723a3a7-fa2b-4641-b6b8-8ec8e2f22a8b",
"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": "97d9d92a-4645-4977-9f12-21dedd5212cd",
"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-07-28T17:02:43.4429823+00:00"
},
"work_instruction_details_id": "0d088304-e279-44cf-a2d2-004aa550668f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8e90ac51-58d1-43c8-8be5-222d1b3b48a9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8f04b0da-376b-4f5c-a32b-b070d1442c79",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-28T17:02:43.4429823+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": "25da043b-e0c7-4b4f-9b17-e3eac023087a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-28T17:02:43.4429823+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.