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": "9398c41d-375d-4d3e-83e4-41b0a3e2b713",
"jobs_id": "3ae6c124-625c-4c80-b228-a18f037d637b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c7e47313-0c85-4b20-93da-a3f1787fb533",
"_parent_id": "bc9f240a-9deb-41d2-8e57-9bc8343138c1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1034f4e6-1468-42a7-97de-a108f21eb348",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0c1cd7c4-db11-4cc0-b66d-c9f597dd3f27",
"_parent_id": "be429a2e-f6e7-428b-96f9-f3def04543d9",
"root_parent_id": "da6b1a30-b7b7-47e3-82d0-5718e17454e7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ec54c97e-967e-45c6-8024-7920f01c00b5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d15fa9b3-7270-4373-8c6b-dd687ef801e6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2d2416a7-6a98-4c00-9e6c-7ff38f56897f",
"_parent_code": "sample string 6",
"sales_organization_id": "c71aa21a-0ba9-4096-a278-22091b85616d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "de431657-2a7a-49fe-a567-104fa74ca5bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c07b9682-9d9c-474d-8900-090610aa1aae",
"db_currency_id": "90cd41ba-8e7d-451a-8c96-dccc3362232a",
"db_language_id": "14f3063f-35af-436d-9753-348f310e10e5",
"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-07-10T00:34:33.7267933+00:00"
},
"modified_dateutc": "2026-07-10T00:34:33.7267933+00:00"
},
"equipment_model_id": "8d0880f9-3ce2-4e71-85ab-5d27a06b9d15",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3a716acc-3043-42f1-8f12-3bfc1f476e6e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "75ab20e7-d103-4421-89f0-7a1e0a9069a2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9bcf8db0-8dd6-4e90-ad0b-2ba27d95e166",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5c61150e-3f2e-4db8-b106-25866c6ef116",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "de431657-2a7a-49fe-a567-104fa74ca5bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c07b9682-9d9c-474d-8900-090610aa1aae",
"db_currency_id": "90cd41ba-8e7d-451a-8c96-dccc3362232a",
"db_language_id": "14f3063f-35af-436d-9753-348f310e10e5",
"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-07-10T00:34:33.7267933+00:00"
},
"modified_dateutc": "2026-07-10T00:34:33.7267933+00:00"
},
"equipment_family_id": "e9ec600e-8ab6-4c29-836d-8bb418b48403",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d15fa9b3-7270-4373-8c6b-dd687ef801e6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2d2416a7-6a98-4c00-9e6c-7ff38f56897f",
"_parent_code": "sample string 6",
"sales_organization_id": "c71aa21a-0ba9-4096-a278-22091b85616d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "de431657-2a7a-49fe-a567-104fa74ca5bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c07b9682-9d9c-474d-8900-090610aa1aae",
"db_currency_id": "90cd41ba-8e7d-451a-8c96-dccc3362232a",
"db_language_id": "14f3063f-35af-436d-9753-348f310e10e5",
"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-07-10T00:34:33.7267933+00:00"
},
"modified_dateutc": "2026-07-10T00:34:33.7267933+00:00"
},
"date_in_production_since": "2026-07-10T00:34:33.7267933+00:00",
"date_out_of_production_since": "2026-07-10T00:34:33.7267933+00:00",
"date_end_support": "2026-07-10T00:34:33.7267933+00:00",
"sales_organization_id": "6699b0a0-d5b1-4d96-ba9f-91060e374f8f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "de431657-2a7a-49fe-a567-104fa74ca5bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c07b9682-9d9c-474d-8900-090610aa1aae",
"db_currency_id": "90cd41ba-8e7d-451a-8c96-dccc3362232a",
"db_language_id": "14f3063f-35af-436d-9753-348f310e10e5",
"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-07-10T00:34:33.7267933+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-07-10T00:34:33.7267933+00:00"
},
"project_status_id": "4c73f298-c60a-44aa-a0e0-6e24dbdf26b6",
"project_status_code": "sample string 10",
"project_status": {
"id": "252adce3-9e83-4e64-b2b8-c9be29e9a7eb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "02b3ea34-a67d-484a-9134-a0bcfdb5edf9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "de431657-2a7a-49fe-a567-104fa74ca5bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c07b9682-9d9c-474d-8900-090610aa1aae",
"db_currency_id": "90cd41ba-8e7d-451a-8c96-dccc3362232a",
"db_language_id": "14f3063f-35af-436d-9753-348f310e10e5",
"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-07-10T00:34:33.7267933+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-10T00:34:33.7267933+00:00"
},
"company_id": "cfcad7f3-3297-4342-a621-eeedf2d905f9",
"company_code": "sample string 12",
"db_address_id": "92aa8739-9973-4026-b4c1-ea201cd61c51",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f23aee50-85ef-4c6f-9ff7-727ff3d49ec4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d0d9de9d-3913-445e-94c4-71121696439d",
"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-07-10T00:34:33.7267933+00:00",
"date_create": "2026-07-10T00:34:33.7267933+00:00",
"date_update": "2026-07-10T00:34:33.7267933+00:00",
"updated_by_user_id": "ed86963b-58f2-493f-9eef-666bce3b7c16",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-10T00:34:33.7267933+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-07-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-10T00:34:33.7267933+00:00",
"date_last_job": "2026-07-10T00:34:33.7267933+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-10T00:34:33.7267933+00:00",
"modified_dateutc": "2026-07-10T00:34:33.7267933+00:00",
"is_mobile_installation": true
},
"job_type_id": "2fe30b83-d96d-4259-ae42-b711c8aaa05f",
"job_type_code": "sample string 7",
"job_type": {
"id": "f6448ed1-79b4-43e4-a034-9cc2314a5efc",
"name": "sample string 2",
"sales_organization_id": "5a9b487b-b88a-47ab-925d-f39cd8e9816a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-10T00:34:33.7267933+00:00",
"code": "sample string 7"
},
"job_priority_id": "4cb8aab0-963c-4392-801c-8f3abd9a3292",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9aded73e-ce1c-4628-8fc7-973f814c2eac",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9ba2b38d-8f75-40df-b171-80a74354e792",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "de431657-2a7a-49fe-a567-104fa74ca5bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c07b9682-9d9c-474d-8900-090610aa1aae",
"db_currency_id": "90cd41ba-8e7d-451a-8c96-dccc3362232a",
"db_language_id": "14f3063f-35af-436d-9753-348f310e10e5",
"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-07-10T00:34:33.7267933+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-10T00:34:33.7267933+00:00"
},
"job_status_id": "9fb71494-1464-4967-b449-742793e4a339",
"job_status_code": "sample string 11",
"db_address_id": "4c38bb06-7cdb-41b8-89f9-f5f1882de297",
"contact_id": "d06df7dd-1122-4541-8f26-0c1bec2edae0",
"requested_by_company_id": "6bd344c9-16a9-4a3b-939b-0ef54c3b8f97",
"requested_by_contact_id": "0e9e3979-3299-4aca-9233-4ae8377bd29a",
"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-07-10T00:34:33.7267933+00:00",
"due_date": "2026-07-10T00:34:33.7267933+00:00",
"date_create": "2026-07-10T00:34:33.7267933+00:00",
"date_update": "2026-07-10T00:34:33.7267933+00:00",
"date_closed": "2026-07-10T00:34:33.7267933+00:00",
"suggested_user_id": "8f829bdb-0865-4148-8b34-7202474f98d6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "03e10cbd-35f3-47bf-89ba-58feba2f0f47",
"db_language_id": "3703d211-ba90-48e9-8a5d-0b0a1141da44",
"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-07-10T00:34:33.7267933+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "43eace84-925a-4122-86f7-917ab0e9e5ee",
"sales_organization": {
"id": "de431657-2a7a-49fe-a567-104fa74ca5bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c07b9682-9d9c-474d-8900-090610aa1aae",
"db_currency_id": "90cd41ba-8e7d-451a-8c96-dccc3362232a",
"db_language_id": "14f3063f-35af-436d-9753-348f310e10e5",
"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-07-10T00:34:33.7267933+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a5d5c7f4-2ab4-406e-ab33-c9704d0d4fcd",
"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": "0cec8e4f-348c-469f-a108-73995e06ff97",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-10T00:34:33.7267933+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "bbcb6c0a-ad76-4f45-9f7b-16a20a4d112b"
},
"suggested_date_start": "2026-07-10T00:34:33.7267933+00:00",
"skill_id": "11617b52-8b5f-4868-b5a0-9dc3e72704c8",
"skill_code": "sample string 32",
"skill": {
"id": "33174939-fccc-492a-b30f-7be801c7cd22",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "63588edd-86b1-4efd-b259-6eaec6547933",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "de431657-2a7a-49fe-a567-104fa74ca5bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c07b9682-9d9c-474d-8900-090610aa1aae",
"db_currency_id": "90cd41ba-8e7d-451a-8c96-dccc3362232a",
"db_language_id": "14f3063f-35af-436d-9753-348f310e10e5",
"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-07-10T00:34:33.7267933+00:00"
},
"modified_dateutc": "2026-07-10T00:34:33.7267933+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c416ffa8-76cf-4763-bd73-5c14715cd6e6",
"date_reported_by_company": "2026-07-10T00:34:33.7267933+00:00",
"id2": 36,
"company_id": "87129ae1-9274-43e5-9dfd-9c90e73971be",
"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": "d98b3a8e-74c2-4862-8adf-d5e84ed87d11",
"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-07-10T00:34:33.7267933+00:00"
},
"work_instruction_details_id": "012df919-3e90-45bc-a544-527b17342e07",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0ee2ddbf-824c-466e-a51b-191778892251",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "df582c69-6175-4fcf-ad92-f4026b8d6426",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-10T00:34:33.7267933+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": "71ca0ff4-bcfe-42e2-85dd-38a56045d39b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-10T00:34:33.7267933+00:00"
}