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": "b73f917c-ad9a-4ada-97b2-6d7d0c1d9550",
"jobs_id": "157ba605-3c42-46aa-a765-4b29c29fcdbc",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "de194978-3ad0-4186-85eb-0ddfbf83cec3",
"_parent_id": "7053dcab-d51f-42c6-9ef4-36c386a78082",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "18218c0b-62ae-4db0-81c7-6da8b5d3981d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ee351f48-f015-458b-b8cf-a37aa95a772c",
"_parent_id": "491def88-e88c-410e-96bb-ec7356059d16",
"root_parent_id": "869d4d39-fedf-4f62-bb58-e4b10402a7e0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c7722e05-7596-470c-a450-b8cd9215775f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "081daa10-6ef6-4040-9a0b-ccb34c1330c3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b528e834-3832-4ed6-a77d-4045dd5544c0",
"_parent_code": "sample string 6",
"sales_organization_id": "3a316142-6971-44a6-b3e5-531f52c07092",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1fba0a9b-d354-4f0c-8101-3ba0bf561a3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90fba2f0-ff79-439a-8e5a-016139fe3f65",
"db_currency_id": "7e1437c9-ecf8-4673-9595-f667ac594581",
"db_language_id": "26a24e9d-0b8c-4513-b59c-a62c8321987f",
"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-11-21T19:35:01.9770073+00:00"
},
"modified_dateutc": "2025-11-21T19:35:01.9770073+00:00"
},
"equipment_model_id": "dc0ddb86-83d8-4efc-9aa0-56db40286c7c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b30771fc-5854-4a69-b8ba-afcb77f3c372",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1234fcea-129b-4acf-83ef-b8f6723874f5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "71def844-ee90-4d8a-936a-075fdb63c8b8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "87246159-c500-40ea-aa62-1f3678188d14",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1fba0a9b-d354-4f0c-8101-3ba0bf561a3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90fba2f0-ff79-439a-8e5a-016139fe3f65",
"db_currency_id": "7e1437c9-ecf8-4673-9595-f667ac594581",
"db_language_id": "26a24e9d-0b8c-4513-b59c-a62c8321987f",
"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-11-21T19:35:01.9770073+00:00"
},
"modified_dateutc": "2025-11-21T19:35:01.9770073+00:00"
},
"equipment_family_id": "208aaada-d744-4256-a55e-7339b8ff3640",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "081daa10-6ef6-4040-9a0b-ccb34c1330c3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b528e834-3832-4ed6-a77d-4045dd5544c0",
"_parent_code": "sample string 6",
"sales_organization_id": "3a316142-6971-44a6-b3e5-531f52c07092",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1fba0a9b-d354-4f0c-8101-3ba0bf561a3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90fba2f0-ff79-439a-8e5a-016139fe3f65",
"db_currency_id": "7e1437c9-ecf8-4673-9595-f667ac594581",
"db_language_id": "26a24e9d-0b8c-4513-b59c-a62c8321987f",
"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-11-21T19:35:01.9770073+00:00"
},
"modified_dateutc": "2025-11-21T19:35:01.9770073+00:00"
},
"date_in_production_since": "2025-11-21T19:35:01.9770073+00:00",
"date_out_of_production_since": "2025-11-21T19:35:01.9770073+00:00",
"date_end_support": "2025-11-21T19:35:01.9770073+00:00",
"sales_organization_id": "0b2a75d2-8861-42d7-b235-334254501471",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1fba0a9b-d354-4f0c-8101-3ba0bf561a3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90fba2f0-ff79-439a-8e5a-016139fe3f65",
"db_currency_id": "7e1437c9-ecf8-4673-9595-f667ac594581",
"db_language_id": "26a24e9d-0b8c-4513-b59c-a62c8321987f",
"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-11-21T19:35:01.9770073+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-11-21T19:35:01.9770073+00:00"
},
"project_status_id": "565397aa-b899-40e2-9b11-55ff23af1d7b",
"project_status_code": "sample string 10",
"project_status": {
"id": "b0d6711b-3484-426a-b0e6-745c36137d46",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ee1df4f8-1d51-42df-92d4-7dec4cbda5fe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1fba0a9b-d354-4f0c-8101-3ba0bf561a3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90fba2f0-ff79-439a-8e5a-016139fe3f65",
"db_currency_id": "7e1437c9-ecf8-4673-9595-f667ac594581",
"db_language_id": "26a24e9d-0b8c-4513-b59c-a62c8321987f",
"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-11-21T19:35:01.9770073+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-21T19:35:01.9770073+00:00"
},
"company_id": "689c56e9-44ce-498c-8daf-1130628bea41",
"company_code": "sample string 12",
"db_address_id": "ad182a19-c80b-4afa-9b8e-2eb3338d5db7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "273e92e9-bbce-4e97-929e-e7e793fb0001",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8abcd5c7-0c9f-4c81-96c3-3a0b15914a44",
"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-11-21T19:35:01.9770073+00:00",
"date_create": "2025-11-21T19:35:01.9770073+00:00",
"date_update": "2025-11-21T19:35:01.9770073+00:00",
"updated_by_user_id": "366ccf5d-b2c4-4fb1-b52b-41f7aadd2a88",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-21T19:35:01.9770073+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-11-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-21T19:35:01.9770073+00:00",
"date_last_job": "2025-11-21T19:35:01.9770073+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-21T19:35:01.9770073+00:00",
"modified_dateutc": "2025-11-21T19:35:01.9770073+00:00",
"is_mobile_installation": true
},
"job_type_id": "60e8fe03-7336-428f-a3cd-03b353181a53",
"job_type_code": "sample string 7",
"job_type": {
"id": "7c8313e2-f75a-4254-bbfb-32402e73f5c4",
"name": "sample string 2",
"sales_organization_id": "37475ecb-d475-4040-8002-fbbf7acf285b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-21T19:35:01.9770073+00:00",
"code": "sample string 7"
},
"job_priority_id": "e003890b-55c5-40d1-8e17-646dfdd6c335",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bc2f28b7-7d6b-4f23-b683-e95e6d551bc1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9b00cd75-9df6-444c-aa1c-d2280ac2fc76",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1fba0a9b-d354-4f0c-8101-3ba0bf561a3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90fba2f0-ff79-439a-8e5a-016139fe3f65",
"db_currency_id": "7e1437c9-ecf8-4673-9595-f667ac594581",
"db_language_id": "26a24e9d-0b8c-4513-b59c-a62c8321987f",
"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-11-21T19:35:01.9770073+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-21T19:35:01.9770073+00:00"
},
"job_status_id": "919b5213-759f-4fc1-aa54-162d82ee224b",
"job_status_code": "sample string 11",
"db_address_id": "633dacb3-3def-4049-a080-1b916c863233",
"contact_id": "655f4d78-3be1-4e38-934d-c250b08239fd",
"requested_by_company_id": "d9e6f440-0816-4f1b-bd66-a998051e653f",
"requested_by_contact_id": "615f7457-0cb3-43c3-9b6d-2a87237b1558",
"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-11-21T19:35:01.9770073+00:00",
"due_date": "2025-11-21T19:35:01.9770073+00:00",
"date_create": "2025-11-21T19:35:01.9770073+00:00",
"date_update": "2025-11-21T19:35:01.9770073+00:00",
"date_closed": "2025-11-21T19:35:01.9770073+00:00",
"suggested_user_id": "05965638-e5ba-4d40-bd24-c5c038ff0f43",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a93d3e36-7128-4f16-8e48-f2a62a9b4ae5",
"db_language_id": "df560ac4-cb06-48c5-866f-6897a15e0a1a",
"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-11-21T19:35:01.9770073+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d158443b-b741-42f9-8afb-0549b483de7d",
"sales_organization": {
"id": "1fba0a9b-d354-4f0c-8101-3ba0bf561a3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90fba2f0-ff79-439a-8e5a-016139fe3f65",
"db_currency_id": "7e1437c9-ecf8-4673-9595-f667ac594581",
"db_language_id": "26a24e9d-0b8c-4513-b59c-a62c8321987f",
"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-11-21T19:35:01.9770073+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9dc981ad-f1f4-42ca-b4ea-04056e2bd899",
"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": "0513e1ca-aec2-4d2a-9c5b-8f9263797668",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-21T19:35:01.9770073+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "967543c0-0f97-4e10-91b8-2508827dcaa3"
},
"suggested_date_start": "2025-11-21T19:35:01.9770073+00:00",
"skill_id": "84a57bf7-2cb1-45a0-987b-38a6527c1d6e",
"skill_code": "sample string 32",
"skill": {
"id": "10dc9b0d-90b5-41ff-b100-cdb64f2079f0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1eb299a0-e02d-4614-ac89-1bf30c9c99c1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1fba0a9b-d354-4f0c-8101-3ba0bf561a3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90fba2f0-ff79-439a-8e5a-016139fe3f65",
"db_currency_id": "7e1437c9-ecf8-4673-9595-f667ac594581",
"db_language_id": "26a24e9d-0b8c-4513-b59c-a62c8321987f",
"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-11-21T19:35:01.9770073+00:00"
},
"modified_dateutc": "2025-11-21T19:35:01.9770073+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3f9f008d-78c7-461d-986e-25f4e971f234",
"date_reported_by_company": "2025-11-21T19:35:01.9770073+00:00",
"id2": 36,
"company_id": "e3419237-f321-4fa3-96ca-ee690bc3195d",
"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": "0baaf91f-09c3-4c34-8edb-470e9e7e16cf",
"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-11-21T19:35:01.9770073+00:00"
},
"work_instruction_details_id": "98e769ce-8c8f-435c-a905-6471b6064e83",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ad4ec074-1e6c-4f70-879f-7264b64a8991",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7e74919f-1be5-4144-81b9-86c2b9da5062",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-21T19:35:01.9770073+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": "884947a9-d407-4f5d-8add-096f9693d585",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-21T19:35:01.9770073+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.