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": "0e6595e7-79f7-4fe9-92f8-ee269713538c",
"jobs_id": "770edbcf-b043-4cdf-9f52-d38d2a2ce727",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b03b8e04-011c-4fef-a8ff-cd28c4be0e49",
"_parent_id": "410cead7-2efa-4eef-9bd6-0d9a758ceaf5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "70fd8d69-92f0-4c42-a23b-a002d64a3732",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ed685899-65de-4340-99cd-8df8fe7c0860",
"_parent_id": "93af68e3-3bf7-415a-bdd0-1d7782c7b6e5",
"root_parent_id": "97821658-e646-4f8f-aef6-08f3e45b3606",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "90aaf32c-0567-4461-befb-0e3021ce7547",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0265959a-5745-4f24-8a7b-33ee8b61ce9e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ffe68b25-7b42-4d2c-a4a6-03db126d4cba",
"_parent_code": "sample string 6",
"sales_organization_id": "7264257e-1980-4387-ac09-acd1ea338eb5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "99f15d8f-743b-40ce-a4ad-afd20f952c54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d883ca64-1aff-4929-adb6-dea146ebfcfb",
"db_currency_id": "b9fb9e65-8d49-4def-8bb6-2497b0dc3a4a",
"db_language_id": "c80ce703-9cef-4079-9570-56163f871306",
"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-14T23:46:48.3444824+00:00"
},
"modified_dateutc": "2026-07-14T23:46:48.3444824+00:00"
},
"equipment_model_id": "d315521c-cf1a-410b-b678-0aa59dafae06",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "547e29df-e7ee-4a7a-b223-6e69a67090ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ed074e59-23a6-4c28-9554-4f850d15b561",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "cdb0577e-039e-4836-9e1f-0fef1c9c9d74",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "086b420c-cc44-4abf-9926-f6ba35cf3dcb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "99f15d8f-743b-40ce-a4ad-afd20f952c54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d883ca64-1aff-4929-adb6-dea146ebfcfb",
"db_currency_id": "b9fb9e65-8d49-4def-8bb6-2497b0dc3a4a",
"db_language_id": "c80ce703-9cef-4079-9570-56163f871306",
"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-14T23:46:48.3444824+00:00"
},
"modified_dateutc": "2026-07-14T23:46:48.3444824+00:00"
},
"equipment_family_id": "eef942bc-c4e7-4bf8-be46-a449f85bd645",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0265959a-5745-4f24-8a7b-33ee8b61ce9e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ffe68b25-7b42-4d2c-a4a6-03db126d4cba",
"_parent_code": "sample string 6",
"sales_organization_id": "7264257e-1980-4387-ac09-acd1ea338eb5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "99f15d8f-743b-40ce-a4ad-afd20f952c54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d883ca64-1aff-4929-adb6-dea146ebfcfb",
"db_currency_id": "b9fb9e65-8d49-4def-8bb6-2497b0dc3a4a",
"db_language_id": "c80ce703-9cef-4079-9570-56163f871306",
"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-14T23:46:48.3444824+00:00"
},
"modified_dateutc": "2026-07-14T23:46:48.3444824+00:00"
},
"date_in_production_since": "2026-07-14T23:46:48.3444824+00:00",
"date_out_of_production_since": "2026-07-14T23:46:48.3444824+00:00",
"date_end_support": "2026-07-14T23:46:48.3444824+00:00",
"sales_organization_id": "921bb719-22e3-4e16-9938-f6794edc3423",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "99f15d8f-743b-40ce-a4ad-afd20f952c54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d883ca64-1aff-4929-adb6-dea146ebfcfb",
"db_currency_id": "b9fb9e65-8d49-4def-8bb6-2497b0dc3a4a",
"db_language_id": "c80ce703-9cef-4079-9570-56163f871306",
"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-14T23:46:48.3444824+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-14T23:46:48.3444824+00:00"
},
"project_status_id": "3341dca1-bcbd-4fb5-a511-568b08af9039",
"project_status_code": "sample string 10",
"project_status": {
"id": "bc2fe700-7224-4640-896c-d39fbd5c3beb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f973dc8a-dc9f-4c86-ba05-7c8a1f1d8f3a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "99f15d8f-743b-40ce-a4ad-afd20f952c54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d883ca64-1aff-4929-adb6-dea146ebfcfb",
"db_currency_id": "b9fb9e65-8d49-4def-8bb6-2497b0dc3a4a",
"db_language_id": "c80ce703-9cef-4079-9570-56163f871306",
"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-14T23:46:48.3444824+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-14T23:46:48.3444824+00:00"
},
"company_id": "27336408-9bbe-48f8-8f20-9165461bfdf5",
"company_code": "sample string 12",
"db_address_id": "08950248-9ed6-46cd-8141-277c6c7f9317",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ee6bd514-d46c-48e6-af55-a1c64c7de270",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "20228a22-895b-47a8-b194-abcb7248dba2",
"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-14T23:46:48.3444824+00:00",
"date_create": "2026-07-14T23:46:48.3444824+00:00",
"date_update": "2026-07-14T23:46:48.3444824+00:00",
"updated_by_user_id": "0d061beb-cc1a-4108-ae75-f2260dba419b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-14T23:46:48.3444824+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-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-14T23:46:48.3444824+00:00",
"date_last_job": "2026-07-14T23:46:48.3444824+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-14T23:46:48.3444824+00:00",
"modified_dateutc": "2026-07-14T23:46:48.3444824+00:00",
"is_mobile_installation": true
},
"job_type_id": "0b939ac6-818e-4d5c-89ed-89f964779b00",
"job_type_code": "sample string 7",
"job_type": {
"id": "5a6c6159-362d-48de-a85b-0b5b247f9167",
"name": "sample string 2",
"sales_organization_id": "3695712f-721d-4474-aa45-ef03c38d8d32",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-14T23:46:48.3444824+00:00",
"code": "sample string 7"
},
"job_priority_id": "29fedf4e-7f11-427a-b6f6-a4cf2ce82d1b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "eabb0ba3-4f92-472f-a956-92e86f03c1a4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "89a06cd9-9547-4f4d-b31e-3b882f78b569",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "99f15d8f-743b-40ce-a4ad-afd20f952c54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d883ca64-1aff-4929-adb6-dea146ebfcfb",
"db_currency_id": "b9fb9e65-8d49-4def-8bb6-2497b0dc3a4a",
"db_language_id": "c80ce703-9cef-4079-9570-56163f871306",
"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-14T23:46:48.3444824+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-14T23:46:48.3444824+00:00"
},
"job_status_id": "5a2c56ef-4a15-4980-a6dc-531d1a7584ad",
"job_status_code": "sample string 11",
"db_address_id": "acafc270-96dd-4bd9-8737-74816186a506",
"contact_id": "e8690946-350e-4a8d-8153-d828768bb064",
"requested_by_company_id": "825b1c5b-87f7-42eb-8ee6-a57d35189f31",
"requested_by_contact_id": "2a6fcfee-5288-43cf-a95e-b01baebfaa0e",
"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-14T23:46:48.3444824+00:00",
"due_date": "2026-07-14T23:46:48.3444824+00:00",
"date_create": "2026-07-14T23:46:48.3444824+00:00",
"date_update": "2026-07-14T23:46:48.3444824+00:00",
"date_closed": "2026-07-14T23:46:48.3444824+00:00",
"suggested_user_id": "603abf2a-5e6c-45d8-ae20-db8baf3422bc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d5e8047f-20bb-4cf3-95e6-bca4c8918a54",
"db_language_id": "27782ffe-e7f6-44ed-a7d5-6a0e8b0ad557",
"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-14T23:46:48.3444824+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1846dda8-7827-4166-a75f-6d5559d2160f",
"sales_organization": {
"id": "99f15d8f-743b-40ce-a4ad-afd20f952c54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d883ca64-1aff-4929-adb6-dea146ebfcfb",
"db_currency_id": "b9fb9e65-8d49-4def-8bb6-2497b0dc3a4a",
"db_language_id": "c80ce703-9cef-4079-9570-56163f871306",
"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-14T23:46:48.3444824+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "63629eb0-56d6-45fd-bf3e-902d3c50b8d6",
"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": "7655d28d-7250-4aef-b63e-0bb546e49cb6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-14T23:46:48.3444824+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4edfcc25-0f27-47f4-b6b6-0379a3aaf045"
},
"suggested_date_start": "2026-07-14T23:46:48.3444824+00:00",
"skill_id": "e581075f-5500-48a1-b6fd-63b8ff93282b",
"skill_code": "sample string 32",
"skill": {
"id": "4def1584-e6ec-4ec2-866b-f7675682a6e1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "31a86621-481f-4ea2-a005-d29ad6f598ff",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "99f15d8f-743b-40ce-a4ad-afd20f952c54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d883ca64-1aff-4929-adb6-dea146ebfcfb",
"db_currency_id": "b9fb9e65-8d49-4def-8bb6-2497b0dc3a4a",
"db_language_id": "c80ce703-9cef-4079-9570-56163f871306",
"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-14T23:46:48.3444824+00:00"
},
"modified_dateutc": "2026-07-14T23:46:48.3444824+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "cd1ebe51-7248-4a1a-bc86-8ff4a4cc6144",
"date_reported_by_company": "2026-07-14T23:46:48.3444824+00:00",
"id2": 36,
"company_id": "31312248-117b-4db4-8e2e-20d7b452cca2",
"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": "de9acf86-d993-4efc-9b81-5420cb5d7f52",
"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-14T23:46:48.3444824+00:00"
},
"work_instruction_details_id": "7480efce-6105-461a-9c75-13b71289a731",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5adb132c-859a-4548-aa26-4d3e26780c33",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "764a1b10-60cc-433d-a227-f85cb903c07e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-14T23:46:48.3444824+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": "5ab42cac-f765-48e5-8f7a-b0a8d173ea11",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-14T23:46:48.3444824+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.