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": "66aedcae-20ca-4a6a-8df5-72d5894255ce",
"jobs_id": "ca1d92b0-f42b-4eac-b28a-b79cc53e2a71",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fb9822e4-75b9-41ff-b259-dee043efe682",
"_parent_id": "683e805f-52bb-4f23-97e6-f5a19c85d1a4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "811bc04f-c498-4f16-bc6c-8913c82e4162",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f66fd27b-8c50-4151-868d-595fd19bf450",
"_parent_id": "23521fee-1a35-4fdd-a22c-db56b7ae533d",
"root_parent_id": "a3707254-5d61-4a8d-a429-f8bedac2e077",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "615bbe92-9dfa-482a-a687-c9f7a77a17c8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "808373a6-1258-4561-bbe2-24b22c5056db",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6964fda5-7ebf-4104-9193-f5129fd964fb",
"_parent_code": "sample string 6",
"sales_organization_id": "c2d1b39a-8517-4009-90f0-9ef50e25b7e1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "71921987-4336-444c-8597-fb3b3670ef8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5fffa3ce-d07d-4618-bbd4-dd43103a18c2",
"db_currency_id": "35eef6fd-a4c1-42ef-a723-e4d27d169c01",
"db_language_id": "d713e821-3e67-46fd-ab49-414099c123db",
"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-09T02:23:47.3909356+00:00"
},
"modified_dateutc": "2026-04-09T02:23:47.3909356+00:00"
},
"equipment_model_id": "67559192-6a52-4cd7-8bcc-39c4e2362569",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8412d582-0147-4985-a1f6-e378052964c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "44b38bf8-67ef-4595-bb76-43075085592c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3cbd1033-3430-4b10-a6b9-16631eff5554",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f840a326-e3da-40cc-9bd7-922a29353cac",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "71921987-4336-444c-8597-fb3b3670ef8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5fffa3ce-d07d-4618-bbd4-dd43103a18c2",
"db_currency_id": "35eef6fd-a4c1-42ef-a723-e4d27d169c01",
"db_language_id": "d713e821-3e67-46fd-ab49-414099c123db",
"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-09T02:23:47.3909356+00:00"
},
"modified_dateutc": "2026-04-09T02:23:47.3909356+00:00"
},
"equipment_family_id": "4c1f93f7-6243-4600-957e-2754a99e8282",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "808373a6-1258-4561-bbe2-24b22c5056db",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6964fda5-7ebf-4104-9193-f5129fd964fb",
"_parent_code": "sample string 6",
"sales_organization_id": "c2d1b39a-8517-4009-90f0-9ef50e25b7e1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "71921987-4336-444c-8597-fb3b3670ef8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5fffa3ce-d07d-4618-bbd4-dd43103a18c2",
"db_currency_id": "35eef6fd-a4c1-42ef-a723-e4d27d169c01",
"db_language_id": "d713e821-3e67-46fd-ab49-414099c123db",
"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-09T02:23:47.3909356+00:00"
},
"modified_dateutc": "2026-04-09T02:23:47.3909356+00:00"
},
"date_in_production_since": "2026-04-09T02:23:47.3909356+00:00",
"date_out_of_production_since": "2026-04-09T02:23:47.3909356+00:00",
"date_end_support": "2026-04-09T02:23:47.3909356+00:00",
"sales_organization_id": "e7b3b425-0f44-4b5d-b5a3-284f99f3a036",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "71921987-4336-444c-8597-fb3b3670ef8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5fffa3ce-d07d-4618-bbd4-dd43103a18c2",
"db_currency_id": "35eef6fd-a4c1-42ef-a723-e4d27d169c01",
"db_language_id": "d713e821-3e67-46fd-ab49-414099c123db",
"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-09T02:23:47.3909356+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-09T02:23:47.3909356+00:00"
},
"project_status_id": "6928b3cc-b16c-4a71-8e00-606f3897ec9e",
"project_status_code": "sample string 10",
"project_status": {
"id": "4018426a-4b02-4e0a-a631-b7988b0ef5ed",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "aa383120-397a-4d4d-9419-b1fb1687a1a6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "71921987-4336-444c-8597-fb3b3670ef8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5fffa3ce-d07d-4618-bbd4-dd43103a18c2",
"db_currency_id": "35eef6fd-a4c1-42ef-a723-e4d27d169c01",
"db_language_id": "d713e821-3e67-46fd-ab49-414099c123db",
"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-09T02:23:47.3909356+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-09T02:23:47.3909356+00:00"
},
"company_id": "6364ce6b-94d6-4324-b491-02163f868e21",
"company_code": "sample string 12",
"db_address_id": "e81d2cbd-ce0e-4d51-9bf1-a505775297a6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0ac5d923-52bd-4f93-8fb9-9c53e45e6153",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1fa9dc90-d4fb-4604-8f32-390435ed4f12",
"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-09T02:23:47.3909356+00:00",
"date_create": "2026-04-09T02:23:47.3909356+00:00",
"date_update": "2026-04-09T02:23:47.3909356+00:00",
"updated_by_user_id": "7af3ad9d-c14e-4a3e-921a-6adc2a8acaaf",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-09T02:23:47.3909356+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-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-09T02:23:47.3909356+00:00",
"date_last_job": "2026-04-09T02:23:47.3909356+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-09T02:23:47.3909356+00:00",
"modified_dateutc": "2026-04-09T02:23:47.3909356+00:00",
"is_mobile_installation": true
},
"job_type_id": "bee1cd33-d32a-48da-8a64-b36fa18a884b",
"job_type_code": "sample string 7",
"job_type": {
"id": "1b54c1c2-f1a2-4f83-8ab3-6b8959b9bb93",
"name": "sample string 2",
"sales_organization_id": "688dda32-65e3-4116-ade0-0b34708ee54c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-09T02:23:47.3909356+00:00",
"code": "sample string 7"
},
"job_priority_id": "8544a4d4-365e-4a4d-a637-b3e1880f39b7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "30cccd75-cb5d-46f5-bb03-4ef736259fbd",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "17c39dc5-a666-4589-b69c-e1ef66690914",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "71921987-4336-444c-8597-fb3b3670ef8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5fffa3ce-d07d-4618-bbd4-dd43103a18c2",
"db_currency_id": "35eef6fd-a4c1-42ef-a723-e4d27d169c01",
"db_language_id": "d713e821-3e67-46fd-ab49-414099c123db",
"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-09T02:23:47.3909356+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-09T02:23:47.3909356+00:00"
},
"job_status_id": "c6b2992f-8b6e-458b-a92d-f524534a31c1",
"job_status_code": "sample string 11",
"db_address_id": "2e98ab1e-a589-421e-b8e1-0fe691b85201",
"contact_id": "a8c6bfcc-5e93-4004-a126-f9f13e648f59",
"requested_by_company_id": "e7450f23-ee9d-466a-bb1c-d317e82f6bf2",
"requested_by_contact_id": "063e4f69-6be6-4e6f-b88a-9041b5e86912",
"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-09T02:23:47.3909356+00:00",
"due_date": "2026-04-09T02:23:47.3909356+00:00",
"date_create": "2026-04-09T02:23:47.3909356+00:00",
"date_update": "2026-04-09T02:23:47.3909356+00:00",
"date_closed": "2026-04-09T02:23:47.3909356+00:00",
"suggested_user_id": "32e23a6c-941b-404e-8f66-e348bfb572af",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "95f434d9-9986-46bc-bddd-fe8491ab27be",
"db_language_id": "982e7e31-1314-4673-9dce-e8a5cd1fb6fd",
"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-09T02:23:47.3909356+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "74d685d3-621c-4c94-af3a-aff3b1b25332",
"sales_organization": {
"id": "71921987-4336-444c-8597-fb3b3670ef8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5fffa3ce-d07d-4618-bbd4-dd43103a18c2",
"db_currency_id": "35eef6fd-a4c1-42ef-a723-e4d27d169c01",
"db_language_id": "d713e821-3e67-46fd-ab49-414099c123db",
"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-09T02:23:47.3909356+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3382d192-38e0-4cb4-bf40-cfcc4e793c89",
"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": "1f655fb2-d314-4926-9953-53faa4e78e28",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-09T02:23:47.3909356+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e702a78f-1c04-4e6f-9047-21b5fc6cfe32"
},
"suggested_date_start": "2026-04-09T02:23:47.3909356+00:00",
"skill_id": "1b4bb66c-4871-4ff9-91fc-ef2286b751a4",
"skill_code": "sample string 32",
"skill": {
"id": "70adbafc-f991-4817-a1c8-fd918b770c9b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5d190910-637e-4dfa-a323-8131c61ad834",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "71921987-4336-444c-8597-fb3b3670ef8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5fffa3ce-d07d-4618-bbd4-dd43103a18c2",
"db_currency_id": "35eef6fd-a4c1-42ef-a723-e4d27d169c01",
"db_language_id": "d713e821-3e67-46fd-ab49-414099c123db",
"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-09T02:23:47.3909356+00:00"
},
"modified_dateutc": "2026-04-09T02:23:47.3909356+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5ef97376-3aa8-4dcc-9769-adaf715e4418",
"date_reported_by_company": "2026-04-09T02:23:47.3909356+00:00",
"id2": 36,
"company_id": "a66d45cd-f02f-45b2-9d84-3016be733f10",
"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": "12295ea5-2446-4c17-9f03-220700c4fabb",
"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-09T02:23:47.3909356+00:00"
},
"work_instruction_details_id": "62409b8a-c3ea-4830-a0c7-14f4c155b2d1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cf8a860b-9cac-4b30-a194-3d0f2ec434d5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6eba9921-9739-4254-91de-206d0a84edae",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-09T02:23:47.3909356+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": "ebd18461-6991-4f29-aece-4114d24c5d7c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-09T02:23:47.3909356+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.