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": "5847ff8f-7c66-4ca2-be01-e409309ac18e",
"jobs_id": "63abcea8-0f8a-49af-95a3-7c0ee3ae6ada",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "379fb83a-ded9-4fd4-a1a4-29ec792bb831",
"_parent_id": "25789c20-26fb-4c76-bbad-1e0cba656541",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "08f0fd4f-ed14-4285-9def-6d1000a83226",
"project_reference_back_office": "sample string 5",
"project": {
"id": "deb15967-95cf-4218-9be5-984717e07b65",
"_parent_id": "3f6b6d37-83d3-4612-ac6e-b045eec60469",
"root_parent_id": "a5bee030-6f5d-4b02-a67e-96df2e3b776b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "abe5b690-d104-4a09-b96d-d8740ecfd463",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "23a0cad0-01c0-4de8-9d2a-2e0198374f8a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f3c16a3c-e91e-4089-ab91-871ce257e4e6",
"_parent_code": "sample string 6",
"sales_organization_id": "8103ac84-6465-4a28-9c2a-d5685d307b8e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "65a0e8e3-db13-46d4-94bf-874e95048eb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6063d8b-22d7-4d4b-baa7-401324fbc01d",
"db_currency_id": "d6e84a69-9030-4f7f-bd9f-d3c8407a6998",
"db_language_id": "c47d2437-2430-435a-8522-aef860b6815a",
"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-03-07T16:48:42.8472222+00:00"
},
"modified_dateutc": "2026-03-07T16:48:42.8472222+00:00"
},
"equipment_model_id": "533f5953-2632-4a2f-844c-0c8ffb07a119",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5aba8293-1803-49c9-af1d-90242cd574d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e8766e51-3b57-4eee-bbf2-552484ba3214",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4182f510-8b5a-40d4-99c0-72c1f2da8a83",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c36dd4b2-3751-4c3f-b18b-43717973fb50",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "65a0e8e3-db13-46d4-94bf-874e95048eb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6063d8b-22d7-4d4b-baa7-401324fbc01d",
"db_currency_id": "d6e84a69-9030-4f7f-bd9f-d3c8407a6998",
"db_language_id": "c47d2437-2430-435a-8522-aef860b6815a",
"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-03-07T16:48:42.8472222+00:00"
},
"modified_dateutc": "2026-03-07T16:48:42.8472222+00:00"
},
"equipment_family_id": "72088e54-4876-4f0a-b421-72c42ca10542",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "23a0cad0-01c0-4de8-9d2a-2e0198374f8a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f3c16a3c-e91e-4089-ab91-871ce257e4e6",
"_parent_code": "sample string 6",
"sales_organization_id": "8103ac84-6465-4a28-9c2a-d5685d307b8e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "65a0e8e3-db13-46d4-94bf-874e95048eb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6063d8b-22d7-4d4b-baa7-401324fbc01d",
"db_currency_id": "d6e84a69-9030-4f7f-bd9f-d3c8407a6998",
"db_language_id": "c47d2437-2430-435a-8522-aef860b6815a",
"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-03-07T16:48:42.8472222+00:00"
},
"modified_dateutc": "2026-03-07T16:48:42.8472222+00:00"
},
"date_in_production_since": "2026-03-07T16:48:42.8472222+00:00",
"date_out_of_production_since": "2026-03-07T16:48:42.8472222+00:00",
"date_end_support": "2026-03-07T16:48:42.8472222+00:00",
"sales_organization_id": "ba814e1c-5a5b-45ac-b4eb-2e8710f14fab",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "65a0e8e3-db13-46d4-94bf-874e95048eb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6063d8b-22d7-4d4b-baa7-401324fbc01d",
"db_currency_id": "d6e84a69-9030-4f7f-bd9f-d3c8407a6998",
"db_language_id": "c47d2437-2430-435a-8522-aef860b6815a",
"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-03-07T16:48:42.8472222+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-03-07T16:48:42.8472222+00:00"
},
"project_status_id": "8ddf4b5f-6cea-4a66-971a-9b1c4fca54d7",
"project_status_code": "sample string 10",
"project_status": {
"id": "3de62240-cc57-401a-8974-62643afeed1b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "84aac1b8-1972-4308-9181-423c902fae4a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "65a0e8e3-db13-46d4-94bf-874e95048eb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6063d8b-22d7-4d4b-baa7-401324fbc01d",
"db_currency_id": "d6e84a69-9030-4f7f-bd9f-d3c8407a6998",
"db_language_id": "c47d2437-2430-435a-8522-aef860b6815a",
"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-03-07T16:48:42.8472222+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-07T16:48:42.8472222+00:00"
},
"company_id": "13076a2a-185f-44a7-be26-9b455258c245",
"company_code": "sample string 12",
"db_address_id": "f94d0e59-3e38-4c1b-b20d-ca6fdd52da61",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "72cf749b-2341-4af5-b79f-a719836e99cf",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cb72addf-e307-4d61-9efd-ee531127398f",
"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-03-07T16:48:42.8472222+00:00",
"date_create": "2026-03-07T16:48:42.8472222+00:00",
"date_update": "2026-03-07T16:48:42.8472222+00:00",
"updated_by_user_id": "ea296678-98c4-4e16-90d9-a835ce5a45c8",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-07T16:48:42.8472222+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-03-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-07T16:48:42.8472222+00:00",
"date_last_job": "2026-03-07T16:48:42.8472222+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-07T16:48:42.8472222+00:00",
"modified_dateutc": "2026-03-07T16:48:42.8472222+00:00",
"is_mobile_installation": true
},
"job_type_id": "a3c8063f-dc64-4f2a-924a-a1cb7d9b3c19",
"job_type_code": "sample string 7",
"job_type": {
"id": "0d7b0dad-aa6f-4d12-8346-3048c3da9916",
"name": "sample string 2",
"sales_organization_id": "b55e5809-2ffb-4fa5-8e54-2b2051cc45af",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-07T16:48:42.8472222+00:00",
"code": "sample string 7"
},
"job_priority_id": "26647c55-d4c6-477e-a32d-b213b14bd0a7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8f27d92f-ca8d-4056-86de-e7085e2d4d28",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "371699ee-dba1-4405-926c-d18404ea7027",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "65a0e8e3-db13-46d4-94bf-874e95048eb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6063d8b-22d7-4d4b-baa7-401324fbc01d",
"db_currency_id": "d6e84a69-9030-4f7f-bd9f-d3c8407a6998",
"db_language_id": "c47d2437-2430-435a-8522-aef860b6815a",
"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-03-07T16:48:42.8472222+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-07T16:48:42.8472222+00:00"
},
"job_status_id": "0159cc26-d466-4a12-8c87-1f5b7f018790",
"job_status_code": "sample string 11",
"db_address_id": "e49a526b-e1d7-4ba9-8e72-d5f347ec704a",
"contact_id": "0924aea9-cc54-4d2a-9d7b-ff0cce604f96",
"requested_by_company_id": "847a539d-d7e4-40db-b169-f90f1a016d76",
"requested_by_contact_id": "5f67d683-edb0-4f62-ad32-00b6d9521585",
"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-03-07T16:48:42.8472222+00:00",
"due_date": "2026-03-07T16:48:42.8472222+00:00",
"date_create": "2026-03-07T16:48:42.8628467+00:00",
"date_update": "2026-03-07T16:48:42.8628467+00:00",
"date_closed": "2026-03-07T16:48:42.8628467+00:00",
"suggested_user_id": "a6cb6888-7242-48f9-8e5c-062a6eabe97c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "805d68c6-4067-42e9-86a6-c2e1ac922ddb",
"db_language_id": "5e3c1680-4245-41a7-a213-378162b5876e",
"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-03-07T16:48:42.8628467+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e9db1b90-385e-4bba-93e8-8cda34694aea",
"sales_organization": {
"id": "65a0e8e3-db13-46d4-94bf-874e95048eb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6063d8b-22d7-4d4b-baa7-401324fbc01d",
"db_currency_id": "d6e84a69-9030-4f7f-bd9f-d3c8407a6998",
"db_language_id": "c47d2437-2430-435a-8522-aef860b6815a",
"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-03-07T16:48:42.8472222+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0c57227c-de84-4875-a820-17d24430cac1",
"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": "b1ef3c42-1ea3-4af1-bca4-647ddc61713a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-07T16:48:42.8628467+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "66e3236e-28a7-41b2-b2d7-5aa0503e50f6"
},
"suggested_date_start": "2026-03-07T16:48:42.8628467+00:00",
"skill_id": "1d2f226d-e09a-4a88-a72b-8c7c939af469",
"skill_code": "sample string 32",
"skill": {
"id": "d9eca51d-1758-46e8-ba06-dc15e955d5f8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0368ce67-b79a-4dc4-b27b-0be32e19d575",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "65a0e8e3-db13-46d4-94bf-874e95048eb8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6063d8b-22d7-4d4b-baa7-401324fbc01d",
"db_currency_id": "d6e84a69-9030-4f7f-bd9f-d3c8407a6998",
"db_language_id": "c47d2437-2430-435a-8522-aef860b6815a",
"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-03-07T16:48:42.8472222+00:00"
},
"modified_dateutc": "2026-03-07T16:48:42.8628467+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b07d43a2-36fb-49ce-8061-713c49b3635c",
"date_reported_by_company": "2026-03-07T16:48:42.8628467+00:00",
"id2": 36,
"company_id": "21bf13d6-a16a-4bfa-b1b0-727b7af883b0",
"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": "bf3a3e1c-467a-4180-b772-2367206b8439",
"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-03-07T16:48:42.8628467+00:00"
},
"work_instruction_details_id": "a8a9419f-b824-4b15-be6c-f1b404a1792d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a06c85f1-fe06-45e8-9dda-a7978feb3aaf",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "15b16681-e735-4c82-b7c5-d1552e0b67f7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-07T16:48:42.8628467+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": "b6a22231-117a-4b89-811f-5108f5bb76f8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-07T16:48:42.8628467+00:00"
}