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": "06e21aa0-56c0-4caf-a334-fa6d20454afc",
"jobs_id": "8920a059-aec8-489d-a979-f7647bcdfe2a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2adc9874-3c57-449c-8b93-2cb81c15ba77",
"_parent_id": "b52dc0cb-7049-43d1-8f9f-7a90e04e8bb5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c50215c5-ba8b-4908-bdc4-36577ae46838",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1c2ccacd-d019-4fe3-ad65-84741fd3d5c0",
"_parent_id": "10b7b596-06b0-4eee-937b-7bb0d42fcec5",
"root_parent_id": "2121f111-73f1-4cc8-9bc0-78f679c2aac7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8d2e6c74-c07f-4643-8860-7b1b7c3716e5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8b2e1390-e51b-46a8-99f9-2e386088122e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6322a1ca-ccf5-4e23-ba62-64fa1f88f0bd",
"_parent_code": "sample string 6",
"sales_organization_id": "a8cac1d7-502d-40f3-8ad6-d01c6d6e089c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "54e9c444-c51c-4141-9ad2-63c37ac70a6b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3464775-c6c1-4bd0-852b-b287b5860440",
"db_currency_id": "2e25f28f-2e45-410d-aef8-2380cbbadb29",
"db_language_id": "99f523bf-3d8d-4284-b4c6-340218003762",
"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-14T05:55:25.515487+00:00"
},
"modified_dateutc": "2026-09-14T05:55:25.515487+00:00"
},
"equipment_model_id": "72907323-b776-4840-b33b-f551d9ad10f0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c438dd88-7465-477a-9c48-ac4fafaa24ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "cf31614e-eeda-4deb-9b23-216b912f5964",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "cf83e073-aaad-43ff-bef0-e89583586a99",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9d9085ef-f4c8-40da-948b-ed9e3a265c0a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "54e9c444-c51c-4141-9ad2-63c37ac70a6b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3464775-c6c1-4bd0-852b-b287b5860440",
"db_currency_id": "2e25f28f-2e45-410d-aef8-2380cbbadb29",
"db_language_id": "99f523bf-3d8d-4284-b4c6-340218003762",
"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-14T05:55:25.515487+00:00"
},
"modified_dateutc": "2026-09-14T05:55:25.515487+00:00"
},
"equipment_family_id": "ef6fa0f9-10d4-4c4d-8935-6646f61563bf",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8b2e1390-e51b-46a8-99f9-2e386088122e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6322a1ca-ccf5-4e23-ba62-64fa1f88f0bd",
"_parent_code": "sample string 6",
"sales_organization_id": "a8cac1d7-502d-40f3-8ad6-d01c6d6e089c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "54e9c444-c51c-4141-9ad2-63c37ac70a6b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3464775-c6c1-4bd0-852b-b287b5860440",
"db_currency_id": "2e25f28f-2e45-410d-aef8-2380cbbadb29",
"db_language_id": "99f523bf-3d8d-4284-b4c6-340218003762",
"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-14T05:55:25.515487+00:00"
},
"modified_dateutc": "2026-09-14T05:55:25.515487+00:00"
},
"date_in_production_since": "2026-09-14T05:55:25.515487+00:00",
"date_out_of_production_since": "2026-09-14T05:55:25.515487+00:00",
"date_end_support": "2026-09-14T05:55:25.515487+00:00",
"sales_organization_id": "96b607c4-61e9-4d12-9cfa-7b10a6e6c86b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "54e9c444-c51c-4141-9ad2-63c37ac70a6b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3464775-c6c1-4bd0-852b-b287b5860440",
"db_currency_id": "2e25f28f-2e45-410d-aef8-2380cbbadb29",
"db_language_id": "99f523bf-3d8d-4284-b4c6-340218003762",
"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-14T05:55:25.515487+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-14T05:55:25.515487+00:00"
},
"project_status_id": "f1115329-a89c-4dac-93a3-bfed0ea0bbe8",
"project_status_code": "sample string 10",
"project_status": {
"id": "b36cacee-44f6-4d31-8105-16439ea2cbf8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a25c9123-564e-4c37-b117-73e268deef00",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "54e9c444-c51c-4141-9ad2-63c37ac70a6b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3464775-c6c1-4bd0-852b-b287b5860440",
"db_currency_id": "2e25f28f-2e45-410d-aef8-2380cbbadb29",
"db_language_id": "99f523bf-3d8d-4284-b4c6-340218003762",
"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-14T05:55:25.515487+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-14T05:55:25.515487+00:00"
},
"company_id": "0af71ae1-c003-41c8-ab9d-ed78d6b80698",
"company_code": "sample string 12",
"db_address_id": "ef3ae402-d103-4c98-9c0e-ba41cf728799",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ccd67c7e-5e2b-4a1c-b915-11c662b13738",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "90ecf89d-1943-4c71-b1ca-27be5f3d359c",
"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-14T05:55:25.515487+00:00",
"date_create": "2026-09-14T05:55:25.515487+00:00",
"date_update": "2026-09-14T05:55:25.515487+00:00",
"updated_by_user_id": "373b5873-b4f2-4868-8041-2593db6c4e49",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-14T05:55:25.515487+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-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-14T05:55:25.515487+00:00",
"date_last_job": "2026-09-14T05:55:25.515487+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-14T05:55:25.515487+00:00",
"modified_dateutc": "2026-09-14T05:55:25.515487+00:00",
"is_mobile_installation": true
},
"job_type_id": "5cb6447d-a374-4895-b9d4-48241d4f339c",
"job_type_code": "sample string 7",
"job_type": {
"id": "1dd6524f-b6f1-46ff-84df-b8120b3cf19d",
"name": "sample string 2",
"sales_organization_id": "1ce63dc7-25d0-4f3e-ade6-ceee99df3d63",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-14T05:55:25.515487+00:00",
"code": "sample string 7"
},
"job_priority_id": "d5cef800-1c7e-4157-8776-8593603bec3e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "468b5d4d-2660-4f17-89ec-297d71363e0f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1cd21233-2fa8-44be-93f3-dd403e7b0f46",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "54e9c444-c51c-4141-9ad2-63c37ac70a6b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3464775-c6c1-4bd0-852b-b287b5860440",
"db_currency_id": "2e25f28f-2e45-410d-aef8-2380cbbadb29",
"db_language_id": "99f523bf-3d8d-4284-b4c6-340218003762",
"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-14T05:55:25.515487+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-14T05:55:25.515487+00:00"
},
"job_status_id": "46281c13-253f-4e56-8353-ad5d7a955379",
"job_status_code": "sample string 11",
"db_address_id": "7fbfa653-5d75-4ceb-b3e0-1f4f0d3c8d52",
"contact_id": "2a465fda-0e53-44b6-96e1-ef282a603a0e",
"requested_by_company_id": "6ff4f1f5-5d5e-41fc-aa7a-e91e0a785d02",
"requested_by_contact_id": "0cf50486-c889-406d-831c-e43db608ddd3",
"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-14T05:55:25.515487+00:00",
"due_date": "2026-09-14T05:55:25.515487+00:00",
"date_create": "2026-09-14T05:55:25.515487+00:00",
"date_update": "2026-09-14T05:55:25.515487+00:00",
"date_closed": "2026-09-14T05:55:25.515487+00:00",
"suggested_user_id": "b51f0f21-020d-4a42-aa26-a32db16ec07c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "10cd5071-3596-4f20-be2d-bcec81efe6cc",
"db_language_id": "405147aa-4bce-4f8c-afac-c6c4cbc0972c",
"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-14T05:55:25.515487+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6de2b2b9-64f2-4b51-b082-1419d967d869",
"sales_organization": {
"id": "54e9c444-c51c-4141-9ad2-63c37ac70a6b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3464775-c6c1-4bd0-852b-b287b5860440",
"db_currency_id": "2e25f28f-2e45-410d-aef8-2380cbbadb29",
"db_language_id": "99f523bf-3d8d-4284-b4c6-340218003762",
"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-14T05:55:25.515487+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2d11ba11-c442-4e13-bdbc-747de653c570",
"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": "dad8b32d-c1b9-48ff-aab4-22d04aed5f25",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-14T05:55:25.515487+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5694cd51-9e96-473b-bd70-7a81de5c1510"
},
"suggested_date_start": "2026-09-14T05:55:25.515487+00:00",
"skill_id": "4a83e7ec-72ad-4eb5-8692-c0cf179d6e3f",
"skill_code": "sample string 32",
"skill": {
"id": "4a65cda5-4682-407f-800d-3cae5cb57a41",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e973db1b-d3c3-4693-b4f2-d74a96534fb7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "54e9c444-c51c-4141-9ad2-63c37ac70a6b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3464775-c6c1-4bd0-852b-b287b5860440",
"db_currency_id": "2e25f28f-2e45-410d-aef8-2380cbbadb29",
"db_language_id": "99f523bf-3d8d-4284-b4c6-340218003762",
"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-14T05:55:25.515487+00:00"
},
"modified_dateutc": "2026-09-14T05:55:25.515487+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "603e0aea-423f-4966-8d56-f5aeab792855",
"date_reported_by_company": "2026-09-14T05:55:25.515487+00:00",
"id2": 36,
"company_id": "82627607-9318-45b4-9db2-d531b9a8c6e8",
"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": "8f43e223-5baf-4e05-aa88-6167d11805d3",
"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-14T05:55:25.515487+00:00"
},
"work_instruction_details_id": "26be2ded-5f2a-45c0-ad9d-296c48b56bb0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1a21bfe6-0fb5-41a8-9e54-671b4a208ae4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dc632db5-cbba-45a4-b8ac-6e0ba07185db",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-14T05:55:25.515487+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": "600954f6-a219-46c6-bdad-3374ddb0589a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-14T05:55:25.515487+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.