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": "d6865d49-3436-4432-ad1e-dc2023d4255b",
"jobs_id": "ca252695-9161-4e65-af4d-72f24e0e06e9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "af848128-d37e-4195-b7bd-8cce76ca4b77",
"_parent_id": "2038bdce-61c7-457d-853f-61d8e953014a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cf214ec5-040b-4658-9f8e-7fe0a0da10a5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dcb7026c-65e0-4d0b-ad6e-f44f326a4d3d",
"_parent_id": "4afc85e6-fa41-4c23-acd1-9207f1677a64",
"root_parent_id": "20734eae-5238-4315-833c-cc0b21acfd4b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "207cfd37-1e19-49f7-ab46-cb7ed1d52751",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "498851f6-68f9-4cfd-9d34-b53303b5537d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8461e2e4-bfca-47dc-9aa0-cc875eb8628d",
"_parent_code": "sample string 6",
"sales_organization_id": "ea82813b-c80c-4569-bf9e-33937315c206",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "adcfb12f-1d1b-4805-8a0c-12128217c0e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8352ef1-b331-4d1e-a364-484eebb35bad",
"db_currency_id": "33b63ad4-3106-44c0-aa33-ec3ef003859e",
"db_language_id": "8c59f45b-6a37-435a-9b5e-dd7e083f79b5",
"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-06-25T06:01:27.3101265+00:00"
},
"modified_dateutc": "2026-06-25T06:01:27.3101265+00:00"
},
"equipment_model_id": "d4470e05-600e-47b3-b93a-d59ddc39329c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e584cad1-b55f-4679-8eaf-5820882ef4cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b3b57f13-6ede-47cf-8527-61602a6efdf0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "212fc637-cddd-4cb8-95a8-a5bca370cb06",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "81befcf6-8b8e-47d2-a16f-25644969473d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "adcfb12f-1d1b-4805-8a0c-12128217c0e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8352ef1-b331-4d1e-a364-484eebb35bad",
"db_currency_id": "33b63ad4-3106-44c0-aa33-ec3ef003859e",
"db_language_id": "8c59f45b-6a37-435a-9b5e-dd7e083f79b5",
"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-06-25T06:01:27.3101265+00:00"
},
"modified_dateutc": "2026-06-25T06:01:27.3101265+00:00"
},
"equipment_family_id": "bcf0c07b-4b62-4862-bc08-ddfe329f9330",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "498851f6-68f9-4cfd-9d34-b53303b5537d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8461e2e4-bfca-47dc-9aa0-cc875eb8628d",
"_parent_code": "sample string 6",
"sales_organization_id": "ea82813b-c80c-4569-bf9e-33937315c206",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "adcfb12f-1d1b-4805-8a0c-12128217c0e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8352ef1-b331-4d1e-a364-484eebb35bad",
"db_currency_id": "33b63ad4-3106-44c0-aa33-ec3ef003859e",
"db_language_id": "8c59f45b-6a37-435a-9b5e-dd7e083f79b5",
"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-06-25T06:01:27.3101265+00:00"
},
"modified_dateutc": "2026-06-25T06:01:27.3101265+00:00"
},
"date_in_production_since": "2026-06-25T06:01:27.3101265+00:00",
"date_out_of_production_since": "2026-06-25T06:01:27.3101265+00:00",
"date_end_support": "2026-06-25T06:01:27.3101265+00:00",
"sales_organization_id": "fb637702-82cc-40c3-ae33-8f53db906e2d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "adcfb12f-1d1b-4805-8a0c-12128217c0e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8352ef1-b331-4d1e-a364-484eebb35bad",
"db_currency_id": "33b63ad4-3106-44c0-aa33-ec3ef003859e",
"db_language_id": "8c59f45b-6a37-435a-9b5e-dd7e083f79b5",
"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-06-25T06:01:27.3101265+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-06-25T06:01:27.3101265+00:00"
},
"project_status_id": "8b082668-6bad-4445-839a-0e8a5983aa6b",
"project_status_code": "sample string 10",
"project_status": {
"id": "785a352d-86bc-4d0e-8fc0-fae27cae7308",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bc53595e-b87b-40a3-bcfa-8ab6ac285fc5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "adcfb12f-1d1b-4805-8a0c-12128217c0e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8352ef1-b331-4d1e-a364-484eebb35bad",
"db_currency_id": "33b63ad4-3106-44c0-aa33-ec3ef003859e",
"db_language_id": "8c59f45b-6a37-435a-9b5e-dd7e083f79b5",
"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-06-25T06:01:27.3101265+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-25T06:01:27.3101265+00:00"
},
"company_id": "84f02884-f5c0-42e2-a5ff-75ef7d96e5ff",
"company_code": "sample string 12",
"db_address_id": "adb75b57-f9f1-42ae-9d11-e36be4c0b7a9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f842d32f-2de8-4d7d-b062-1479190a00c2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7ca78e35-a069-4660-951a-75d2c15b1304",
"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-06-25T06:01:27.3101265+00:00",
"date_create": "2026-06-25T06:01:27.3101265+00:00",
"date_update": "2026-06-25T06:01:27.3101265+00:00",
"updated_by_user_id": "b22282f1-deaf-4d1b-a050-446b55b003f9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-25T06:01:27.3101265+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-06-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-25T06:01:27.3101265+00:00",
"date_last_job": "2026-06-25T06:01:27.3101265+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-25T06:01:27.3101265+00:00",
"modified_dateutc": "2026-06-25T06:01:27.3101265+00:00",
"is_mobile_installation": true
},
"job_type_id": "54f949fe-6a12-4140-9e7a-f57aa6257fb2",
"job_type_code": "sample string 7",
"job_type": {
"id": "ee809e0d-bdac-4859-96b0-1d08ef16d99b",
"name": "sample string 2",
"sales_organization_id": "482763f6-e41d-4abc-adab-19355897089c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-25T06:01:27.3101265+00:00",
"code": "sample string 7"
},
"job_priority_id": "3ff8b662-cfb0-4d3c-b66b-a77328e58f4f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d473fad1-8e25-4287-baaa-f4eca63a1ccc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2b24aed0-2e6f-4c29-991a-b1c754b710c3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "adcfb12f-1d1b-4805-8a0c-12128217c0e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8352ef1-b331-4d1e-a364-484eebb35bad",
"db_currency_id": "33b63ad4-3106-44c0-aa33-ec3ef003859e",
"db_language_id": "8c59f45b-6a37-435a-9b5e-dd7e083f79b5",
"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-06-25T06:01:27.3101265+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-25T06:01:27.3101265+00:00"
},
"job_status_id": "0ed208fc-2d54-4fbd-9430-9b6c5b2bce41",
"job_status_code": "sample string 11",
"db_address_id": "925292bc-3bf8-4303-a65c-99fb8aa77ebf",
"contact_id": "686278fc-b8f4-493e-8027-21a02198f11a",
"requested_by_company_id": "d708dda4-2106-44c0-8675-39f45de42c0b",
"requested_by_contact_id": "3f5132fd-393b-40b8-b7cd-99d6c50067c6",
"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-06-25T06:01:27.3101265+00:00",
"due_date": "2026-06-25T06:01:27.3101265+00:00",
"date_create": "2026-06-25T06:01:27.3101265+00:00",
"date_update": "2026-06-25T06:01:27.3101265+00:00",
"date_closed": "2026-06-25T06:01:27.3101265+00:00",
"suggested_user_id": "fb9dde0d-d8b9-4203-ad38-95fec340ea82",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8f4d73ce-2ccd-4cf9-b478-6938daaba49a",
"db_language_id": "24b90c36-fac2-41ca-bdc4-94cb4cd549c9",
"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-06-25T06:01:27.3101265+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a97978fd-4a04-446d-9044-02844315aa39",
"sales_organization": {
"id": "adcfb12f-1d1b-4805-8a0c-12128217c0e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8352ef1-b331-4d1e-a364-484eebb35bad",
"db_currency_id": "33b63ad4-3106-44c0-aa33-ec3ef003859e",
"db_language_id": "8c59f45b-6a37-435a-9b5e-dd7e083f79b5",
"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-06-25T06:01:27.3101265+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e14454ed-ef43-462e-aa39-a33c2b8f1c24",
"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": "6860880a-4ed9-4d96-b8de-f3a79a2737ce",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-25T06:01:27.3101265+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a773da62-836a-4fac-9443-e0cf305e5376"
},
"suggested_date_start": "2026-06-25T06:01:27.3101265+00:00",
"skill_id": "80f97cbb-20c6-4fde-b75d-79905207cc40",
"skill_code": "sample string 32",
"skill": {
"id": "028270c1-1bdb-4542-9f45-9941a0a85d03",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9578e18f-e858-481d-b278-63c8e2d5ae47",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "adcfb12f-1d1b-4805-8a0c-12128217c0e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8352ef1-b331-4d1e-a364-484eebb35bad",
"db_currency_id": "33b63ad4-3106-44c0-aa33-ec3ef003859e",
"db_language_id": "8c59f45b-6a37-435a-9b5e-dd7e083f79b5",
"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-06-25T06:01:27.3101265+00:00"
},
"modified_dateutc": "2026-06-25T06:01:27.3101265+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2ca20d6f-1b47-404d-bd41-bdb112fe3661",
"date_reported_by_company": "2026-06-25T06:01:27.3101265+00:00",
"id2": 36,
"company_id": "cd2cbfba-82fb-4a73-a4c8-874cf929a4c2",
"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": "ed9906a4-65fa-45c8-8402-a3676c347e1c",
"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-06-25T06:01:27.3101265+00:00"
},
"work_instruction_details_id": "8bbbe41d-24af-44d6-a41a-8f656ea1aa47",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "55ee9222-4833-4392-897a-33343041c3a8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "844a52fa-96db-4267-80a7-7f40840f49ee",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-25T06:01:27.3101265+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": "f37841a3-5972-4dbe-9f89-319f6c77f438",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-25T06:01:27.3101265+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.