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": "ef041d99-51fe-41e4-bc27-b8e0ef86ecec",
"jobs_id": "45dc9456-6b28-4106-92cf-9016bb8a2f37",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ed28ea19-2f9c-4b4c-a2a8-9833938d05f6",
"_parent_id": "d9098d9b-86d9-4fd0-a357-e862c331ce92",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "66a94865-b7e7-4464-a17a-d635a34ea73e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "78ed858e-221d-4f23-a004-40de0d477f36",
"_parent_id": "35bb76c8-2d99-4258-b9ae-ced03c3b4ffc",
"root_parent_id": "fac957b1-fab9-4aab-b80e-757fd867f658",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ab4ee929-f14c-41f5-a3ae-0f02c05258a0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "afa4acf1-2a95-473c-90f0-890fb04c17c5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fb7914ab-e1a9-4468-8e78-b7742bf76c12",
"_parent_code": "sample string 6",
"sales_organization_id": "29db5539-5842-4b70-af4b-2fe5a35f8ced",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74dd6ea9-f0cd-4b8f-963d-65a18676a6aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a71e4e9-d1a5-4770-9d93-952dc36f500f",
"db_currency_id": "ab06e111-af2c-4bf2-b624-2d32d6859ea9",
"db_language_id": "abb05af6-bfc5-4d7e-8073-120696dc5941",
"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-23T00:10:19.8652889+00:00"
},
"modified_dateutc": "2026-09-23T00:10:19.8652889+00:00"
},
"equipment_model_id": "c653b90c-426f-4b10-973e-7bbfd1801f23",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "287269ab-5c8b-41d1-b11e-a0d3bf2db011",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2b475771-1cfd-4617-a9c6-5a8c592fa080",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a383aa45-c863-408a-ae30-711a29a2989e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "58f72fa5-c693-4520-a1b2-af81bac8a6f7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "74dd6ea9-f0cd-4b8f-963d-65a18676a6aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a71e4e9-d1a5-4770-9d93-952dc36f500f",
"db_currency_id": "ab06e111-af2c-4bf2-b624-2d32d6859ea9",
"db_language_id": "abb05af6-bfc5-4d7e-8073-120696dc5941",
"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-23T00:10:19.8652889+00:00"
},
"modified_dateutc": "2026-09-23T00:10:19.8652889+00:00"
},
"equipment_family_id": "30b031f4-949d-4c0b-a70f-fb75526d4e6c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "afa4acf1-2a95-473c-90f0-890fb04c17c5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fb7914ab-e1a9-4468-8e78-b7742bf76c12",
"_parent_code": "sample string 6",
"sales_organization_id": "29db5539-5842-4b70-af4b-2fe5a35f8ced",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74dd6ea9-f0cd-4b8f-963d-65a18676a6aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a71e4e9-d1a5-4770-9d93-952dc36f500f",
"db_currency_id": "ab06e111-af2c-4bf2-b624-2d32d6859ea9",
"db_language_id": "abb05af6-bfc5-4d7e-8073-120696dc5941",
"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-23T00:10:19.8652889+00:00"
},
"modified_dateutc": "2026-09-23T00:10:19.8652889+00:00"
},
"date_in_production_since": "2026-09-23T00:10:19.8652889+00:00",
"date_out_of_production_since": "2026-09-23T00:10:19.8652889+00:00",
"date_end_support": "2026-09-23T00:10:19.8652889+00:00",
"sales_organization_id": "7614731c-c3ad-4fd4-91da-7601f297b94b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "74dd6ea9-f0cd-4b8f-963d-65a18676a6aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a71e4e9-d1a5-4770-9d93-952dc36f500f",
"db_currency_id": "ab06e111-af2c-4bf2-b624-2d32d6859ea9",
"db_language_id": "abb05af6-bfc5-4d7e-8073-120696dc5941",
"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-23T00:10:19.8652889+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-23T00:10:19.8652889+00:00"
},
"project_status_id": "6237e85b-6b9c-4a4c-b0ea-bd7f0e1218c2",
"project_status_code": "sample string 10",
"project_status": {
"id": "8b1dc5bb-f762-4495-b847-09adac6a7850",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "42798ad5-8fb1-4f12-b33e-487804191d1f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74dd6ea9-f0cd-4b8f-963d-65a18676a6aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a71e4e9-d1a5-4770-9d93-952dc36f500f",
"db_currency_id": "ab06e111-af2c-4bf2-b624-2d32d6859ea9",
"db_language_id": "abb05af6-bfc5-4d7e-8073-120696dc5941",
"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-23T00:10:19.8652889+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T00:10:19.8652889+00:00"
},
"company_id": "09c45b1c-f91e-4831-8e5f-632d558b2aae",
"company_code": "sample string 12",
"db_address_id": "de6ef275-be1f-4ffc-8313-8d1f996d7811",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cf991f90-abc1-44d3-9f16-f2a37b8555e2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "519e4572-53da-491d-a778-2907433ee88a",
"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-23T00:10:19.8652889+00:00",
"date_create": "2026-09-23T00:10:19.8652889+00:00",
"date_update": "2026-09-23T00:10:19.8652889+00:00",
"updated_by_user_id": "b9a09f1b-463d-4c77-a2d6-c26c0e3a72a6",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-23T00:10:19.8652889+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-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-23T00:10:19.8652889+00:00",
"date_last_job": "2026-09-23T00:10:19.8652889+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-23T00:10:19.8652889+00:00",
"modified_dateutc": "2026-09-23T00:10:19.8652889+00:00",
"is_mobile_installation": true
},
"job_type_id": "8c86eee3-fa53-4535-a356-54d5fb03caf6",
"job_type_code": "sample string 7",
"job_type": {
"id": "bfaa6aca-4c56-481f-bf9d-e9378d53668a",
"name": "sample string 2",
"sales_organization_id": "0168814a-1792-4f97-8933-44f05b8c8709",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-23T00:10:19.8652889+00:00",
"code": "sample string 7"
},
"job_priority_id": "1444d4fd-68c9-481d-bab6-acaabd87f63a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "17c95afc-b80d-4f76-9669-68c763f8ae66",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e2fd2841-4839-49e5-b35e-4ab423abaf74",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74dd6ea9-f0cd-4b8f-963d-65a18676a6aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a71e4e9-d1a5-4770-9d93-952dc36f500f",
"db_currency_id": "ab06e111-af2c-4bf2-b624-2d32d6859ea9",
"db_language_id": "abb05af6-bfc5-4d7e-8073-120696dc5941",
"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-23T00:10:19.8652889+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T00:10:19.8652889+00:00"
},
"job_status_id": "c9fd3a86-36dc-4ea2-8343-6edf878ab0f1",
"job_status_code": "sample string 11",
"db_address_id": "cf23e0bb-75c4-402c-a11e-7771efb2fb0d",
"contact_id": "e3639b33-d1ad-4477-b0b9-3a4d6d423727",
"requested_by_company_id": "059dbaf3-3fc0-4696-83a8-326187be6dc9",
"requested_by_contact_id": "c444e71b-b9f2-41c2-b05a-2c75f49ce28d",
"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-23T00:10:19.8652889+00:00",
"due_date": "2026-09-23T00:10:19.8652889+00:00",
"date_create": "2026-09-23T00:10:19.8652889+00:00",
"date_update": "2026-09-23T00:10:19.8652889+00:00",
"date_closed": "2026-09-23T00:10:19.8652889+00:00",
"suggested_user_id": "e5c0b038-e059-4a9f-9eef-fc1e6c68b96a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "dca565a4-b412-452f-a569-4efafcac2e77",
"db_language_id": "78f9360b-6cde-450f-81d5-3d786d07ace2",
"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-23T00:10:19.8652889+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "04abaf37-9195-443c-8785-bcb294380d0b",
"sales_organization": {
"id": "74dd6ea9-f0cd-4b8f-963d-65a18676a6aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a71e4e9-d1a5-4770-9d93-952dc36f500f",
"db_currency_id": "ab06e111-af2c-4bf2-b624-2d32d6859ea9",
"db_language_id": "abb05af6-bfc5-4d7e-8073-120696dc5941",
"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-23T00:10:19.8652889+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f3027eb3-d995-48dc-91f7-3b5c607d164d",
"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": "ed4ed7f8-feaa-41b3-9004-74a648cbf7ea",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-23T00:10:19.8652889+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4e9d70f5-3b61-4267-9f45-f4b36ddacc43"
},
"suggested_date_start": "2026-09-23T00:10:19.8652889+00:00",
"skill_id": "c829288c-c814-43da-aac8-d58ef09e3d08",
"skill_code": "sample string 32",
"skill": {
"id": "a74333d9-561b-4c20-ab28-e552b0a1d778",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b8509f7d-ded8-41d2-a8ad-3fe1fa275a38",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74dd6ea9-f0cd-4b8f-963d-65a18676a6aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a71e4e9-d1a5-4770-9d93-952dc36f500f",
"db_currency_id": "ab06e111-af2c-4bf2-b624-2d32d6859ea9",
"db_language_id": "abb05af6-bfc5-4d7e-8073-120696dc5941",
"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-23T00:10:19.8652889+00:00"
},
"modified_dateutc": "2026-09-23T00:10:19.8652889+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d18e2dd3-cf60-4172-aaca-978a79019c07",
"date_reported_by_company": "2026-09-23T00:10:19.8652889+00:00",
"id2": 36,
"company_id": "090eee4d-d498-49e3-a3cd-26dfb14b9164",
"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": "4cd1ee8e-67a4-4ac9-9388-b24eba1350ea",
"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-23T00:10:19.8652889+00:00"
},
"work_instruction_details_id": "c0572e78-83f9-47c5-a4c8-d3788af600a9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c12680aa-06e3-4279-a0d6-23d7ea671cba",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d8b0d686-72a4-49b3-8ca1-2ae81873c577",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-23T00:10:19.8652889+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": "9891f8b7-420c-4dcd-ab60-c482b84f62e9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-23T00:10:19.8652889+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.