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": "ea2f5af4-2c69-4fe6-9e71-e9da30135fc1",
"jobs_id": "fab6af73-7b18-4506-91d3-252a32f406cd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1a467f54-f6dc-470e-98e9-2df78dc4216f",
"_parent_id": "cb797359-4d7b-4a38-a8f1-48ed02d7abfa",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b5aeebcb-3737-4359-b8b9-be7be46b54e6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8b4282cd-c4e0-4676-99b1-ffa4fabc3662",
"_parent_id": "5895b447-b5ee-4873-967e-5ca0ff4f824c",
"root_parent_id": "c439f4ec-cee6-439c-bbd5-0419acc330d3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "db18d4fb-f20c-4a43-9355-7a3b9ad516ae",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "79a9af45-960f-4d5e-86dd-2426fb509b80",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fa7875ef-2cab-4fcc-8335-2e89dd3be9b1",
"_parent_code": "sample string 6",
"sales_organization_id": "7cabcdfa-5d26-419d-896f-8dab5922189d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2ba508fd-e912-4010-8a12-b8d349fca726",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "faaa4336-dffa-42b5-9708-15e75deb5306",
"db_currency_id": "d7bb38d8-00be-4c5c-bff6-47993964072b",
"db_language_id": "70feb9b7-3115-46a9-97ad-9db79d0357a1",
"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-07-10T14:19:20.2011007+00:00"
},
"modified_dateutc": "2026-07-10T14:19:20.2011007+00:00"
},
"equipment_model_id": "d691565e-62c3-4404-ac0e-2d9207082837",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "95e8565f-dd60-4126-868a-07ee28ff0889",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ffd918a9-1ff7-4b6c-a63d-602306bd33f8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "17f192fc-22eb-4ab1-b589-33930517583c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e3cea6f7-8612-460e-90a8-05f60c784b83",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2ba508fd-e912-4010-8a12-b8d349fca726",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "faaa4336-dffa-42b5-9708-15e75deb5306",
"db_currency_id": "d7bb38d8-00be-4c5c-bff6-47993964072b",
"db_language_id": "70feb9b7-3115-46a9-97ad-9db79d0357a1",
"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-07-10T14:19:20.2011007+00:00"
},
"modified_dateutc": "2026-07-10T14:19:20.2011007+00:00"
},
"equipment_family_id": "68bf3983-225d-4dac-a8db-8cd69f9ffae7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "79a9af45-960f-4d5e-86dd-2426fb509b80",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fa7875ef-2cab-4fcc-8335-2e89dd3be9b1",
"_parent_code": "sample string 6",
"sales_organization_id": "7cabcdfa-5d26-419d-896f-8dab5922189d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2ba508fd-e912-4010-8a12-b8d349fca726",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "faaa4336-dffa-42b5-9708-15e75deb5306",
"db_currency_id": "d7bb38d8-00be-4c5c-bff6-47993964072b",
"db_language_id": "70feb9b7-3115-46a9-97ad-9db79d0357a1",
"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-07-10T14:19:20.2011007+00:00"
},
"modified_dateutc": "2026-07-10T14:19:20.2011007+00:00"
},
"date_in_production_since": "2026-07-10T14:19:20.2011007+00:00",
"date_out_of_production_since": "2026-07-10T14:19:20.2011007+00:00",
"date_end_support": "2026-07-10T14:19:20.2011007+00:00",
"sales_organization_id": "0bce0953-c914-4892-ab4b-c62adc15ca17",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2ba508fd-e912-4010-8a12-b8d349fca726",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "faaa4336-dffa-42b5-9708-15e75deb5306",
"db_currency_id": "d7bb38d8-00be-4c5c-bff6-47993964072b",
"db_language_id": "70feb9b7-3115-46a9-97ad-9db79d0357a1",
"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-07-10T14:19:20.2011007+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-07-10T14:19:20.2011007+00:00"
},
"project_status_id": "68150684-e4a7-4688-8725-42e9f86471ed",
"project_status_code": "sample string 10",
"project_status": {
"id": "15f71891-dde4-4922-93c3-5cade8b6af7d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0ecbdac5-d55e-487c-a55a-de4853cdf784",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2ba508fd-e912-4010-8a12-b8d349fca726",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "faaa4336-dffa-42b5-9708-15e75deb5306",
"db_currency_id": "d7bb38d8-00be-4c5c-bff6-47993964072b",
"db_language_id": "70feb9b7-3115-46a9-97ad-9db79d0357a1",
"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-07-10T14:19:20.2011007+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-10T14:19:20.2011007+00:00"
},
"company_id": "d4df3e9a-fd99-43a8-9dc5-b60e1aca4ee3",
"company_code": "sample string 12",
"db_address_id": "be84a828-55ab-456e-b934-236eb94cc75d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f9fce9b0-3ed9-426d-899d-4d0987858a4f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "56ae499b-fffa-482d-b9c5-fdc271b24024",
"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-07-10T14:19:20.2011007+00:00",
"date_create": "2026-07-10T14:19:20.2011007+00:00",
"date_update": "2026-07-10T14:19:20.2011007+00:00",
"updated_by_user_id": "258f3cfa-022f-4687-9994-3fb402e5a5d8",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-10T14:19:20.2011007+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-07-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-10T14:19:20.2011007+00:00",
"date_last_job": "2026-07-10T14:19:20.2011007+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-10T14:19:20.2011007+00:00",
"modified_dateutc": "2026-07-10T14:19:20.2011007+00:00",
"is_mobile_installation": true
},
"job_type_id": "5498cf6b-42d0-4b6e-9ee8-b116b0ef29c6",
"job_type_code": "sample string 7",
"job_type": {
"id": "1f838a46-0f81-4c61-b32c-2f43efb73425",
"name": "sample string 2",
"sales_organization_id": "d36ba5db-49db-434d-8aae-2eff830c60e0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-10T14:19:20.2011007+00:00",
"code": "sample string 7"
},
"job_priority_id": "f6cf6e6c-68ec-4d07-a9d8-f861e51c3ef3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "be523590-6a6b-430d-8e13-08c41e0b458b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c62680ae-0821-4a48-b903-9c44f429aed6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2ba508fd-e912-4010-8a12-b8d349fca726",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "faaa4336-dffa-42b5-9708-15e75deb5306",
"db_currency_id": "d7bb38d8-00be-4c5c-bff6-47993964072b",
"db_language_id": "70feb9b7-3115-46a9-97ad-9db79d0357a1",
"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-07-10T14:19:20.2011007+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-10T14:19:20.2011007+00:00"
},
"job_status_id": "be75ecaa-59a4-497e-aaf9-bf5b8b4fa2c2",
"job_status_code": "sample string 11",
"db_address_id": "d85df4c7-16a3-4fcb-ab7a-a436925aee03",
"contact_id": "bd1412d4-262f-4afc-81a8-35e5909c08c4",
"requested_by_company_id": "b30b6f2c-8d30-452f-a60c-e987eaed1da8",
"requested_by_contact_id": "2970cbb2-6ca7-46ab-b087-db842e9d420e",
"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-07-10T14:19:20.2011007+00:00",
"due_date": "2026-07-10T14:19:20.2011007+00:00",
"date_create": "2026-07-10T14:19:20.2011007+00:00",
"date_update": "2026-07-10T14:19:20.2011007+00:00",
"date_closed": "2026-07-10T14:19:20.2011007+00:00",
"suggested_user_id": "891a3a47-ddf2-4b0f-a4ba-a7f0f3330123",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fec56b01-f0d6-4c75-ae7c-b683de7eb76b",
"db_language_id": "7659e955-80a5-4174-8d29-22f24a831e9e",
"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-07-10T14:19:20.2011007+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b798bd4a-ecc6-4418-a854-4da2a35521fa",
"sales_organization": {
"id": "2ba508fd-e912-4010-8a12-b8d349fca726",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "faaa4336-dffa-42b5-9708-15e75deb5306",
"db_currency_id": "d7bb38d8-00be-4c5c-bff6-47993964072b",
"db_language_id": "70feb9b7-3115-46a9-97ad-9db79d0357a1",
"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-07-10T14:19:20.2011007+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f718d5d9-cf80-4bb0-907c-149b17a162e0",
"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": "820674b6-999e-4cb2-9516-9561f362f2f6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-10T14:19:20.2011007+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1fcd6106-fc2c-4b24-be3e-67f2e6ca3146"
},
"suggested_date_start": "2026-07-10T14:19:20.2011007+00:00",
"skill_id": "3a8619f0-9ecb-4a25-aaf4-edbe9fb88eee",
"skill_code": "sample string 32",
"skill": {
"id": "3211934a-a69b-4678-8ac3-e8ce10bed760",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "577af530-a379-4bc1-90c6-a91066263c7e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2ba508fd-e912-4010-8a12-b8d349fca726",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "faaa4336-dffa-42b5-9708-15e75deb5306",
"db_currency_id": "d7bb38d8-00be-4c5c-bff6-47993964072b",
"db_language_id": "70feb9b7-3115-46a9-97ad-9db79d0357a1",
"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-07-10T14:19:20.2011007+00:00"
},
"modified_dateutc": "2026-07-10T14:19:20.2011007+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "cfaece35-a7ae-4b27-9a83-482653e28a6d",
"date_reported_by_company": "2026-07-10T14:19:20.2011007+00:00",
"id2": 36,
"company_id": "0af9acf9-bccd-4b2c-b0fb-46d026899ef2",
"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": "89c3b330-c9e2-404c-af98-bdbb7d163d14",
"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-07-10T14:19:20.2011007+00:00"
},
"work_instruction_details_id": "96f89934-5f6a-4346-a843-cfb5237a7e99",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "83a86121-9107-4a96-b1ca-756cd0a78b7d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1dae8cdd-0c33-4b99-9704-edd22beaed23",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-10T14:19:20.2011007+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": "6c0a4698-756d-47c1-9d50-9e33940ef551",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-10T14:19:20.2011007+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.