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": "17e83755-15c4-4c8b-810a-b54d26f0b683",
"jobs_id": "c1566367-5ecf-4f11-bcb9-4eda4a296688",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2daee2ff-653d-403f-8ef6-528f9d1f595a",
"_parent_id": "893299bc-00d9-41d4-887e-027e0e246a3a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ef053d9b-cc05-4e56-a2a0-bec81aa1597e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "48d0badc-627c-48d4-a9e2-d5efe3fccd14",
"_parent_id": "c1a661e1-86d8-4d89-be0a-bf5b0e9e49d5",
"root_parent_id": "f4088c84-3d59-4a5e-838a-03e6a2d2ac86",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "257a0e1e-3a87-4a05-b26e-25e20dc0eb87",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "38cf0807-d829-41d5-9043-79d690b546a7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ecf015a7-4dfc-48cc-8225-94bc007376bb",
"_parent_code": "sample string 6",
"sales_organization_id": "96f77f70-c97a-4dda-8d31-ce174564e4a4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1867d1c4-f6c4-487f-b343-1adcfec7a172",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38d84567-8abf-422c-b8c2-5708122a1c56",
"db_currency_id": "d1af5c2a-469b-4ad4-af87-167e036527a8",
"db_language_id": "9361dbb0-f4c1-424f-9c4d-33175dafaf72",
"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-03-12T05:26:46.0037415+00:00"
},
"modified_dateutc": "2026-03-12T05:26:46.0037415+00:00"
},
"equipment_model_id": "76e55da4-671f-418d-b8cc-8234ced4cef7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4e1e0539-dade-45b8-8d76-f69c51a426d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "49f5eb68-b81c-4643-99c7-fbd4dbd8c9d8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "452a8ce8-fde4-4f47-abf8-aeeceb7f13d3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ba3f9f17-b035-41de-9d40-44f5dc9a3975",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1867d1c4-f6c4-487f-b343-1adcfec7a172",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38d84567-8abf-422c-b8c2-5708122a1c56",
"db_currency_id": "d1af5c2a-469b-4ad4-af87-167e036527a8",
"db_language_id": "9361dbb0-f4c1-424f-9c4d-33175dafaf72",
"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-03-12T05:26:46.0037415+00:00"
},
"modified_dateutc": "2026-03-12T05:26:46.0037415+00:00"
},
"equipment_family_id": "8189728a-0937-46f3-9a08-22803b16a22b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "38cf0807-d829-41d5-9043-79d690b546a7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ecf015a7-4dfc-48cc-8225-94bc007376bb",
"_parent_code": "sample string 6",
"sales_organization_id": "96f77f70-c97a-4dda-8d31-ce174564e4a4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1867d1c4-f6c4-487f-b343-1adcfec7a172",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38d84567-8abf-422c-b8c2-5708122a1c56",
"db_currency_id": "d1af5c2a-469b-4ad4-af87-167e036527a8",
"db_language_id": "9361dbb0-f4c1-424f-9c4d-33175dafaf72",
"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-03-12T05:26:46.0037415+00:00"
},
"modified_dateutc": "2026-03-12T05:26:46.0037415+00:00"
},
"date_in_production_since": "2026-03-12T05:26:46.0037415+00:00",
"date_out_of_production_since": "2026-03-12T05:26:46.0037415+00:00",
"date_end_support": "2026-03-12T05:26:46.0037415+00:00",
"sales_organization_id": "7f68caf8-bd16-4747-911a-578d28c4c65d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1867d1c4-f6c4-487f-b343-1adcfec7a172",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38d84567-8abf-422c-b8c2-5708122a1c56",
"db_currency_id": "d1af5c2a-469b-4ad4-af87-167e036527a8",
"db_language_id": "9361dbb0-f4c1-424f-9c4d-33175dafaf72",
"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-03-12T05:26:46.0037415+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-03-12T05:26:46.0037415+00:00"
},
"project_status_id": "0a4d5c35-5131-48c9-bb93-65bee4887f8e",
"project_status_code": "sample string 10",
"project_status": {
"id": "3329635f-ea06-4e1c-9b2f-a092267c9d7c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "733234cc-6caf-4fd4-aaa1-435c577921fa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1867d1c4-f6c4-487f-b343-1adcfec7a172",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38d84567-8abf-422c-b8c2-5708122a1c56",
"db_currency_id": "d1af5c2a-469b-4ad4-af87-167e036527a8",
"db_language_id": "9361dbb0-f4c1-424f-9c4d-33175dafaf72",
"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-03-12T05:26:46.0037415+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T05:26:46.0037415+00:00"
},
"company_id": "fd5c5639-8be6-4ca3-b62f-dbb6020232ff",
"company_code": "sample string 12",
"db_address_id": "df0bb624-ec93-4a91-a9cc-8b3cbf8d89bb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0b09342b-2aeb-42dd-877c-dbcf29b52b5b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "940e8ac7-d9e7-45a8-9385-7e7fe83c9689",
"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-03-12T05:26:46.0037415+00:00",
"date_create": "2026-03-12T05:26:46.0037415+00:00",
"date_update": "2026-03-12T05:26:46.0037415+00:00",
"updated_by_user_id": "9cdc062f-aa0f-47f1-9256-05292870fb6e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-12T05:26:46.0037415+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-03-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-12T05:26:46.0037415+00:00",
"date_last_job": "2026-03-12T05:26:46.0037415+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-12T05:26:46.0037415+00:00",
"modified_dateutc": "2026-03-12T05:26:46.0037415+00:00",
"is_mobile_installation": true
},
"job_type_id": "13851c2d-2265-4eb7-873e-f7de4737feae",
"job_type_code": "sample string 7",
"job_type": {
"id": "4d1d3e95-f0ea-46af-b716-443794aa7f49",
"name": "sample string 2",
"sales_organization_id": "5c6ee0cf-129a-41f1-bbe5-2a44df35a919",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-12T05:26:46.0037415+00:00",
"code": "sample string 7"
},
"job_priority_id": "8dafc536-a9c2-4502-9304-18583874cb93",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "58ebd88b-c7c2-44af-8a32-0703f8a6c486",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0a5c8f2f-9df2-490a-ad29-52a1b1b5fe26",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1867d1c4-f6c4-487f-b343-1adcfec7a172",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38d84567-8abf-422c-b8c2-5708122a1c56",
"db_currency_id": "d1af5c2a-469b-4ad4-af87-167e036527a8",
"db_language_id": "9361dbb0-f4c1-424f-9c4d-33175dafaf72",
"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-03-12T05:26:46.0037415+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T05:26:46.0037415+00:00"
},
"job_status_id": "70e8cc5a-f39f-47cd-a011-190b5e21dd70",
"job_status_code": "sample string 11",
"db_address_id": "b1cb9efd-c40d-46b5-9215-c05c9617e87b",
"contact_id": "43ad8b88-ec0d-4ffc-976a-d5ba9ffe858e",
"requested_by_company_id": "a2b08ea7-a4bb-4482-a790-ed8d3e17fc80",
"requested_by_contact_id": "7da6e6fc-436b-4645-b73b-baf46f0c427f",
"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-03-12T05:26:46.0037415+00:00",
"due_date": "2026-03-12T05:26:46.0037415+00:00",
"date_create": "2026-03-12T05:26:46.0037415+00:00",
"date_update": "2026-03-12T05:26:46.0037415+00:00",
"date_closed": "2026-03-12T05:26:46.0037415+00:00",
"suggested_user_id": "9b722eb2-a53a-4008-9e76-1fdb4a1bdc9e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "bd17eacf-26b6-48ec-bd5c-705e4e6c6c90",
"db_language_id": "879c6ce9-d0d1-41be-9d24-cbc95c9682ab",
"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-03-12T05:26:46.0037415+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c555777e-13bd-469a-b6f8-742cb36e4b85",
"sales_organization": {
"id": "1867d1c4-f6c4-487f-b343-1adcfec7a172",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38d84567-8abf-422c-b8c2-5708122a1c56",
"db_currency_id": "d1af5c2a-469b-4ad4-af87-167e036527a8",
"db_language_id": "9361dbb0-f4c1-424f-9c4d-33175dafaf72",
"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-03-12T05:26:46.0037415+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6d08c106-4855-4c6b-9b94-49896d483627",
"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": "e42061de-51e6-4365-a20e-b0e44c38bef8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-12T05:26:46.0037415+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "95bbf8bc-be36-48ad-b092-8198ee6363fd"
},
"suggested_date_start": "2026-03-12T05:26:46.0037415+00:00",
"skill_id": "c5f800f1-122a-4caf-a361-59b8dd07e117",
"skill_code": "sample string 32",
"skill": {
"id": "0453b5ae-df2f-46b8-be20-1f3afffb57e9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4ee8850e-20a6-4975-8303-20f5106d5d5d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1867d1c4-f6c4-487f-b343-1adcfec7a172",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38d84567-8abf-422c-b8c2-5708122a1c56",
"db_currency_id": "d1af5c2a-469b-4ad4-af87-167e036527a8",
"db_language_id": "9361dbb0-f4c1-424f-9c4d-33175dafaf72",
"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-03-12T05:26:46.0037415+00:00"
},
"modified_dateutc": "2026-03-12T05:26:46.0037415+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "833a5bae-61ab-4522-ad01-de679b129d35",
"date_reported_by_company": "2026-03-12T05:26:46.0037415+00:00",
"id2": 36,
"company_id": "ecd0d27e-bb69-4fe3-ac1a-1305980e0310",
"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": "48fdb5c9-663a-43c6-b2fc-68c485729cc9",
"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-03-12T05:26:46.0193645+00:00"
},
"work_instruction_details_id": "f4f35097-d428-4ac8-9a49-3d480187dd78",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "abc89677-3690-49cc-b07e-6dcd5185f81d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c108384d-b3e7-4969-a993-c1a5075f72a6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-12T05:26:46.0193645+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": "2915a62e-94c9-49d6-8577-bab4f5e9674c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-12T05:26:46.0193645+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.