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": "e5d563b0-1d7b-4fef-8878-dc3f57d6434e",
"jobs_id": "a7858f02-f635-41e7-bb1a-75636e1cbfd1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7b403fec-8ae9-4577-822b-2f5aa3503073",
"_parent_id": "178e2ec2-d375-4db3-8797-d530b248437f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1cbd3c84-59d8-4fbc-96d5-693c89a213b5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dff8da25-b6b3-4042-90ed-a1de3e5624d4",
"_parent_id": "e77c055d-c61d-4c70-a61b-b20cea67721c",
"root_parent_id": "6e50c905-f060-4a12-ac36-8f305cf15991",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8119a600-670b-4c90-b3f6-97da851293c0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "77698710-5c4f-47ca-ac6a-e504d5e94e11",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1c134465-67c6-47c5-a68a-09d3eddce5ec",
"_parent_code": "sample string 6",
"sales_organization_id": "73b0b6e4-a006-4b61-a09d-34516d156765",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c7caa938-7ed6-4b6f-abc9-b653c2207ce0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2bd4058a-26f9-4f4e-91d1-4ba6f0adae1c",
"db_currency_id": "4812c26c-966a-4c40-adad-3b6cf2819dfb",
"db_language_id": "5f6e6d79-625b-4ac3-9c96-e5ebceb72eb6",
"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-01-22T18:58:34.3201596+00:00"
},
"modified_dateutc": "2026-01-22T18:58:34.3201596+00:00"
},
"equipment_model_id": "fb9e6f6a-b564-43bc-a2e2-60f0a3e2547e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b28091e9-28b9-4362-b8d8-4b30d772b7a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "da5309f7-dde4-495b-b19a-92f2b7975784",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "29d9affe-e6e7-4414-b1df-a13ec64438c5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f1cdc728-17af-4925-bfb4-b8dc7e2ab9ee",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c7caa938-7ed6-4b6f-abc9-b653c2207ce0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2bd4058a-26f9-4f4e-91d1-4ba6f0adae1c",
"db_currency_id": "4812c26c-966a-4c40-adad-3b6cf2819dfb",
"db_language_id": "5f6e6d79-625b-4ac3-9c96-e5ebceb72eb6",
"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-01-22T18:58:34.3201596+00:00"
},
"modified_dateutc": "2026-01-22T18:58:34.3201596+00:00"
},
"equipment_family_id": "5c49340b-6112-428f-b953-4bc8c2848588",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "77698710-5c4f-47ca-ac6a-e504d5e94e11",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1c134465-67c6-47c5-a68a-09d3eddce5ec",
"_parent_code": "sample string 6",
"sales_organization_id": "73b0b6e4-a006-4b61-a09d-34516d156765",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c7caa938-7ed6-4b6f-abc9-b653c2207ce0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2bd4058a-26f9-4f4e-91d1-4ba6f0adae1c",
"db_currency_id": "4812c26c-966a-4c40-adad-3b6cf2819dfb",
"db_language_id": "5f6e6d79-625b-4ac3-9c96-e5ebceb72eb6",
"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-01-22T18:58:34.3201596+00:00"
},
"modified_dateutc": "2026-01-22T18:58:34.3201596+00:00"
},
"date_in_production_since": "2026-01-22T18:58:34.3201596+00:00",
"date_out_of_production_since": "2026-01-22T18:58:34.3201596+00:00",
"date_end_support": "2026-01-22T18:58:34.3201596+00:00",
"sales_organization_id": "75d8afa5-afa9-42bb-8024-8568666e5d48",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c7caa938-7ed6-4b6f-abc9-b653c2207ce0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2bd4058a-26f9-4f4e-91d1-4ba6f0adae1c",
"db_currency_id": "4812c26c-966a-4c40-adad-3b6cf2819dfb",
"db_language_id": "5f6e6d79-625b-4ac3-9c96-e5ebceb72eb6",
"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-01-22T18:58:34.3201596+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-01-22T18:58:34.3201596+00:00"
},
"project_status_id": "432dafc3-9234-4b65-8b61-9720f956a5b3",
"project_status_code": "sample string 10",
"project_status": {
"id": "44d6013a-83f1-47d8-ad85-2a1323450a36",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f501f2bf-9640-491a-9538-d91963f92f56",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c7caa938-7ed6-4b6f-abc9-b653c2207ce0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2bd4058a-26f9-4f4e-91d1-4ba6f0adae1c",
"db_currency_id": "4812c26c-966a-4c40-adad-3b6cf2819dfb",
"db_language_id": "5f6e6d79-625b-4ac3-9c96-e5ebceb72eb6",
"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-01-22T18:58:34.3201596+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-22T18:58:34.3201596+00:00"
},
"company_id": "1505728c-094f-453e-905c-100267f8c4cb",
"company_code": "sample string 12",
"db_address_id": "32bdb4e0-269d-4c83-9c8a-4887718f23fb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "79436e72-5132-4d5d-83a6-01a97877b948",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ddf59d6a-6ea5-40aa-b845-065664210bcc",
"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-01-22T18:58:34.3201596+00:00",
"date_create": "2026-01-22T18:58:34.3201596+00:00",
"date_update": "2026-01-22T18:58:34.3201596+00:00",
"updated_by_user_id": "e41b8182-0e43-4566-bca3-04519dd029d2",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-22T18:58:34.3201596+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-01-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-22T18:58:34.3201596+00:00",
"date_last_job": "2026-01-22T18:58:34.3201596+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-22T18:58:34.3201596+00:00",
"modified_dateutc": "2026-01-22T18:58:34.3201596+00:00",
"is_mobile_installation": true
},
"job_type_id": "fd053e60-0bc7-4888-ac2a-646dfdca8dc5",
"job_type_code": "sample string 7",
"job_type": {
"id": "d80a673b-eceb-44a7-a1c7-57cbb797b2ba",
"name": "sample string 2",
"sales_organization_id": "ea70d181-df0a-4a81-b992-ad8e7054ceff",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-22T18:58:34.3201596+00:00",
"code": "sample string 7"
},
"job_priority_id": "ce941085-bd02-4d3f-af98-5da6608f163b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f48b13c4-8435-420e-be1b-6c8c531b1715",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b86d42fa-6e1e-4d4c-b24f-4106f21216f8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c7caa938-7ed6-4b6f-abc9-b653c2207ce0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2bd4058a-26f9-4f4e-91d1-4ba6f0adae1c",
"db_currency_id": "4812c26c-966a-4c40-adad-3b6cf2819dfb",
"db_language_id": "5f6e6d79-625b-4ac3-9c96-e5ebceb72eb6",
"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-01-22T18:58:34.3201596+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-22T18:58:34.3201596+00:00"
},
"job_status_id": "66340325-df6b-4609-909b-42618707b895",
"job_status_code": "sample string 11",
"db_address_id": "6708a34d-2183-4d95-aa21-0e74cc2f8677",
"contact_id": "40f99478-b76b-4b15-9f5b-5e4e8723160e",
"requested_by_company_id": "1c75a7c7-f43b-4eb4-951b-684e47a00910",
"requested_by_contact_id": "2953c4a1-475e-440d-9559-a5ebc03ee508",
"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-01-22T18:58:34.3201596+00:00",
"due_date": "2026-01-22T18:58:34.3201596+00:00",
"date_create": "2026-01-22T18:58:34.3201596+00:00",
"date_update": "2026-01-22T18:58:34.3201596+00:00",
"date_closed": "2026-01-22T18:58:34.3201596+00:00",
"suggested_user_id": "08c4a182-71cd-49ca-9783-a07eac6223d2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7fb32e23-85c2-4ce2-9d69-3aa28a50cadd",
"db_language_id": "3204c1f6-e7f7-4181-9eab-d0b03b5b5b74",
"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-01-22T18:58:34.3201596+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d08489f6-d7c3-4c24-853a-149d7dc7bed1",
"sales_organization": {
"id": "c7caa938-7ed6-4b6f-abc9-b653c2207ce0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2bd4058a-26f9-4f4e-91d1-4ba6f0adae1c",
"db_currency_id": "4812c26c-966a-4c40-adad-3b6cf2819dfb",
"db_language_id": "5f6e6d79-625b-4ac3-9c96-e5ebceb72eb6",
"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-01-22T18:58:34.3201596+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f9a083b2-98be-4cfe-9385-a2cc5c7e5aee",
"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": "718058d4-fdc0-40a8-9b40-1b001ab0e5d6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-22T18:58:34.3201596+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ecf07514-f994-4b91-b55e-20713f30603d"
},
"suggested_date_start": "2026-01-22T18:58:34.3201596+00:00",
"skill_id": "929a3b6a-3098-4f55-897c-86f3c5e16263",
"skill_code": "sample string 32",
"skill": {
"id": "c23ba52d-5fcb-46d9-8c02-c96ca9c5369c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ca5edebc-26c5-4969-9794-48fe5cf5113a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c7caa938-7ed6-4b6f-abc9-b653c2207ce0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2bd4058a-26f9-4f4e-91d1-4ba6f0adae1c",
"db_currency_id": "4812c26c-966a-4c40-adad-3b6cf2819dfb",
"db_language_id": "5f6e6d79-625b-4ac3-9c96-e5ebceb72eb6",
"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-01-22T18:58:34.3201596+00:00"
},
"modified_dateutc": "2026-01-22T18:58:34.3201596+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "028559d4-a260-4367-bc04-ec4f3e2144b6",
"date_reported_by_company": "2026-01-22T18:58:34.3201596+00:00",
"id2": 36,
"company_id": "8d7d78b3-5f3f-4667-b9b4-b1981e3fc9a0",
"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": "3736a6f8-d40d-4719-aa20-b30eb810ae67",
"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-01-22T18:58:34.3201596+00:00"
},
"work_instruction_details_id": "d5ab1c32-2951-469d-9b56-83d653a07f37",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5eb54827-16cd-41f7-8504-7aa2f91d7082",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "54ab1a1f-7adc-4aef-a91e-ce9e205b72b6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-22T18:58:34.3201596+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": "9cf04e41-3abf-4ac7-b5e8-dc6aa2f5c00f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-22T18:58:34.3201596+00:00"
}