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": "f1069f27-010d-4707-a5df-426d95f20918",
"jobs_id": "c66cce14-4b30-43a4-85f9-f834fcb7c83f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2a0cc178-69e5-4cf2-b8a4-98c674863b71",
"_parent_id": "5b6dff7f-6d22-4693-9f0f-5856ca6fed6a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cef26337-d1c1-4bd4-9c10-150dd5e9f03c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dee8874d-1e91-4f94-9d9d-260c6d700a2f",
"_parent_id": "f0ee5946-b2d1-465a-90f2-8a7c769db32d",
"root_parent_id": "8dbd6eb0-7fcc-4c42-8a68-e111bff33c5f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "86263e07-f534-4da6-9129-ae4e6602bc77",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "eee7ba69-742a-492b-9028-438fe890b136",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2ca64f36-8550-4d96-b967-819ab2b7d163",
"_parent_code": "sample string 6",
"sales_organization_id": "a1518bec-cbb8-4097-8673-3e45a2cb4586",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0007e22c-aa98-4bd5-a2a0-c0148f7cdce9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8850d512-9479-4c93-bb59-c549fdc557c2",
"db_currency_id": "8a2eb50b-3fd0-487f-93c6-ed70c7ab8b3c",
"db_language_id": "7eb39935-8860-45d6-a8d3-d2bc8c6b4c10",
"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-07-05T09:16:34.5469048+00:00"
},
"modified_dateutc": "2025-07-05T09:16:34.5469048+00:00"
},
"equipment_model_id": "a5e588df-eafd-4eaf-a1c0-0ca2c5659269",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2a8256a6-8a9f-4e37-85e3-94dfe30ed4f8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1b8ef5fe-b762-4d65-91d2-fd07107c630d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9eea3321-3941-4cf2-8e2c-b087637a9699",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b3e0d9be-a2f4-4afe-be97-6fd6adf6e4e4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0007e22c-aa98-4bd5-a2a0-c0148f7cdce9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8850d512-9479-4c93-bb59-c549fdc557c2",
"db_currency_id": "8a2eb50b-3fd0-487f-93c6-ed70c7ab8b3c",
"db_language_id": "7eb39935-8860-45d6-a8d3-d2bc8c6b4c10",
"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-07-05T09:16:34.5469048+00:00"
},
"modified_dateutc": "2025-07-05T09:16:34.5469048+00:00"
},
"equipment_family_id": "2592210e-563e-4821-a2cb-8a24f48171e3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "eee7ba69-742a-492b-9028-438fe890b136",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2ca64f36-8550-4d96-b967-819ab2b7d163",
"_parent_code": "sample string 6",
"sales_organization_id": "a1518bec-cbb8-4097-8673-3e45a2cb4586",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0007e22c-aa98-4bd5-a2a0-c0148f7cdce9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8850d512-9479-4c93-bb59-c549fdc557c2",
"db_currency_id": "8a2eb50b-3fd0-487f-93c6-ed70c7ab8b3c",
"db_language_id": "7eb39935-8860-45d6-a8d3-d2bc8c6b4c10",
"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-07-05T09:16:34.5469048+00:00"
},
"modified_dateutc": "2025-07-05T09:16:34.5469048+00:00"
},
"date_in_production_since": "2025-07-05T09:16:34.5469048+00:00",
"date_out_of_production_since": "2025-07-05T09:16:34.5469048+00:00",
"date_end_support": "2025-07-05T09:16:34.5469048+00:00",
"sales_organization_id": "b853604e-8fa8-471e-afcd-54aa41f0aca7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0007e22c-aa98-4bd5-a2a0-c0148f7cdce9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8850d512-9479-4c93-bb59-c549fdc557c2",
"db_currency_id": "8a2eb50b-3fd0-487f-93c6-ed70c7ab8b3c",
"db_language_id": "7eb39935-8860-45d6-a8d3-d2bc8c6b4c10",
"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-07-05T09:16:34.5469048+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-07-05T09:16:34.5469048+00:00"
},
"project_status_id": "aa2affbf-69b1-4e29-aea6-fe844bdea071",
"project_status_code": "sample string 10",
"project_status": {
"id": "d3156740-d2d5-4f16-8e89-349bed4f3d74",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "28bc01a4-d738-4598-9bd3-62f069af952b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0007e22c-aa98-4bd5-a2a0-c0148f7cdce9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8850d512-9479-4c93-bb59-c549fdc557c2",
"db_currency_id": "8a2eb50b-3fd0-487f-93c6-ed70c7ab8b3c",
"db_language_id": "7eb39935-8860-45d6-a8d3-d2bc8c6b4c10",
"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-07-05T09:16:34.5469048+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-05T09:16:34.5469048+00:00"
},
"company_id": "3de0920a-ab7e-4874-873a-c947e7faad27",
"company_code": "sample string 12",
"db_address_id": "4e287597-87be-4d67-b6da-3c42e32963e8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "545237b9-1b52-466d-8e9c-7e2b4653ee8d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a252cb4d-b292-4b27-bf14-545676f90112",
"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-07-05T09:16:34.5469048+00:00",
"date_create": "2025-07-05T09:16:34.5469048+00:00",
"date_update": "2025-07-05T09:16:34.5469048+00:00",
"updated_by_user_id": "d2756f3d-871f-43fb-8f4f-6fb98f642f00",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-07-05T09:16:34.5469048+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-07-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-07-05T09:16:34.5469048+00:00",
"date_last_job": "2025-07-05T09:16:34.5469048+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-07-05T09:16:34.5469048+00:00",
"modified_dateutc": "2025-07-05T09:16:34.5469048+00:00",
"is_mobile_installation": true
},
"job_type_id": "134fa450-02d5-4ebb-97fe-d7c101214ca9",
"job_type_code": "sample string 7",
"job_type": {
"id": "8d153260-3bb2-4a82-9588-7631dc091092",
"name": "sample string 2",
"sales_organization_id": "ab5c9719-197e-4e9c-ad47-4ba6bc72ec06",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-07-05T09:16:34.5469048+00:00",
"code": "sample string 7"
},
"job_priority_id": "130801cc-2eb8-4039-bdc6-ed5f33b44607",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2b789854-bc55-49f0-8a0d-476dad4e2cab",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5afd3383-fe89-4dd5-90f6-54ada8fb3e8d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0007e22c-aa98-4bd5-a2a0-c0148f7cdce9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8850d512-9479-4c93-bb59-c549fdc557c2",
"db_currency_id": "8a2eb50b-3fd0-487f-93c6-ed70c7ab8b3c",
"db_language_id": "7eb39935-8860-45d6-a8d3-d2bc8c6b4c10",
"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-07-05T09:16:34.5469048+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-05T09:16:34.5469048+00:00"
},
"job_status_id": "a0c7373d-5125-4399-bec4-94fae86dd257",
"job_status_code": "sample string 11",
"db_address_id": "7d71e8b4-721b-4c8a-9a24-0881867cda29",
"contact_id": "17897ed4-26c3-4d20-9e83-256197bf202f",
"requested_by_company_id": "e75432aa-b3e8-40d0-b0d8-0e26c004f24a",
"requested_by_contact_id": "ff64792d-4730-46c1-aaa7-16dfcfd8bc5b",
"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-07-05T09:16:34.5469048+00:00",
"due_date": "2025-07-05T09:16:34.5469048+00:00",
"date_create": "2025-07-05T09:16:34.5469048+00:00",
"date_update": "2025-07-05T09:16:34.5469048+00:00",
"date_closed": "2025-07-05T09:16:34.5469048+00:00",
"suggested_user_id": "be46ce54-2c1a-4ab1-a6c7-d6a2bc7a5ee7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c2c012b6-7f7f-4aea-8f40-f068b787981a",
"db_language_id": "3de1be3a-eba4-4c37-9477-a7a3d46065cf",
"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-07-05T09:16:34.5469048+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "362a2d02-add5-4ac9-adfc-9fec7fb24c7f",
"sales_organization": {
"id": "0007e22c-aa98-4bd5-a2a0-c0148f7cdce9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8850d512-9479-4c93-bb59-c549fdc557c2",
"db_currency_id": "8a2eb50b-3fd0-487f-93c6-ed70c7ab8b3c",
"db_language_id": "7eb39935-8860-45d6-a8d3-d2bc8c6b4c10",
"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-07-05T09:16:34.5469048+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "144df1e5-acb9-421c-934d-ec645579a8ea",
"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": "077a3ae1-e327-4eb1-b0f9-d6f665f5a9a3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-07-05T09:16:34.6251418+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "732d16ea-f657-4b26-95bc-f27f52620716"
},
"suggested_date_start": "2025-07-05T09:16:34.6251418+00:00",
"skill_id": "c95e3ff1-a18e-4e23-b96c-9d89363ded85",
"skill_code": "sample string 32",
"skill": {
"id": "f7ef3626-2492-4c09-9248-1d39ed15412a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cc39dcd5-7da1-45e4-862c-1733f43090d2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0007e22c-aa98-4bd5-a2a0-c0148f7cdce9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8850d512-9479-4c93-bb59-c549fdc557c2",
"db_currency_id": "8a2eb50b-3fd0-487f-93c6-ed70c7ab8b3c",
"db_language_id": "7eb39935-8860-45d6-a8d3-d2bc8c6b4c10",
"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-07-05T09:16:34.5469048+00:00"
},
"modified_dateutc": "2025-07-05T09:16:34.6251418+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a2ca65ff-7499-4d1d-8cd9-48671a9ae81e",
"date_reported_by_company": "2025-07-05T09:16:34.6251418+00:00",
"id2": 36,
"company_id": "6bdbfd69-7b5a-49ff-a76c-a7a927ce99ab",
"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": "c7e5e988-8723-4b09-b309-4ed34394bd36",
"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-07-05T09:16:34.6251418+00:00"
},
"work_instruction_details_id": "5f9f0976-ddd3-40fe-83ee-93d3e2f2388a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5bcead0e-0a07-4843-9ade-47cfc6779031",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "04364afa-d97d-4b84-a92a-18b9abb7f125",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-07-05T09:16:34.6406527+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": "1a43f635-f30f-4df2-82c4-3e0eb22f4cfe",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-07-05T09:16:34.6406527+00:00"
}