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": "192c03c8-e51e-4c3b-84f4-a5954a8efbb9",
"jobs_id": "3951ce61-d7f0-4923-9b79-aee0dbbb55c2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "825d21d8-1df4-4ef8-9c05-fda12c224eac",
"_parent_id": "19b572d4-d260-45e3-a76a-fa7db1e36b1a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ee898fda-624e-4e38-ac39-dc61c31890ab",
"project_reference_back_office": "sample string 5",
"project": {
"id": "86bf3072-56a8-4651-8bba-08a47c48dfc3",
"_parent_id": "b8d33b0e-7b6a-46d2-a94e-4aecd6e21f82",
"root_parent_id": "55e5efa2-079c-4ce9-a797-7a7650782313",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5fb34fe0-915c-4d10-bd38-a2eaa7b23c9a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "308e916e-449c-4295-ad7c-306393acb91c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "63960a27-4a20-4620-b172-8be8f52a76f8",
"_parent_code": "sample string 6",
"sales_organization_id": "412400e0-7a9e-4ef5-9fb4-0707982e3726",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "562c6d58-efeb-40c4-b88d-87ea5032e463",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52041e2f-3def-4a1c-9eab-2161720b3a75",
"db_currency_id": "90aee99f-bc32-4af7-996e-ed6ac56a65c4",
"db_language_id": "3fc108a7-b420-418b-9c83-c22ee5a19bf0",
"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": "2025-12-16T10:23:28.7359715+00:00"
},
"modified_dateutc": "2025-12-16T10:23:28.7359715+00:00"
},
"equipment_model_id": "9569814e-face-47fd-bca3-7e2d26d5ac59",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7a65627d-881f-4667-a45c-b9bd6bb4d594",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ea9c3519-5c31-43a0-950c-9ff0a36f5043",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "586916cb-1b2a-4f15-a354-abe132f44585",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2f04a0f1-4cc5-4874-8633-102261804265",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "562c6d58-efeb-40c4-b88d-87ea5032e463",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52041e2f-3def-4a1c-9eab-2161720b3a75",
"db_currency_id": "90aee99f-bc32-4af7-996e-ed6ac56a65c4",
"db_language_id": "3fc108a7-b420-418b-9c83-c22ee5a19bf0",
"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": "2025-12-16T10:23:28.7359715+00:00"
},
"modified_dateutc": "2025-12-16T10:23:28.7359715+00:00"
},
"equipment_family_id": "c1b36a50-6afb-461b-9578-f115d846e503",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "308e916e-449c-4295-ad7c-306393acb91c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "63960a27-4a20-4620-b172-8be8f52a76f8",
"_parent_code": "sample string 6",
"sales_organization_id": "412400e0-7a9e-4ef5-9fb4-0707982e3726",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "562c6d58-efeb-40c4-b88d-87ea5032e463",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52041e2f-3def-4a1c-9eab-2161720b3a75",
"db_currency_id": "90aee99f-bc32-4af7-996e-ed6ac56a65c4",
"db_language_id": "3fc108a7-b420-418b-9c83-c22ee5a19bf0",
"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": "2025-12-16T10:23:28.7359715+00:00"
},
"modified_dateutc": "2025-12-16T10:23:28.7359715+00:00"
},
"date_in_production_since": "2025-12-16T10:23:28.7359715+00:00",
"date_out_of_production_since": "2025-12-16T10:23:28.7359715+00:00",
"date_end_support": "2025-12-16T10:23:28.7359715+00:00",
"sales_organization_id": "013c5a90-9214-479a-ac30-a0e42b925a85",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "562c6d58-efeb-40c4-b88d-87ea5032e463",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52041e2f-3def-4a1c-9eab-2161720b3a75",
"db_currency_id": "90aee99f-bc32-4af7-996e-ed6ac56a65c4",
"db_language_id": "3fc108a7-b420-418b-9c83-c22ee5a19bf0",
"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": "2025-12-16T10:23:28.7359715+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": "2025-12-16T10:23:28.7359715+00:00"
},
"project_status_id": "fe860c93-cd16-4f26-9983-ec55f4d2c7c3",
"project_status_code": "sample string 10",
"project_status": {
"id": "5f7e6283-b9f7-495f-bb40-8457c431f7a1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "742eaced-9d04-401c-ac27-8df1204d2cbb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "562c6d58-efeb-40c4-b88d-87ea5032e463",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52041e2f-3def-4a1c-9eab-2161720b3a75",
"db_currency_id": "90aee99f-bc32-4af7-996e-ed6ac56a65c4",
"db_language_id": "3fc108a7-b420-418b-9c83-c22ee5a19bf0",
"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": "2025-12-16T10:23:28.7359715+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-16T10:23:28.7359715+00:00"
},
"company_id": "26916401-ce7f-488e-b4af-b58ff14696c3",
"company_code": "sample string 12",
"db_address_id": "971e9fbd-82bb-4c6d-92ac-62de7c73142c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2a901f8e-2aed-42aa-84d8-7a857686c0b7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bc81eba4-cb22-4b85-af9f-094e14cbb986",
"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": "2025-12-16T10:23:28.7359715+00:00",
"date_create": "2025-12-16T10:23:28.7359715+00:00",
"date_update": "2025-12-16T10:23:28.7359715+00:00",
"updated_by_user_id": "6e6b82d7-9aca-4a27-9e44-98659dc72300",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-16T10:23:28.7359715+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": "2025-12-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-16T10:23:28.7359715+00:00",
"date_last_job": "2025-12-16T10:23:28.7359715+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-16T10:23:28.7359715+00:00",
"modified_dateutc": "2025-12-16T10:23:28.7359715+00:00",
"is_mobile_installation": true
},
"job_type_id": "7e996bf6-6264-46e4-90f6-6f21e0d7d19e",
"job_type_code": "sample string 7",
"job_type": {
"id": "985e3872-6a33-4d75-98ca-726e877a6186",
"name": "sample string 2",
"sales_organization_id": "7f588c39-b4f9-4a29-9eb9-833bbb38af70",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-16T10:23:28.7359715+00:00",
"code": "sample string 7"
},
"job_priority_id": "5409262f-f521-44e9-99db-56413952f781",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f063427f-db4f-4cd5-b08c-2ca81df1069c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "dc26216a-a59c-4d23-ba0a-918bbd9da2e0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "562c6d58-efeb-40c4-b88d-87ea5032e463",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52041e2f-3def-4a1c-9eab-2161720b3a75",
"db_currency_id": "90aee99f-bc32-4af7-996e-ed6ac56a65c4",
"db_language_id": "3fc108a7-b420-418b-9c83-c22ee5a19bf0",
"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": "2025-12-16T10:23:28.7359715+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-16T10:23:28.7359715+00:00"
},
"job_status_id": "c663d121-1107-4e06-aaf9-dd8b5bb1ade0",
"job_status_code": "sample string 11",
"db_address_id": "94e628a5-f312-4ae2-934b-ea249701f36e",
"contact_id": "75fc8bde-4b89-442d-b061-64d01e3b883d",
"requested_by_company_id": "82036459-d095-426e-8454-5dbe1de92e4e",
"requested_by_contact_id": "1725e82b-9cda-42ed-ba02-082672cc029d",
"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": "2025-12-16T10:23:28.7359715+00:00",
"due_date": "2025-12-16T10:23:28.7359715+00:00",
"date_create": "2025-12-16T10:23:28.7359715+00:00",
"date_update": "2025-12-16T10:23:28.7359715+00:00",
"date_closed": "2025-12-16T10:23:28.7359715+00:00",
"suggested_user_id": "fbe7ecf8-ec19-4541-9c2f-ffa0b764da36",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b651c3d3-27d8-45d4-bc08-1f8002684dc6",
"db_language_id": "f657ad85-477a-4a19-acb6-e0e5a5eb1a36",
"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": "2025-12-16T10:23:28.7359715+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f83ba402-1cb2-47f6-b9a0-860a45ab1f4c",
"sales_organization": {
"id": "562c6d58-efeb-40c4-b88d-87ea5032e463",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52041e2f-3def-4a1c-9eab-2161720b3a75",
"db_currency_id": "90aee99f-bc32-4af7-996e-ed6ac56a65c4",
"db_language_id": "3fc108a7-b420-418b-9c83-c22ee5a19bf0",
"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": "2025-12-16T10:23:28.7359715+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5fa4133e-546e-45fc-bb0d-5c99f79f867f",
"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": "581914e0-b036-41ff-a738-fdb7ea05a568",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-16T10:23:28.7359715+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "abe47ba5-e630-4a7e-887b-c0ed37ced45b"
},
"suggested_date_start": "2025-12-16T10:23:28.7359715+00:00",
"skill_id": "8c5686c8-df82-4221-b831-4c378f84de25",
"skill_code": "sample string 32",
"skill": {
"id": "0ed47f40-6985-4019-bc41-736b57070ffd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d34a2e87-1888-4f40-914b-9509d9c34840",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "562c6d58-efeb-40c4-b88d-87ea5032e463",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52041e2f-3def-4a1c-9eab-2161720b3a75",
"db_currency_id": "90aee99f-bc32-4af7-996e-ed6ac56a65c4",
"db_language_id": "3fc108a7-b420-418b-9c83-c22ee5a19bf0",
"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": "2025-12-16T10:23:28.7359715+00:00"
},
"modified_dateutc": "2025-12-16T10:23:28.7359715+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5bdd446e-179f-4804-ac89-052198b14d1e",
"date_reported_by_company": "2025-12-16T10:23:28.7359715+00:00",
"id2": 36,
"company_id": "f5d5465b-7a36-4190-b759-44d6a8f6a422",
"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": "5c77d929-836c-4ec4-b1bc-36ed1c65d0e8",
"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": "2025-12-16T10:23:28.7359715+00:00"
},
"work_instruction_details_id": "a8852639-9cbc-4e30-9f47-e6197d5fa505",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7183bc51-3d6d-4fdc-a500-54da8771bb18",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "549ca156-18ba-475e-804b-feba23496bf2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-16T10:23:28.7359715+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": "ecf9eee5-4e7a-45c7-bbc2-b1d0d2802354",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-16T10:23:28.7359715+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.