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": "94913b76-5f79-41de-b55d-fa3df066bcb9",
"jobs_id": "ffc9c814-74c8-46e2-b279-6efcba73b648",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fc637923-dc97-4023-9dd6-d95ceae688bf",
"_parent_id": "3e5b2083-0177-41dd-8c4a-2cbaeaebb07a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8bf6d495-607d-41ad-9af9-b2f4dfe9cfca",
"project_reference_back_office": "sample string 5",
"project": {
"id": "50e1e3ca-2950-4c72-936e-7382dba672bb",
"_parent_id": "8d0d9264-2d1a-4909-a7b1-393a2094240c",
"root_parent_id": "dc859451-1904-4c4b-8511-401e75b8d8cd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4409372d-bcba-46ea-981c-4e2765521646",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "021e5651-fcf7-4522-a1e3-91001b3f0233",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cb76a83d-9bac-44cf-a8a2-4ed93ac5197e",
"_parent_code": "sample string 6",
"sales_organization_id": "c67179c9-b37c-48fd-ac33-e4575fe03036",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cb777178-8469-40ad-b697-c5dbd6a458a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2606e487-9cc3-46b5-8902-42772bce2897",
"db_currency_id": "bc2f89d8-7d2a-4842-80bd-b60c41026faf",
"db_language_id": "e927674f-7507-4f23-857b-33ecec13cf27",
"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-23T23:21:01.2008577+00:00"
},
"modified_dateutc": "2026-09-23T23:21:01.2008577+00:00"
},
"equipment_model_id": "97285e1b-e7d9-47af-97c5-ec3740eb1319",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7011bc0b-6c48-4c33-a981-ebf381b9b575",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "83854cb4-3dd9-493f-a721-651b82162ab7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4942af63-c1b9-4720-a5d0-2009a7d953ac",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7230b6de-5c5e-4f32-891a-268c693c5fce",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cb777178-8469-40ad-b697-c5dbd6a458a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2606e487-9cc3-46b5-8902-42772bce2897",
"db_currency_id": "bc2f89d8-7d2a-4842-80bd-b60c41026faf",
"db_language_id": "e927674f-7507-4f23-857b-33ecec13cf27",
"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-23T23:21:01.2008577+00:00"
},
"modified_dateutc": "2026-09-23T23:21:01.2008577+00:00"
},
"equipment_family_id": "aeffc035-aa15-4f3a-9f72-d05b5a945f87",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "021e5651-fcf7-4522-a1e3-91001b3f0233",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cb76a83d-9bac-44cf-a8a2-4ed93ac5197e",
"_parent_code": "sample string 6",
"sales_organization_id": "c67179c9-b37c-48fd-ac33-e4575fe03036",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cb777178-8469-40ad-b697-c5dbd6a458a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2606e487-9cc3-46b5-8902-42772bce2897",
"db_currency_id": "bc2f89d8-7d2a-4842-80bd-b60c41026faf",
"db_language_id": "e927674f-7507-4f23-857b-33ecec13cf27",
"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-23T23:21:01.2008577+00:00"
},
"modified_dateutc": "2026-09-23T23:21:01.2008577+00:00"
},
"date_in_production_since": "2026-09-23T23:21:01.2008577+00:00",
"date_out_of_production_since": "2026-09-23T23:21:01.2008577+00:00",
"date_end_support": "2026-09-23T23:21:01.2008577+00:00",
"sales_organization_id": "83a87651-9744-4503-af69-b20751e06525",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cb777178-8469-40ad-b697-c5dbd6a458a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2606e487-9cc3-46b5-8902-42772bce2897",
"db_currency_id": "bc2f89d8-7d2a-4842-80bd-b60c41026faf",
"db_language_id": "e927674f-7507-4f23-857b-33ecec13cf27",
"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-23T23:21:01.2008577+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-23T23:21:01.2008577+00:00"
},
"project_status_id": "29d191ad-0db0-402c-8f45-45fc04f742ba",
"project_status_code": "sample string 10",
"project_status": {
"id": "ed93868e-c413-4a1e-a424-bf1ecdc12dc8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b7ab649d-725a-4ba2-8b4d-a600ea9239d5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cb777178-8469-40ad-b697-c5dbd6a458a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2606e487-9cc3-46b5-8902-42772bce2897",
"db_currency_id": "bc2f89d8-7d2a-4842-80bd-b60c41026faf",
"db_language_id": "e927674f-7507-4f23-857b-33ecec13cf27",
"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-23T23:21:01.2008577+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T23:21:01.2008577+00:00"
},
"company_id": "2d86d0e1-8ba8-425d-b6d8-c0ef972541aa",
"company_code": "sample string 12",
"db_address_id": "9db9140e-886b-475f-950e-5dd9786cbcc5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "58e8db55-ddbc-4386-b05d-252d81032fd2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c7351a5e-828d-488f-836b-76943673f66e",
"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-23T23:21:01.2008577+00:00",
"date_create": "2026-09-23T23:21:01.2008577+00:00",
"date_update": "2026-09-23T23:21:01.2008577+00:00",
"updated_by_user_id": "775a3ed1-11cc-41c2-9360-a78105ff0d90",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-23T23:21:01.2008577+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-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-23T23:21:01.2008577+00:00",
"date_last_job": "2026-09-23T23:21:01.2008577+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-23T23:21:01.2008577+00:00",
"modified_dateutc": "2026-09-23T23:21:01.2008577+00:00",
"is_mobile_installation": true
},
"job_type_id": "58996fc2-5958-4ddc-b173-434634a56565",
"job_type_code": "sample string 7",
"job_type": {
"id": "4f3c8297-1c72-4a1b-9f60-3593347e70ac",
"name": "sample string 2",
"sales_organization_id": "214b6719-09fc-4f82-aca8-757474d21b60",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-23T23:21:01.2008577+00:00",
"code": "sample string 7"
},
"job_priority_id": "4496c30a-a74b-4b69-b98c-9ece799ca5a9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f1d34753-0b0b-4740-a0b3-2ca83ca31b34",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1d7370fc-f856-46f5-a881-d07dd57f384e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cb777178-8469-40ad-b697-c5dbd6a458a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2606e487-9cc3-46b5-8902-42772bce2897",
"db_currency_id": "bc2f89d8-7d2a-4842-80bd-b60c41026faf",
"db_language_id": "e927674f-7507-4f23-857b-33ecec13cf27",
"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-23T23:21:01.2008577+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T23:21:01.2008577+00:00"
},
"job_status_id": "b6f82bf5-091b-4580-980b-f9bd86e47258",
"job_status_code": "sample string 11",
"db_address_id": "ce0a085f-6f37-4167-9837-66d9b619b430",
"contact_id": "8ac967a4-ae0f-431a-b850-1f23c29ed3b0",
"requested_by_company_id": "3df0e2da-b6d9-4ca9-93c1-03eb84cfa85c",
"requested_by_contact_id": "33a5b5cc-5856-4152-9bb7-fa1d0df8d39a",
"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-23T23:21:01.2008577+00:00",
"due_date": "2026-09-23T23:21:01.2008577+00:00",
"date_create": "2026-09-23T23:21:01.2008577+00:00",
"date_update": "2026-09-23T23:21:01.2008577+00:00",
"date_closed": "2026-09-23T23:21:01.2008577+00:00",
"suggested_user_id": "8b610645-6316-4134-9016-1aaf8b938847",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5002490b-f30a-4625-bf41-7fbc1e338243",
"db_language_id": "aeec365d-c6c7-44a8-b5c0-87b3fa74a1ee",
"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-23T23:21:01.2008577+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "06cd14d9-9cce-41f7-85d2-8419707f64ee",
"sales_organization": {
"id": "cb777178-8469-40ad-b697-c5dbd6a458a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2606e487-9cc3-46b5-8902-42772bce2897",
"db_currency_id": "bc2f89d8-7d2a-4842-80bd-b60c41026faf",
"db_language_id": "e927674f-7507-4f23-857b-33ecec13cf27",
"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-23T23:21:01.2008577+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "51e7f8cb-9492-4150-8bb4-cfef72470456",
"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": "e3884ad3-e4c3-4b61-b16e-b384c6f7becb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-23T23:21:01.2008577+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d0f8b89f-36be-4625-b284-17e60b1cc78e"
},
"suggested_date_start": "2026-09-23T23:21:01.2008577+00:00",
"skill_id": "ddc14bb2-85e2-4674-b677-4e2de16a64bc",
"skill_code": "sample string 32",
"skill": {
"id": "53c2de8e-8ce2-4043-8692-1704354a3fd5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b1b9b2eb-60f8-46c5-8c98-97291ec76ef7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cb777178-8469-40ad-b697-c5dbd6a458a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2606e487-9cc3-46b5-8902-42772bce2897",
"db_currency_id": "bc2f89d8-7d2a-4842-80bd-b60c41026faf",
"db_language_id": "e927674f-7507-4f23-857b-33ecec13cf27",
"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-23T23:21:01.2008577+00:00"
},
"modified_dateutc": "2026-09-23T23:21:01.2008577+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "929da110-655a-47ce-8cd4-999a8e8ce6b7",
"date_reported_by_company": "2026-09-23T23:21:01.2008577+00:00",
"id2": 36,
"company_id": "2fb64971-7661-419e-b45d-668d6af8e477",
"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": "9864c723-8d0d-4cfe-a64b-5d8dd0e5cbbc",
"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-23T23:21:01.2008577+00:00"
},
"work_instruction_details_id": "c8225223-e3f0-4fe2-b117-a727c0dfbb13",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "00a0721f-718e-4251-9f07-ab9257b312cf",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8bed603b-9778-4495-b80e-f7c850a91a21",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-23T23:21:01.2008577+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": "96b72878-4ba3-48be-9b1c-8618eed44e03",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-23T23:21:01.2008577+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.