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": "65ceaf13-b480-4ef2-b614-65fad814dcb5",
"jobs_id": "cf019acc-71b1-4acb-bb85-7376cdd57f3a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c7862c29-f3f3-478e-a5d9-c6129c803ec8",
"_parent_id": "830832e3-c33b-4d64-98d7-d9e55bca2060",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a3c0ec82-d114-4f8b-a68e-041211a41a3f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5d9af94e-bc7c-4cb9-86bc-f856aaaaf3be",
"_parent_id": "23917232-da76-4ec2-aa70-2bfc1e0fc8e1",
"root_parent_id": "4bc00da9-340e-4e6b-aa90-c9ec4234b4b7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "78456ab7-10ed-4cea-99e2-679219640557",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1c58f4a9-20f7-44b7-92fc-4e37ac96fd46",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ebfe465f-b3ce-446a-a305-c0dd6597a709",
"_parent_code": "sample string 6",
"sales_organization_id": "a414d304-d9da-465b-a98b-9de272b705f8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "39c52255-949f-4bb0-86c6-26e45323c71f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f3b2639-5cce-4ccf-8eab-9488127cb6a6",
"db_currency_id": "a9ca935e-28c8-4e85-8c67-87805d1408e6",
"db_language_id": "b766a6d9-d697-4f19-810a-94997bb4ae55",
"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-14T05:53:39.6366994+00:00"
},
"modified_dateutc": "2025-12-14T05:53:39.6366994+00:00"
},
"equipment_model_id": "b5d6fb5c-72af-4387-babc-2102af415781",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "beb15c1e-d3a3-48e1-aa0b-cc3b600852d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "59ff77b9-7d91-4d21-a458-faa2d73e61e9",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "badf90e1-5741-48b8-b4b4-fbb2342a7e81",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a66e1f8c-d366-40be-af06-6e3b75b9a9a4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "39c52255-949f-4bb0-86c6-26e45323c71f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f3b2639-5cce-4ccf-8eab-9488127cb6a6",
"db_currency_id": "a9ca935e-28c8-4e85-8c67-87805d1408e6",
"db_language_id": "b766a6d9-d697-4f19-810a-94997bb4ae55",
"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-14T05:53:39.6366994+00:00"
},
"modified_dateutc": "2025-12-14T05:53:39.6366994+00:00"
},
"equipment_family_id": "8b365c6c-e97c-43f2-9f01-f721a72cefcc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1c58f4a9-20f7-44b7-92fc-4e37ac96fd46",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ebfe465f-b3ce-446a-a305-c0dd6597a709",
"_parent_code": "sample string 6",
"sales_organization_id": "a414d304-d9da-465b-a98b-9de272b705f8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "39c52255-949f-4bb0-86c6-26e45323c71f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f3b2639-5cce-4ccf-8eab-9488127cb6a6",
"db_currency_id": "a9ca935e-28c8-4e85-8c67-87805d1408e6",
"db_language_id": "b766a6d9-d697-4f19-810a-94997bb4ae55",
"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-14T05:53:39.6366994+00:00"
},
"modified_dateutc": "2025-12-14T05:53:39.6366994+00:00"
},
"date_in_production_since": "2025-12-14T05:53:39.6366994+00:00",
"date_out_of_production_since": "2025-12-14T05:53:39.6366994+00:00",
"date_end_support": "2025-12-14T05:53:39.6366994+00:00",
"sales_organization_id": "e5817e34-d498-43f6-ae35-15a6483e0ef5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "39c52255-949f-4bb0-86c6-26e45323c71f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f3b2639-5cce-4ccf-8eab-9488127cb6a6",
"db_currency_id": "a9ca935e-28c8-4e85-8c67-87805d1408e6",
"db_language_id": "b766a6d9-d697-4f19-810a-94997bb4ae55",
"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-14T05:53:39.6366994+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-14T05:53:39.6366994+00:00"
},
"project_status_id": "d3c6fd45-70b8-4948-b9d5-d92cea92744b",
"project_status_code": "sample string 10",
"project_status": {
"id": "11a943f8-e86b-445f-8b2c-30f47860dd72",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3d9fd9c1-4bb0-4038-ab88-cef40018c380",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "39c52255-949f-4bb0-86c6-26e45323c71f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f3b2639-5cce-4ccf-8eab-9488127cb6a6",
"db_currency_id": "a9ca935e-28c8-4e85-8c67-87805d1408e6",
"db_language_id": "b766a6d9-d697-4f19-810a-94997bb4ae55",
"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-14T05:53:39.6366994+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-14T05:53:39.6366994+00:00"
},
"company_id": "c62299c8-64e2-452e-9b4a-96e4b7192a58",
"company_code": "sample string 12",
"db_address_id": "8276c402-f737-4f32-aba7-49e384a12f8a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1b9bdfd5-94e0-4cca-b4c8-78fbc279b250",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8083135f-756c-4eec-887e-2611333e6333",
"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-14T05:53:39.6366994+00:00",
"date_create": "2025-12-14T05:53:39.6366994+00:00",
"date_update": "2025-12-14T05:53:39.6366994+00:00",
"updated_by_user_id": "4478ca68-7613-4900-93ed-68c9198aedf7",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-14T05:53:39.6366994+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-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-14T05:53:39.6366994+00:00",
"date_last_job": "2025-12-14T05:53:39.6366994+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-14T05:53:39.6366994+00:00",
"modified_dateutc": "2025-12-14T05:53:39.6366994+00:00",
"is_mobile_installation": true
},
"job_type_id": "c3960bd9-c2e5-496b-9c4a-6412e2e9b42f",
"job_type_code": "sample string 7",
"job_type": {
"id": "bfb21602-941c-451c-a07a-fb9ffb69894e",
"name": "sample string 2",
"sales_organization_id": "7d4bdc26-2d3f-4bf4-9ec6-91799e8713d9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-14T05:53:39.6366994+00:00",
"code": "sample string 7"
},
"job_priority_id": "b53ac199-32fe-442b-bdaf-bfa9330e4d9c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d9edf5bd-307d-4c76-ba23-df3490412f5c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d0eeffc2-e8d5-4e10-9f41-0451f6306680",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "39c52255-949f-4bb0-86c6-26e45323c71f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f3b2639-5cce-4ccf-8eab-9488127cb6a6",
"db_currency_id": "a9ca935e-28c8-4e85-8c67-87805d1408e6",
"db_language_id": "b766a6d9-d697-4f19-810a-94997bb4ae55",
"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-14T05:53:39.6366994+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-14T05:53:39.6366994+00:00"
},
"job_status_id": "ccd818ef-ad66-4a64-a9bc-bf5d330f0c31",
"job_status_code": "sample string 11",
"db_address_id": "4d84da9e-30bf-4ae5-9e88-c7a8b4016ebd",
"contact_id": "b6dcb6d5-038f-437e-a927-5b14876f849b",
"requested_by_company_id": "6d59ca60-0298-4908-a5a6-935fc9c76bc7",
"requested_by_contact_id": "66d22551-582f-4935-bfab-e0770547f90a",
"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-14T05:53:39.6523269+00:00",
"due_date": "2025-12-14T05:53:39.6523269+00:00",
"date_create": "2025-12-14T05:53:39.6523269+00:00",
"date_update": "2025-12-14T05:53:39.6523269+00:00",
"date_closed": "2025-12-14T05:53:39.6523269+00:00",
"suggested_user_id": "5017a805-740e-40eb-9f7f-61423a44b0a7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "169e1ec5-48f3-4d40-9914-ab97bbb33d2b",
"db_language_id": "4d296540-e605-46bd-b524-19486306dd0c",
"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-14T05:53:39.6523269+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "637a8783-3c82-458c-9b8a-8189b05e1426",
"sales_organization": {
"id": "39c52255-949f-4bb0-86c6-26e45323c71f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f3b2639-5cce-4ccf-8eab-9488127cb6a6",
"db_currency_id": "a9ca935e-28c8-4e85-8c67-87805d1408e6",
"db_language_id": "b766a6d9-d697-4f19-810a-94997bb4ae55",
"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-14T05:53:39.6366994+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9bbaceab-3edf-4344-8fc1-23a3cc1118e9",
"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": "3e5afe35-e117-4512-8acf-d61de94a0941",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-14T05:53:39.6523269+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "821cc6ac-e649-44c6-8274-6ffb2a6b846d"
},
"suggested_date_start": "2025-12-14T05:53:39.6523269+00:00",
"skill_id": "22a5b50d-0f3d-4d1b-8e71-b235a0c0d89b",
"skill_code": "sample string 32",
"skill": {
"id": "ab3a9eb7-37be-4f68-911b-0511d62322a8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8fd3af6a-4bd9-407d-bf77-4648d43250d1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "39c52255-949f-4bb0-86c6-26e45323c71f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f3b2639-5cce-4ccf-8eab-9488127cb6a6",
"db_currency_id": "a9ca935e-28c8-4e85-8c67-87805d1408e6",
"db_language_id": "b766a6d9-d697-4f19-810a-94997bb4ae55",
"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-14T05:53:39.6366994+00:00"
},
"modified_dateutc": "2025-12-14T05:53:39.6523269+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "77b54fc5-8919-497f-b296-6ec31b937334",
"date_reported_by_company": "2025-12-14T05:53:39.6523269+00:00",
"id2": 36,
"company_id": "7524e630-dbc4-454d-993f-0dc18b657cda",
"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": "5687fc71-e19f-4cc4-b813-7dfe29304228",
"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-14T05:53:39.6523269+00:00"
},
"work_instruction_details_id": "901113ee-af68-400f-817c-5d68b7075346",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9f06e61f-c26e-46d5-bee8-4b227966248e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9990dd0c-b062-40d7-a3a8-8cf721009876",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-14T05:53:39.6523269+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": "e35bcd53-b8e0-43ce-bce5-5a9c6addd7ba",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-14T05:53:39.6523269+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.