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": "a5b495d2-fd34-45b6-879a-84e7a7c4fe65",
"jobs_id": "0983bdb7-9ed7-4f2c-910e-f496cd8fbcb1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "50fbd14c-dbcc-4674-8022-5d11e48b8024",
"_parent_id": "20bfe659-eef2-4636-b360-4620258d8d51",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ea74557f-a76b-497e-91f6-0da25738546d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "add894fb-5a7b-4c11-8e18-02f559eafca8",
"_parent_id": "6c0958ab-f0e0-49d4-8aaf-a437719f1b45",
"root_parent_id": "c665a7ce-05c2-41d7-845e-536de0201a0e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "74f8af81-e9ea-42a6-9088-3e1cb513eb91",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a93a5d87-51c5-4597-9ae3-17f6b48e9c49",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f3aff1da-bb4b-43fc-b35c-d3342274aeee",
"_parent_code": "sample string 6",
"sales_organization_id": "fa6e5347-1cdf-43e8-970c-868c94c068b5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dbc20d58-aa7b-4e6b-ac9a-74c085283e82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f8a1002-59f5-4197-a6c4-e42030d46873",
"db_currency_id": "efafc8e1-9f09-42d2-9b7e-9a7f96a339ee",
"db_language_id": "23845214-d280-431f-894d-0d693b8339ad",
"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-05-13T21:11:13.1927509+00:00"
},
"modified_dateutc": "2026-05-13T21:11:13.1927509+00:00"
},
"equipment_model_id": "1a4fbda0-084a-42e0-8d8d-a8c524ae2de8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "aa1d7163-c412-4f74-8da0-2c3a80288eb1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e9b2ef23-1dd2-4726-b60a-de7efc27c931",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "563a21b1-4eab-49b1-836b-efb49ebccff6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e918401a-9dc5-403f-b6e2-08ff8875b849",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dbc20d58-aa7b-4e6b-ac9a-74c085283e82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f8a1002-59f5-4197-a6c4-e42030d46873",
"db_currency_id": "efafc8e1-9f09-42d2-9b7e-9a7f96a339ee",
"db_language_id": "23845214-d280-431f-894d-0d693b8339ad",
"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-05-13T21:11:13.1927509+00:00"
},
"modified_dateutc": "2026-05-13T21:11:13.1927509+00:00"
},
"equipment_family_id": "2d86a62a-acf4-4770-8e9a-84683bff7033",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a93a5d87-51c5-4597-9ae3-17f6b48e9c49",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f3aff1da-bb4b-43fc-b35c-d3342274aeee",
"_parent_code": "sample string 6",
"sales_organization_id": "fa6e5347-1cdf-43e8-970c-868c94c068b5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dbc20d58-aa7b-4e6b-ac9a-74c085283e82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f8a1002-59f5-4197-a6c4-e42030d46873",
"db_currency_id": "efafc8e1-9f09-42d2-9b7e-9a7f96a339ee",
"db_language_id": "23845214-d280-431f-894d-0d693b8339ad",
"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-05-13T21:11:13.1927509+00:00"
},
"modified_dateutc": "2026-05-13T21:11:13.1927509+00:00"
},
"date_in_production_since": "2026-05-13T21:11:13.1927509+00:00",
"date_out_of_production_since": "2026-05-13T21:11:13.1927509+00:00",
"date_end_support": "2026-05-13T21:11:13.1927509+00:00",
"sales_organization_id": "42c59e22-7891-4bac-a176-268722c8ed80",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "dbc20d58-aa7b-4e6b-ac9a-74c085283e82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f8a1002-59f5-4197-a6c4-e42030d46873",
"db_currency_id": "efafc8e1-9f09-42d2-9b7e-9a7f96a339ee",
"db_language_id": "23845214-d280-431f-894d-0d693b8339ad",
"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-05-13T21:11:13.1927509+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-05-13T21:11:13.1927509+00:00"
},
"project_status_id": "b3548c18-cea6-4dba-9276-2d4813a2e820",
"project_status_code": "sample string 10",
"project_status": {
"id": "05274994-c83b-4210-be1c-348814854c53",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "aa7f4698-c062-4ed9-b0dc-affa59a1d9bf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dbc20d58-aa7b-4e6b-ac9a-74c085283e82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f8a1002-59f5-4197-a6c4-e42030d46873",
"db_currency_id": "efafc8e1-9f09-42d2-9b7e-9a7f96a339ee",
"db_language_id": "23845214-d280-431f-894d-0d693b8339ad",
"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-05-13T21:11:13.1927509+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-13T21:11:13.1927509+00:00"
},
"company_id": "c02583a2-afc0-4b39-b985-39202ef92a73",
"company_code": "sample string 12",
"db_address_id": "eefb324b-4c87-4949-96e9-956153c49a93",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f774ac40-1ee7-49c4-b062-71528dd54b37",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d8ca82c9-5436-4eba-9e78-c47d13144542",
"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-05-13T21:11:13.1927509+00:00",
"date_create": "2026-05-13T21:11:13.1927509+00:00",
"date_update": "2026-05-13T21:11:13.1927509+00:00",
"updated_by_user_id": "6b86c27a-bdb6-4bed-ae6c-eddfed3cd492",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-13T21:11:13.1927509+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-05-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-13T21:11:13.1927509+00:00",
"date_last_job": "2026-05-13T21:11:13.1927509+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-13T21:11:13.1927509+00:00",
"modified_dateutc": "2026-05-13T21:11:13.1927509+00:00",
"is_mobile_installation": true
},
"job_type_id": "41f5804d-e50d-4e79-86da-b8b23502798a",
"job_type_code": "sample string 7",
"job_type": {
"id": "2f643cce-8061-4a25-a58d-c420a95c4784",
"name": "sample string 2",
"sales_organization_id": "bf23bd85-fc4c-48d2-938c-ac275eb67f41",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-13T21:11:13.1927509+00:00",
"code": "sample string 7"
},
"job_priority_id": "b503c506-9b38-4202-9b85-f29fde754c14",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "17fe3313-ffef-4a0a-a133-311579e487c2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "507199fb-0fb0-4380-9f34-decd6ffa52c3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dbc20d58-aa7b-4e6b-ac9a-74c085283e82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f8a1002-59f5-4197-a6c4-e42030d46873",
"db_currency_id": "efafc8e1-9f09-42d2-9b7e-9a7f96a339ee",
"db_language_id": "23845214-d280-431f-894d-0d693b8339ad",
"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-05-13T21:11:13.1927509+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-13T21:11:13.1927509+00:00"
},
"job_status_id": "3a3e48bc-a4a1-4b3f-87c8-89c0c240b060",
"job_status_code": "sample string 11",
"db_address_id": "142deef9-287b-4d3c-bce6-2dd96d8a724b",
"contact_id": "186994a4-ed6f-4e93-b7a4-76962cd69714",
"requested_by_company_id": "a738a60b-fef5-4d7c-8d0b-361a9fc5cf36",
"requested_by_contact_id": "45b856e2-8f1a-4ab4-a348-bf5d4bbb5794",
"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-05-13T21:11:13.1927509+00:00",
"due_date": "2026-05-13T21:11:13.1927509+00:00",
"date_create": "2026-05-13T21:11:13.1927509+00:00",
"date_update": "2026-05-13T21:11:13.1927509+00:00",
"date_closed": "2026-05-13T21:11:13.1927509+00:00",
"suggested_user_id": "082cfb10-b739-4a24-89e9-545813dc7dc3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cd5f4f9d-2772-436b-8b59-6c0ee4d3e9cc",
"db_language_id": "e802f0bf-7697-40a8-88b1-fdb5b47a8101",
"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-05-13T21:11:13.1927509+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4f630aed-3995-4ecb-a660-2712bb125242",
"sales_organization": {
"id": "dbc20d58-aa7b-4e6b-ac9a-74c085283e82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f8a1002-59f5-4197-a6c4-e42030d46873",
"db_currency_id": "efafc8e1-9f09-42d2-9b7e-9a7f96a339ee",
"db_language_id": "23845214-d280-431f-894d-0d693b8339ad",
"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-05-13T21:11:13.1927509+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b0af36fc-91e5-407f-82a3-0a8f97701140",
"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": "b15f2ef4-c48e-4560-ae66-fde00099c60b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-13T21:11:13.1927509+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "744490a0-6a94-49af-8989-df83454d05ec"
},
"suggested_date_start": "2026-05-13T21:11:13.1927509+00:00",
"skill_id": "ee057039-c76b-4c5d-a5f5-60cd9c94c247",
"skill_code": "sample string 32",
"skill": {
"id": "79b50839-b53e-45e6-a616-e8f09dcae923",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "41371d7d-e76c-4531-abb9-e3992034d0ed",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dbc20d58-aa7b-4e6b-ac9a-74c085283e82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f8a1002-59f5-4197-a6c4-e42030d46873",
"db_currency_id": "efafc8e1-9f09-42d2-9b7e-9a7f96a339ee",
"db_language_id": "23845214-d280-431f-894d-0d693b8339ad",
"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-05-13T21:11:13.1927509+00:00"
},
"modified_dateutc": "2026-05-13T21:11:13.1927509+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e268d46b-2588-429c-9bf8-e90812d27ecb",
"date_reported_by_company": "2026-05-13T21:11:13.1927509+00:00",
"id2": 36,
"company_id": "86ddc8b6-42e7-4350-94fd-1241387e68c8",
"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": "c7b7ecc1-760f-4509-8c09-08495f90f582",
"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-05-13T21:11:13.1927509+00:00"
},
"work_instruction_details_id": "ff34f301-7fcd-4106-be35-431d3afa94b9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "94fb104b-9717-4f54-8593-e60f95553784",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fd70d282-51d6-4f72-9cd9-8872f0fb78fe",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-13T21:11:13.1927509+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": "28b6a89a-d332-41f6-8580-c42995534478",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-13T21:11:13.1927509+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.