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": "e5f39a4c-4767-45b0-b311-0c60ac71c2db",
"jobs_id": "42bc0072-68d5-4c39-bc71-084ad6ab19a2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9b7b91c3-f90e-4295-a207-e1bc2dcd5358",
"_parent_id": "bc095753-f672-4bd6-b2ba-379c757e7d8b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7a6dbc04-894b-4ca3-9502-48782bbe5fc7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "78afaf3d-16ed-4546-b1ab-2530acfddf44",
"_parent_id": "83fe4ce5-ec7d-4d90-974a-0e9dfd13cd53",
"root_parent_id": "88ece04d-b457-4fd7-9023-95c4f6edcc14",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "03bb7042-8aa4-408a-a902-fd1038e73214",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0f37b367-b54c-40e9-9c04-7d1f5818053a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5ca42b8f-ef1d-4890-9448-0d32c52a0177",
"_parent_code": "sample string 6",
"sales_organization_id": "225ffe05-7ff0-4343-a159-b6681aae3cfe",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d8a7f401-11ba-477e-a4a2-600f0a372c09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3d8513e-d9c6-4ffb-99fd-2a03c1b5c05d",
"db_currency_id": "a3f3a167-255a-4041-bafd-b49c77f4d923",
"db_language_id": "cb33f614-3e38-4c58-abb1-1705a372bc97",
"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": "2025-10-01T00:51:12.9723242+00:00"
},
"modified_dateutc": "2025-10-01T00:51:12.9723242+00:00"
},
"equipment_model_id": "4f3faf64-35bb-427a-8cdd-661c1f19e1d2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0e3b1fa6-a6c3-4e10-a6c4-3b95d98f172a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d33ceb7e-e3ce-4950-b0ff-b668644923df",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d608408f-7e2a-4344-81e0-33a35e6b3eff",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a0206a3c-661e-43d1-a866-6cff49ed8726",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d8a7f401-11ba-477e-a4a2-600f0a372c09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3d8513e-d9c6-4ffb-99fd-2a03c1b5c05d",
"db_currency_id": "a3f3a167-255a-4041-bafd-b49c77f4d923",
"db_language_id": "cb33f614-3e38-4c58-abb1-1705a372bc97",
"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": "2025-10-01T00:51:12.9723242+00:00"
},
"modified_dateutc": "2025-10-01T00:51:12.9723242+00:00"
},
"equipment_family_id": "e7b1f5b3-e00e-4dbc-8e40-dbce04caf4f2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0f37b367-b54c-40e9-9c04-7d1f5818053a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5ca42b8f-ef1d-4890-9448-0d32c52a0177",
"_parent_code": "sample string 6",
"sales_organization_id": "225ffe05-7ff0-4343-a159-b6681aae3cfe",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d8a7f401-11ba-477e-a4a2-600f0a372c09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3d8513e-d9c6-4ffb-99fd-2a03c1b5c05d",
"db_currency_id": "a3f3a167-255a-4041-bafd-b49c77f4d923",
"db_language_id": "cb33f614-3e38-4c58-abb1-1705a372bc97",
"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": "2025-10-01T00:51:12.9723242+00:00"
},
"modified_dateutc": "2025-10-01T00:51:12.9723242+00:00"
},
"date_in_production_since": "2025-10-01T00:51:12.9723242+00:00",
"date_out_of_production_since": "2025-10-01T00:51:12.9723242+00:00",
"date_end_support": "2025-10-01T00:51:12.9723242+00:00",
"sales_organization_id": "57db1b70-dd34-4ef6-ac4f-7f180b688a2e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d8a7f401-11ba-477e-a4a2-600f0a372c09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3d8513e-d9c6-4ffb-99fd-2a03c1b5c05d",
"db_currency_id": "a3f3a167-255a-4041-bafd-b49c77f4d923",
"db_language_id": "cb33f614-3e38-4c58-abb1-1705a372bc97",
"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": "2025-10-01T00:51:12.9723242+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": "2025-10-01T00:51:12.9723242+00:00"
},
"project_status_id": "735f40aa-e54a-468e-92fc-22acf015c914",
"project_status_code": "sample string 10",
"project_status": {
"id": "a9f81af0-87f8-4c0e-9004-8f74162920b9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "71300771-a0f3-4893-82bb-67a98f838618",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d8a7f401-11ba-477e-a4a2-600f0a372c09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3d8513e-d9c6-4ffb-99fd-2a03c1b5c05d",
"db_currency_id": "a3f3a167-255a-4041-bafd-b49c77f4d923",
"db_language_id": "cb33f614-3e38-4c58-abb1-1705a372bc97",
"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": "2025-10-01T00:51:12.9723242+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-01T00:51:12.9723242+00:00"
},
"company_id": "8355b89e-b32b-44ad-ac25-469a0fd19c3c",
"company_code": "sample string 12",
"db_address_id": "3a0f3470-be42-48f3-a9ba-8e1d4ed9aef0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "774e6ce5-88be-4bd9-80df-af4c1bc6c497",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "76b5a116-93c4-42ca-87bc-eb883c7003d1",
"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": "2025-10-01T00:51:12.9723242+00:00",
"date_create": "2025-10-01T00:51:12.9723242+00:00",
"date_update": "2025-10-01T00:51:12.9723242+00:00",
"updated_by_user_id": "3e71683c-1925-429a-868b-67ec5956c239",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-01T00:51:12.9723242+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": "2025-10-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-01T00:51:12.9723242+00:00",
"date_last_job": "2025-10-01T00:51:12.9723242+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-01T00:51:12.9723242+00:00",
"modified_dateutc": "2025-10-01T00:51:12.9723242+00:00",
"is_mobile_installation": true
},
"job_type_id": "e16dea97-0177-4fdd-ba3f-367208cee93a",
"job_type_code": "sample string 7",
"job_type": {
"id": "804f4d81-cf3c-4c53-bfb4-e91261153823",
"name": "sample string 2",
"sales_organization_id": "f9ab1d5e-1567-462b-8a34-c94c32944ff7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-01T00:51:12.9723242+00:00",
"code": "sample string 7"
},
"job_priority_id": "fa7b5a0e-d244-4f3b-8668-3ed9d33cbdcd",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2351a65a-1bcc-4bc5-9f1b-41ea79080734",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c8292a3b-d391-4857-b34c-682f401a71b3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d8a7f401-11ba-477e-a4a2-600f0a372c09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3d8513e-d9c6-4ffb-99fd-2a03c1b5c05d",
"db_currency_id": "a3f3a167-255a-4041-bafd-b49c77f4d923",
"db_language_id": "cb33f614-3e38-4c58-abb1-1705a372bc97",
"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": "2025-10-01T00:51:12.9723242+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-01T00:51:12.9723242+00:00"
},
"job_status_id": "495a9dd2-6e97-4dd3-b7de-38b968cb151b",
"job_status_code": "sample string 11",
"db_address_id": "d31848da-fd38-4cd7-83ce-9bd1af6802bc",
"contact_id": "81176185-fb15-4144-8a74-ee5ea04e4f85",
"requested_by_company_id": "9b15038d-1259-472a-a81b-c73615132e71",
"requested_by_contact_id": "95ad927b-7de3-46af-92b3-2ddf87f1c342",
"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": "2025-10-01T00:51:12.9723242+00:00",
"due_date": "2025-10-01T00:51:12.9723242+00:00",
"date_create": "2025-10-01T00:51:12.9723242+00:00",
"date_update": "2025-10-01T00:51:12.9723242+00:00",
"date_closed": "2025-10-01T00:51:12.9723242+00:00",
"suggested_user_id": "2f5ab196-a98b-498c-936b-a65db901b2df",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "99434a73-273b-40b0-bdf4-9eaf64856a6b",
"db_language_id": "f3e30037-e5ac-429b-a553-6da361757032",
"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": "2025-10-01T00:51:12.9723242+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b7fb4445-e903-411d-a732-4e7a84e16ee0",
"sales_organization": {
"id": "d8a7f401-11ba-477e-a4a2-600f0a372c09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3d8513e-d9c6-4ffb-99fd-2a03c1b5c05d",
"db_currency_id": "a3f3a167-255a-4041-bafd-b49c77f4d923",
"db_language_id": "cb33f614-3e38-4c58-abb1-1705a372bc97",
"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": "2025-10-01T00:51:12.9723242+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "996e466b-05d4-4049-9189-79ada705f94e",
"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": "b14ac8ca-880a-4976-8938-9b710983a623",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-01T00:51:12.9723242+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1dbb6f89-cb7d-4d37-94a7-150aafbb0285"
},
"suggested_date_start": "2025-10-01T00:51:12.9723242+00:00",
"skill_id": "a02c8a03-4614-434f-9ae6-39153ff4836c",
"skill_code": "sample string 32",
"skill": {
"id": "9de7a438-de20-4890-bc30-98122df40ba1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "59e004de-3519-46c2-8def-c7b267846241",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d8a7f401-11ba-477e-a4a2-600f0a372c09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3d8513e-d9c6-4ffb-99fd-2a03c1b5c05d",
"db_currency_id": "a3f3a167-255a-4041-bafd-b49c77f4d923",
"db_language_id": "cb33f614-3e38-4c58-abb1-1705a372bc97",
"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": "2025-10-01T00:51:12.9723242+00:00"
},
"modified_dateutc": "2025-10-01T00:51:12.9723242+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5684cd42-efd6-4716-b77d-fbf339f6a098",
"date_reported_by_company": "2025-10-01T00:51:12.9723242+00:00",
"id2": 36,
"company_id": "ecff91aa-1d8b-418f-a45a-3e4e3aeb5408",
"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": "dbeb0e13-f0ac-4fde-abc8-9fbfbe2077c7",
"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": "2025-10-01T00:51:12.9723242+00:00"
},
"work_instruction_details_id": "37c3a272-35dc-41ac-a2f4-de5f6fd41941",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b05f8bde-23b1-4bd2-917c-4e7c4b7c4514",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bbbf4dc8-dbd7-4803-8d64-9e7e9a68d9ea",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-01T00:51:12.9723242+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": "1da068e1-0242-4c00-bd90-56dd21291f4e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-01T00:51:12.9879479+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.