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": "f47a6c4f-d188-4167-a85a-7e5e587872a6",
"jobs_id": "98d73c35-6192-4200-a5f1-717c9163bbec",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a6afc9ef-dc3b-4a5b-9ea1-1d16e3882b81",
"_parent_id": "9d089a9f-c4ef-4a6c-99ae-db6dec523cdc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ca79d2b9-aeaf-4fbd-b864-7c38b93c5921",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cc6f0859-b4b3-46e6-8f47-f24750ca3969",
"_parent_id": "98ba1aee-dfc7-4a00-8fd8-8685a9901ec7",
"root_parent_id": "6487eb1f-3402-481e-a7a0-6fd097981f32",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "38a4ca41-ac11-41a1-8f44-38c601fc362b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "963c8637-4dbe-4708-be33-637444c2df19",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "36d8ebdd-f2a0-4783-a1e0-40f40d30e882",
"_parent_code": "sample string 6",
"sales_organization_id": "fd826879-39ef-4213-8136-4da883e13d6b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "28af26b6-4bba-4006-a76d-f2eaf2cfecce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fd20d2c-aa18-4844-a411-cfe388dc666e",
"db_currency_id": "c56423bc-d662-40a8-86be-0e1940614f9d",
"db_language_id": "0ef2e003-f777-464b-9e57-9277f2ca9e41",
"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-04-04T03:53:53.7979607+00:00"
},
"modified_dateutc": "2026-04-04T03:53:53.7979607+00:00"
},
"equipment_model_id": "88fe0b9c-f7fb-4c88-bc6a-9fcf3e4422ed",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4d472e96-36c8-4622-b511-e65f5cd6a667",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "934c5ab5-05b8-422d-8dff-c7bd94172112",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "53475c8f-feb3-4654-8f33-38cdda0c546f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4c364ac0-d1fc-4445-bf2f-a24ecb8ca104",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "28af26b6-4bba-4006-a76d-f2eaf2cfecce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fd20d2c-aa18-4844-a411-cfe388dc666e",
"db_currency_id": "c56423bc-d662-40a8-86be-0e1940614f9d",
"db_language_id": "0ef2e003-f777-464b-9e57-9277f2ca9e41",
"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-04-04T03:53:53.7979607+00:00"
},
"modified_dateutc": "2026-04-04T03:53:53.7979607+00:00"
},
"equipment_family_id": "914509c1-9374-4607-942c-236c43ba9f35",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "963c8637-4dbe-4708-be33-637444c2df19",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "36d8ebdd-f2a0-4783-a1e0-40f40d30e882",
"_parent_code": "sample string 6",
"sales_organization_id": "fd826879-39ef-4213-8136-4da883e13d6b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "28af26b6-4bba-4006-a76d-f2eaf2cfecce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fd20d2c-aa18-4844-a411-cfe388dc666e",
"db_currency_id": "c56423bc-d662-40a8-86be-0e1940614f9d",
"db_language_id": "0ef2e003-f777-464b-9e57-9277f2ca9e41",
"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-04-04T03:53:53.7979607+00:00"
},
"modified_dateutc": "2026-04-04T03:53:53.7979607+00:00"
},
"date_in_production_since": "2026-04-04T03:53:53.7979607+00:00",
"date_out_of_production_since": "2026-04-04T03:53:53.7979607+00:00",
"date_end_support": "2026-04-04T03:53:53.7979607+00:00",
"sales_organization_id": "bc29eac8-a7f8-42c5-9b91-4d30e6e65b85",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "28af26b6-4bba-4006-a76d-f2eaf2cfecce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fd20d2c-aa18-4844-a411-cfe388dc666e",
"db_currency_id": "c56423bc-d662-40a8-86be-0e1940614f9d",
"db_language_id": "0ef2e003-f777-464b-9e57-9277f2ca9e41",
"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-04-04T03:53:53.7979607+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-04-04T03:53:53.7979607+00:00"
},
"project_status_id": "f37cf20c-105d-49f1-a92d-db15168a988e",
"project_status_code": "sample string 10",
"project_status": {
"id": "6c0ced23-7687-4297-b33a-8ffce0485f66",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c7d5c123-f6e7-4bfe-a1ef-9e7aee1f7e95",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "28af26b6-4bba-4006-a76d-f2eaf2cfecce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fd20d2c-aa18-4844-a411-cfe388dc666e",
"db_currency_id": "c56423bc-d662-40a8-86be-0e1940614f9d",
"db_language_id": "0ef2e003-f777-464b-9e57-9277f2ca9e41",
"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-04-04T03:53:53.7979607+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-04T03:53:53.7979607+00:00"
},
"company_id": "d7516561-31d1-4fe6-af7b-2c8e118b26db",
"company_code": "sample string 12",
"db_address_id": "3f0c1678-346d-4f00-b693-f682408aaed2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "51504fe8-eecd-47b6-9458-fecf6da86dcd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "72eb4737-a2fe-4e03-b94a-671fd3bb94e9",
"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-04-04T03:53:53.7979607+00:00",
"date_create": "2026-04-04T03:53:53.7979607+00:00",
"date_update": "2026-04-04T03:53:53.7979607+00:00",
"updated_by_user_id": "e68fbcb6-0c10-4842-9134-90c2a8a76493",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-04T03:53:53.7979607+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-04-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-04T03:53:53.7979607+00:00",
"date_last_job": "2026-04-04T03:53:53.7979607+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-04T03:53:53.7979607+00:00",
"modified_dateutc": "2026-04-04T03:53:53.7979607+00:00",
"is_mobile_installation": true
},
"job_type_id": "d9489954-616c-412d-bf3b-d69ed54d5142",
"job_type_code": "sample string 7",
"job_type": {
"id": "7625c088-01f1-42ab-a79c-4a474221ed44",
"name": "sample string 2",
"sales_organization_id": "da7a6738-f463-45ec-a00f-63de0c1c473f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-04T03:53:53.7979607+00:00",
"code": "sample string 7"
},
"job_priority_id": "2b6de13d-9b5b-4bca-bc75-235504e9ab31",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fd17297c-b10a-45b4-96e0-2bcc8a7291dc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "34270a19-3d8b-42d4-bc48-f3867fabe808",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "28af26b6-4bba-4006-a76d-f2eaf2cfecce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fd20d2c-aa18-4844-a411-cfe388dc666e",
"db_currency_id": "c56423bc-d662-40a8-86be-0e1940614f9d",
"db_language_id": "0ef2e003-f777-464b-9e57-9277f2ca9e41",
"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-04-04T03:53:53.7979607+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-04T03:53:53.7979607+00:00"
},
"job_status_id": "0b9ab594-b88b-44c5-95b1-8423f9dd7671",
"job_status_code": "sample string 11",
"db_address_id": "e693113e-bbcf-447b-87d2-0863a6365c80",
"contact_id": "0cea55f3-b124-482b-b140-e13d045ac54e",
"requested_by_company_id": "e678337e-26e2-4de0-ad06-ec9a7872acf5",
"requested_by_contact_id": "ccaa86a6-5dbc-410e-8f8e-ac1ebc1c51e8",
"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-04-04T03:53:53.7979607+00:00",
"due_date": "2026-04-04T03:53:53.7979607+00:00",
"date_create": "2026-04-04T03:53:53.7979607+00:00",
"date_update": "2026-04-04T03:53:53.7979607+00:00",
"date_closed": "2026-04-04T03:53:53.7979607+00:00",
"suggested_user_id": "8822f992-3eb6-4414-8ea7-370f0f0e4593",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1126a1c6-3564-4676-844f-6a53968187eb",
"db_language_id": "0ff03c27-5342-4de6-9d02-dc1780389bd3",
"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-04-04T03:53:53.7979607+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c0f4a44a-1015-4c1c-86a2-ad282fe35435",
"sales_organization": {
"id": "28af26b6-4bba-4006-a76d-f2eaf2cfecce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fd20d2c-aa18-4844-a411-cfe388dc666e",
"db_currency_id": "c56423bc-d662-40a8-86be-0e1940614f9d",
"db_language_id": "0ef2e003-f777-464b-9e57-9277f2ca9e41",
"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-04-04T03:53:53.7979607+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8416228b-c321-4f25-9325-4cbd11c83db3",
"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": "b9aad762-8944-4e34-998e-f277adb6f341",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-04T03:53:53.7979607+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fa532d00-a09b-4ba9-8d67-a635f6c5b957"
},
"suggested_date_start": "2026-04-04T03:53:53.7979607+00:00",
"skill_id": "600a24ff-e6eb-4c98-a956-fac2fd69972f",
"skill_code": "sample string 32",
"skill": {
"id": "d24c69f7-01c1-4ae1-91b4-07043b026d71",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b5c056ae-12da-4a41-ae45-0bc427171362",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "28af26b6-4bba-4006-a76d-f2eaf2cfecce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fd20d2c-aa18-4844-a411-cfe388dc666e",
"db_currency_id": "c56423bc-d662-40a8-86be-0e1940614f9d",
"db_language_id": "0ef2e003-f777-464b-9e57-9277f2ca9e41",
"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-04-04T03:53:53.7979607+00:00"
},
"modified_dateutc": "2026-04-04T03:53:53.7979607+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1031a50c-e34b-484e-b085-f499d791ec1b",
"date_reported_by_company": "2026-04-04T03:53:53.7979607+00:00",
"id2": 36,
"company_id": "be3c4d9a-d054-4907-88e9-d14b49ef9d3d",
"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": "458d6973-4e28-46d1-8acd-2f6e1aefc186",
"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-04-04T03:53:53.7979607+00:00"
},
"work_instruction_details_id": "7d0a7e68-59ee-4397-a85c-c6e6a759ac7b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1f40d13e-35f0-4814-b485-22bfa899b092",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "35fe276c-9e73-4286-97f2-c9cda0de7778",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-04T03:53:53.7979607+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": "6e8c8a85-1364-4137-bedc-894c838c6d6a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-04T03:53:53.7979607+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.