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": "31345364-2f43-4923-87ba-9523b1be0ba3",
"jobs_id": "2ec52a34-5cf1-49eb-9ad2-be8e521012d9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "416d00e6-2a41-4d62-bcce-4b0fe2eb88f8",
"_parent_id": "7658a6a5-f0d1-44aa-860f-17f4e57743ba",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "72f0332f-695f-4884-acce-9fe49b175e24",
"project_reference_back_office": "sample string 5",
"project": {
"id": "10d8375d-b19e-479b-8659-cb43c63d6eed",
"_parent_id": "c0d7fd6d-3993-42d3-95e0-d40a4ec0a3da",
"root_parent_id": "f09d56fb-476d-433f-8cb7-cdae0a6db881",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "53c455fe-e31c-4bde-b0a4-5ccbef3b3f7e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c4c7f699-50ca-444e-ae8c-b132ee69184c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "873054f1-755f-46f3-b536-c0bd9a0bc682",
"_parent_code": "sample string 6",
"sales_organization_id": "03abffb6-b975-43ff-9654-3fa77fd32a9f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "aa7f0296-82b5-421f-81a8-1e74c21d188d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "12f82fb2-d5e2-4ac3-9cc9-3b4894d63f11",
"db_currency_id": "28542409-f85a-4f29-9cc2-83a884cda576",
"db_language_id": "25f613c7-c33c-4163-810f-cb37bd5bbc4c",
"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-02-04T21:10:43.7823883+00:00"
},
"modified_dateutc": "2026-02-04T21:10:43.7823883+00:00"
},
"equipment_model_id": "df21d19f-9960-4833-8d49-e6dbc3867e68",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b9cb3d8d-a064-4fad-bda3-27211a1a3c16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7157d9a8-f74d-4c73-a8c6-328a6f438d94",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "04789861-f9b5-41dc-8fdd-78080000c134",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "438d116b-eed2-4290-b74e-d87ff60cf76e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "aa7f0296-82b5-421f-81a8-1e74c21d188d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "12f82fb2-d5e2-4ac3-9cc9-3b4894d63f11",
"db_currency_id": "28542409-f85a-4f29-9cc2-83a884cda576",
"db_language_id": "25f613c7-c33c-4163-810f-cb37bd5bbc4c",
"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-02-04T21:10:43.7823883+00:00"
},
"modified_dateutc": "2026-02-04T21:10:43.7823883+00:00"
},
"equipment_family_id": "b459e7c1-0361-49d9-9e60-3fc115aab1c2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c4c7f699-50ca-444e-ae8c-b132ee69184c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "873054f1-755f-46f3-b536-c0bd9a0bc682",
"_parent_code": "sample string 6",
"sales_organization_id": "03abffb6-b975-43ff-9654-3fa77fd32a9f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "aa7f0296-82b5-421f-81a8-1e74c21d188d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "12f82fb2-d5e2-4ac3-9cc9-3b4894d63f11",
"db_currency_id": "28542409-f85a-4f29-9cc2-83a884cda576",
"db_language_id": "25f613c7-c33c-4163-810f-cb37bd5bbc4c",
"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-02-04T21:10:43.7823883+00:00"
},
"modified_dateutc": "2026-02-04T21:10:43.7823883+00:00"
},
"date_in_production_since": "2026-02-04T21:10:43.7823883+00:00",
"date_out_of_production_since": "2026-02-04T21:10:43.7823883+00:00",
"date_end_support": "2026-02-04T21:10:43.7823883+00:00",
"sales_organization_id": "0ca2ce0d-a73d-43f5-974c-626b34bdfa35",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "aa7f0296-82b5-421f-81a8-1e74c21d188d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "12f82fb2-d5e2-4ac3-9cc9-3b4894d63f11",
"db_currency_id": "28542409-f85a-4f29-9cc2-83a884cda576",
"db_language_id": "25f613c7-c33c-4163-810f-cb37bd5bbc4c",
"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-02-04T21:10:43.7823883+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-02-04T21:10:43.7823883+00:00"
},
"project_status_id": "3a7dfd45-c85d-4b2d-8526-ab11436f5b0a",
"project_status_code": "sample string 10",
"project_status": {
"id": "828b5639-59b0-4f82-a211-d3172250dd72",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c6274e70-4a11-4308-b328-ac759a532716",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aa7f0296-82b5-421f-81a8-1e74c21d188d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "12f82fb2-d5e2-4ac3-9cc9-3b4894d63f11",
"db_currency_id": "28542409-f85a-4f29-9cc2-83a884cda576",
"db_language_id": "25f613c7-c33c-4163-810f-cb37bd5bbc4c",
"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-02-04T21:10:43.7823883+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-04T21:10:43.7980113+00:00"
},
"company_id": "556750d5-a694-4ea2-840b-285eae13d0ac",
"company_code": "sample string 12",
"db_address_id": "42d49f13-7a57-40e4-8747-bd808b15c608",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e470872a-66fc-468e-ae89-51914522f5c6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "68e8e985-1a72-4d17-ba54-bd24a1759a32",
"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-02-04T21:10:43.7980113+00:00",
"date_create": "2026-02-04T21:10:43.7980113+00:00",
"date_update": "2026-02-04T21:10:43.7980113+00:00",
"updated_by_user_id": "19d30f51-3324-4f2d-9ffe-10e15730960d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-04T21:10:43.7980113+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-02-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-04T21:10:43.7980113+00:00",
"date_last_job": "2026-02-04T21:10:43.7980113+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-04T21:10:43.7980113+00:00",
"modified_dateutc": "2026-02-04T21:10:43.7980113+00:00",
"is_mobile_installation": true
},
"job_type_id": "f89d6890-17da-4ca8-9296-0038ba82ecc4",
"job_type_code": "sample string 7",
"job_type": {
"id": "ff50814b-ae11-4522-8524-b211ff69890e",
"name": "sample string 2",
"sales_organization_id": "a4dac3fd-d4fb-4ff2-9758-e3083e4ebc7a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-04T21:10:43.7980113+00:00",
"code": "sample string 7"
},
"job_priority_id": "f03fd482-4c7b-45b7-a8c8-38ea1caf8e3e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4c3eec28-ab39-4214-8e19-6a088376d839",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "03bb1930-415c-4c37-9757-35e360ed2307",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aa7f0296-82b5-421f-81a8-1e74c21d188d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "12f82fb2-d5e2-4ac3-9cc9-3b4894d63f11",
"db_currency_id": "28542409-f85a-4f29-9cc2-83a884cda576",
"db_language_id": "25f613c7-c33c-4163-810f-cb37bd5bbc4c",
"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-02-04T21:10:43.7823883+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-04T21:10:43.7980113+00:00"
},
"job_status_id": "f5c385e3-4710-4996-a7a9-ddb9faba74d1",
"job_status_code": "sample string 11",
"db_address_id": "d5744077-fea6-44f0-bee2-21c84671744d",
"contact_id": "4a378b95-2d7b-4ff6-a5bb-ec821c841db4",
"requested_by_company_id": "463ae70a-eba9-4af2-b208-b965b045d408",
"requested_by_contact_id": "a14e5593-c2ad-45d5-813a-fccd63e9ffa6",
"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-02-04T21:10:43.7980113+00:00",
"due_date": "2026-02-04T21:10:43.7980113+00:00",
"date_create": "2026-02-04T21:10:43.7980113+00:00",
"date_update": "2026-02-04T21:10:43.7980113+00:00",
"date_closed": "2026-02-04T21:10:43.7980113+00:00",
"suggested_user_id": "20f6c229-f03c-425b-983c-9c08950affdb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2174f95d-384e-44a7-8e71-5d7704a8ed1e",
"db_language_id": "18f1175a-1825-4161-b143-5399b428e080",
"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-02-04T21:10:43.7980113+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e04c579b-1f38-46af-b7ee-fd09c56f024e",
"sales_organization": {
"id": "aa7f0296-82b5-421f-81a8-1e74c21d188d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "12f82fb2-d5e2-4ac3-9cc9-3b4894d63f11",
"db_currency_id": "28542409-f85a-4f29-9cc2-83a884cda576",
"db_language_id": "25f613c7-c33c-4163-810f-cb37bd5bbc4c",
"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-02-04T21:10:43.7823883+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "471fd292-f50a-4687-aee0-cdf4a88e99b1",
"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": "3d8d8400-dbd0-49c3-8559-991f3395ba08",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-04T21:10:43.7980113+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8ed46750-74ce-4aa9-b92f-2ae04cb64a89"
},
"suggested_date_start": "2026-02-04T21:10:43.7980113+00:00",
"skill_id": "c5db717e-877d-4a98-906d-9a0482b4aa7b",
"skill_code": "sample string 32",
"skill": {
"id": "c62525d8-f11b-4d6b-a5ff-f7582b3f9a33",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "21403dc2-8756-4e17-b380-ed4953220792",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aa7f0296-82b5-421f-81a8-1e74c21d188d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "12f82fb2-d5e2-4ac3-9cc9-3b4894d63f11",
"db_currency_id": "28542409-f85a-4f29-9cc2-83a884cda576",
"db_language_id": "25f613c7-c33c-4163-810f-cb37bd5bbc4c",
"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-02-04T21:10:43.7823883+00:00"
},
"modified_dateutc": "2026-02-04T21:10:43.7980113+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5b0f3031-7018-4515-8e7c-facdcac6d300",
"date_reported_by_company": "2026-02-04T21:10:43.7980113+00:00",
"id2": 36,
"company_id": "d37d2b49-316a-425a-ab31-056abebf6adf",
"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": "40e278ee-98f3-4313-a720-c3e1684f8406",
"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-02-04T21:10:43.7980113+00:00"
},
"work_instruction_details_id": "5aab95b1-46e7-48d5-a965-0297611ca441",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "954e4753-6fdf-4530-868a-cd5111289d8e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7b477ddc-e2a4-46c7-98e8-83486d27269d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-04T21:10:43.7980113+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": "ab63b039-1cb8-4c16-a56e-df0830377bc0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-04T21:10:43.7980113+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.