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": "34094bd6-51a9-4804-8928-f6d2581d020e",
"jobs_id": "0c13d727-64e5-4bc3-8c47-71a054e2b936",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ca703af8-a0d2-430d-820b-39aae25b05be",
"_parent_id": "d101a22a-c7f7-4804-bb2f-efd90af61189",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4db37218-fad6-4f2e-9267-a0f840ad4def",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0a5e36b4-5783-43af-9e4f-9c95b7b1997b",
"_parent_id": "f59c52c1-86ed-483d-881d-b5ab7f2da388",
"root_parent_id": "619cbfb1-ade7-4635-b54e-78770eca9172",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "21d1f13e-f38b-4203-9f8a-d159dfdb0a8a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2304f856-ddc5-45ef-80c7-175ab749a8f4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ace72bdc-d3fd-4528-9441-d4f45936dd8d",
"_parent_code": "sample string 6",
"sales_organization_id": "1210cfe2-5ef0-4a0c-bc51-69c94cd948be",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9783928d-c2bf-4150-a417-a1516a2ccfc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db71b8ed-52c9-4b02-beb4-f1c7fb4135da",
"db_currency_id": "fb6c9e4f-7afa-490b-84f0-58955fc211b7",
"db_language_id": "65379d0d-ed6b-4aed-9de7-b32c55f144a8",
"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-10-06T06:36:53.9430384+00:00"
},
"modified_dateutc": "2026-10-06T06:36:54.0211623+00:00"
},
"equipment_model_id": "de860125-b461-4b68-ae73-e7f71560984a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d447fc95-4e25-47b8-83b3-25c3db1ce439",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "135f22ab-bd16-4c2f-9d33-5ecf80496bf5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c69e6987-f32e-4c16-bb82-f0b817bc376b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e2f2e8ed-901d-4d38-afc3-6410d70c65ab",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9783928d-c2bf-4150-a417-a1516a2ccfc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db71b8ed-52c9-4b02-beb4-f1c7fb4135da",
"db_currency_id": "fb6c9e4f-7afa-490b-84f0-58955fc211b7",
"db_language_id": "65379d0d-ed6b-4aed-9de7-b32c55f144a8",
"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-10-06T06:36:53.9430384+00:00"
},
"modified_dateutc": "2026-10-06T06:36:54.0211623+00:00"
},
"equipment_family_id": "5dec1aee-1c34-4e3a-a981-b83bd2c3f6e5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2304f856-ddc5-45ef-80c7-175ab749a8f4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ace72bdc-d3fd-4528-9441-d4f45936dd8d",
"_parent_code": "sample string 6",
"sales_organization_id": "1210cfe2-5ef0-4a0c-bc51-69c94cd948be",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9783928d-c2bf-4150-a417-a1516a2ccfc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db71b8ed-52c9-4b02-beb4-f1c7fb4135da",
"db_currency_id": "fb6c9e4f-7afa-490b-84f0-58955fc211b7",
"db_language_id": "65379d0d-ed6b-4aed-9de7-b32c55f144a8",
"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-10-06T06:36:53.9430384+00:00"
},
"modified_dateutc": "2026-10-06T06:36:54.0211623+00:00"
},
"date_in_production_since": "2026-10-06T06:36:54.0211623+00:00",
"date_out_of_production_since": "2026-10-06T06:36:54.0211623+00:00",
"date_end_support": "2026-10-06T06:36:54.0211623+00:00",
"sales_organization_id": "5e947d27-5fe3-4c33-a1b8-2570f4dcfe4b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9783928d-c2bf-4150-a417-a1516a2ccfc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db71b8ed-52c9-4b02-beb4-f1c7fb4135da",
"db_currency_id": "fb6c9e4f-7afa-490b-84f0-58955fc211b7",
"db_language_id": "65379d0d-ed6b-4aed-9de7-b32c55f144a8",
"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-10-06T06:36:53.9430384+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-10-06T06:36:54.0400311+00:00"
},
"project_status_id": "84ef034b-f025-4c9b-adea-7d89da60aebd",
"project_status_code": "sample string 10",
"project_status": {
"id": "4871aaaa-6cdb-4464-b3d1-6ea14d2776ef",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f0a0a356-13aa-40de-b9d6-caba956dedeb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9783928d-c2bf-4150-a417-a1516a2ccfc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db71b8ed-52c9-4b02-beb4-f1c7fb4135da",
"db_currency_id": "fb6c9e4f-7afa-490b-84f0-58955fc211b7",
"db_language_id": "65379d0d-ed6b-4aed-9de7-b32c55f144a8",
"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-10-06T06:36:53.9430384+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-06T06:36:54.0524171+00:00"
},
"company_id": "12dcc6b2-d4fd-4f7b-89c2-c721adab01c0",
"company_code": "sample string 12",
"db_address_id": "ea7b4cfd-f685-4854-99a6-4fe6205c2bee",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d89e837f-1cab-4b88-ba92-b72cc4f68094",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "61c93c75-6486-4c03-baca-c5be4969f3c2",
"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-10-06T06:36:54.0524171+00:00",
"date_create": "2026-10-06T06:36:54.0524171+00:00",
"date_update": "2026-10-06T06:36:54.0524171+00:00",
"updated_by_user_id": "dace2bfd-1d7e-4f51-b288-0669d386813d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-06T06:36:54.0524171+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-10-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-06T06:36:54.0524171+00:00",
"date_last_job": "2026-10-06T06:36:54.0524171+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-06T06:36:54.0524171+00:00",
"modified_dateutc": "2026-10-06T06:36:54.0524171+00:00",
"is_mobile_installation": true
},
"job_type_id": "175ae762-a07d-4daf-b2f1-a8fbf4a99908",
"job_type_code": "sample string 7",
"job_type": {
"id": "5cef292a-9f40-4a17-819c-e73a60d428bb",
"name": "sample string 2",
"sales_organization_id": "7a65f37d-5658-42ce-baf8-c83f87721fe1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-06T06:36:54.0524171+00:00",
"code": "sample string 7"
},
"job_priority_id": "7b9156e0-2d4b-40e7-8404-480fc063d842",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f1f1d381-4296-42b8-8788-83cf88a4bbf5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "27eb4f82-0b91-48a5-be71-9edb9ef682cc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9783928d-c2bf-4150-a417-a1516a2ccfc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db71b8ed-52c9-4b02-beb4-f1c7fb4135da",
"db_currency_id": "fb6c9e4f-7afa-490b-84f0-58955fc211b7",
"db_language_id": "65379d0d-ed6b-4aed-9de7-b32c55f144a8",
"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-10-06T06:36:53.9430384+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-06T06:36:54.0524171+00:00"
},
"job_status_id": "d44046d1-1892-4cf0-b432-0400a3f61c43",
"job_status_code": "sample string 11",
"db_address_id": "5cfef914-cbcf-44dc-a882-dc64e203ef46",
"contact_id": "e5bb32cd-e7ec-465e-b407-5199d8ed8180",
"requested_by_company_id": "36400e2c-77f5-436c-b520-50880c5f6160",
"requested_by_contact_id": "33bbea43-e119-4ae0-8649-667bd9efa15d",
"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-10-06T06:36:54.0695782+00:00",
"due_date": "2026-10-06T06:36:54.0695782+00:00",
"date_create": "2026-10-06T06:36:54.0695782+00:00",
"date_update": "2026-10-06T06:36:54.0695782+00:00",
"date_closed": "2026-10-06T06:36:54.0695782+00:00",
"suggested_user_id": "6770a9a6-02ae-41ff-a28c-390e05104c4a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "04d7cbaf-c97a-4062-9204-164e1f18f766",
"db_language_id": "060235cb-24e6-4825-803d-e094868c8eff",
"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-10-06T06:36:54.0695782+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3c4deabd-34a5-41fd-8360-410204e79884",
"sales_organization": {
"id": "9783928d-c2bf-4150-a417-a1516a2ccfc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db71b8ed-52c9-4b02-beb4-f1c7fb4135da",
"db_currency_id": "fb6c9e4f-7afa-490b-84f0-58955fc211b7",
"db_language_id": "65379d0d-ed6b-4aed-9de7-b32c55f144a8",
"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-10-06T06:36:53.9430384+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2a96fb61-3157-48bd-8632-3405458241a4",
"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": "62be5feb-7e4b-4dbc-8e36-04f8e9167e0a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-06T06:36:54.0695782+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6203ca29-b21e-45df-b2f9-06538663fe02"
},
"suggested_date_start": "2026-10-06T06:36:54.0695782+00:00",
"skill_id": "f14946b0-e407-4a53-aa6b-335ad613cd70",
"skill_code": "sample string 32",
"skill": {
"id": "7e9f3f65-632a-41d1-8211-49a0eab0efa6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "832ca5c4-9f28-48cb-9aa7-a87a12960c80",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9783928d-c2bf-4150-a417-a1516a2ccfc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db71b8ed-52c9-4b02-beb4-f1c7fb4135da",
"db_currency_id": "fb6c9e4f-7afa-490b-84f0-58955fc211b7",
"db_language_id": "65379d0d-ed6b-4aed-9de7-b32c55f144a8",
"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-10-06T06:36:53.9430384+00:00"
},
"modified_dateutc": "2026-10-06T06:36:54.0695782+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a73632a8-2e1f-40b5-b586-48a53f7992e7",
"date_reported_by_company": "2026-10-06T06:36:54.0695782+00:00",
"id2": 36,
"company_id": "884a4ab0-e0df-467d-9e5b-d5d639ab40ba",
"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": "d71c1a99-bac9-429e-8f47-a5d6db420e36",
"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-10-06T06:36:54.0695782+00:00"
},
"work_instruction_details_id": "cb3d19e2-8b0d-4e4d-b411-3cc6937be415",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1a8d4687-a7cd-4ef7-b878-ceff8d28e485",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ffbd0425-33a9-4266-9f83-27c21042a6d4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-06T06:36:54.0695782+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": "33520df9-46c5-4b39-946d-5dcc979250c0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-06T06:36:54.0892236+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.