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": "36d378a4-f74b-40f5-8fe5-0b2c744a16a8",
"jobs_id": "904f6f80-5a0e-48b7-a634-503dacc06744",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fb695b31-25f8-4f7d-9e78-4dd7cdf3d6a3",
"_parent_id": "e468be34-9817-47e2-85b6-f8a5c0efc69f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "50998fef-4c46-4fb6-9280-72699dbc6fec",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ee8ed043-6bc1-4cec-98ab-3e314f08e5c3",
"_parent_id": "19b3d84d-982f-4906-bea4-15dc2b3b5c28",
"root_parent_id": "7294f12a-86a1-4df7-bcb9-406a264e44b2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7d9d75b3-d5c0-43ef-8618-f9bf27421ccf",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b3c009c3-339b-4a56-9ba9-81fd9cca3763",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9beead78-e042-4baf-a7fb-f378507ccdfb",
"_parent_code": "sample string 6",
"sales_organization_id": "09a8a138-398a-4a0d-98fb-64fd10274de6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d38ab37d-afbf-46a8-9049-b9b128e259d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2919e9b9-15aa-4b5e-bb3e-129a21cc8e3c",
"db_currency_id": "9e4f158e-2cec-4044-912c-4c3f9dff5741",
"db_language_id": "249d5445-462b-4efe-9428-e0e3a8b27cb6",
"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-04T03:15:16.7985552+00:00"
},
"modified_dateutc": "2026-06-04T03:15:16.7985552+00:00"
},
"equipment_model_id": "cdb0d0b9-0892-4a9c-b84d-b4649d78474a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fc074723-7d0c-4708-8810-7e135b4fb841",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c4b9f4f9-f613-4eac-bcb0-804726eb68bd",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d7249406-4efb-4d14-afd1-34fdb43b396f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "353dd2ca-14f6-4ba3-b7bb-90f565ba1c59",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d38ab37d-afbf-46a8-9049-b9b128e259d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2919e9b9-15aa-4b5e-bb3e-129a21cc8e3c",
"db_currency_id": "9e4f158e-2cec-4044-912c-4c3f9dff5741",
"db_language_id": "249d5445-462b-4efe-9428-e0e3a8b27cb6",
"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-04T03:15:16.7985552+00:00"
},
"modified_dateutc": "2026-06-04T03:15:16.7985552+00:00"
},
"equipment_family_id": "a21d8778-0d62-4911-9ce8-d1a398c2c831",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b3c009c3-339b-4a56-9ba9-81fd9cca3763",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9beead78-e042-4baf-a7fb-f378507ccdfb",
"_parent_code": "sample string 6",
"sales_organization_id": "09a8a138-398a-4a0d-98fb-64fd10274de6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d38ab37d-afbf-46a8-9049-b9b128e259d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2919e9b9-15aa-4b5e-bb3e-129a21cc8e3c",
"db_currency_id": "9e4f158e-2cec-4044-912c-4c3f9dff5741",
"db_language_id": "249d5445-462b-4efe-9428-e0e3a8b27cb6",
"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-04T03:15:16.7985552+00:00"
},
"modified_dateutc": "2026-06-04T03:15:16.7985552+00:00"
},
"date_in_production_since": "2026-06-04T03:15:16.7985552+00:00",
"date_out_of_production_since": "2026-06-04T03:15:16.7985552+00:00",
"date_end_support": "2026-06-04T03:15:16.7985552+00:00",
"sales_organization_id": "21169491-ac25-4a11-9c39-03fccf33d753",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d38ab37d-afbf-46a8-9049-b9b128e259d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2919e9b9-15aa-4b5e-bb3e-129a21cc8e3c",
"db_currency_id": "9e4f158e-2cec-4044-912c-4c3f9dff5741",
"db_language_id": "249d5445-462b-4efe-9428-e0e3a8b27cb6",
"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-04T03:15:16.7985552+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-04T03:15:16.7985552+00:00"
},
"project_status_id": "d36ca366-c26c-48ba-b95a-f1cfb3a9f1a0",
"project_status_code": "sample string 10",
"project_status": {
"id": "ff740500-3efd-461b-94d5-479a03e3e621",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5f572e43-d45f-44d1-9b8b-6265d3b73a4f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d38ab37d-afbf-46a8-9049-b9b128e259d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2919e9b9-15aa-4b5e-bb3e-129a21cc8e3c",
"db_currency_id": "9e4f158e-2cec-4044-912c-4c3f9dff5741",
"db_language_id": "249d5445-462b-4efe-9428-e0e3a8b27cb6",
"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-04T03:15:16.7985552+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-04T03:15:16.7985552+00:00"
},
"company_id": "613f254e-8774-4cbf-bb02-47cbb983eaf0",
"company_code": "sample string 12",
"db_address_id": "b9cb7087-95c6-4bd0-b820-a1b2d4f271c7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7a101d15-362a-4a2f-92f0-b3a62db922f5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "57f1a13b-a950-44a1-a56a-3186d23e1872",
"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-04T03:15:16.7985552+00:00",
"date_create": "2026-06-04T03:15:16.7985552+00:00",
"date_update": "2026-06-04T03:15:16.7985552+00:00",
"updated_by_user_id": "efc8d00a-c0c5-41e3-93bf-d3c303338456",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-04T03:15:16.7985552+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-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-04T03:15:16.7985552+00:00",
"date_last_job": "2026-06-04T03:15:16.7985552+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-04T03:15:16.7985552+00:00",
"modified_dateutc": "2026-06-04T03:15:16.7985552+00:00",
"is_mobile_installation": true
},
"job_type_id": "45ef24ec-3d10-4d22-8a87-159f46755c2b",
"job_type_code": "sample string 7",
"job_type": {
"id": "c852a924-c330-4d7c-b646-9f23a40f8b28",
"name": "sample string 2",
"sales_organization_id": "8a1a28c9-0fac-4785-9a5d-42a612e7ed56",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-04T03:15:16.7985552+00:00",
"code": "sample string 7"
},
"job_priority_id": "622652dd-77e9-4347-944d-3553ce8a8ab0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d36972d6-b57f-4349-a99a-60a627294ad9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "841dfd7b-dbe5-4773-a65b-4d0ab0060774",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d38ab37d-afbf-46a8-9049-b9b128e259d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2919e9b9-15aa-4b5e-bb3e-129a21cc8e3c",
"db_currency_id": "9e4f158e-2cec-4044-912c-4c3f9dff5741",
"db_language_id": "249d5445-462b-4efe-9428-e0e3a8b27cb6",
"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-04T03:15:16.7985552+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-04T03:15:16.7985552+00:00"
},
"job_status_id": "d4029476-d9ca-4f07-8826-0a8d12f9e19b",
"job_status_code": "sample string 11",
"db_address_id": "8d34ad2e-3571-4e1e-89d0-c81ed6b7546e",
"contact_id": "083c2e99-d391-4aa7-a7b0-60b13070662c",
"requested_by_company_id": "5a27f11c-140f-4e84-ac08-0f2d11600836",
"requested_by_contact_id": "33fbc63b-e884-4dc9-a1a6-81a30f2206d6",
"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-04T03:15:16.7985552+00:00",
"due_date": "2026-06-04T03:15:16.7985552+00:00",
"date_create": "2026-06-04T03:15:16.7985552+00:00",
"date_update": "2026-06-04T03:15:16.7985552+00:00",
"date_closed": "2026-06-04T03:15:16.7985552+00:00",
"suggested_user_id": "1a5241fa-18da-41b9-ac85-12faa7541801",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0332e3bb-7d4f-48b5-abcf-828d3e4b2183",
"db_language_id": "d6420216-9515-4a03-af15-b8ad1307a055",
"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-04T03:15:16.7985552+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0c243781-0050-429c-9d5c-963f908b484b",
"sales_organization": {
"id": "d38ab37d-afbf-46a8-9049-b9b128e259d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2919e9b9-15aa-4b5e-bb3e-129a21cc8e3c",
"db_currency_id": "9e4f158e-2cec-4044-912c-4c3f9dff5741",
"db_language_id": "249d5445-462b-4efe-9428-e0e3a8b27cb6",
"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-04T03:15:16.7985552+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e23e5d62-e717-42c0-9547-e2185627a05a",
"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": "3d62c463-fd98-4628-9378-f2926e059015",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-04T03:15:16.8141824+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3a6489b3-12e3-4110-b4bc-38115d66a598"
},
"suggested_date_start": "2026-06-04T03:15:16.8141824+00:00",
"skill_id": "8106fc7c-513d-46fe-a0e5-7cdab375dc3a",
"skill_code": "sample string 32",
"skill": {
"id": "999d95d5-3ef7-4a56-a157-44af9b8f3478",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ad8344f6-8980-457f-9d21-33f90a475145",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d38ab37d-afbf-46a8-9049-b9b128e259d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2919e9b9-15aa-4b5e-bb3e-129a21cc8e3c",
"db_currency_id": "9e4f158e-2cec-4044-912c-4c3f9dff5741",
"db_language_id": "249d5445-462b-4efe-9428-e0e3a8b27cb6",
"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-04T03:15:16.7985552+00:00"
},
"modified_dateutc": "2026-06-04T03:15:16.8141824+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d2441845-21ec-4e31-abca-3de25e5be5c1",
"date_reported_by_company": "2026-06-04T03:15:16.8141824+00:00",
"id2": 36,
"company_id": "fa371937-1030-4469-97b9-7fbf4d941484",
"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": "1fe0c9ce-4fa9-40e5-8fbf-30572261e541",
"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-04T03:15:16.8141824+00:00"
},
"work_instruction_details_id": "cff59705-0022-4bc1-a614-e7987d98c27b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e341d82f-7224-42b4-9664-6b8c1ba3665d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "efd7d1df-1051-4e37-a45b-d89dad4c915e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-04T03:15:16.8141824+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": "c1786d76-ca8a-486c-8eb8-8bc4bc9f5c84",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-04T03:15:16.8141824+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.