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": "bd851e2e-9e31-447d-864b-eae98724d452",
"jobs_id": "62db9ded-4c9b-46e1-a6bd-b63413d49d4e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6b122780-c588-46ac-b26d-1b91e1e2779c",
"_parent_id": "d8016028-aa6a-4ca0-ab93-1925607d8c15",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fcd274bf-2ffd-45e1-8c56-e8748871e367",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5d4e4431-6556-476a-bc50-9ecbd609571e",
"_parent_id": "c563a9bd-48a2-4d14-9b03-d654af11640a",
"root_parent_id": "c3f4d559-796e-4a6b-b684-49ad5e07aa33",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3fa199fb-d050-42e0-af13-08dce4cc912d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "822e3d95-ddd1-463b-ad96-0bd69f3fbd7a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e6f3dde8-0f5e-4262-acfb-6458acfd9620",
"_parent_code": "sample string 6",
"sales_organization_id": "0fac4aff-9558-4a3d-8902-aabb66e5820d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b1caba44-82ca-4054-8819-ef75301233d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4bfc821f-5b55-44b6-ba08-08cca40209db",
"db_currency_id": "508b70a4-4421-4738-a0e4-e73e75634442",
"db_language_id": "404a1438-e4a7-44f7-b4a9-a39bbe0d36f3",
"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-11-04T13:29:30.8960083+00:00"
},
"modified_dateutc": "2025-11-04T13:29:30.8960083+00:00"
},
"equipment_model_id": "ce9f1599-76d1-47f7-85f8-d010b01407fd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "adccd529-8a3e-486f-b810-e136499a3839",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "87d5694c-70ee-4f4d-a1c1-cd0efa64a76d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9732c34c-9c48-4a60-92a8-f8a0189915c4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d9795a68-fa13-4281-98fc-20ad0da1f2fd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b1caba44-82ca-4054-8819-ef75301233d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4bfc821f-5b55-44b6-ba08-08cca40209db",
"db_currency_id": "508b70a4-4421-4738-a0e4-e73e75634442",
"db_language_id": "404a1438-e4a7-44f7-b4a9-a39bbe0d36f3",
"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-11-04T13:29:30.8960083+00:00"
},
"modified_dateutc": "2025-11-04T13:29:30.8960083+00:00"
},
"equipment_family_id": "c683045c-fc8d-4d6c-957e-859cc6bba74b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "822e3d95-ddd1-463b-ad96-0bd69f3fbd7a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e6f3dde8-0f5e-4262-acfb-6458acfd9620",
"_parent_code": "sample string 6",
"sales_organization_id": "0fac4aff-9558-4a3d-8902-aabb66e5820d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b1caba44-82ca-4054-8819-ef75301233d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4bfc821f-5b55-44b6-ba08-08cca40209db",
"db_currency_id": "508b70a4-4421-4738-a0e4-e73e75634442",
"db_language_id": "404a1438-e4a7-44f7-b4a9-a39bbe0d36f3",
"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-11-04T13:29:30.8960083+00:00"
},
"modified_dateutc": "2025-11-04T13:29:30.8960083+00:00"
},
"date_in_production_since": "2025-11-04T13:29:30.8960083+00:00",
"date_out_of_production_since": "2025-11-04T13:29:30.8960083+00:00",
"date_end_support": "2025-11-04T13:29:30.8960083+00:00",
"sales_organization_id": "b8829d7a-85c0-4912-9ce0-6594d25b790f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b1caba44-82ca-4054-8819-ef75301233d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4bfc821f-5b55-44b6-ba08-08cca40209db",
"db_currency_id": "508b70a4-4421-4738-a0e4-e73e75634442",
"db_language_id": "404a1438-e4a7-44f7-b4a9-a39bbe0d36f3",
"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-11-04T13:29:30.8960083+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-11-04T13:29:30.8960083+00:00"
},
"project_status_id": "6ce7b6c0-40d6-4498-86ac-b3c74fd57ce7",
"project_status_code": "sample string 10",
"project_status": {
"id": "2a08e81c-535d-4949-8025-c8ca4d31f23c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6168ab1d-8870-43ae-80ed-0515bc6230b3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b1caba44-82ca-4054-8819-ef75301233d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4bfc821f-5b55-44b6-ba08-08cca40209db",
"db_currency_id": "508b70a4-4421-4738-a0e4-e73e75634442",
"db_language_id": "404a1438-e4a7-44f7-b4a9-a39bbe0d36f3",
"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-11-04T13:29:30.8960083+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-04T13:29:30.8960083+00:00"
},
"company_id": "016b1c5e-223b-4a59-994d-623c07850bef",
"company_code": "sample string 12",
"db_address_id": "7924fd54-5e0c-4e29-b0fa-2a3c951ab107",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2051817a-8387-4ffd-8c8a-145bcf44b235",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "729e1c01-fe41-4c60-bbf9-5584e7105ef5",
"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-11-04T13:29:30.8960083+00:00",
"date_create": "2025-11-04T13:29:30.8960083+00:00",
"date_update": "2025-11-04T13:29:30.8960083+00:00",
"updated_by_user_id": "617e6b49-7434-4f21-acfd-1ece1960843a",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-04T13:29:30.8960083+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-11-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-04T13:29:30.8960083+00:00",
"date_last_job": "2025-11-04T13:29:30.8960083+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-04T13:29:30.8960083+00:00",
"modified_dateutc": "2025-11-04T13:29:30.8960083+00:00",
"is_mobile_installation": true
},
"job_type_id": "c2e9fede-e2ea-491c-b9f4-1a5748a8c8d0",
"job_type_code": "sample string 7",
"job_type": {
"id": "74ceb112-247e-407b-9752-f95e4ca017d2",
"name": "sample string 2",
"sales_organization_id": "33a33a81-9cbd-4f2b-a83a-f12fe4861a97",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-04T13:29:30.8960083+00:00",
"code": "sample string 7"
},
"job_priority_id": "3bbdff2a-cd23-4544-8d4f-58e4d47e53c1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e4b8c2a5-2589-45c3-9789-0f1a92f1388c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cd22dd65-ed92-4e88-b34c-761e01d1643a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b1caba44-82ca-4054-8819-ef75301233d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4bfc821f-5b55-44b6-ba08-08cca40209db",
"db_currency_id": "508b70a4-4421-4738-a0e4-e73e75634442",
"db_language_id": "404a1438-e4a7-44f7-b4a9-a39bbe0d36f3",
"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-11-04T13:29:30.8960083+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-04T13:29:30.8960083+00:00"
},
"job_status_id": "38adf152-9670-4ee9-9daf-2056125ee36f",
"job_status_code": "sample string 11",
"db_address_id": "60cf3545-1bdd-4aa1-bcd0-8f1fe91e9f05",
"contact_id": "0e30d463-4797-4ec1-b919-d218e2502c4b",
"requested_by_company_id": "7a1ceb32-27c7-4e53-be5d-9ae6fbb11f4e",
"requested_by_contact_id": "cd6ec666-f1b2-4511-b6ef-3d1808ca944a",
"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-11-04T13:29:30.8960083+00:00",
"due_date": "2025-11-04T13:29:30.8960083+00:00",
"date_create": "2025-11-04T13:29:30.8960083+00:00",
"date_update": "2025-11-04T13:29:30.8960083+00:00",
"date_closed": "2025-11-04T13:29:30.8960083+00:00",
"suggested_user_id": "ef5c2f58-4d98-4b3d-a640-43c415d8f8c5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9715740e-ecb9-4caf-9a10-385ea6afb5c7",
"db_language_id": "7c164b7d-33b0-476e-95bd-45ab077c4755",
"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-11-04T13:29:30.8960083+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "73b41230-e5cc-4caf-9a6e-e349742f4eaa",
"sales_organization": {
"id": "b1caba44-82ca-4054-8819-ef75301233d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4bfc821f-5b55-44b6-ba08-08cca40209db",
"db_currency_id": "508b70a4-4421-4738-a0e4-e73e75634442",
"db_language_id": "404a1438-e4a7-44f7-b4a9-a39bbe0d36f3",
"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-11-04T13:29:30.8960083+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1116f787-e8c5-42fb-b41c-c7fc40eb84c7",
"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": "a82613f2-1841-4506-ba33-47dc51c3a478",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-04T13:29:30.8960083+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fa4beeee-fe4d-4136-aa91-e23884863e9c"
},
"suggested_date_start": "2025-11-04T13:29:30.8960083+00:00",
"skill_id": "62a34245-6131-4460-84ad-eb7f69bbe5ec",
"skill_code": "sample string 32",
"skill": {
"id": "2666f2aa-41a3-4146-9044-2684cd97f1fe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3e8afe93-3ba5-4a19-84fe-203f9f45aeba",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b1caba44-82ca-4054-8819-ef75301233d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4bfc821f-5b55-44b6-ba08-08cca40209db",
"db_currency_id": "508b70a4-4421-4738-a0e4-e73e75634442",
"db_language_id": "404a1438-e4a7-44f7-b4a9-a39bbe0d36f3",
"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-11-04T13:29:30.8960083+00:00"
},
"modified_dateutc": "2025-11-04T13:29:30.8960083+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "54d3b442-8682-4cdb-942d-0d27e14029c1",
"date_reported_by_company": "2025-11-04T13:29:30.8960083+00:00",
"id2": 36,
"company_id": "6e4b6a22-dfee-4448-9a77-bbbb322056ad",
"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": "cc65e160-a2eb-4419-82d1-efe07878adc0",
"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-11-04T13:29:30.8960083+00:00"
},
"work_instruction_details_id": "9cde9b5a-9a72-4ca0-b2a3-5c60750619ad",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "06271309-d92a-4a8e-b283-100085b16eb7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c929de83-5933-48e9-a178-70a2d2459040",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-04T13:29:30.8960083+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": "eaff34a5-ad13-42b2-95fb-213d78993c4c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-04T13:29:30.8960083+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.