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": "ae089f94-9b2b-4958-9329-45f96a847207",
"jobs_id": "438ff4d5-74d6-4dd5-a15f-f3097af5628c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "79443e3d-7b3d-4eb2-8124-acb5f79d748a",
"_parent_id": "130332d4-4a4c-4f40-a25f-d2d6e2a92857",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bef2a2d8-1786-4949-9049-05300cb139d4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0237da03-e08d-4f18-afca-9a3887a79414",
"_parent_id": "68414419-d745-491b-bc15-e428ac7eeef8",
"root_parent_id": "3996007e-8f2e-4344-a8b3-da6ef254e2cb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a8b52d04-56fd-4838-a98f-5a42ac419b53",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4ee8c12b-8041-4a91-807d-d447ea7c9c77",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bf18aa85-a7a8-4f47-a2da-090b1f1c9c92",
"_parent_code": "sample string 6",
"sales_organization_id": "fab68e3e-7165-407a-9a29-548b336a2204",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "024d7455-7acc-43c2-9667-ac66ab2f0a19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "029a7a9e-2acd-4200-adcd-a9e5eba07936",
"db_currency_id": "47fa2556-a40a-4763-9441-63ef7a8bfb5e",
"db_language_id": "24cd651d-ff64-4c20-98be-2f59f7fc8ed6",
"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-04T20:35:29.5716904+00:00"
},
"modified_dateutc": "2026-07-04T20:35:29.5716904+00:00"
},
"equipment_model_id": "d081baa0-c379-4da1-994d-f27c7d5bb26d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ba60d77e-cb73-40d3-ae59-767a026c4272",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6eaae293-ea6d-4951-9e41-a70f987e38bf",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7f095af3-8762-418a-9b9c-a83fdee7989c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6af77f4c-15d3-4859-aae8-ae59da665f8b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "024d7455-7acc-43c2-9667-ac66ab2f0a19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "029a7a9e-2acd-4200-adcd-a9e5eba07936",
"db_currency_id": "47fa2556-a40a-4763-9441-63ef7a8bfb5e",
"db_language_id": "24cd651d-ff64-4c20-98be-2f59f7fc8ed6",
"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-04T20:35:29.5716904+00:00"
},
"modified_dateutc": "2026-07-04T20:35:29.5716904+00:00"
},
"equipment_family_id": "c354a210-aaf6-4719-bca4-f950d9ad0620",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4ee8c12b-8041-4a91-807d-d447ea7c9c77",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bf18aa85-a7a8-4f47-a2da-090b1f1c9c92",
"_parent_code": "sample string 6",
"sales_organization_id": "fab68e3e-7165-407a-9a29-548b336a2204",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "024d7455-7acc-43c2-9667-ac66ab2f0a19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "029a7a9e-2acd-4200-adcd-a9e5eba07936",
"db_currency_id": "47fa2556-a40a-4763-9441-63ef7a8bfb5e",
"db_language_id": "24cd651d-ff64-4c20-98be-2f59f7fc8ed6",
"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-04T20:35:29.5716904+00:00"
},
"modified_dateutc": "2026-07-04T20:35:29.5716904+00:00"
},
"date_in_production_since": "2026-07-04T20:35:29.5716904+00:00",
"date_out_of_production_since": "2026-07-04T20:35:29.5716904+00:00",
"date_end_support": "2026-07-04T20:35:29.5716904+00:00",
"sales_organization_id": "75d34475-6578-473d-b19f-86f9f6760e45",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "024d7455-7acc-43c2-9667-ac66ab2f0a19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "029a7a9e-2acd-4200-adcd-a9e5eba07936",
"db_currency_id": "47fa2556-a40a-4763-9441-63ef7a8bfb5e",
"db_language_id": "24cd651d-ff64-4c20-98be-2f59f7fc8ed6",
"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-04T20:35:29.5716904+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-04T20:35:29.5716904+00:00"
},
"project_status_id": "9374d6ea-0a6f-4d35-a821-593b6fafaa25",
"project_status_code": "sample string 10",
"project_status": {
"id": "54c6820c-4058-4887-8546-26642cf1f6ee",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "62465f6a-59de-4b80-8df8-ed7167862b69",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "024d7455-7acc-43c2-9667-ac66ab2f0a19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "029a7a9e-2acd-4200-adcd-a9e5eba07936",
"db_currency_id": "47fa2556-a40a-4763-9441-63ef7a8bfb5e",
"db_language_id": "24cd651d-ff64-4c20-98be-2f59f7fc8ed6",
"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-04T20:35:29.5716904+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-04T20:35:29.5716904+00:00"
},
"company_id": "20c24ece-6309-4841-a670-eb539190c4e1",
"company_code": "sample string 12",
"db_address_id": "44dc9658-6551-4c66-8174-6240b14a92ef",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "04621464-220d-481d-b3fa-57fd3e7e892b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bf7007b4-a89e-40ae-af01-e958f15a936b",
"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-04T20:35:29.5716904+00:00",
"date_create": "2026-07-04T20:35:29.5716904+00:00",
"date_update": "2026-07-04T20:35:29.5716904+00:00",
"updated_by_user_id": "8dd2fc50-dcb3-4ff7-9504-618380c8570b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-04T20:35:29.5716904+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-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-04T20:35:29.5716904+00:00",
"date_last_job": "2026-07-04T20:35:29.5716904+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-04T20:35:29.5716904+00:00",
"modified_dateutc": "2026-07-04T20:35:29.5716904+00:00",
"is_mobile_installation": true
},
"job_type_id": "2b2c04ee-3681-422e-85ee-0177c37ffdf4",
"job_type_code": "sample string 7",
"job_type": {
"id": "7da79f7f-332b-4ae5-9cc5-7ac9d7eed63c",
"name": "sample string 2",
"sales_organization_id": "b3365a2d-ba01-4f28-817f-acd077ad2840",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-04T20:35:29.5716904+00:00",
"code": "sample string 7"
},
"job_priority_id": "05f25c48-b110-4490-8d36-25a3696b1997",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "67180c73-de3d-43d9-aedf-104b195c6688",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3be7be39-7edf-4b1a-8e8a-ca42815fe29d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "024d7455-7acc-43c2-9667-ac66ab2f0a19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "029a7a9e-2acd-4200-adcd-a9e5eba07936",
"db_currency_id": "47fa2556-a40a-4763-9441-63ef7a8bfb5e",
"db_language_id": "24cd651d-ff64-4c20-98be-2f59f7fc8ed6",
"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-04T20:35:29.5716904+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-04T20:35:29.5716904+00:00"
},
"job_status_id": "5aac16d0-41a3-4143-b63a-ff54a574c11f",
"job_status_code": "sample string 11",
"db_address_id": "bba3f288-7d70-4d70-8244-9404861546db",
"contact_id": "f0ff70cd-f8e0-46a6-9da5-fcf4a073fe16",
"requested_by_company_id": "5e2a27d5-de14-40fd-955a-00a9aee6ed4f",
"requested_by_contact_id": "2c17951d-3f1d-45d5-8bec-748cf1c784ed",
"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-04T20:35:29.5716904+00:00",
"due_date": "2026-07-04T20:35:29.5716904+00:00",
"date_create": "2026-07-04T20:35:29.5716904+00:00",
"date_update": "2026-07-04T20:35:29.5716904+00:00",
"date_closed": "2026-07-04T20:35:29.5716904+00:00",
"suggested_user_id": "ad234b03-bc4c-4432-9e5b-5a91b64a6746",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "68edc06c-b789-4dc8-b65c-d75e3c44c112",
"db_language_id": "1892b798-34b6-47b4-992b-58f36a72c0e7",
"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-04T20:35:29.5716904+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "85ff7059-b02a-4957-9a32-a1f4d612ace2",
"sales_organization": {
"id": "024d7455-7acc-43c2-9667-ac66ab2f0a19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "029a7a9e-2acd-4200-adcd-a9e5eba07936",
"db_currency_id": "47fa2556-a40a-4763-9441-63ef7a8bfb5e",
"db_language_id": "24cd651d-ff64-4c20-98be-2f59f7fc8ed6",
"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-04T20:35:29.5716904+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4d16fb8b-c7d0-4551-b93c-b332b3996b57",
"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": "d5fbfa5c-8870-4b22-a21c-77b9dd5427bf",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-04T20:35:29.5716904+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a6e27c6b-8041-4a44-81e3-af356a9f958f"
},
"suggested_date_start": "2026-07-04T20:35:29.5716904+00:00",
"skill_id": "bbde17e8-15a2-459b-bc03-865964d3fb29",
"skill_code": "sample string 32",
"skill": {
"id": "03922723-e39f-4c7d-80a7-9e839fb9b8e3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9750cb9a-89f6-4c1f-9bf7-6aef28e67b43",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "024d7455-7acc-43c2-9667-ac66ab2f0a19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "029a7a9e-2acd-4200-adcd-a9e5eba07936",
"db_currency_id": "47fa2556-a40a-4763-9441-63ef7a8bfb5e",
"db_language_id": "24cd651d-ff64-4c20-98be-2f59f7fc8ed6",
"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-04T20:35:29.5716904+00:00"
},
"modified_dateutc": "2026-07-04T20:35:29.5716904+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bbbf7a3c-7b52-4993-857d-712885008105",
"date_reported_by_company": "2026-07-04T20:35:29.5716904+00:00",
"id2": 36,
"company_id": "441a6f2c-e0c4-4964-9417-d64c5850928e",
"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": "9b33cbf8-e4c2-4f58-a853-e52e311bb5a9",
"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-04T20:35:29.5716904+00:00"
},
"work_instruction_details_id": "4b1d3bf4-4760-4209-b6d7-13a46cbdd4b2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d8fa1b6d-aa44-4499-b7b3-5b325d3f7621",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "16396925-360a-4eaf-879b-efce76bc103e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-04T20:35:29.5716904+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": "40478e69-0c3b-40b4-98a7-67996b311cb7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-04T20:35:29.5873109+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.