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": "c0b3ae64-0a76-47d8-b055-211a88741b46",
"jobs_id": "2d40dba6-c090-45c8-8f1b-c7fa8d4a6cf1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e486800f-0ee4-4d8f-a034-53d48637334c",
"_parent_id": "1e82d249-ceba-4cc8-b006-5d28dd51a3e5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6054cf21-d744-4b46-8e9c-dafcf555635f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "bbd472aa-ad8d-40b9-994a-8d26af1950f1",
"_parent_id": "ef5f7785-4186-4f12-81f5-27aed9df8762",
"root_parent_id": "beb79365-2cf4-471e-82c1-be2221c47346",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a753eadb-057f-467b-9481-947c3f43cf9c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "687345b4-c304-42a7-9e51-534d4296011f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cd52637b-9b41-41d1-9cf4-a0d1514d7dd9",
"_parent_code": "sample string 6",
"sales_organization_id": "ae5dcf96-5c98-4a32-a166-3479a605b8e8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "19b15448-a947-4f83-bec4-5d22124bf58a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c28c087-2f17-4c47-b260-87d255bd9568",
"db_currency_id": "fbbb5107-a265-4890-822d-856d69365fa1",
"db_language_id": "8ef9eb53-d5e6-41cd-a974-5f878fcfff61",
"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": "2025-12-10T19:27:04.958965+00:00"
},
"modified_dateutc": "2025-12-10T19:27:04.958965+00:00"
},
"equipment_model_id": "1ff5a7af-641c-4e86-a865-e9f57c887873",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2a812e24-6073-43a2-b348-09779ed596b8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "31276b1f-2847-45b8-96b0-7202c89572f5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "77fa98e9-3ea5-416a-b3e8-81abf360b270",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4ac4a5b6-b3a1-4c3b-9c9a-00cd817e36ab",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "19b15448-a947-4f83-bec4-5d22124bf58a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c28c087-2f17-4c47-b260-87d255bd9568",
"db_currency_id": "fbbb5107-a265-4890-822d-856d69365fa1",
"db_language_id": "8ef9eb53-d5e6-41cd-a974-5f878fcfff61",
"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": "2025-12-10T19:27:04.958965+00:00"
},
"modified_dateutc": "2025-12-10T19:27:04.958965+00:00"
},
"equipment_family_id": "06008f1a-0070-4184-96e5-ec9a5f4e3cf0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "687345b4-c304-42a7-9e51-534d4296011f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cd52637b-9b41-41d1-9cf4-a0d1514d7dd9",
"_parent_code": "sample string 6",
"sales_organization_id": "ae5dcf96-5c98-4a32-a166-3479a605b8e8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "19b15448-a947-4f83-bec4-5d22124bf58a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c28c087-2f17-4c47-b260-87d255bd9568",
"db_currency_id": "fbbb5107-a265-4890-822d-856d69365fa1",
"db_language_id": "8ef9eb53-d5e6-41cd-a974-5f878fcfff61",
"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": "2025-12-10T19:27:04.958965+00:00"
},
"modified_dateutc": "2025-12-10T19:27:04.958965+00:00"
},
"date_in_production_since": "2025-12-10T19:27:04.958965+00:00",
"date_out_of_production_since": "2025-12-10T19:27:04.958965+00:00",
"date_end_support": "2025-12-10T19:27:04.958965+00:00",
"sales_organization_id": "c85cf426-67f1-4237-8378-b1b4232dabf6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "19b15448-a947-4f83-bec4-5d22124bf58a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c28c087-2f17-4c47-b260-87d255bd9568",
"db_currency_id": "fbbb5107-a265-4890-822d-856d69365fa1",
"db_language_id": "8ef9eb53-d5e6-41cd-a974-5f878fcfff61",
"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": "2025-12-10T19:27:04.958965+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": "2025-12-10T19:27:04.958965+00:00"
},
"project_status_id": "8e1906ef-0779-4415-870d-7bfe3264f6ef",
"project_status_code": "sample string 10",
"project_status": {
"id": "b6a24a3f-d012-4404-92e0-6328b251d326",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b12baae3-127c-4b98-b2b1-eb0185b807c8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "19b15448-a947-4f83-bec4-5d22124bf58a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c28c087-2f17-4c47-b260-87d255bd9568",
"db_currency_id": "fbbb5107-a265-4890-822d-856d69365fa1",
"db_language_id": "8ef9eb53-d5e6-41cd-a974-5f878fcfff61",
"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": "2025-12-10T19:27:04.958965+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-10T19:27:04.958965+00:00"
},
"company_id": "24f91e43-2d3f-4440-bd19-07f22abdb861",
"company_code": "sample string 12",
"db_address_id": "bbfff434-6e38-4ad0-94f5-91d1f247cbba",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a3256b5b-9678-4f32-9cd3-e03c6b2672a3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "33f5bea1-bf3a-425e-bd00-bcc01da1ac1c",
"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": "2025-12-10T19:27:04.958965+00:00",
"date_create": "2025-12-10T19:27:04.958965+00:00",
"date_update": "2025-12-10T19:27:04.958965+00:00",
"updated_by_user_id": "e1302997-8d56-4d0f-9d3d-1a584c41caa6",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-10T19:27:04.958965+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": "2025-12-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-10T19:27:04.958965+00:00",
"date_last_job": "2025-12-10T19:27:04.958965+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-10T19:27:04.958965+00:00",
"modified_dateutc": "2025-12-10T19:27:04.958965+00:00",
"is_mobile_installation": true
},
"job_type_id": "90c89295-b682-47ea-b8dc-adaefcd93e21",
"job_type_code": "sample string 7",
"job_type": {
"id": "00c8ee42-3717-4fed-a41f-f2f0352ca4c7",
"name": "sample string 2",
"sales_organization_id": "16b5ee2c-8ddf-4b21-99f8-2e68db5a0975",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-10T19:27:04.958965+00:00",
"code": "sample string 7"
},
"job_priority_id": "3f32863f-129c-49b7-8f42-e39ffa7ec7eb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f3ec1cc6-3904-4674-b6c5-0c7984dfaf58",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e770b334-f76f-4a40-a44c-98311d51ee14",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "19b15448-a947-4f83-bec4-5d22124bf58a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c28c087-2f17-4c47-b260-87d255bd9568",
"db_currency_id": "fbbb5107-a265-4890-822d-856d69365fa1",
"db_language_id": "8ef9eb53-d5e6-41cd-a974-5f878fcfff61",
"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": "2025-12-10T19:27:04.958965+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-10T19:27:04.958965+00:00"
},
"job_status_id": "93b93cd3-db75-4a12-a8fe-79996f4fe7be",
"job_status_code": "sample string 11",
"db_address_id": "0880a4e7-4377-4893-904f-a5a2287bfdfc",
"contact_id": "e089fba3-7481-49e1-806b-0c6ee4852059",
"requested_by_company_id": "803cb36e-c7a0-4220-91f8-5cd0e2efdf07",
"requested_by_contact_id": "ca538acf-f20f-4e90-9728-6bd91f6a8c65",
"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": "2025-12-10T19:27:04.958965+00:00",
"due_date": "2025-12-10T19:27:04.958965+00:00",
"date_create": "2025-12-10T19:27:04.958965+00:00",
"date_update": "2025-12-10T19:27:04.958965+00:00",
"date_closed": "2025-12-10T19:27:04.958965+00:00",
"suggested_user_id": "62b9541c-e95b-4803-8c27-d1df41999c65",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e62551c1-0781-41c1-8bca-d9fed286fb89",
"db_language_id": "4f561381-43d5-4207-be4a-6487382690b5",
"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": "2025-12-10T19:27:04.958965+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "01ca66fc-1d7d-4439-aa11-865a3c92e521",
"sales_organization": {
"id": "19b15448-a947-4f83-bec4-5d22124bf58a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c28c087-2f17-4c47-b260-87d255bd9568",
"db_currency_id": "fbbb5107-a265-4890-822d-856d69365fa1",
"db_language_id": "8ef9eb53-d5e6-41cd-a974-5f878fcfff61",
"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": "2025-12-10T19:27:04.958965+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4eebdbcf-c79c-407c-9c2b-71caecb1356e",
"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": "975a2a9e-9fa7-49b2-a3fc-54eee274ede1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-10T19:27:04.958965+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "68c58524-156a-47b5-9cb2-ccd13d51972a"
},
"suggested_date_start": "2025-12-10T19:27:04.958965+00:00",
"skill_id": "2ba7aaa3-9a62-4553-afbc-56f1c9a6ffbc",
"skill_code": "sample string 32",
"skill": {
"id": "7c716e0e-431f-460c-9c47-10e538d7c505",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7cef6637-b964-4afa-b206-e2ab28b45369",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "19b15448-a947-4f83-bec4-5d22124bf58a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c28c087-2f17-4c47-b260-87d255bd9568",
"db_currency_id": "fbbb5107-a265-4890-822d-856d69365fa1",
"db_language_id": "8ef9eb53-d5e6-41cd-a974-5f878fcfff61",
"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": "2025-12-10T19:27:04.958965+00:00"
},
"modified_dateutc": "2025-12-10T19:27:04.958965+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d092e43f-35fe-45f3-8cb6-d86df9d1ccb3",
"date_reported_by_company": "2025-12-10T19:27:04.958965+00:00",
"id2": 36,
"company_id": "ca2adbe8-dd2b-40a7-bfe8-09b4ac7b3dbb",
"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": "a89fcf8f-efaa-4d7a-8b5a-400abfa9b657",
"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": "2025-12-10T19:27:04.958965+00:00"
},
"work_instruction_details_id": "c4468548-7761-4164-b3c0-f2f1da16b290",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a10e44fe-86c1-44ae-a672-bd7d99d11e2e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9b5db07f-77e4-43d8-aee2-74f7cc8ee6ef",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-10T19:27:04.958965+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": "d4b4f2ea-fcf5-4f19-996b-f516aeca41dd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-10T19:27:04.958965+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.