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": "2463c024-fc57-40b6-b358-2aec62902602",
"jobs_id": "d4d1490f-0bcb-47a1-8f40-491408f15cb5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "93e9807a-7eb5-40c2-ada4-0d0b749c0fa1",
"_parent_id": "f1e79674-5ee9-4a70-86dd-42a4c83929fd",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "83372222-66bc-415d-a4cc-f3f0ac22d510",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a1041965-0f47-4c51-bae0-9737dc8a4bf7",
"_parent_id": "1b57c27e-1c7c-414d-9bff-e90cec3f92a7",
"root_parent_id": "f03c126e-29df-463f-aa28-d0fc81c802fb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "25287d2a-ee47-4793-8a24-58f67f07146c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "99fa3910-8373-49e7-9184-88022b805388",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "19168f62-5877-42d0-b0d7-64893e75f941",
"_parent_code": "sample string 6",
"sales_organization_id": "30ef8249-0fc5-4f42-bc51-2bb6bf3318a3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "99f921ee-3a94-4593-be61-17bc19e7cc5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a354545-ab33-404d-9bc9-526a624839a0",
"db_currency_id": "c52386a4-6513-4636-b1fa-ab2e54f87d49",
"db_language_id": "e353e8ea-99b8-45ef-b93d-9b75b64a0ad4",
"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": "2025-10-24T06:02:00.2199465+00:00"
},
"modified_dateutc": "2025-10-24T06:02:00.2199465+00:00"
},
"equipment_model_id": "7471ddfd-7686-4e10-8893-73d48d6e19c8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f379ae24-7963-4477-a5e5-15acff178c88",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a2ba95f1-eaab-4b9b-9127-74a1cc70afbb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "200ec177-6da1-4b71-97bc-122a4fb0c4d9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8b8bca87-6989-4d43-a3c2-31ee5555c3ef",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "99f921ee-3a94-4593-be61-17bc19e7cc5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a354545-ab33-404d-9bc9-526a624839a0",
"db_currency_id": "c52386a4-6513-4636-b1fa-ab2e54f87d49",
"db_language_id": "e353e8ea-99b8-45ef-b93d-9b75b64a0ad4",
"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": "2025-10-24T06:02:00.2199465+00:00"
},
"modified_dateutc": "2025-10-24T06:02:00.2199465+00:00"
},
"equipment_family_id": "d96a3455-3d8f-4564-bc43-7a37756e8b17",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "99fa3910-8373-49e7-9184-88022b805388",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "19168f62-5877-42d0-b0d7-64893e75f941",
"_parent_code": "sample string 6",
"sales_organization_id": "30ef8249-0fc5-4f42-bc51-2bb6bf3318a3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "99f921ee-3a94-4593-be61-17bc19e7cc5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a354545-ab33-404d-9bc9-526a624839a0",
"db_currency_id": "c52386a4-6513-4636-b1fa-ab2e54f87d49",
"db_language_id": "e353e8ea-99b8-45ef-b93d-9b75b64a0ad4",
"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": "2025-10-24T06:02:00.2199465+00:00"
},
"modified_dateutc": "2025-10-24T06:02:00.2199465+00:00"
},
"date_in_production_since": "2025-10-24T06:02:00.2199465+00:00",
"date_out_of_production_since": "2025-10-24T06:02:00.2199465+00:00",
"date_end_support": "2025-10-24T06:02:00.2199465+00:00",
"sales_organization_id": "71b4d69b-4690-4e9b-b5d4-0212b9b96177",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "99f921ee-3a94-4593-be61-17bc19e7cc5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a354545-ab33-404d-9bc9-526a624839a0",
"db_currency_id": "c52386a4-6513-4636-b1fa-ab2e54f87d49",
"db_language_id": "e353e8ea-99b8-45ef-b93d-9b75b64a0ad4",
"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": "2025-10-24T06:02:00.2199465+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": "2025-10-24T06:02:00.2199465+00:00"
},
"project_status_id": "35c0e4bb-2366-4fb9-a583-0e77a1b58a0d",
"project_status_code": "sample string 10",
"project_status": {
"id": "ef35f9ac-0308-4965-bacc-4b04e80db2f8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4549d682-b2fd-4a76-af24-c6c172a468d6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "99f921ee-3a94-4593-be61-17bc19e7cc5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a354545-ab33-404d-9bc9-526a624839a0",
"db_currency_id": "c52386a4-6513-4636-b1fa-ab2e54f87d49",
"db_language_id": "e353e8ea-99b8-45ef-b93d-9b75b64a0ad4",
"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": "2025-10-24T06:02:00.2199465+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-24T06:02:00.2199465+00:00"
},
"company_id": "acf76147-30c2-4322-b6a1-9f033b164521",
"company_code": "sample string 12",
"db_address_id": "11d896de-5c36-43ee-90f7-a04db5ad4a3f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "30554c99-ed71-4daa-8ffc-a56ab969a977",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "30244390-6b98-4ec0-ae51-30f72d7205f8",
"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": "2025-10-24T06:02:00.2199465+00:00",
"date_create": "2025-10-24T06:02:00.2199465+00:00",
"date_update": "2025-10-24T06:02:00.2199465+00:00",
"updated_by_user_id": "0335160a-74e1-4c77-9c76-3ef6d8ba7458",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-24T06:02:00.2199465+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": "2025-10-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-24T06:02:00.2199465+00:00",
"date_last_job": "2025-10-24T06:02:00.2199465+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-24T06:02:00.2199465+00:00",
"modified_dateutc": "2025-10-24T06:02:00.2199465+00:00",
"is_mobile_installation": true
},
"job_type_id": "1ebde05c-0288-42ef-afb9-be6b40875b1c",
"job_type_code": "sample string 7",
"job_type": {
"id": "38f65c86-852f-4f9c-bb5f-5a0ef994bc54",
"name": "sample string 2",
"sales_organization_id": "8094c7f0-23f5-4249-9cdc-0ee27022e8a0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-24T06:02:00.2199465+00:00",
"code": "sample string 7"
},
"job_priority_id": "0125c3a7-10f8-4f8b-af12-8f97f24cefe0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "52a245ea-eb4f-43c2-9c8e-580bc00211bd",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c3777a4d-59c2-4f99-858a-ea87ca3ca2e9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "99f921ee-3a94-4593-be61-17bc19e7cc5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a354545-ab33-404d-9bc9-526a624839a0",
"db_currency_id": "c52386a4-6513-4636-b1fa-ab2e54f87d49",
"db_language_id": "e353e8ea-99b8-45ef-b93d-9b75b64a0ad4",
"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": "2025-10-24T06:02:00.2199465+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-24T06:02:00.2199465+00:00"
},
"job_status_id": "d565c618-481a-4c44-bce2-f746e8dab118",
"job_status_code": "sample string 11",
"db_address_id": "a6bd12b8-195f-4e81-85e1-31cf96fe6441",
"contact_id": "25cc67f3-d982-4b9b-bb27-15ee0338c44c",
"requested_by_company_id": "02b69a74-d682-4131-ac81-fe6a14a8b02b",
"requested_by_contact_id": "817ffc0e-3fc8-4407-bae3-c00b23db07e5",
"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": "2025-10-24T06:02:00.2199465+00:00",
"due_date": "2025-10-24T06:02:00.2199465+00:00",
"date_create": "2025-10-24T06:02:00.2199465+00:00",
"date_update": "2025-10-24T06:02:00.2199465+00:00",
"date_closed": "2025-10-24T06:02:00.2199465+00:00",
"suggested_user_id": "27d312ee-6deb-44da-b705-a8863c332d67",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "580c38eb-4fc4-428d-97b0-ac5c2e13c328",
"db_language_id": "5af09ef3-7618-472f-b48f-98c5203ebfc5",
"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": "2025-10-24T06:02:00.2199465+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "af8a43d5-1139-43ad-b0a3-ce42d27d241a",
"sales_organization": {
"id": "99f921ee-3a94-4593-be61-17bc19e7cc5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a354545-ab33-404d-9bc9-526a624839a0",
"db_currency_id": "c52386a4-6513-4636-b1fa-ab2e54f87d49",
"db_language_id": "e353e8ea-99b8-45ef-b93d-9b75b64a0ad4",
"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": "2025-10-24T06:02:00.2199465+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "20471fdd-b223-428f-bdce-6337689d48a7",
"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": "7809de9a-23e5-4871-924d-ff6ffda9085e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-24T06:02:00.2199465+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4f307c39-76f7-4529-8fa4-f3067fe23f00"
},
"suggested_date_start": "2025-10-24T06:02:00.2199465+00:00",
"skill_id": "f5118061-7a11-43db-ad97-3bbb71fdcfb5",
"skill_code": "sample string 32",
"skill": {
"id": "5efc5066-a17c-4e88-a8f7-4ad3216b5ae9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "fc7f887e-c15d-4533-b13e-92b4e86c3669",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "99f921ee-3a94-4593-be61-17bc19e7cc5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9a354545-ab33-404d-9bc9-526a624839a0",
"db_currency_id": "c52386a4-6513-4636-b1fa-ab2e54f87d49",
"db_language_id": "e353e8ea-99b8-45ef-b93d-9b75b64a0ad4",
"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": "2025-10-24T06:02:00.2199465+00:00"
},
"modified_dateutc": "2025-10-24T06:02:00.2199465+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8614ce6f-0e31-492b-8031-2110bb0acf98",
"date_reported_by_company": "2025-10-24T06:02:00.2199465+00:00",
"id2": 36,
"company_id": "7cdeebea-338e-4b74-8193-e4f9d15d46eb",
"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": "4fd1b4c5-d092-4ad1-9721-2621d2d45b1e",
"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": "2025-10-24T06:02:00.2199465+00:00"
},
"work_instruction_details_id": "ef92444f-4a4f-473d-b548-ff54b270d174",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e9301b24-6944-4360-9c94-15b4fea1ce10",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c08a8f81-75b7-4a4c-90b1-9f848fec7fa5",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-24T06:02:00.2355721+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": "6ec5f286-d92d-4fd8-beb9-1d049e4b0f3d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-24T06:02:00.2355721+00:00"
}