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": "7c8cef42-a3bd-434d-968d-7ffb172375a6",
"jobs_id": "3a74001b-db10-4aa8-b0ab-fb2621330b3d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a92aea35-f47f-46e9-9c5b-7d5298746af1",
"_parent_id": "f117dd1b-8f95-4943-8b0c-8a3dfeda10e4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b0ce41b3-0f47-480e-9435-af4b1ae1742a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "60fbb928-2361-4258-b7db-4b79410db4c6",
"_parent_id": "b44d9fbb-9864-4af6-bd4b-379ae7ced2d9",
"root_parent_id": "b01d66c9-e205-48a2-a460-a594368a5708",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3e2e709a-7bcb-4595-80d6-44a70ca056d0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "77452e84-8341-49c5-92c7-f0b71dc24c92",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6426669b-c51e-4b57-9f58-5b9abfd89bc2",
"_parent_code": "sample string 6",
"sales_organization_id": "f1ea8b67-2594-4898-ae50-638ae01dd798",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fc2c0222-835f-4259-9219-190aa907c37e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e3a7eb2-e9e6-4b6f-8523-3d6c932a46ff",
"db_currency_id": "d9b5eaad-e444-416b-831f-f742e27a6d25",
"db_language_id": "7cfc512b-ac53-4d8a-8330-29de556de726",
"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-06-05T21:00:33.3123724+00:00"
},
"modified_dateutc": "2026-06-05T21:00:33.3123724+00:00"
},
"equipment_model_id": "7a42eea2-d567-43d3-8a5b-6a170957b1e2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ff4adf2b-6bd5-4e27-9b50-052196052991",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "597d85cc-9b9f-4b16-8a23-9e66b18103c4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fe883c4b-4944-4de2-a781-9299f07013f1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ce28f3d6-7cc6-41c2-b88e-5dd847015451",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fc2c0222-835f-4259-9219-190aa907c37e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e3a7eb2-e9e6-4b6f-8523-3d6c932a46ff",
"db_currency_id": "d9b5eaad-e444-416b-831f-f742e27a6d25",
"db_language_id": "7cfc512b-ac53-4d8a-8330-29de556de726",
"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-06-05T21:00:33.3123724+00:00"
},
"modified_dateutc": "2026-06-05T21:00:33.3123724+00:00"
},
"equipment_family_id": "7ce1a490-3a34-446b-b713-87476b6c09fd",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "77452e84-8341-49c5-92c7-f0b71dc24c92",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6426669b-c51e-4b57-9f58-5b9abfd89bc2",
"_parent_code": "sample string 6",
"sales_organization_id": "f1ea8b67-2594-4898-ae50-638ae01dd798",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fc2c0222-835f-4259-9219-190aa907c37e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e3a7eb2-e9e6-4b6f-8523-3d6c932a46ff",
"db_currency_id": "d9b5eaad-e444-416b-831f-f742e27a6d25",
"db_language_id": "7cfc512b-ac53-4d8a-8330-29de556de726",
"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-06-05T21:00:33.3123724+00:00"
},
"modified_dateutc": "2026-06-05T21:00:33.3123724+00:00"
},
"date_in_production_since": "2026-06-05T21:00:33.3123724+00:00",
"date_out_of_production_since": "2026-06-05T21:00:33.3123724+00:00",
"date_end_support": "2026-06-05T21:00:33.3123724+00:00",
"sales_organization_id": "10cf1473-99ca-4ed9-9ed8-c6d55fcb7df0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fc2c0222-835f-4259-9219-190aa907c37e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e3a7eb2-e9e6-4b6f-8523-3d6c932a46ff",
"db_currency_id": "d9b5eaad-e444-416b-831f-f742e27a6d25",
"db_language_id": "7cfc512b-ac53-4d8a-8330-29de556de726",
"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-06-05T21:00:33.3123724+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-06-05T21:00:33.3123724+00:00"
},
"project_status_id": "9689fdcc-9c6d-46d6-ae63-14f36c2d8f8a",
"project_status_code": "sample string 10",
"project_status": {
"id": "dbe46625-ca9d-4a44-9302-40e333e5dbf3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6695c211-bea6-4198-9c6d-f6de4d36e8a8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fc2c0222-835f-4259-9219-190aa907c37e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e3a7eb2-e9e6-4b6f-8523-3d6c932a46ff",
"db_currency_id": "d9b5eaad-e444-416b-831f-f742e27a6d25",
"db_language_id": "7cfc512b-ac53-4d8a-8330-29de556de726",
"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-06-05T21:00:33.3123724+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-05T21:00:33.3123724+00:00"
},
"company_id": "2b2806ed-90f8-46ea-9c22-1b86f73a2565",
"company_code": "sample string 12",
"db_address_id": "92c06d1f-d7e3-4b7c-b044-4f256b7e4d21",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a370a4dc-b19b-4238-84aa-29e035f8cc61",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b955b008-53e4-4e1a-96ce-8ce2f34b140d",
"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-06-05T21:00:33.3123724+00:00",
"date_create": "2026-06-05T21:00:33.3123724+00:00",
"date_update": "2026-06-05T21:00:33.3123724+00:00",
"updated_by_user_id": "2b92808c-8c70-48aa-83b2-77c089192924",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-05T21:00:33.3123724+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-06-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-05T21:00:33.3123724+00:00",
"date_last_job": "2026-06-05T21:00:33.3123724+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-05T21:00:33.3123724+00:00",
"modified_dateutc": "2026-06-05T21:00:33.3123724+00:00",
"is_mobile_installation": true
},
"job_type_id": "69a4814b-14a4-4b9d-9df3-e61f6809d0d7",
"job_type_code": "sample string 7",
"job_type": {
"id": "f2c0c112-7dbd-4c6f-b89d-83ad1fcc5cf2",
"name": "sample string 2",
"sales_organization_id": "55ef21ac-95e9-4620-b7fe-f027dbcb031d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-05T21:00:33.3123724+00:00",
"code": "sample string 7"
},
"job_priority_id": "6c987b6e-9b40-460a-b616-b19c21a2c14a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a8cace17-3048-422e-82e6-d0e0b111a83d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2970f9aa-b405-4c53-a412-6dec110a5748",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fc2c0222-835f-4259-9219-190aa907c37e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e3a7eb2-e9e6-4b6f-8523-3d6c932a46ff",
"db_currency_id": "d9b5eaad-e444-416b-831f-f742e27a6d25",
"db_language_id": "7cfc512b-ac53-4d8a-8330-29de556de726",
"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-06-05T21:00:33.3123724+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-05T21:00:33.3123724+00:00"
},
"job_status_id": "2291e654-bb9c-4ba1-93aa-f14835c6338a",
"job_status_code": "sample string 11",
"db_address_id": "f20e9020-cba0-4535-9d6e-d0df9e4655ca",
"contact_id": "898809de-d046-491b-a664-c5f924d14055",
"requested_by_company_id": "6d58dc07-4c6b-4e09-9dbb-1806a778066b",
"requested_by_contact_id": "cb42eb9e-40f9-4c94-834a-0d4ca7181b4a",
"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-06-05T21:00:33.3123724+00:00",
"due_date": "2026-06-05T21:00:33.3123724+00:00",
"date_create": "2026-06-05T21:00:33.3123724+00:00",
"date_update": "2026-06-05T21:00:33.3123724+00:00",
"date_closed": "2026-06-05T21:00:33.3123724+00:00",
"suggested_user_id": "65b39a1e-64e0-4450-8c78-23dc95f8a4de",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "aa26f025-45af-4c46-933f-d9860f5cffba",
"db_language_id": "11076fdb-59e4-476b-b81e-ed4595f0cd64",
"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-06-05T21:00:33.3123724+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dab40938-90be-4c36-b57f-193c4b75257c",
"sales_organization": {
"id": "fc2c0222-835f-4259-9219-190aa907c37e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e3a7eb2-e9e6-4b6f-8523-3d6c932a46ff",
"db_currency_id": "d9b5eaad-e444-416b-831f-f742e27a6d25",
"db_language_id": "7cfc512b-ac53-4d8a-8330-29de556de726",
"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-06-05T21:00:33.3123724+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6723a28e-9d7a-4cac-92a2-ce2a753e7b79",
"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": "9cb22259-a47b-467b-beb1-6100c0e13814",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-05T21:00:33.3123724+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "82ab450a-c278-4d62-90f9-a3e75e9015ab"
},
"suggested_date_start": "2026-06-05T21:00:33.3123724+00:00",
"skill_id": "3d2d06eb-8c86-4b64-997e-2a7c8cf8ee43",
"skill_code": "sample string 32",
"skill": {
"id": "f15b4aa4-1214-4b1a-8a50-67e24d511f3e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0d73c003-e678-463e-b63e-6384e1f67927",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fc2c0222-835f-4259-9219-190aa907c37e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1e3a7eb2-e9e6-4b6f-8523-3d6c932a46ff",
"db_currency_id": "d9b5eaad-e444-416b-831f-f742e27a6d25",
"db_language_id": "7cfc512b-ac53-4d8a-8330-29de556de726",
"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-06-05T21:00:33.3123724+00:00"
},
"modified_dateutc": "2026-06-05T21:00:33.3123724+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8345cbba-3c83-4df1-9f26-5060d2c671bf",
"date_reported_by_company": "2026-06-05T21:00:33.3123724+00:00",
"id2": 36,
"company_id": "32761253-96d8-47bb-851c-027959a47270",
"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": "61931082-7e16-4b14-9962-139e76ad6dd3",
"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-06-05T21:00:33.3123724+00:00"
},
"work_instruction_details_id": "ab6153b0-5ca9-4496-b969-99fa8414bcf1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fe9f3a4f-6c2a-42ca-871d-32e048722037",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3f02df1f-bfdd-4b77-b6c5-55dd644442e5",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-05T21:00:33.3123724+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": "e53301c1-35d4-446c-9866-38696e1403e3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-05T21:00:33.3123724+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.