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
{
"id": "d3eaa3eb-ea61-42e8-95d7-deba9161db43",
"jobs_id": "cd27a421-ffd6-4b0f-b67b-edf3daf3b59c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "93b4bb68-221a-4a6d-85c1-0244ae473174",
"_parent_id": "bfe8f23c-caa2-4d81-a0f6-221397578579",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9f7880d1-a732-43bd-b682-bc509a5b4dfe",
"project_reference_back_office": "sample string 5",
"project": {
"id": "07355c4f-7ab3-4b9f-84e6-611c73ba8561",
"_parent_id": "d6ade1aa-ac5a-49ac-be34-00ed40154599",
"root_parent_id": "d8aa1f5e-ee80-46c4-8eb8-2782862032a7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1cb4092c-30cb-493f-b6a2-ca2ab306a5a5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "13af546c-995b-4aa8-a51e-4504cd2c67b8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dc0d1554-69db-4678-a0cf-b38df047b4a5",
"_parent_code": "sample string 6",
"sales_organization_id": "e0070471-d68e-4987-81ff-51afecd6f37c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a26462b6-46d6-48e1-9ee5-8bf1fd7cb153",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4ecdc4a-38f1-475f-ac5b-433e27c662a6",
"db_currency_id": "76cdde28-c287-464e-a10b-e7304867eb9d",
"db_language_id": "5cdeda9c-98c1-41a1-84cd-7aaa88c39bed",
"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-17T08:01:04.9396273+00:00"
},
"modified_dateutc": "2026-11-17T08:01:04.9396273+00:00"
},
"equipment_model_id": "ae89ced7-ae78-4c1d-8b31-0211262efc01",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2b94155a-5f4e-4849-a4ed-770d96aaa50b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7f0827d9-7acf-4b79-8a6a-65d0cb81b38d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1cd980d5-2a5e-4096-9eb4-2c1a1a96ca8e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "99ccca1f-6105-4e8e-a09c-4d7874d3278c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a26462b6-46d6-48e1-9ee5-8bf1fd7cb153",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4ecdc4a-38f1-475f-ac5b-433e27c662a6",
"db_currency_id": "76cdde28-c287-464e-a10b-e7304867eb9d",
"db_language_id": "5cdeda9c-98c1-41a1-84cd-7aaa88c39bed",
"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-17T08:01:04.9396273+00:00"
},
"modified_dateutc": "2026-11-17T08:01:04.9396273+00:00"
},
"equipment_family_id": "457df051-c7ed-4132-b521-35e2c2f5526b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "13af546c-995b-4aa8-a51e-4504cd2c67b8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dc0d1554-69db-4678-a0cf-b38df047b4a5",
"_parent_code": "sample string 6",
"sales_organization_id": "e0070471-d68e-4987-81ff-51afecd6f37c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a26462b6-46d6-48e1-9ee5-8bf1fd7cb153",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4ecdc4a-38f1-475f-ac5b-433e27c662a6",
"db_currency_id": "76cdde28-c287-464e-a10b-e7304867eb9d",
"db_language_id": "5cdeda9c-98c1-41a1-84cd-7aaa88c39bed",
"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-17T08:01:04.9396273+00:00"
},
"modified_dateutc": "2026-11-17T08:01:04.9396273+00:00"
},
"date_in_production_since": "2026-11-17T08:01:04.9396273+00:00",
"date_out_of_production_since": "2026-11-17T08:01:04.9396273+00:00",
"date_end_support": "2026-11-17T08:01:04.9396273+00:00",
"sales_organization_id": "066831e2-3ab7-47da-86dc-8bce346c569b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a26462b6-46d6-48e1-9ee5-8bf1fd7cb153",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4ecdc4a-38f1-475f-ac5b-433e27c662a6",
"db_currency_id": "76cdde28-c287-464e-a10b-e7304867eb9d",
"db_language_id": "5cdeda9c-98c1-41a1-84cd-7aaa88c39bed",
"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-17T08:01:04.9396273+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-17T08:01:04.9396273+00:00"
},
"project_status_id": "4eb0c14d-343e-49ce-a5b3-3a5802285d19",
"project_status_code": "sample string 10",
"project_status": {
"id": "530c1748-274e-474e-8f1b-94d639fd8a36",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f7f38c51-8daf-4520-bd49-f2bed31b9f32",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a26462b6-46d6-48e1-9ee5-8bf1fd7cb153",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4ecdc4a-38f1-475f-ac5b-433e27c662a6",
"db_currency_id": "76cdde28-c287-464e-a10b-e7304867eb9d",
"db_language_id": "5cdeda9c-98c1-41a1-84cd-7aaa88c39bed",
"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-17T08:01:04.9396273+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-17T08:01:04.9396273+00:00"
},
"company_id": "3a24ec65-b57d-4396-9ae3-d1bc068df3ef",
"company_code": "sample string 12",
"db_address_id": "a3acae24-c5a4-4166-9c64-d89526e74d48",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1d3c45ab-b245-4309-88f5-a6f07abd6341",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "476590ee-d578-44c1-8ae6-af460a1730d2",
"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-17T08:01:04.9396273+00:00",
"date_create": "2026-11-17T08:01:04.9396273+00:00",
"date_update": "2026-11-17T08:01:04.9396273+00:00",
"updated_by_user_id": "cbb12cee-702f-490d-9028-e225da6f91ae",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-17T08:01:04.9396273+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-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-17T08:01:04.9396273+00:00",
"date_last_job": "2026-11-17T08:01:04.9396273+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-17T08:01:04.9396273+00:00",
"modified_dateutc": "2026-11-17T08:01:04.9396273+00:00",
"is_mobile_installation": true
},
"job_type_id": "613eaf6e-8f42-42e1-8fb9-221420aaf007",
"job_type_code": "sample string 7",
"job_type": {
"id": "6bc7dc23-ca9f-413e-a760-26ec53c87d5a",
"name": "sample string 2",
"sales_organization_id": "0cb6f2a0-a667-49db-9e82-80ea89a2ff85",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-17T08:01:04.9396273+00:00",
"code": "sample string 7"
},
"job_priority_id": "921cfaee-42ab-4817-9734-7716c3714a3d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1129e95b-fb2e-4110-8a02-88fc11c9a0dc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0e469ec8-572a-48b2-86f3-f29e06c11814",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a26462b6-46d6-48e1-9ee5-8bf1fd7cb153",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4ecdc4a-38f1-475f-ac5b-433e27c662a6",
"db_currency_id": "76cdde28-c287-464e-a10b-e7304867eb9d",
"db_language_id": "5cdeda9c-98c1-41a1-84cd-7aaa88c39bed",
"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-17T08:01:04.9396273+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-17T08:01:04.9396273+00:00"
},
"job_status_id": "87792900-994c-4c74-9d5b-b431ec4a79e5",
"job_status_code": "sample string 11",
"db_address_id": "09d8855a-32ee-4a47-a1a1-b28463198e4f",
"contact_id": "21a9992a-3868-4a2c-b8ad-935c9f3a8b24",
"requested_by_company_id": "b2e234e5-2caa-4f9a-9c70-45cebf2a0380",
"requested_by_contact_id": "c5b52188-ef1f-44fc-9a32-43cbdbf95984",
"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-17T08:01:04.9396273+00:00",
"due_date": "2026-11-17T08:01:04.9396273+00:00",
"date_create": "2026-11-17T08:01:04.9396273+00:00",
"date_update": "2026-11-17T08:01:04.9396273+00:00",
"date_closed": "2026-11-17T08:01:04.9396273+00:00",
"suggested_user_id": "cd63cf02-4fa3-4356-975a-3c02db0ab289",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "aa2366cc-c11a-49ca-b130-e4b51e6dc560",
"db_language_id": "171bd1dd-3baa-4046-9eba-aef00b3ed309",
"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-17T08:01:04.9583623+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "517c5264-957c-4f85-a7e0-3681d2763407",
"sales_organization": {
"id": "a26462b6-46d6-48e1-9ee5-8bf1fd7cb153",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4ecdc4a-38f1-475f-ac5b-433e27c662a6",
"db_currency_id": "76cdde28-c287-464e-a10b-e7304867eb9d",
"db_language_id": "5cdeda9c-98c1-41a1-84cd-7aaa88c39bed",
"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-17T08:01:04.9396273+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "32b683d7-b0d1-486e-8de2-8b5f29d9667d",
"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": "452c9a24-7f3d-417e-85ee-de3a6df13c06",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-17T08:01:04.9583623+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d2a1f069-c7fe-4649-a384-aea2061750da"
},
"suggested_date_start": "2026-11-17T08:01:04.9583623+00:00",
"skill_id": "a396a167-0448-4e49-a34e-9b1d0450805c",
"skill_code": "sample string 32",
"skill": {
"id": "14e3679a-9f94-43bc-84bb-16c492d5de53",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7faa084a-164a-4045-b9c4-95c75ff54ad0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a26462b6-46d6-48e1-9ee5-8bf1fd7cb153",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4ecdc4a-38f1-475f-ac5b-433e27c662a6",
"db_currency_id": "76cdde28-c287-464e-a10b-e7304867eb9d",
"db_language_id": "5cdeda9c-98c1-41a1-84cd-7aaa88c39bed",
"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-17T08:01:04.9396273+00:00"
},
"modified_dateutc": "2026-11-17T08:01:04.9583623+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a81a7a0d-3228-4a9e-9065-ff4a9421384e",
"date_reported_by_company": "2026-11-17T08:01:04.9583623+00:00",
"id2": 36,
"company_id": "757389aa-02be-4e82-acab-a2541254137d",
"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": "5f288b03-558c-4f53-b63c-2c27706bb0a0",
"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-17T08:01:04.9583623+00:00"
},
"work_instruction_details_id": "e56c64ab-f3ce-424c-9c34-61a70f4aaa3b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dbc04d21-0176-4a48-a001-414c96aacb8f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1a23da07-ff94-4efd-b357-04ad72bd04a6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-17T08:01:04.9583623+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": "5aed3287-bb7f-4644-8b67-2bf752d7049c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-17T08:01:04.9583623+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.