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": "2ad6b6f6-fa84-48a7-9539-2cc0b9f3022f",
"jobs_id": "11944ce7-9199-48a8-b3c5-0057e3decb52",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fec14228-4ae2-45a1-a292-94a561295d8a",
"_parent_id": "7b2d2fd0-333c-44b1-b63d-fd14077936e6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a597f532-9ce2-47a6-bd6f-f529b53c3ea4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "71bdf44e-94ce-4980-b3db-29645b0157b5",
"_parent_id": "86a6be85-7be7-4f8e-8920-228cc1ffe3b7",
"root_parent_id": "df559111-f003-4697-bca7-d7c5fc7e4b88",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c070230d-9c01-436e-98d9-334c2fc2999f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "465e66c2-7ff3-4cd8-aac4-ba0b014d865c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "86d46800-8252-4b66-a7ef-1eed098ec961",
"_parent_code": "sample string 6",
"sales_organization_id": "6bf3bba2-2d47-4692-bd26-4c29993cd4ac",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b1443073-a5c1-4874-999b-0aa5dfc0ffb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8852bc1d-841c-4928-9d68-789748eccac1",
"db_currency_id": "f02d3252-e51d-4b52-913e-d923e427c960",
"db_language_id": "8712bfcd-e2f7-45b7-b3d5-26cecbeb6897",
"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-09-13T00:08:16.1914469+00:00"
},
"modified_dateutc": "2026-09-13T00:08:16.1914469+00:00"
},
"equipment_model_id": "3c8447a4-8028-40cd-93b2-0a0b4e59ae8e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "47981e31-c32d-4d2e-b5b4-00e4e97c604f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "556f988d-711a-4227-ba0f-4053ae61640d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e68e979e-3693-43c5-8e7e-6fedfb2bbc06",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2d79d68a-e57e-4d30-91fa-2c0717879cea",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b1443073-a5c1-4874-999b-0aa5dfc0ffb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8852bc1d-841c-4928-9d68-789748eccac1",
"db_currency_id": "f02d3252-e51d-4b52-913e-d923e427c960",
"db_language_id": "8712bfcd-e2f7-45b7-b3d5-26cecbeb6897",
"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-09-13T00:08:16.1914469+00:00"
},
"modified_dateutc": "2026-09-13T00:08:16.1914469+00:00"
},
"equipment_family_id": "a4d1f4f3-da79-477b-9d4e-2b081114a6ee",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "465e66c2-7ff3-4cd8-aac4-ba0b014d865c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "86d46800-8252-4b66-a7ef-1eed098ec961",
"_parent_code": "sample string 6",
"sales_organization_id": "6bf3bba2-2d47-4692-bd26-4c29993cd4ac",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b1443073-a5c1-4874-999b-0aa5dfc0ffb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8852bc1d-841c-4928-9d68-789748eccac1",
"db_currency_id": "f02d3252-e51d-4b52-913e-d923e427c960",
"db_language_id": "8712bfcd-e2f7-45b7-b3d5-26cecbeb6897",
"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-09-13T00:08:16.1914469+00:00"
},
"modified_dateutc": "2026-09-13T00:08:16.1914469+00:00"
},
"date_in_production_since": "2026-09-13T00:08:16.1914469+00:00",
"date_out_of_production_since": "2026-09-13T00:08:16.1914469+00:00",
"date_end_support": "2026-09-13T00:08:16.1914469+00:00",
"sales_organization_id": "7aa50efe-60ab-4b0c-a6ae-3c640f3b616c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b1443073-a5c1-4874-999b-0aa5dfc0ffb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8852bc1d-841c-4928-9d68-789748eccac1",
"db_currency_id": "f02d3252-e51d-4b52-913e-d923e427c960",
"db_language_id": "8712bfcd-e2f7-45b7-b3d5-26cecbeb6897",
"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-09-13T00:08:16.1914469+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-09-13T00:08:16.1914469+00:00"
},
"project_status_id": "d2ba41cc-8ae4-4883-92fc-23033161181e",
"project_status_code": "sample string 10",
"project_status": {
"id": "7bda9568-c641-4543-b5f5-c8ea0984644b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "de5043fa-4f73-4923-90bd-74c5708f7ae5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b1443073-a5c1-4874-999b-0aa5dfc0ffb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8852bc1d-841c-4928-9d68-789748eccac1",
"db_currency_id": "f02d3252-e51d-4b52-913e-d923e427c960",
"db_language_id": "8712bfcd-e2f7-45b7-b3d5-26cecbeb6897",
"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-09-13T00:08:16.1914469+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-13T00:08:16.1914469+00:00"
},
"company_id": "d676002e-0e50-4df4-b02d-d21a30046288",
"company_code": "sample string 12",
"db_address_id": "f55d7b03-ce73-4013-91b4-171aa19777c7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cdd0ec19-4d45-4be4-8bb4-db631daee767",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f78c0bce-d048-4285-bb84-d1f8bc203359",
"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-09-13T00:08:16.1914469+00:00",
"date_create": "2026-09-13T00:08:16.1914469+00:00",
"date_update": "2026-09-13T00:08:16.1914469+00:00",
"updated_by_user_id": "377a59e3-c96b-48be-aba8-95994126a611",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-13T00:08:16.1914469+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-09-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-13T00:08:16.1914469+00:00",
"date_last_job": "2026-09-13T00:08:16.1914469+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-13T00:08:16.1914469+00:00",
"modified_dateutc": "2026-09-13T00:08:16.1914469+00:00",
"is_mobile_installation": true
},
"job_type_id": "da86c265-fc94-4ec2-ba8f-fa481adfbbe9",
"job_type_code": "sample string 7",
"job_type": {
"id": "6075c239-ae4e-4a38-a3f9-ddc2f127eb9f",
"name": "sample string 2",
"sales_organization_id": "2636d7f9-4de8-49ca-970f-885170f40689",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-13T00:08:16.1914469+00:00",
"code": "sample string 7"
},
"job_priority_id": "7727f144-555b-4437-8df7-a99d4f81796e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c5bd8716-aa6f-4a1f-843a-b3fac58d77ba",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b014b3d8-64b0-405c-b9c7-211829241e22",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b1443073-a5c1-4874-999b-0aa5dfc0ffb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8852bc1d-841c-4928-9d68-789748eccac1",
"db_currency_id": "f02d3252-e51d-4b52-913e-d923e427c960",
"db_language_id": "8712bfcd-e2f7-45b7-b3d5-26cecbeb6897",
"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-09-13T00:08:16.1914469+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-13T00:08:16.1914469+00:00"
},
"job_status_id": "eb19bb7e-887d-4d6b-995d-b83afb171a4e",
"job_status_code": "sample string 11",
"db_address_id": "291c41c8-4bae-4a91-934b-e7ca91085d68",
"contact_id": "b2c3776e-86a8-426d-9ea4-1c3d97b5a450",
"requested_by_company_id": "300ed457-b13e-44b9-9352-fa91fd14a217",
"requested_by_contact_id": "5add7af7-23bd-42a5-ab21-2cd6c4297918",
"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-09-13T00:08:16.1914469+00:00",
"due_date": "2026-09-13T00:08:16.1914469+00:00",
"date_create": "2026-09-13T00:08:16.1914469+00:00",
"date_update": "2026-09-13T00:08:16.1914469+00:00",
"date_closed": "2026-09-13T00:08:16.1914469+00:00",
"suggested_user_id": "c674818f-5922-440b-b97e-74dc27c61c6e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b14a20cc-9020-49e1-bcca-959036bd602a",
"db_language_id": "af0ccd3c-1c5a-4ecd-8393-dc3306953d3f",
"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-09-13T00:08:16.1914469+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c9c61763-24cb-48af-96d9-94027b4739cd",
"sales_organization": {
"id": "b1443073-a5c1-4874-999b-0aa5dfc0ffb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8852bc1d-841c-4928-9d68-789748eccac1",
"db_currency_id": "f02d3252-e51d-4b52-913e-d923e427c960",
"db_language_id": "8712bfcd-e2f7-45b7-b3d5-26cecbeb6897",
"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-09-13T00:08:16.1914469+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "472b235d-71c8-4622-9812-fbca534f583f",
"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": "f9b008e6-d04a-4499-92ad-8b306f096f04",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-13T00:08:16.1914469+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "585eeca2-d28e-462d-b65d-70b9c72f6a84"
},
"suggested_date_start": "2026-09-13T00:08:16.1914469+00:00",
"skill_id": "884a8132-a26e-475f-a9ee-c5123a6b55c1",
"skill_code": "sample string 32",
"skill": {
"id": "81d5af7f-f561-4352-917e-696f54004e03",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1aa1e6d5-1511-461d-973c-b563e8815161",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b1443073-a5c1-4874-999b-0aa5dfc0ffb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8852bc1d-841c-4928-9d68-789748eccac1",
"db_currency_id": "f02d3252-e51d-4b52-913e-d923e427c960",
"db_language_id": "8712bfcd-e2f7-45b7-b3d5-26cecbeb6897",
"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-09-13T00:08:16.1914469+00:00"
},
"modified_dateutc": "2026-09-13T00:08:16.1914469+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "419a9177-268e-4a75-a375-b53bf1a6f455",
"date_reported_by_company": "2026-09-13T00:08:16.1914469+00:00",
"id2": 36,
"company_id": "7ee243cf-d216-45af-b3fe-d40a36470279",
"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": "8972e75b-6acb-4a01-869e-84188a949c51",
"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-09-13T00:08:16.1914469+00:00"
},
"work_instruction_details_id": "aa01430a-a438-47ea-9e44-b12acfb58e44",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e73cef90-17c4-4491-a7d4-ba2641bf987e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "47b48742-c206-4e1b-aa47-67837ac399f0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-13T00:08:16.1914469+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": "d78765e1-0759-4ff4-b7c8-0a05a606c247",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-13T00:08:16.1914469+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.