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": "0fff938b-81f0-4941-bb8e-7b82a41d091d",
"jobs_id": "4c9083e2-c181-4e12-b72f-b7d376af1821",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5afee68c-5d60-455b-837a-23b21d13f145",
"_parent_id": "fc820b1d-448c-4e05-bc55-554b6be4cea8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f7d0eb21-8255-4a87-b576-d73c4c27353d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7d99e2d2-7487-4190-aeb9-0d732647c39a",
"_parent_id": "33fd7d38-f177-47d1-b756-862d3587dbbb",
"root_parent_id": "6d7784ab-47ff-4085-8b36-a81389ff85c6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f3e86dbc-1fc1-4c68-b1a6-b727f9bb5fca",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "01db8681-f60d-4578-952e-1c52c7ac73ca",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "74d60288-9c24-4e2e-8150-635f8d4c522b",
"_parent_code": "sample string 6",
"sales_organization_id": "e95b1685-86eb-4a86-820e-9a63ebfa0934",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "60a66de4-9d8d-4954-ab64-340d47a4c6df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "984ea113-9f15-4c5c-8414-88f0961828ea",
"db_currency_id": "470e6888-bdfc-49ef-afe4-cd7143d9174c",
"db_language_id": "7dc3f904-a7ec-4eea-b69e-dcafbbe0287f",
"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-09-28T02:04:28.6522726+00:00"
},
"modified_dateutc": "2026-09-28T02:04:28.6522726+00:00"
},
"equipment_model_id": "add12d24-9564-4863-a6fd-93df784543a5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e5d697a4-0e8b-4ca2-9e91-3ad56d05f08d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "278e0da9-6049-4d91-8b5f-cb334be92d57",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b4d454df-2c9d-4ac1-9da6-5e7c79c0a0da",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "23605dd6-4bdb-4038-bd6f-e001e6832178",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "60a66de4-9d8d-4954-ab64-340d47a4c6df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "984ea113-9f15-4c5c-8414-88f0961828ea",
"db_currency_id": "470e6888-bdfc-49ef-afe4-cd7143d9174c",
"db_language_id": "7dc3f904-a7ec-4eea-b69e-dcafbbe0287f",
"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-09-28T02:04:28.6522726+00:00"
},
"modified_dateutc": "2026-09-28T02:04:28.6522726+00:00"
},
"equipment_family_id": "5e351791-5850-4023-b7d2-5f1d71331432",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "01db8681-f60d-4578-952e-1c52c7ac73ca",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "74d60288-9c24-4e2e-8150-635f8d4c522b",
"_parent_code": "sample string 6",
"sales_organization_id": "e95b1685-86eb-4a86-820e-9a63ebfa0934",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "60a66de4-9d8d-4954-ab64-340d47a4c6df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "984ea113-9f15-4c5c-8414-88f0961828ea",
"db_currency_id": "470e6888-bdfc-49ef-afe4-cd7143d9174c",
"db_language_id": "7dc3f904-a7ec-4eea-b69e-dcafbbe0287f",
"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-09-28T02:04:28.6522726+00:00"
},
"modified_dateutc": "2026-09-28T02:04:28.6522726+00:00"
},
"date_in_production_since": "2026-09-28T02:04:28.6522726+00:00",
"date_out_of_production_since": "2026-09-28T02:04:28.6522726+00:00",
"date_end_support": "2026-09-28T02:04:28.6522726+00:00",
"sales_organization_id": "b888bcd9-eb2d-4018-9b94-aab4bd72c03a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "60a66de4-9d8d-4954-ab64-340d47a4c6df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "984ea113-9f15-4c5c-8414-88f0961828ea",
"db_currency_id": "470e6888-bdfc-49ef-afe4-cd7143d9174c",
"db_language_id": "7dc3f904-a7ec-4eea-b69e-dcafbbe0287f",
"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-09-28T02:04:28.6522726+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-09-28T02:04:28.6522726+00:00"
},
"project_status_id": "8bae61bc-2c01-4faa-a9c4-4560c432e133",
"project_status_code": "sample string 10",
"project_status": {
"id": "2ea00268-dd4c-4126-967b-2f8f4a9d060a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2c0fda40-4bb3-4f94-9304-39c24c07f27b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "60a66de4-9d8d-4954-ab64-340d47a4c6df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "984ea113-9f15-4c5c-8414-88f0961828ea",
"db_currency_id": "470e6888-bdfc-49ef-afe4-cd7143d9174c",
"db_language_id": "7dc3f904-a7ec-4eea-b69e-dcafbbe0287f",
"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-09-28T02:04:28.6522726+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-28T02:04:28.6522726+00:00"
},
"company_id": "b9aaf592-89f6-4a83-8c11-13b54ad95c6e",
"company_code": "sample string 12",
"db_address_id": "9d97a760-5b34-4cc8-a0e0-eb793a924f5d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2ccc4adc-8b5e-46e4-9db0-6a8e9ca0ff26",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "993e1ce6-dc05-4ec2-852d-f0f5708ea747",
"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-09-28T02:04:28.6522726+00:00",
"date_create": "2026-09-28T02:04:28.6522726+00:00",
"date_update": "2026-09-28T02:04:28.6522726+00:00",
"updated_by_user_id": "cabe9c46-d8ec-4be9-adaa-3dc0c0e18c98",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-28T02:04:28.6522726+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-09-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-28T02:04:28.6522726+00:00",
"date_last_job": "2026-09-28T02:04:28.6522726+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-28T02:04:28.6522726+00:00",
"modified_dateutc": "2026-09-28T02:04:28.6522726+00:00",
"is_mobile_installation": true
},
"job_type_id": "970ad9eb-81ad-4b1c-8e8e-67449cec9125",
"job_type_code": "sample string 7",
"job_type": {
"id": "885c11c7-5bc0-4a6b-b2b3-cddbfd2bf712",
"name": "sample string 2",
"sales_organization_id": "e3f07e50-5de3-40f0-8065-04807d0dd6ff",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-28T02:04:28.6522726+00:00",
"code": "sample string 7"
},
"job_priority_id": "24ce4134-c680-434a-95b6-3de2aedab6c2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "656a0721-4662-4fa6-8407-8e0dd5f2b76c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "69e15b70-b404-4acc-97a0-79051b8e38a5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "60a66de4-9d8d-4954-ab64-340d47a4c6df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "984ea113-9f15-4c5c-8414-88f0961828ea",
"db_currency_id": "470e6888-bdfc-49ef-afe4-cd7143d9174c",
"db_language_id": "7dc3f904-a7ec-4eea-b69e-dcafbbe0287f",
"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-09-28T02:04:28.6522726+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-28T02:04:28.6522726+00:00"
},
"job_status_id": "694e577c-1bd5-4135-bd4c-571bf7334300",
"job_status_code": "sample string 11",
"db_address_id": "46df463f-da1e-44ab-87a1-7f0f447e6bef",
"contact_id": "ea3468dd-03a1-4342-8c14-285c680f20b9",
"requested_by_company_id": "ce26d29d-7413-468e-9ec5-daea1ec99753",
"requested_by_contact_id": "362c4fc7-82bb-4fc4-8790-8cd768df1dda",
"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-09-28T02:04:28.6522726+00:00",
"due_date": "2026-09-28T02:04:28.6522726+00:00",
"date_create": "2026-09-28T02:04:28.6522726+00:00",
"date_update": "2026-09-28T02:04:28.6522726+00:00",
"date_closed": "2026-09-28T02:04:28.6522726+00:00",
"suggested_user_id": "c6e61375-6332-484a-82ce-7ad4663c96d5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5e3c2173-8a6b-485d-a501-25288cc73d8f",
"db_language_id": "1b64931e-3963-418d-abbe-a05576ba75e1",
"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-09-28T02:04:28.6678945+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e88a9219-84b5-4f9e-9de5-58cfec97056e",
"sales_organization": {
"id": "60a66de4-9d8d-4954-ab64-340d47a4c6df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "984ea113-9f15-4c5c-8414-88f0961828ea",
"db_currency_id": "470e6888-bdfc-49ef-afe4-cd7143d9174c",
"db_language_id": "7dc3f904-a7ec-4eea-b69e-dcafbbe0287f",
"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-09-28T02:04:28.6522726+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ba58c4b4-47f9-4dc1-afa0-4610794851be",
"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": "1edeebcf-a5fd-40e7-b4c5-dd8159c1ebef",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-28T02:04:28.6678945+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7a8c0ee8-d06e-4a94-b264-2d13b1096d2e"
},
"suggested_date_start": "2026-09-28T02:04:28.6678945+00:00",
"skill_id": "f648dbf0-9836-4583-9451-41b05af62bc5",
"skill_code": "sample string 32",
"skill": {
"id": "5c773ae6-3184-405a-9a38-e9f3aa8f3c5d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ff90b109-799e-4fda-84c9-ca527cbdc159",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "60a66de4-9d8d-4954-ab64-340d47a4c6df",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "984ea113-9f15-4c5c-8414-88f0961828ea",
"db_currency_id": "470e6888-bdfc-49ef-afe4-cd7143d9174c",
"db_language_id": "7dc3f904-a7ec-4eea-b69e-dcafbbe0287f",
"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-09-28T02:04:28.6522726+00:00"
},
"modified_dateutc": "2026-09-28T02:04:28.6678945+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "14692f7b-d3be-4cdd-9891-be27bb15ff86",
"date_reported_by_company": "2026-09-28T02:04:28.6678945+00:00",
"id2": 36,
"company_id": "9f4660bb-70c9-4967-922e-f1dc81925fb5",
"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": "ab7a0bd2-5e37-4561-bae9-dbb1ba949488",
"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-09-28T02:04:28.6678945+00:00"
},
"work_instruction_details_id": "91466666-2985-4448-819e-b134b4cf9cb2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b5f52954-e76b-4070-920c-721ed2fceb96",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d013ab75-d611-4d55-90cb-59b5a0f16750",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-28T02:04:28.6678945+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": "1945c223-8763-473a-b0e1-83892a3cfc83",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-28T02:04:28.6678945+00:00"
}