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": "636b905b-7a93-49fc-bb35-97909113fdf1",
"jobs_id": "ec58a15b-7611-4736-820b-c104b6e0094f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "92657ad1-8790-4091-92c1-a450eb039837",
"_parent_id": "2c2659db-1fac-4ac0-a84d-9d7ed3fd257f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3f7c69b8-81af-4028-9a58-47f6f6e33b06",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a70c1dca-8df0-4a77-8828-2747870f4804",
"_parent_id": "30f30865-88ee-45c0-8af6-98fad435cdf2",
"root_parent_id": "3488ef91-a553-4847-8184-f896385850f0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "49b1d796-499b-4c43-9c27-cfb66752ea07",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8e043e07-a572-4812-861f-98109ca47674",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "78c12922-eff0-494d-aa40-22c458ababe6",
"_parent_code": "sample string 6",
"sales_organization_id": "ac2c8f9e-9731-4521-b459-5b45ec273ef2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0b4819d2-0605-489c-91ed-478bbdb7cd53",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74bb8839-8789-4135-9b41-932d77bae341",
"db_currency_id": "4e5ab335-54d9-432a-8d12-82a2cec363fc",
"db_language_id": "a55fb713-6fae-4702-bbc6-e86416c15328",
"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-09-30T08:20:51.8435643+00:00"
},
"modified_dateutc": "2026-09-30T08:20:51.8435643+00:00"
},
"equipment_model_id": "6b4bed14-dd96-44ee-af04-d094a54d7cd9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b3a91e1f-0803-46d7-b8f8-068429c3e7fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7c365693-6d1f-42ca-b52a-1d1a19e40193",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8991dc3a-f85b-4377-a71c-61e486852249",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fd6b4de8-f878-432f-a100-1816a5b6745d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0b4819d2-0605-489c-91ed-478bbdb7cd53",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74bb8839-8789-4135-9b41-932d77bae341",
"db_currency_id": "4e5ab335-54d9-432a-8d12-82a2cec363fc",
"db_language_id": "a55fb713-6fae-4702-bbc6-e86416c15328",
"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-09-30T08:20:51.8435643+00:00"
},
"modified_dateutc": "2026-09-30T08:20:51.8591535+00:00"
},
"equipment_family_id": "b3a4ee3f-d8bd-4c9b-9d45-3a1cf18c8d28",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8e043e07-a572-4812-861f-98109ca47674",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "78c12922-eff0-494d-aa40-22c458ababe6",
"_parent_code": "sample string 6",
"sales_organization_id": "ac2c8f9e-9731-4521-b459-5b45ec273ef2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0b4819d2-0605-489c-91ed-478bbdb7cd53",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74bb8839-8789-4135-9b41-932d77bae341",
"db_currency_id": "4e5ab335-54d9-432a-8d12-82a2cec363fc",
"db_language_id": "a55fb713-6fae-4702-bbc6-e86416c15328",
"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-09-30T08:20:51.8435643+00:00"
},
"modified_dateutc": "2026-09-30T08:20:51.8435643+00:00"
},
"date_in_production_since": "2026-09-30T08:20:51.8591535+00:00",
"date_out_of_production_since": "2026-09-30T08:20:51.8591535+00:00",
"date_end_support": "2026-09-30T08:20:51.8591535+00:00",
"sales_organization_id": "2f0eb5b5-a8b7-467b-80da-3afb1216981c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0b4819d2-0605-489c-91ed-478bbdb7cd53",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74bb8839-8789-4135-9b41-932d77bae341",
"db_currency_id": "4e5ab335-54d9-432a-8d12-82a2cec363fc",
"db_language_id": "a55fb713-6fae-4702-bbc6-e86416c15328",
"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-09-30T08:20:51.8435643+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-09-30T08:20:51.8591535+00:00"
},
"project_status_id": "8a215414-369d-4425-b171-7e3f75f14e25",
"project_status_code": "sample string 10",
"project_status": {
"id": "15a8dc48-373b-4bb2-8e41-cf2c71c57f2b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bed57f33-d1dc-4a51-b4f0-fdec1d9a604f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0b4819d2-0605-489c-91ed-478bbdb7cd53",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74bb8839-8789-4135-9b41-932d77bae341",
"db_currency_id": "4e5ab335-54d9-432a-8d12-82a2cec363fc",
"db_language_id": "a55fb713-6fae-4702-bbc6-e86416c15328",
"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-09-30T08:20:51.8435643+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-30T08:20:51.8591535+00:00"
},
"company_id": "01d4ef38-3ee1-494e-a9c9-49d3e819832a",
"company_code": "sample string 12",
"db_address_id": "67c57aa4-4b9d-485f-bc37-11c792fdb8f7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e349fb66-359c-4d2c-92c6-0871a8f7aa01",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f741ae17-c519-44ef-83ae-07c0f5b508f3",
"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-09-30T08:20:51.8591535+00:00",
"date_create": "2026-09-30T08:20:51.8591535+00:00",
"date_update": "2026-09-30T08:20:51.8748364+00:00",
"updated_by_user_id": "b04c4e21-8d99-46c2-9f06-6518dcb06989",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-30T08:20:51.8748364+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-09-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-30T08:20:51.8748364+00:00",
"date_last_job": "2026-09-30T08:20:51.8748364+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-30T08:20:51.8748364+00:00",
"modified_dateutc": "2026-09-30T08:20:51.8748364+00:00",
"is_mobile_installation": true
},
"job_type_id": "0ab377c3-9f74-43aa-aa29-fae6860fab2b",
"job_type_code": "sample string 7",
"job_type": {
"id": "eb50ad53-14dc-4008-8ec9-9de7e7651eea",
"name": "sample string 2",
"sales_organization_id": "315cdc81-9cd1-44df-812d-6ee5f7659777",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-30T08:20:51.8748364+00:00",
"code": "sample string 7"
},
"job_priority_id": "8b73b4c2-c42d-4e3e-a6a6-70d198061f17",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "43fba27f-72c8-43d2-a9ed-79d6e46b984a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4bf88c48-6202-4023-acb8-1c0b2b8c8c93",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0b4819d2-0605-489c-91ed-478bbdb7cd53",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74bb8839-8789-4135-9b41-932d77bae341",
"db_currency_id": "4e5ab335-54d9-432a-8d12-82a2cec363fc",
"db_language_id": "a55fb713-6fae-4702-bbc6-e86416c15328",
"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-09-30T08:20:51.8435643+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-30T08:20:51.8748364+00:00"
},
"job_status_id": "14fd9580-ec7e-42ef-8912-c79f9b7e6034",
"job_status_code": "sample string 11",
"db_address_id": "c8547754-5cb3-47a9-bbf8-aa4c42e986d2",
"contact_id": "a754f722-180c-4104-b7d8-9cc8dafe7bf5",
"requested_by_company_id": "1ab05749-4ccb-4387-8dd4-f14cd790a198",
"requested_by_contact_id": "ec720b59-98d2-40a1-bba9-aa4bc00a6c9e",
"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-09-30T08:20:51.8748364+00:00",
"due_date": "2026-09-30T08:20:51.8748364+00:00",
"date_create": "2026-09-30T08:20:51.8748364+00:00",
"date_update": "2026-09-30T08:20:51.8748364+00:00",
"date_closed": "2026-09-30T08:20:51.8748364+00:00",
"suggested_user_id": "849748d2-82b9-4acd-9056-7cb8b571b049",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fafa81bb-d7f1-4e62-b5e6-6e071c335f79",
"db_language_id": "cd08b67f-654a-475b-8af0-ebcbd622ee5e",
"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-09-30T08:20:51.8748364+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "04cc055b-65d6-41ca-a4f7-a1095edec955",
"sales_organization": {
"id": "0b4819d2-0605-489c-91ed-478bbdb7cd53",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74bb8839-8789-4135-9b41-932d77bae341",
"db_currency_id": "4e5ab335-54d9-432a-8d12-82a2cec363fc",
"db_language_id": "a55fb713-6fae-4702-bbc6-e86416c15328",
"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-09-30T08:20:51.8435643+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6a2ea8a7-d433-4724-a6c6-d1636c00f4f7",
"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": "22775772-bc9e-4cc5-ab57-ca430e17f2dd",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-30T08:20:51.8748364+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "df2025d2-f2bb-4244-bb23-6bb0704628f7"
},
"suggested_date_start": "2026-09-30T08:20:51.8748364+00:00",
"skill_id": "2a4a3e04-479e-4b0d-9793-60bcfce88c0e",
"skill_code": "sample string 32",
"skill": {
"id": "2c763186-27fc-4d93-9b2a-a93a8ff7e13b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1808c1c0-ec72-4da8-b590-99bc79ec92e1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0b4819d2-0605-489c-91ed-478bbdb7cd53",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74bb8839-8789-4135-9b41-932d77bae341",
"db_currency_id": "4e5ab335-54d9-432a-8d12-82a2cec363fc",
"db_language_id": "a55fb713-6fae-4702-bbc6-e86416c15328",
"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-09-30T08:20:51.8435643+00:00"
},
"modified_dateutc": "2026-09-30T08:20:51.8748364+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2a576e89-9235-49dc-9316-3fc889c7d5a1",
"date_reported_by_company": "2026-09-30T08:20:51.8748364+00:00",
"id2": 36,
"company_id": "448bc943-b836-4a57-972c-d2b70776ce30",
"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": "094ef224-b8e0-4cf8-973a-c26db3527a00",
"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-09-30T08:20:51.8748364+00:00"
},
"work_instruction_details_id": "2ff632b2-e2e0-48ef-90dc-49148cb8890c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "65b641c2-bd01-4272-a6ba-dc27bde956bc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fcd4fb4b-f5ba-46c0-9269-9a1dacdaf968",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-30T08:20:51.8748364+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": "020acaac-538f-4e48-9687-3c9507f17b7f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-30T08:20:51.8748364+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.