Retrieves 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 :
None.
Response Information
Resource Description :
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 |
Response Formats
application/json, text/json
Sample:
{
"id": "5c4d7f33-2949-4ba6-9861-6f3a71a302c0",
"jobs_id": "dcc269ef-ba9f-4273-a694-f0fc29f07ebd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f3f07be0-4b9a-46a1-892c-46bcb5981f68",
"_parent_id": "c2b028c5-803c-40e7-a40a-d540d548953d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "79bcdaa7-6175-43ef-a113-78e38c0fe67f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1fb4ee80-5f0d-4161-b8c5-b9410d4deac2",
"_parent_id": "5816c28c-7dfa-4f10-b03f-beebe2c83bbe",
"root_parent_id": "142e1406-269b-4479-9177-aa1ee8c73612",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d609fad7-a8b9-443d-b51e-d224a3565e8e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "afff273a-c732-4e2c-a9ad-96fab737fcfb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4d72fcd3-d1e8-4016-8229-8ce5dc78c1d0",
"_parent_code": "sample string 6",
"sales_organization_id": "9c76f03d-5773-4aba-9c95-9149319ad440",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0c8c17b2-cfd1-4ae9-91d0-3dc9cad2052d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ecd3a97-933f-453c-bb5a-0726f1ad2d55",
"db_currency_id": "b4c543d0-a19b-428e-bc9b-480b4fb22c68",
"db_language_id": "96be975d-1a40-4d1b-9437-36807056d73e",
"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-10-30T21:42:00.9973848+00:00"
},
"modified_dateutc": "2026-10-30T21:42:00.9973848+00:00"
},
"equipment_model_id": "e6988c5e-d70b-438d-aa0c-da09466fd658",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ea9238e6-e6c9-4ab4-811b-e49a84bddd9c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "69a499f7-4add-468f-a424-ab7cb9e980df",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d96190d9-dfca-4d52-81ad-5b2b02fd0aed",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6effec97-26ea-4d08-8ffe-aa1210b2a023",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0c8c17b2-cfd1-4ae9-91d0-3dc9cad2052d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ecd3a97-933f-453c-bb5a-0726f1ad2d55",
"db_currency_id": "b4c543d0-a19b-428e-bc9b-480b4fb22c68",
"db_language_id": "96be975d-1a40-4d1b-9437-36807056d73e",
"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-10-30T21:42:00.9973848+00:00"
},
"modified_dateutc": "2026-10-30T21:42:00.9973848+00:00"
},
"equipment_family_id": "1bbee930-f504-4987-95ff-c9424546c603",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "afff273a-c732-4e2c-a9ad-96fab737fcfb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4d72fcd3-d1e8-4016-8229-8ce5dc78c1d0",
"_parent_code": "sample string 6",
"sales_organization_id": "9c76f03d-5773-4aba-9c95-9149319ad440",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0c8c17b2-cfd1-4ae9-91d0-3dc9cad2052d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ecd3a97-933f-453c-bb5a-0726f1ad2d55",
"db_currency_id": "b4c543d0-a19b-428e-bc9b-480b4fb22c68",
"db_language_id": "96be975d-1a40-4d1b-9437-36807056d73e",
"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-10-30T21:42:00.9973848+00:00"
},
"modified_dateutc": "2026-10-30T21:42:00.9973848+00:00"
},
"date_in_production_since": "2026-10-30T21:42:00.9973848+00:00",
"date_out_of_production_since": "2026-10-30T21:42:00.9973848+00:00",
"date_end_support": "2026-10-30T21:42:00.9973848+00:00",
"sales_organization_id": "7ae7da33-d9de-4dac-a1b6-bc0fe07d89b4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0c8c17b2-cfd1-4ae9-91d0-3dc9cad2052d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ecd3a97-933f-453c-bb5a-0726f1ad2d55",
"db_currency_id": "b4c543d0-a19b-428e-bc9b-480b4fb22c68",
"db_language_id": "96be975d-1a40-4d1b-9437-36807056d73e",
"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-10-30T21:42:00.9973848+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-10-30T21:42:01.015135+00:00"
},
"project_status_id": "3226b5ee-e288-42b2-84e7-4d912e942f76",
"project_status_code": "sample string 10",
"project_status": {
"id": "08fbbe80-95fc-41d5-b9c3-d4a8ca336e1a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8564dc80-c659-4448-933a-a78b79d7fcd9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0c8c17b2-cfd1-4ae9-91d0-3dc9cad2052d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ecd3a97-933f-453c-bb5a-0726f1ad2d55",
"db_currency_id": "b4c543d0-a19b-428e-bc9b-480b4fb22c68",
"db_language_id": "96be975d-1a40-4d1b-9437-36807056d73e",
"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-10-30T21:42:00.9973848+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-30T21:42:01.015135+00:00"
},
"company_id": "f276d95d-0e30-43b1-8eb3-86c1c65c675e",
"company_code": "sample string 12",
"db_address_id": "cc22ed69-d2f1-4e0a-9a2c-46966ad10371",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "538b2939-85ef-4270-9199-820f9968115b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4982dfb0-3172-4201-9b37-4d8107d3db03",
"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-10-30T21:42:01.015135+00:00",
"date_create": "2026-10-30T21:42:01.015135+00:00",
"date_update": "2026-10-30T21:42:01.015135+00:00",
"updated_by_user_id": "97ce9cb7-b0da-4d1b-b9fb-2430adb28e08",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-30T21:42:01.015135+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-10-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-30T21:42:01.015135+00:00",
"date_last_job": "2026-10-30T21:42:01.015135+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-30T21:42:01.015135+00:00",
"modified_dateutc": "2026-10-30T21:42:01.015135+00:00",
"is_mobile_installation": true
},
"job_type_id": "cfeb3bdf-0964-4f31-a36e-a0b0c2409895",
"job_type_code": "sample string 7",
"job_type": {
"id": "e4506696-34c1-4644-a81c-20e1a408bda6",
"name": "sample string 2",
"sales_organization_id": "33454628-39d1-493f-84a3-67e65f056dfb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-30T21:42:01.015135+00:00",
"code": "sample string 7"
},
"job_priority_id": "87f25d8d-a4f2-443b-91e1-2c28cea62aef",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "dad6cce5-9eda-455d-9ee5-645f4555b0a7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "84cba73a-8704-4aac-bd83-ebbc2c3a2c77",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0c8c17b2-cfd1-4ae9-91d0-3dc9cad2052d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ecd3a97-933f-453c-bb5a-0726f1ad2d55",
"db_currency_id": "b4c543d0-a19b-428e-bc9b-480b4fb22c68",
"db_language_id": "96be975d-1a40-4d1b-9437-36807056d73e",
"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-10-30T21:42:00.9973848+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-30T21:42:01.015135+00:00"
},
"job_status_id": "ee9cc469-9692-4296-9151-8dacb1f5c285",
"job_status_code": "sample string 11",
"db_address_id": "0b319db1-9da6-4247-8872-bad2af8b58e1",
"contact_id": "8502238c-90fb-43ab-8385-ae12d7c9bb73",
"requested_by_company_id": "a7b9da0d-3bb0-413e-a71b-f5296ca91c03",
"requested_by_contact_id": "aae99071-26bc-44e4-a376-4a7177901c0b",
"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-10-30T21:42:01.015135+00:00",
"due_date": "2026-10-30T21:42:01.015135+00:00",
"date_create": "2026-10-30T21:42:01.015135+00:00",
"date_update": "2026-10-30T21:42:01.015135+00:00",
"date_closed": "2026-10-30T21:42:01.015135+00:00",
"suggested_user_id": "1c2eb410-6857-4614-b3d5-c8b12cbae324",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6102d9d9-17c3-43c3-85ae-a98640a418c9",
"db_language_id": "9d7e8a49-58a6-45e8-9da6-a624fb58274a",
"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-10-30T21:42:01.015135+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5b9d4c55-31b3-4c5e-93bf-1d535ea47e6a",
"sales_organization": {
"id": "0c8c17b2-cfd1-4ae9-91d0-3dc9cad2052d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ecd3a97-933f-453c-bb5a-0726f1ad2d55",
"db_currency_id": "b4c543d0-a19b-428e-bc9b-480b4fb22c68",
"db_language_id": "96be975d-1a40-4d1b-9437-36807056d73e",
"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-10-30T21:42:00.9973848+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b35e7ae5-93b2-4e57-90b7-70d8dc7fa242",
"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": "946f884b-0e6e-413a-9c2d-a72c4a54b81e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-30T21:42:01.015135+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "112cd42d-cbe5-44ee-84b0-4c1a035dbbb7"
},
"suggested_date_start": "2026-10-30T21:42:01.015135+00:00",
"skill_id": "7ef43632-1701-439e-8872-200855259f1b",
"skill_code": "sample string 32",
"skill": {
"id": "d79cbe18-21a6-4265-9fe8-361ea013d579",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3048ea87-3f08-4fcf-a206-a8fcfab95d24",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0c8c17b2-cfd1-4ae9-91d0-3dc9cad2052d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ecd3a97-933f-453c-bb5a-0726f1ad2d55",
"db_currency_id": "b4c543d0-a19b-428e-bc9b-480b4fb22c68",
"db_language_id": "96be975d-1a40-4d1b-9437-36807056d73e",
"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-10-30T21:42:00.9973848+00:00"
},
"modified_dateutc": "2026-10-30T21:42:01.015135+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "77e1eb6a-7d32-44bf-b168-3d79c3101d25",
"date_reported_by_company": "2026-10-30T21:42:01.015135+00:00",
"id2": 36,
"company_id": "02cb6e18-3a6c-457a-b9e4-3a0ce70e41dc",
"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": "5663f9c7-6726-4c9a-8381-25eef815c341",
"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-10-30T21:42:01.015135+00:00"
},
"work_instruction_details_id": "1b91bf88-520d-49ab-890d-a42b2adcf5a5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d77f8fae-22c3-4e31-9a8e-7634c50cc91b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "82beb55c-65e5-4213-b48c-cd7a84768994",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-30T21:42:01.015135+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": "e8fef9de-1ca8-47d2-8085-4516c75642c7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-30T21:42:01.015135+00:00"
}