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": "8ace1668-5b17-4739-b3f1-17b0b015d8c0",
"jobs_id": "704cef13-5c87-4d35-b90b-ada89bd8cdd4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0570cfa5-d31f-4a60-a5d8-928db9a3e471",
"_parent_id": "055cbd47-f625-43f6-a262-2818bff05ab7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cbcae910-1014-4ef6-8da5-a06ce76b3565",
"project_reference_back_office": "sample string 5",
"project": {
"id": "80096693-446e-4da6-9944-e755fb6bc55f",
"_parent_id": "377f6e0f-5d55-4a3a-ae89-f79fc63cfd5b",
"root_parent_id": "f86e27f3-4ae2-499d-b2ec-580baa8c071e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e2403546-0a5f-431f-90e3-1e53c00a8c43",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5942f25b-b1a8-4973-91ff-d209784b5d5e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5bf878db-7b58-4f85-ad7a-93daf2cff5bf",
"_parent_code": "sample string 6",
"sales_organization_id": "5030d112-315e-4f43-b575-89879488eada",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6ca15ea8-ea25-4743-a828-9e1762fdad34",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97e89052-8b8a-4713-ac2f-0b9d1e9464aa",
"db_currency_id": "74272e60-dc88-46c5-b452-ee61250b00a2",
"db_language_id": "481f0074-2dc8-41ca-a994-84598aef1b65",
"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-11-05T07:47:00.684705+00:00"
},
"modified_dateutc": "2026-11-05T07:47:00.684705+00:00"
},
"equipment_model_id": "68be5932-7f50-47bf-9a48-9215d14838d4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "999333ee-5136-4472-8f96-40ad04201932",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "21a670d2-4feb-4109-83ab-1c4cb8565f9c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "22690b67-6a25-42f4-8a3c-90d52bdf3773",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c086b9b8-c112-405c-9295-a8d18df28473",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6ca15ea8-ea25-4743-a828-9e1762fdad34",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97e89052-8b8a-4713-ac2f-0b9d1e9464aa",
"db_currency_id": "74272e60-dc88-46c5-b452-ee61250b00a2",
"db_language_id": "481f0074-2dc8-41ca-a994-84598aef1b65",
"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-11-05T07:47:00.684705+00:00"
},
"modified_dateutc": "2026-11-05T07:47:00.684705+00:00"
},
"equipment_family_id": "b3140530-f17f-483d-b93c-f067bf933c2f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5942f25b-b1a8-4973-91ff-d209784b5d5e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5bf878db-7b58-4f85-ad7a-93daf2cff5bf",
"_parent_code": "sample string 6",
"sales_organization_id": "5030d112-315e-4f43-b575-89879488eada",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6ca15ea8-ea25-4743-a828-9e1762fdad34",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97e89052-8b8a-4713-ac2f-0b9d1e9464aa",
"db_currency_id": "74272e60-dc88-46c5-b452-ee61250b00a2",
"db_language_id": "481f0074-2dc8-41ca-a994-84598aef1b65",
"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-11-05T07:47:00.684705+00:00"
},
"modified_dateutc": "2026-11-05T07:47:00.684705+00:00"
},
"date_in_production_since": "2026-11-05T07:47:00.684705+00:00",
"date_out_of_production_since": "2026-11-05T07:47:00.684705+00:00",
"date_end_support": "2026-11-05T07:47:00.684705+00:00",
"sales_organization_id": "59294249-a570-4d60-8522-0b1b29261e0b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6ca15ea8-ea25-4743-a828-9e1762fdad34",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97e89052-8b8a-4713-ac2f-0b9d1e9464aa",
"db_currency_id": "74272e60-dc88-46c5-b452-ee61250b00a2",
"db_language_id": "481f0074-2dc8-41ca-a994-84598aef1b65",
"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-11-05T07:47:00.684705+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-11-05T07:47:00.684705+00:00"
},
"project_status_id": "4a2787f1-97ac-4061-bfe8-21e47404cb2c",
"project_status_code": "sample string 10",
"project_status": {
"id": "e6752260-0ae1-4536-92aa-b2cd1410b04a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "78cc5ed8-336e-4dcb-ba6d-5392c97e3d4a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6ca15ea8-ea25-4743-a828-9e1762fdad34",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97e89052-8b8a-4713-ac2f-0b9d1e9464aa",
"db_currency_id": "74272e60-dc88-46c5-b452-ee61250b00a2",
"db_language_id": "481f0074-2dc8-41ca-a994-84598aef1b65",
"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-11-05T07:47:00.684705+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-05T07:47:00.684705+00:00"
},
"company_id": "7cf1c5c8-1458-409f-927c-e5a64bb2a951",
"company_code": "sample string 12",
"db_address_id": "92b7ad15-b53e-4706-98fd-3ef1084d9cf2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b1a1314f-ba14-4e28-8b76-d7828727c121",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0a63145e-ee06-4955-a1ff-9d975a5d36d8",
"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-11-05T07:47:00.684705+00:00",
"date_create": "2026-11-05T07:47:00.684705+00:00",
"date_update": "2026-11-05T07:47:00.684705+00:00",
"updated_by_user_id": "79c55088-8ca5-4e54-8020-d1c60e28df83",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-05T07:47:00.684705+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-11-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-05T07:47:00.684705+00:00",
"date_last_job": "2026-11-05T07:47:00.684705+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-05T07:47:00.684705+00:00",
"modified_dateutc": "2026-11-05T07:47:00.684705+00:00",
"is_mobile_installation": true
},
"job_type_id": "8707b4a6-781d-46cd-a578-160cd9095979",
"job_type_code": "sample string 7",
"job_type": {
"id": "550b428a-44c1-4055-806c-9e1bd3b806bd",
"name": "sample string 2",
"sales_organization_id": "d8a4fe95-960d-4f8b-928b-f93acc1c6225",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-05T07:47:00.684705+00:00",
"code": "sample string 7"
},
"job_priority_id": "42bf4987-401c-4416-9ae9-e1fbf4232e7d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "52c7591f-5db0-4b52-8db9-87637d16a300",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9ac8b113-c4a0-4360-99c0-ea61d6e3009b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6ca15ea8-ea25-4743-a828-9e1762fdad34",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97e89052-8b8a-4713-ac2f-0b9d1e9464aa",
"db_currency_id": "74272e60-dc88-46c5-b452-ee61250b00a2",
"db_language_id": "481f0074-2dc8-41ca-a994-84598aef1b65",
"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-11-05T07:47:00.684705+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-05T07:47:00.684705+00:00"
},
"job_status_id": "0d9194b9-1e91-43f7-b7cf-7e2abd34d221",
"job_status_code": "sample string 11",
"db_address_id": "5490ba61-3a92-4913-9353-eb9d1ae05ca8",
"contact_id": "c1a5fcbd-102c-43e5-bbba-41cc3e0748be",
"requested_by_company_id": "873c8d44-cd07-44ae-a2c4-0deb531f8708",
"requested_by_contact_id": "008f92b5-7e8d-45c7-8e54-e24fbfb11c81",
"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-11-05T07:47:00.684705+00:00",
"due_date": "2026-11-05T07:47:00.684705+00:00",
"date_create": "2026-11-05T07:47:00.684705+00:00",
"date_update": "2026-11-05T07:47:00.684705+00:00",
"date_closed": "2026-11-05T07:47:00.684705+00:00",
"suggested_user_id": "eadb886b-7fd7-468b-95b5-fad327be8af6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d69822e5-e0fb-4f1d-a669-f9aa1714c1c6",
"db_language_id": "04806aa8-1992-4225-a861-87ea482366b8",
"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-11-05T07:47:00.684705+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "486406b9-1466-4032-a578-891e6bcf95ea",
"sales_organization": {
"id": "6ca15ea8-ea25-4743-a828-9e1762fdad34",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97e89052-8b8a-4713-ac2f-0b9d1e9464aa",
"db_currency_id": "74272e60-dc88-46c5-b452-ee61250b00a2",
"db_language_id": "481f0074-2dc8-41ca-a994-84598aef1b65",
"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-11-05T07:47:00.684705+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fcaaf695-db72-4d2b-96ad-3b6a6ee6d587",
"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": "42673c7f-2e03-4a3f-9338-f865c247bc59",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-05T07:47:00.684705+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1d6fa2d3-3b5b-4ee3-8d25-5fe14129c3d6"
},
"suggested_date_start": "2026-11-05T07:47:00.684705+00:00",
"skill_id": "298aa690-6b35-4883-94df-175a40143c69",
"skill_code": "sample string 32",
"skill": {
"id": "5f89091c-72ab-4936-91b8-7ab6cc885dcf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9b477c74-f05c-4fb2-8d02-fc06b796cb60",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6ca15ea8-ea25-4743-a828-9e1762fdad34",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97e89052-8b8a-4713-ac2f-0b9d1e9464aa",
"db_currency_id": "74272e60-dc88-46c5-b452-ee61250b00a2",
"db_language_id": "481f0074-2dc8-41ca-a994-84598aef1b65",
"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-11-05T07:47:00.684705+00:00"
},
"modified_dateutc": "2026-11-05T07:47:00.6963308+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "372468de-870d-4b83-a27c-fc3332d8d1bc",
"date_reported_by_company": "2026-11-05T07:47:00.6963308+00:00",
"id2": 36,
"company_id": "eab85350-52d4-4b18-9a6d-73c8df6ab411",
"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": "662c6b68-1993-49c9-b917-b88eed8667e5",
"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-11-05T07:47:00.6963308+00:00"
},
"work_instruction_details_id": "be4cc4fa-73a3-468c-adcf-6c4cb28fab1e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e72381d2-398e-4829-8ceb-bdf9d309bab4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d16d0285-1e08-406a-a12a-5dfe14f0b63b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-05T07:47:00.6963308+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": "cdcce63e-02ee-4c12-8d03-9a57928177cf",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-05T07:47:00.6963308+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.