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": "9ce9b00c-9f40-4a96-8c61-bf942b689a8c",
"jobs_id": "8b5d4caf-ca2f-45bd-897d-bdd106ec5582",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "84efc295-15af-40ad-a6a5-e4f2396f3bf6",
"_parent_id": "e375c087-bb46-4073-8e50-491897041dab",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "722b570b-6c5e-4daa-960d-53fcc9023a36",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5391bf30-eec4-4cec-a5c7-721f2ed53823",
"_parent_id": "359ff62a-0a52-4cd7-a3d3-a5fcc58bd950",
"root_parent_id": "aa4c7b4d-4d62-4a0f-9289-ec5b43f5f800",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f93df0fe-35c8-4e89-9466-a1cec417ebcc",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cf13f831-f8a6-4dc4-bd46-ae1b31d59a02",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f02652fe-5a23-4f1a-ae40-94442299ef09",
"_parent_code": "sample string 6",
"sales_organization_id": "09a2e852-e92d-4e91-b17c-c486f75f8796",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c610b1b7-6deb-4603-a146-e6536d397193",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfc3204c-62e8-4313-bb83-16d603b4114d",
"db_currency_id": "e5ce593e-240d-4147-9c26-ef8011586fcd",
"db_language_id": "f7187162-38b6-4883-8bac-4a83c3acfb46",
"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-09T01:33:58.2300664+00:00"
},
"modified_dateutc": "2026-07-09T01:33:58.2300664+00:00"
},
"equipment_model_id": "8ba854c7-37af-4192-b6a5-3c6589f708ec",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "feda1ad8-fcb5-41e3-9baa-2cdc40b888a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "123311f1-6584-4859-aab5-6860f9f1d678",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f30639ce-593b-4353-beca-017e0878a15f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e0abe881-760a-406a-9e0a-651f31cef38e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c610b1b7-6deb-4603-a146-e6536d397193",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfc3204c-62e8-4313-bb83-16d603b4114d",
"db_currency_id": "e5ce593e-240d-4147-9c26-ef8011586fcd",
"db_language_id": "f7187162-38b6-4883-8bac-4a83c3acfb46",
"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-09T01:33:58.2300664+00:00"
},
"modified_dateutc": "2026-07-09T01:33:58.2300664+00:00"
},
"equipment_family_id": "3e541b57-d36e-4d1d-a44b-1da8306910d8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cf13f831-f8a6-4dc4-bd46-ae1b31d59a02",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f02652fe-5a23-4f1a-ae40-94442299ef09",
"_parent_code": "sample string 6",
"sales_organization_id": "09a2e852-e92d-4e91-b17c-c486f75f8796",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c610b1b7-6deb-4603-a146-e6536d397193",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfc3204c-62e8-4313-bb83-16d603b4114d",
"db_currency_id": "e5ce593e-240d-4147-9c26-ef8011586fcd",
"db_language_id": "f7187162-38b6-4883-8bac-4a83c3acfb46",
"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-09T01:33:58.2300664+00:00"
},
"modified_dateutc": "2026-07-09T01:33:58.2300664+00:00"
},
"date_in_production_since": "2026-07-09T01:33:58.2300664+00:00",
"date_out_of_production_since": "2026-07-09T01:33:58.2300664+00:00",
"date_end_support": "2026-07-09T01:33:58.2300664+00:00",
"sales_organization_id": "198655ae-7641-492e-8669-0d5fc19a9de0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c610b1b7-6deb-4603-a146-e6536d397193",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfc3204c-62e8-4313-bb83-16d603b4114d",
"db_currency_id": "e5ce593e-240d-4147-9c26-ef8011586fcd",
"db_language_id": "f7187162-38b6-4883-8bac-4a83c3acfb46",
"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-09T01:33:58.2300664+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-09T01:33:58.2300664+00:00"
},
"project_status_id": "2afc9132-5233-4315-a93c-4b532f54bc47",
"project_status_code": "sample string 10",
"project_status": {
"id": "658c9ff6-cbef-4371-9230-9be4c175a70b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8cfe4b9e-9a89-4e83-88b4-a95e2d5dfc7b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c610b1b7-6deb-4603-a146-e6536d397193",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfc3204c-62e8-4313-bb83-16d603b4114d",
"db_currency_id": "e5ce593e-240d-4147-9c26-ef8011586fcd",
"db_language_id": "f7187162-38b6-4883-8bac-4a83c3acfb46",
"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-09T01:33:58.2300664+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-09T01:33:58.2300664+00:00"
},
"company_id": "1797ca0e-79bb-4096-a7c3-6e0b45c03835",
"company_code": "sample string 12",
"db_address_id": "61af3873-33b8-4fad-b802-198894a8853a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2aa56421-2e15-45ad-b540-a6aba121cb7f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7f33aca6-528a-4710-aa05-ba6fd7808fdb",
"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-09T01:33:58.2300664+00:00",
"date_create": "2026-07-09T01:33:58.2300664+00:00",
"date_update": "2026-07-09T01:33:58.2300664+00:00",
"updated_by_user_id": "0cca9a4f-2094-4e34-8bd6-a9a35720be64",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-09T01:33:58.2300664+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-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-09T01:33:58.2300664+00:00",
"date_last_job": "2026-07-09T01:33:58.2300664+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-09T01:33:58.2300664+00:00",
"modified_dateutc": "2026-07-09T01:33:58.2300664+00:00",
"is_mobile_installation": true
},
"job_type_id": "c1cd67a7-2091-4b86-9bd5-bfed007aef65",
"job_type_code": "sample string 7",
"job_type": {
"id": "e868cc19-61cf-4eb8-9706-d5a6f829b263",
"name": "sample string 2",
"sales_organization_id": "6fc9901b-85da-41f8-a683-cd5931ccfb2d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-09T01:33:58.2300664+00:00",
"code": "sample string 7"
},
"job_priority_id": "c7c063fb-310e-42a1-908d-eb8fa55f4be2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3ac5acd9-8703-4e8d-9f42-33ac7a9cf447",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a13a5261-321c-45ad-91ed-277deef8009f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c610b1b7-6deb-4603-a146-e6536d397193",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfc3204c-62e8-4313-bb83-16d603b4114d",
"db_currency_id": "e5ce593e-240d-4147-9c26-ef8011586fcd",
"db_language_id": "f7187162-38b6-4883-8bac-4a83c3acfb46",
"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-09T01:33:58.2300664+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-09T01:33:58.2300664+00:00"
},
"job_status_id": "c6538b74-187e-4b5b-a4ef-a956314253a1",
"job_status_code": "sample string 11",
"db_address_id": "2e641382-0f77-4c8e-b1c0-8c76b0832806",
"contact_id": "13fbebde-6582-4750-a488-617a80bf50a7",
"requested_by_company_id": "c36437b4-214f-46c2-a426-99ba125e19d3",
"requested_by_contact_id": "4b335b83-5ca0-4afc-ae24-99032b4b6ca8",
"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-09T01:33:58.2300664+00:00",
"due_date": "2026-07-09T01:33:58.2300664+00:00",
"date_create": "2026-07-09T01:33:58.2300664+00:00",
"date_update": "2026-07-09T01:33:58.2300664+00:00",
"date_closed": "2026-07-09T01:33:58.2300664+00:00",
"suggested_user_id": "c0e0c5c2-303e-4e10-86cb-40beaad9e63d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0ae9b662-c2f7-417f-833d-432339ce292f",
"db_language_id": "81fc3411-4368-452a-a290-95e78eb547e3",
"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-09T01:33:58.2300664+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "23da1ae9-4f61-4598-84bc-73b607b763a8",
"sales_organization": {
"id": "c610b1b7-6deb-4603-a146-e6536d397193",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfc3204c-62e8-4313-bb83-16d603b4114d",
"db_currency_id": "e5ce593e-240d-4147-9c26-ef8011586fcd",
"db_language_id": "f7187162-38b6-4883-8bac-4a83c3acfb46",
"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-09T01:33:58.2300664+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "74ffc174-7b40-4725-8ca8-3296da8bc6a0",
"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": "c6443417-61f8-4a39-a618-7339b0488f05",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-09T01:33:58.2300664+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3d556a37-2554-4596-ac60-e487bd502b75"
},
"suggested_date_start": "2026-07-09T01:33:58.2300664+00:00",
"skill_id": "5aaf6583-c66a-494e-a72d-1d901c6fe5ef",
"skill_code": "sample string 32",
"skill": {
"id": "93848dcb-02ca-4e82-b701-95ffdd862536",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "002fb572-a04c-4c04-978a-03bf761712ee",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c610b1b7-6deb-4603-a146-e6536d397193",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfc3204c-62e8-4313-bb83-16d603b4114d",
"db_currency_id": "e5ce593e-240d-4147-9c26-ef8011586fcd",
"db_language_id": "f7187162-38b6-4883-8bac-4a83c3acfb46",
"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-09T01:33:58.2300664+00:00"
},
"modified_dateutc": "2026-07-09T01:33:58.2300664+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "390d7abb-1a57-4398-90ba-c55e357470ff",
"date_reported_by_company": "2026-07-09T01:33:58.2300664+00:00",
"id2": 36,
"company_id": "71740c96-6dba-4a02-93ac-9c44da35dca5",
"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": "f360a949-bd95-48b0-b5c1-163656872548",
"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-09T01:33:58.2300664+00:00"
},
"work_instruction_details_id": "7fa492f3-2dda-4248-87d5-3ec999505ae5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3a79f198-b852-4d2a-916a-d3f35f591242",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "adbca2fa-80fc-496e-90ee-ea3c3ca24bb7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-09T01:33:58.2300664+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": "3b5667f5-22fb-4075-950d-733e3bc84f16",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-09T01:33:58.2300664+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.