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": "5eac7b52-26bf-45dc-ad9a-0e4b13d63ca9",
"jobs_id": "73c31326-114b-4682-8f87-801eef16b857",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a3bb2bad-9e93-4bff-aa13-cf247aabc41b",
"_parent_id": "c6e821e5-c2b5-4791-b438-2c2f5bd80a71",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "00d23fa0-5818-4d79-949c-b4b101ffdee3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "59ee6c01-d84e-40b0-8778-f5e8d07974ba",
"_parent_id": "ab69137b-e34a-47af-be34-b2ba4c93c66c",
"root_parent_id": "bd54d6d3-22f4-4928-966e-6f2d61790242",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "647ee679-cde2-4c1b-a756-759b69e991c1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b7cc0dd5-973e-4def-8d4c-dc989a34f07f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "66dcd51a-bdcd-4eb9-8c14-9ab363ebb0a7",
"_parent_code": "sample string 6",
"sales_organization_id": "77002f71-11cb-4f29-a1da-6349e74d1a8d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f747b7f5-50bd-4ee9-9b09-42b7c0dafc9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "730d7246-73ba-4707-b396-92e41f8f8e0c",
"db_currency_id": "71ac1ad3-ea4d-461d-8b47-62be7d01f2c2",
"db_language_id": "3219f4f5-adec-4a67-aa1c-642c803a2719",
"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-06-17T23:18:58.2612163+00:00"
},
"modified_dateutc": "2026-06-17T23:18:58.2612163+00:00"
},
"equipment_model_id": "98ddf6b7-f99a-46a9-909a-b32e9f9b6b77",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "183bf406-7420-43ff-abc7-ba723a5e830e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7b7de32d-5dbf-4c2b-83c3-830e6c24ede0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a1bcc770-1989-479b-bfc5-618b9b469fe3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "20421268-1e03-40cc-b21a-5e5158ffc3e4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f747b7f5-50bd-4ee9-9b09-42b7c0dafc9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "730d7246-73ba-4707-b396-92e41f8f8e0c",
"db_currency_id": "71ac1ad3-ea4d-461d-8b47-62be7d01f2c2",
"db_language_id": "3219f4f5-adec-4a67-aa1c-642c803a2719",
"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-06-17T23:18:58.2612163+00:00"
},
"modified_dateutc": "2026-06-17T23:18:58.2612163+00:00"
},
"equipment_family_id": "0f375337-a19c-4bfb-9995-52b07fd50a70",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b7cc0dd5-973e-4def-8d4c-dc989a34f07f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "66dcd51a-bdcd-4eb9-8c14-9ab363ebb0a7",
"_parent_code": "sample string 6",
"sales_organization_id": "77002f71-11cb-4f29-a1da-6349e74d1a8d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f747b7f5-50bd-4ee9-9b09-42b7c0dafc9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "730d7246-73ba-4707-b396-92e41f8f8e0c",
"db_currency_id": "71ac1ad3-ea4d-461d-8b47-62be7d01f2c2",
"db_language_id": "3219f4f5-adec-4a67-aa1c-642c803a2719",
"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-06-17T23:18:58.2612163+00:00"
},
"modified_dateutc": "2026-06-17T23:18:58.2612163+00:00"
},
"date_in_production_since": "2026-06-17T23:18:58.2612163+00:00",
"date_out_of_production_since": "2026-06-17T23:18:58.2612163+00:00",
"date_end_support": "2026-06-17T23:18:58.2612163+00:00",
"sales_organization_id": "66576bc0-8fab-4a8e-992c-ab613d53667d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f747b7f5-50bd-4ee9-9b09-42b7c0dafc9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "730d7246-73ba-4707-b396-92e41f8f8e0c",
"db_currency_id": "71ac1ad3-ea4d-461d-8b47-62be7d01f2c2",
"db_language_id": "3219f4f5-adec-4a67-aa1c-642c803a2719",
"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-06-17T23:18:58.2612163+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-06-17T23:18:58.2612163+00:00"
},
"project_status_id": "5954e589-882c-44f6-9922-c4e66eeafa4b",
"project_status_code": "sample string 10",
"project_status": {
"id": "4269efd3-3667-4650-9907-740426fc7268",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3b5ae15a-7788-4222-ba48-6b174eef098b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f747b7f5-50bd-4ee9-9b09-42b7c0dafc9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "730d7246-73ba-4707-b396-92e41f8f8e0c",
"db_currency_id": "71ac1ad3-ea4d-461d-8b47-62be7d01f2c2",
"db_language_id": "3219f4f5-adec-4a67-aa1c-642c803a2719",
"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-06-17T23:18:58.2612163+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-17T23:18:58.2612163+00:00"
},
"company_id": "aadf36e6-826a-4c01-85ac-1be463723032",
"company_code": "sample string 12",
"db_address_id": "d3eb6bea-6f73-4edc-ab4b-a4bf8be592e5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e8c4dec0-1088-44a7-86cb-e50869aa1b85",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6480be73-6407-4bb6-ac61-f030abbae487",
"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-06-17T23:18:58.2612163+00:00",
"date_create": "2026-06-17T23:18:58.2612163+00:00",
"date_update": "2026-06-17T23:18:58.2612163+00:00",
"updated_by_user_id": "69739f14-4bd5-4a64-af52-48cd7c6ca4d9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-17T23:18:58.2612163+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-06-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-17T23:18:58.2612163+00:00",
"date_last_job": "2026-06-17T23:18:58.2612163+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-17T23:18:58.2612163+00:00",
"modified_dateutc": "2026-06-17T23:18:58.2612163+00:00",
"is_mobile_installation": true
},
"job_type_id": "02a50a06-37fe-41df-ac08-fb34dbc8a14f",
"job_type_code": "sample string 7",
"job_type": {
"id": "31f1a601-bbad-48fa-b175-8d02dc91d54a",
"name": "sample string 2",
"sales_organization_id": "ce360e85-39b0-4e60-a17f-8f5fc302f1a1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-17T23:18:58.2612163+00:00",
"code": "sample string 7"
},
"job_priority_id": "85682f3c-8640-4a9c-9048-7466157b8fbf",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9dda2d48-fc40-49a6-bd23-7bc1f8194393",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c96f2f0d-7416-4f88-88d3-0be329e9d893",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f747b7f5-50bd-4ee9-9b09-42b7c0dafc9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "730d7246-73ba-4707-b396-92e41f8f8e0c",
"db_currency_id": "71ac1ad3-ea4d-461d-8b47-62be7d01f2c2",
"db_language_id": "3219f4f5-adec-4a67-aa1c-642c803a2719",
"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-06-17T23:18:58.2612163+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-17T23:18:58.2612163+00:00"
},
"job_status_id": "9e2e9f5b-240e-4723-8dc4-7dbab5ffcc50",
"job_status_code": "sample string 11",
"db_address_id": "43c3b772-33a6-4f05-a9fe-d69f27f80ef7",
"contact_id": "8bfd8f96-0312-409a-a626-51f8f1c3fb30",
"requested_by_company_id": "e1841c63-704a-44be-aac0-539faa4659f1",
"requested_by_contact_id": "5e64b651-3a7a-4e06-9b51-b7fb29aacedd",
"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-06-17T23:18:58.2612163+00:00",
"due_date": "2026-06-17T23:18:58.2612163+00:00",
"date_create": "2026-06-17T23:18:58.2612163+00:00",
"date_update": "2026-06-17T23:18:58.2612163+00:00",
"date_closed": "2026-06-17T23:18:58.2612163+00:00",
"suggested_user_id": "a184588c-1bef-48ea-b838-76f503670142",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c3b07b2a-75d7-479a-9ac9-f0d43a3e1e2b",
"db_language_id": "0a2b0b86-9f68-4273-90d0-3af7e5591e2c",
"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-06-17T23:18:58.2612163+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7c5e0756-85e8-49ee-a3d9-9c6c0a4c0ea8",
"sales_organization": {
"id": "f747b7f5-50bd-4ee9-9b09-42b7c0dafc9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "730d7246-73ba-4707-b396-92e41f8f8e0c",
"db_currency_id": "71ac1ad3-ea4d-461d-8b47-62be7d01f2c2",
"db_language_id": "3219f4f5-adec-4a67-aa1c-642c803a2719",
"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-06-17T23:18:58.2612163+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "bed1e4d4-b28b-4028-9318-e7fc1e74f2f7",
"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": "6cb4b6b1-c8e4-4c0e-864e-f52c10683fc9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-17T23:18:58.2612163+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f54c3e37-43fc-471d-9c1d-dca089862515"
},
"suggested_date_start": "2026-06-17T23:18:58.2612163+00:00",
"skill_id": "89b9a4ee-20e6-4b4f-b290-97090dd25dc8",
"skill_code": "sample string 32",
"skill": {
"id": "6b481243-b7b1-4dbc-a5c8-50655374d79b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9a822bb6-015b-436d-927e-ece687e787c5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f747b7f5-50bd-4ee9-9b09-42b7c0dafc9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "730d7246-73ba-4707-b396-92e41f8f8e0c",
"db_currency_id": "71ac1ad3-ea4d-461d-8b47-62be7d01f2c2",
"db_language_id": "3219f4f5-adec-4a67-aa1c-642c803a2719",
"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-06-17T23:18:58.2612163+00:00"
},
"modified_dateutc": "2026-06-17T23:18:58.2612163+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1d399b60-569f-417b-80f3-ed1d0bf9e86c",
"date_reported_by_company": "2026-06-17T23:18:58.2612163+00:00",
"id2": 36,
"company_id": "a3bd7f87-7c74-43d9-995e-abec83715ccb",
"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": "ab278519-04c1-467f-8c05-4e8b0f3e3b81",
"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-06-17T23:18:58.2612163+00:00"
},
"work_instruction_details_id": "3f81821d-54ff-4f28-8c27-3a7a860ef08c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "50e3f4eb-04be-43f5-88b7-7c0af5161fd3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0676a439-4491-45da-ad75-2a5bde3eece1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-17T23:18:58.2612163+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": "16964020-7f93-43e4-9ff7-76c2d6fc3bf1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-17T23:18:58.2612163+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.