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": "ab4bcf41-85b4-41ba-8555-d2948ada849e",
"jobs_id": "8ef10ca6-d035-456c-ad26-b9ec9603776e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "032c97f0-2597-4ca8-8603-3eb5fb310f00",
"_parent_id": "819b9a7a-329a-4471-998d-96e2c55c7437",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2ccc3704-cc51-4b3b-9de0-d5d1ab658ee2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "68a5cba9-9c0f-4bdf-8499-36b786acf079",
"_parent_id": "7dcc8a04-a57f-4f97-ba30-e99318402580",
"root_parent_id": "eff18075-7999-4c2e-bb3c-35f64664634b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6410d9c7-e999-46f5-9b52-74fa208e3e14",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "269afbf7-8d3c-4520-891f-5bb8c3007935",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "51201b50-d92f-40e1-b163-4b5e8feb56ba",
"_parent_code": "sample string 6",
"sales_organization_id": "b3cb9c29-575f-461c-9bdf-dcfd23a2fbfc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5cefc631-4b5c-4f7f-8e45-2b57dd8cc514",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef3116dd-aac0-4960-9300-ffd4655343cc",
"db_currency_id": "e389e497-4da6-4ccb-8c55-471d47a207a6",
"db_language_id": "16bf7a5e-423a-44a2-8573-f9992fb4a3dd",
"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-06T19:06:25.2578195+00:00"
},
"modified_dateutc": "2025-12-06T19:06:25.2578195+00:00"
},
"equipment_model_id": "50b06847-8c8f-4a30-88a7-f5780afb3ff7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ca252b6f-8ef4-4958-b5ad-d7c0f16a0b3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4fc17002-e899-42ba-b411-abd408a1ba0c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5261de05-bc9d-4dd5-82bd-27e1673fb16e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "acc84be6-f0b7-4ef6-b23f-62e4e0917777",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5cefc631-4b5c-4f7f-8e45-2b57dd8cc514",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef3116dd-aac0-4960-9300-ffd4655343cc",
"db_currency_id": "e389e497-4da6-4ccb-8c55-471d47a207a6",
"db_language_id": "16bf7a5e-423a-44a2-8573-f9992fb4a3dd",
"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-06T19:06:25.2578195+00:00"
},
"modified_dateutc": "2025-12-06T19:06:25.2578195+00:00"
},
"equipment_family_id": "46571586-6c67-4704-9c3f-c9d8bc05e46c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "269afbf7-8d3c-4520-891f-5bb8c3007935",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "51201b50-d92f-40e1-b163-4b5e8feb56ba",
"_parent_code": "sample string 6",
"sales_organization_id": "b3cb9c29-575f-461c-9bdf-dcfd23a2fbfc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5cefc631-4b5c-4f7f-8e45-2b57dd8cc514",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef3116dd-aac0-4960-9300-ffd4655343cc",
"db_currency_id": "e389e497-4da6-4ccb-8c55-471d47a207a6",
"db_language_id": "16bf7a5e-423a-44a2-8573-f9992fb4a3dd",
"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-06T19:06:25.2578195+00:00"
},
"modified_dateutc": "2025-12-06T19:06:25.2578195+00:00"
},
"date_in_production_since": "2025-12-06T19:06:25.2578195+00:00",
"date_out_of_production_since": "2025-12-06T19:06:25.2578195+00:00",
"date_end_support": "2025-12-06T19:06:25.2578195+00:00",
"sales_organization_id": "6a019af8-7373-48ca-9392-9b5911838925",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5cefc631-4b5c-4f7f-8e45-2b57dd8cc514",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef3116dd-aac0-4960-9300-ffd4655343cc",
"db_currency_id": "e389e497-4da6-4ccb-8c55-471d47a207a6",
"db_language_id": "16bf7a5e-423a-44a2-8573-f9992fb4a3dd",
"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-06T19:06:25.2578195+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-06T19:06:25.2578195+00:00"
},
"project_status_id": "6fda0203-71d0-4b9f-9cab-ebb24c69932b",
"project_status_code": "sample string 10",
"project_status": {
"id": "63fd19ec-aa97-4db1-86de-f3ec26ba66a9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ea0c1a64-7571-47cd-bdd3-3f8e14bbb6f8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5cefc631-4b5c-4f7f-8e45-2b57dd8cc514",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef3116dd-aac0-4960-9300-ffd4655343cc",
"db_currency_id": "e389e497-4da6-4ccb-8c55-471d47a207a6",
"db_language_id": "16bf7a5e-423a-44a2-8573-f9992fb4a3dd",
"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-06T19:06:25.2578195+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-06T19:06:25.2578195+00:00"
},
"company_id": "c0e27b6d-0215-4123-a72a-4f8e36ff9bf2",
"company_code": "sample string 12",
"db_address_id": "57e9d26e-07fd-4cc9-849b-75d075cca8e4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f3db2281-0fc0-42df-b7e5-c7ce433953ef",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3d14b9dc-5c7e-4b4e-8ca3-07810e42ae1c",
"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-06T19:06:25.2578195+00:00",
"date_create": "2025-12-06T19:06:25.2578195+00:00",
"date_update": "2025-12-06T19:06:25.2578195+00:00",
"updated_by_user_id": "9c003110-1790-47ed-8631-7aea8a657e31",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-06T19:06:25.2578195+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-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-06T19:06:25.2578195+00:00",
"date_last_job": "2025-12-06T19:06:25.2578195+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-06T19:06:25.2578195+00:00",
"modified_dateutc": "2025-12-06T19:06:25.2578195+00:00",
"is_mobile_installation": true
},
"job_type_id": "e5e2d361-7168-4433-8c71-ed5f43931025",
"job_type_code": "sample string 7",
"job_type": {
"id": "90a047ce-ba3a-4d32-a3b0-1fe05f645a5f",
"name": "sample string 2",
"sales_organization_id": "7b5005b3-46ab-4554-bee0-b9dcd1a1507c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-06T19:06:25.2578195+00:00",
"code": "sample string 7"
},
"job_priority_id": "652bb99f-596b-453a-a41b-f65b4d32a435",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "db4c1ec4-b76d-4503-a370-dce687ec12b4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4c0953c5-b0ff-4101-afde-1494719269f8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5cefc631-4b5c-4f7f-8e45-2b57dd8cc514",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef3116dd-aac0-4960-9300-ffd4655343cc",
"db_currency_id": "e389e497-4da6-4ccb-8c55-471d47a207a6",
"db_language_id": "16bf7a5e-423a-44a2-8573-f9992fb4a3dd",
"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-06T19:06:25.2578195+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-06T19:06:25.2578195+00:00"
},
"job_status_id": "f9dd919f-3b46-4971-9027-067c8ca6488c",
"job_status_code": "sample string 11",
"db_address_id": "cd027446-9d06-4fbb-9db2-57a940990e18",
"contact_id": "838e5e23-18c2-4b9d-a701-e13046a07572",
"requested_by_company_id": "bf111f55-3b81-4791-82ca-b9a08df0d3ec",
"requested_by_contact_id": "70359b7b-5ad9-4393-9546-28f20fac55c4",
"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-06T19:06:25.2578195+00:00",
"due_date": "2025-12-06T19:06:25.2578195+00:00",
"date_create": "2025-12-06T19:06:25.2578195+00:00",
"date_update": "2025-12-06T19:06:25.2578195+00:00",
"date_closed": "2025-12-06T19:06:25.2578195+00:00",
"suggested_user_id": "8dd1b41f-efc1-4633-b8eb-c83874c82782",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "05cfaeec-b831-4d24-8d65-9bee499510ef",
"db_language_id": "7cf50f6f-bc76-4456-bb54-30da69705706",
"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-06T19:06:25.2578195+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0233fdd6-cf53-45f9-91e8-ac4fd1998f8a",
"sales_organization": {
"id": "5cefc631-4b5c-4f7f-8e45-2b57dd8cc514",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef3116dd-aac0-4960-9300-ffd4655343cc",
"db_currency_id": "e389e497-4da6-4ccb-8c55-471d47a207a6",
"db_language_id": "16bf7a5e-423a-44a2-8573-f9992fb4a3dd",
"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-06T19:06:25.2578195+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "24c70efa-eae1-452d-9faa-59bfa5a70768",
"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": "415d2b97-9194-46cb-9df3-0525ac870def",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-06T19:06:25.2578195+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8d1d59d5-e305-4b31-a943-ecad5b837b12"
},
"suggested_date_start": "2025-12-06T19:06:25.2578195+00:00",
"skill_id": "b7f73b9f-7a94-42bf-8752-f9d47b177a2c",
"skill_code": "sample string 32",
"skill": {
"id": "faa9db8b-d0c2-434b-9ddd-60aa6c7b57f4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0ae73808-f22b-4e0c-b35a-817e1b0afb9e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5cefc631-4b5c-4f7f-8e45-2b57dd8cc514",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef3116dd-aac0-4960-9300-ffd4655343cc",
"db_currency_id": "e389e497-4da6-4ccb-8c55-471d47a207a6",
"db_language_id": "16bf7a5e-423a-44a2-8573-f9992fb4a3dd",
"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-06T19:06:25.2578195+00:00"
},
"modified_dateutc": "2025-12-06T19:06:25.2578195+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e1d35cd7-9853-42b4-86a1-ed3f320b0661",
"date_reported_by_company": "2025-12-06T19:06:25.2578195+00:00",
"id2": 36,
"company_id": "c7fe1809-853f-47f3-aa72-85392357b76d",
"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": "7defe811-6b65-4c23-a09c-52896c0f94b1",
"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-06T19:06:25.2578195+00:00"
},
"work_instruction_details_id": "37b98628-0b43-403f-a178-41c1a00ae905",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "41cfc626-c7e2-45e5-add5-1299678c913a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b8a0dd68-53fe-4c18-b8ed-a62c23e453f1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-06T19:06:25.2578195+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": "6d4fe89f-1973-4e67-9b00-8833ff1b37f3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-06T19:06:25.2578195+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.