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": "52e61766-2ecc-4911-b72b-8c37cf26d5ab",
"jobs_id": "406d331e-fb46-4b9a-8071-36f1e4d4cfe2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c004aaef-7183-46db-b2ff-300ce15f06ff",
"_parent_id": "84923059-b7c9-47dd-acdc-769154cfe657",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "00a00f19-c83d-4d2b-a5ce-3024b719b56e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c7500170-9060-4369-9cc9-57f5af26718d",
"_parent_id": "cf857471-8e8d-4e89-90b5-604c2679063f",
"root_parent_id": "718481a8-05f8-4a7b-9af1-1f52435fa66e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e11811e4-2154-4f91-8842-08e2ef975013",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3e9c91a6-c55e-4022-887c-513292f7354e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e77961c5-5214-4677-978c-72966c75e87d",
"_parent_code": "sample string 6",
"sales_organization_id": "45141389-4251-485e-946d-9ea9432bea23",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "278a31a6-4290-462e-916b-cd4cca9b15a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bbb9426-5ffb-46eb-8006-26cc801e546c",
"db_currency_id": "59a8def4-01cc-4204-a64c-efac3883cdec",
"db_language_id": "5dfe13f0-74ef-49e5-b8dc-ad24d3b8ee53",
"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-12T04:51:57.792117+00:00"
},
"modified_dateutc": "2026-07-12T04:51:57.792117+00:00"
},
"equipment_model_id": "6ac14804-2a59-43f1-8777-d5f7132dce1d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d953d836-761c-45a4-ba66-8d68621ebaba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3ef8a79b-416b-4928-9937-d21c39432830",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a8dc4239-42ed-4d70-a344-207017f22fbe",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "70025281-ce5a-4dc9-9b89-fab6edff4dac",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "278a31a6-4290-462e-916b-cd4cca9b15a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bbb9426-5ffb-46eb-8006-26cc801e546c",
"db_currency_id": "59a8def4-01cc-4204-a64c-efac3883cdec",
"db_language_id": "5dfe13f0-74ef-49e5-b8dc-ad24d3b8ee53",
"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-12T04:51:57.792117+00:00"
},
"modified_dateutc": "2026-07-12T04:51:57.792117+00:00"
},
"equipment_family_id": "6060357f-c576-40c7-8639-5c0fbffa5656",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3e9c91a6-c55e-4022-887c-513292f7354e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e77961c5-5214-4677-978c-72966c75e87d",
"_parent_code": "sample string 6",
"sales_organization_id": "45141389-4251-485e-946d-9ea9432bea23",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "278a31a6-4290-462e-916b-cd4cca9b15a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bbb9426-5ffb-46eb-8006-26cc801e546c",
"db_currency_id": "59a8def4-01cc-4204-a64c-efac3883cdec",
"db_language_id": "5dfe13f0-74ef-49e5-b8dc-ad24d3b8ee53",
"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-12T04:51:57.792117+00:00"
},
"modified_dateutc": "2026-07-12T04:51:57.792117+00:00"
},
"date_in_production_since": "2026-07-12T04:51:57.792117+00:00",
"date_out_of_production_since": "2026-07-12T04:51:57.792117+00:00",
"date_end_support": "2026-07-12T04:51:57.792117+00:00",
"sales_organization_id": "5741c459-4006-4df5-857c-50db03048dfa",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "278a31a6-4290-462e-916b-cd4cca9b15a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bbb9426-5ffb-46eb-8006-26cc801e546c",
"db_currency_id": "59a8def4-01cc-4204-a64c-efac3883cdec",
"db_language_id": "5dfe13f0-74ef-49e5-b8dc-ad24d3b8ee53",
"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-12T04:51:57.792117+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-12T04:51:57.792117+00:00"
},
"project_status_id": "fb71812e-3782-401c-aec0-20f520cef592",
"project_status_code": "sample string 10",
"project_status": {
"id": "a95fb070-d9d7-4e6d-9234-209138344736",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b7310fdd-8c64-434f-82d3-eb75b07fb47f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "278a31a6-4290-462e-916b-cd4cca9b15a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bbb9426-5ffb-46eb-8006-26cc801e546c",
"db_currency_id": "59a8def4-01cc-4204-a64c-efac3883cdec",
"db_language_id": "5dfe13f0-74ef-49e5-b8dc-ad24d3b8ee53",
"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-12T04:51:57.792117+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-12T04:51:57.792117+00:00"
},
"company_id": "5b03966d-937f-4384-9984-82ecc43514b3",
"company_code": "sample string 12",
"db_address_id": "67840707-a8cf-4cfe-af6f-15d48ac4d5a1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9b354fd4-5199-4c96-8596-f9d153122935",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e81817b4-a9e6-4170-8fdd-6db83664a96b",
"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-12T04:51:57.792117+00:00",
"date_create": "2026-07-12T04:51:57.792117+00:00",
"date_update": "2026-07-12T04:51:57.792117+00:00",
"updated_by_user_id": "597cf5d2-b83d-43cf-a429-e1d29145df61",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-12T04:51:57.792117+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-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-12T04:51:57.792117+00:00",
"date_last_job": "2026-07-12T04:51:57.792117+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-12T04:51:57.792117+00:00",
"modified_dateutc": "2026-07-12T04:51:57.8077372+00:00",
"is_mobile_installation": true
},
"job_type_id": "967fd62a-0645-4f2b-adb1-88561022af8a",
"job_type_code": "sample string 7",
"job_type": {
"id": "b811263c-65df-4c46-938e-200faab17185",
"name": "sample string 2",
"sales_organization_id": "b7f3377d-30b9-4738-8715-d17935422929",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-12T04:51:57.8077372+00:00",
"code": "sample string 7"
},
"job_priority_id": "0c730992-282a-4262-b7b4-e3b828b4a32a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7b5c26fd-0ce8-4cb7-96be-7a2447e4c073",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a47eff9e-2117-4ef1-8852-e2f6bb84b65c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "278a31a6-4290-462e-916b-cd4cca9b15a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bbb9426-5ffb-46eb-8006-26cc801e546c",
"db_currency_id": "59a8def4-01cc-4204-a64c-efac3883cdec",
"db_language_id": "5dfe13f0-74ef-49e5-b8dc-ad24d3b8ee53",
"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-12T04:51:57.792117+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-12T04:51:57.8077372+00:00"
},
"job_status_id": "f0075cfb-38aa-4c19-a6ee-70fa7133ac37",
"job_status_code": "sample string 11",
"db_address_id": "eed498a5-c01c-405e-ab4e-a34d761ad53c",
"contact_id": "8cb8b775-dbeb-4a05-b6c1-1723b87efec3",
"requested_by_company_id": "9acd3fb3-484a-45b9-aa89-732a2c582201",
"requested_by_contact_id": "745b795c-e55c-4433-b897-fbc6f21ddb5b",
"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-12T04:51:57.8077372+00:00",
"due_date": "2026-07-12T04:51:57.8077372+00:00",
"date_create": "2026-07-12T04:51:57.8077372+00:00",
"date_update": "2026-07-12T04:51:57.8077372+00:00",
"date_closed": "2026-07-12T04:51:57.8077372+00:00",
"suggested_user_id": "84810886-a488-470a-8a30-2871f61ac2d8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "265c9708-251e-4601-92fa-27e42d4a42c1",
"db_language_id": "9107ce8c-fdb8-4a03-93f9-6a6906fa0a1a",
"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-12T04:51:57.8077372+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dd2c9e33-34d6-4a46-ad32-c345b5d3f9a2",
"sales_organization": {
"id": "278a31a6-4290-462e-916b-cd4cca9b15a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bbb9426-5ffb-46eb-8006-26cc801e546c",
"db_currency_id": "59a8def4-01cc-4204-a64c-efac3883cdec",
"db_language_id": "5dfe13f0-74ef-49e5-b8dc-ad24d3b8ee53",
"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-12T04:51:57.792117+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e4bf2578-3a77-4bb1-a2af-76ed0565d3ce",
"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": "090a25d4-5815-4407-81b8-83f2d3a8b1ea",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-12T04:51:57.8077372+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "eb804f75-c767-4d47-936a-3d91f13be634"
},
"suggested_date_start": "2026-07-12T04:51:57.8077372+00:00",
"skill_id": "4d50bde6-1a7f-4cbe-9deb-8445af70471b",
"skill_code": "sample string 32",
"skill": {
"id": "344296f8-066d-4464-9c63-ec2560cf71e6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9afa61f0-7f2d-4a26-8ddc-5dd91e987697",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "278a31a6-4290-462e-916b-cd4cca9b15a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3bbb9426-5ffb-46eb-8006-26cc801e546c",
"db_currency_id": "59a8def4-01cc-4204-a64c-efac3883cdec",
"db_language_id": "5dfe13f0-74ef-49e5-b8dc-ad24d3b8ee53",
"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-12T04:51:57.792117+00:00"
},
"modified_dateutc": "2026-07-12T04:51:57.8077372+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e7e14018-b257-461c-ba54-bf512a7ff555",
"date_reported_by_company": "2026-07-12T04:51:57.8077372+00:00",
"id2": 36,
"company_id": "db316ef9-ab23-49e5-aa5e-42022d06ab09",
"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": "3d312b27-2de3-4721-b56b-56f43f664882",
"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-12T04:51:57.8077372+00:00"
},
"work_instruction_details_id": "e93b43c1-c61a-4b15-93e0-6a3dc6f5822f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "db7bb6be-d3a0-4eed-87e7-3260f0e7ff77",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9aab3fa5-3948-4f58-b7e3-9f4d8ea1b7b9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-12T04:51:57.8077372+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": "4ca3778d-97a7-4cce-92d0-e61ae3d03cb2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-12T04:51:57.8077372+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.