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": "99006b2a-81ba-45b0-8b34-52f840c15768",
"jobs_id": "f78964e4-0a4e-4a81-bb94-2b0be654a623",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d770f495-ef1b-4238-adf9-cd448f7eba41",
"_parent_id": "95131636-1dc1-4e8a-963d-c471d5bd89ef",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d100636f-e2fe-47d4-89e1-df794f4de16c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c3397240-c12b-429c-8faa-721d0466ac8a",
"_parent_id": "1e5531a7-29a2-4e62-8ee5-e3c558133814",
"root_parent_id": "3422e739-94bf-409b-b215-4a1a780f0551",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8476e7ea-326a-4252-a64b-f16b9f3f388f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "85cf8793-7ab3-441b-9327-3610b894f919",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fdf30e0f-4ed6-4214-bd72-a4a5f5c7d933",
"_parent_code": "sample string 6",
"sales_organization_id": "06dc145b-43f8-418a-9f07-233f6828aa1a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0e015327-a939-43bd-ab93-56e2d20daa14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1516d62a-2291-4d47-8588-c3325eea74ac",
"db_currency_id": "60b5faaa-953f-4a71-8002-3105fa0725a3",
"db_language_id": "2fc4f3ce-62f1-4de8-bf8a-7de44c5903b6",
"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-22T02:18:47.4439719+00:00"
},
"modified_dateutc": "2026-07-22T02:18:47.4439719+00:00"
},
"equipment_model_id": "9375371a-7f52-44a8-94de-6f9e24a70e83",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2842dcaf-df74-42f7-90be-f93dd901df4c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e58ba3e7-bad5-4f8c-9c25-5f0ba8c99bb0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "646d661b-3ccf-4e12-903d-bc45dc7e7b64",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "78e91cf0-d6be-4835-84eb-b0fc429e5a0d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0e015327-a939-43bd-ab93-56e2d20daa14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1516d62a-2291-4d47-8588-c3325eea74ac",
"db_currency_id": "60b5faaa-953f-4a71-8002-3105fa0725a3",
"db_language_id": "2fc4f3ce-62f1-4de8-bf8a-7de44c5903b6",
"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-22T02:18:47.4439719+00:00"
},
"modified_dateutc": "2026-07-22T02:18:47.4439719+00:00"
},
"equipment_family_id": "48ead878-4bc9-43f3-8c37-3d73351442ca",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "85cf8793-7ab3-441b-9327-3610b894f919",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fdf30e0f-4ed6-4214-bd72-a4a5f5c7d933",
"_parent_code": "sample string 6",
"sales_organization_id": "06dc145b-43f8-418a-9f07-233f6828aa1a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0e015327-a939-43bd-ab93-56e2d20daa14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1516d62a-2291-4d47-8588-c3325eea74ac",
"db_currency_id": "60b5faaa-953f-4a71-8002-3105fa0725a3",
"db_language_id": "2fc4f3ce-62f1-4de8-bf8a-7de44c5903b6",
"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-22T02:18:47.4439719+00:00"
},
"modified_dateutc": "2026-07-22T02:18:47.4439719+00:00"
},
"date_in_production_since": "2026-07-22T02:18:47.4439719+00:00",
"date_out_of_production_since": "2026-07-22T02:18:47.4439719+00:00",
"date_end_support": "2026-07-22T02:18:47.4439719+00:00",
"sales_organization_id": "d40a2650-1f01-4926-815b-5670bd0cdd6f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0e015327-a939-43bd-ab93-56e2d20daa14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1516d62a-2291-4d47-8588-c3325eea74ac",
"db_currency_id": "60b5faaa-953f-4a71-8002-3105fa0725a3",
"db_language_id": "2fc4f3ce-62f1-4de8-bf8a-7de44c5903b6",
"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-22T02:18:47.4439719+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-22T02:18:47.4439719+00:00"
},
"project_status_id": "636f2663-9c8e-4ef8-8317-46296f3b15db",
"project_status_code": "sample string 10",
"project_status": {
"id": "21c8377a-fdd7-4983-b474-3fa8e7ce7c06",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "99a39c7e-a57d-4150-a6bf-5e4ddf45e21b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0e015327-a939-43bd-ab93-56e2d20daa14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1516d62a-2291-4d47-8588-c3325eea74ac",
"db_currency_id": "60b5faaa-953f-4a71-8002-3105fa0725a3",
"db_language_id": "2fc4f3ce-62f1-4de8-bf8a-7de44c5903b6",
"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-22T02:18:47.4439719+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-22T02:18:47.4439719+00:00"
},
"company_id": "56014e62-0842-4c68-a61e-a17fc80e09b1",
"company_code": "sample string 12",
"db_address_id": "f47467a7-27e7-4ecc-9ff3-21954a54b5fb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "dc38a950-0ca2-4f21-9c8e-8abe98098e24",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4ce3180a-ae5a-4dec-a7b4-e1d5787ef7d7",
"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-22T02:18:47.4439719+00:00",
"date_create": "2026-07-22T02:18:47.4439719+00:00",
"date_update": "2026-07-22T02:18:47.4439719+00:00",
"updated_by_user_id": "23356814-b13f-4859-a4e9-3ffbd53eac60",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-22T02:18:47.4439719+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-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-22T02:18:47.4439719+00:00",
"date_last_job": "2026-07-22T02:18:47.4439719+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-22T02:18:47.4439719+00:00",
"modified_dateutc": "2026-07-22T02:18:47.4439719+00:00",
"is_mobile_installation": true
},
"job_type_id": "e8499a73-668c-43af-9db3-128ceff36c49",
"job_type_code": "sample string 7",
"job_type": {
"id": "7eaf19c3-d3d7-4d1a-8511-e7f41e83992e",
"name": "sample string 2",
"sales_organization_id": "bbeff18b-c2ac-481c-abee-278c93dbab29",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-22T02:18:47.4439719+00:00",
"code": "sample string 7"
},
"job_priority_id": "fcfe9a55-07b6-46b5-96ca-d06a56b7e288",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1d1831eb-f4f7-4f45-965f-070d3ae43cd5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cb4e79fe-0582-41a5-88a0-1d6b0fa08db8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0e015327-a939-43bd-ab93-56e2d20daa14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1516d62a-2291-4d47-8588-c3325eea74ac",
"db_currency_id": "60b5faaa-953f-4a71-8002-3105fa0725a3",
"db_language_id": "2fc4f3ce-62f1-4de8-bf8a-7de44c5903b6",
"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-22T02:18:47.4439719+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-22T02:18:47.4439719+00:00"
},
"job_status_id": "9c7d41ef-d55b-4090-9d7d-7a4b3e81a336",
"job_status_code": "sample string 11",
"db_address_id": "e05b41a2-3776-4a99-92d5-b30b0c43c263",
"contact_id": "1ba7078a-589f-4ea1-9dcc-7e015cd27346",
"requested_by_company_id": "acb3abe1-f2fb-4252-bee0-20e0b519e90d",
"requested_by_contact_id": "ee57be89-dfe0-4214-9c0d-9eba79020499",
"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-22T02:18:47.4439719+00:00",
"due_date": "2026-07-22T02:18:47.4439719+00:00",
"date_create": "2026-07-22T02:18:47.4439719+00:00",
"date_update": "2026-07-22T02:18:47.4439719+00:00",
"date_closed": "2026-07-22T02:18:47.4439719+00:00",
"suggested_user_id": "e12db61d-d279-4634-bb88-159a88ceefba",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d5ee120a-696a-4eb8-b7f2-2b4531157f06",
"db_language_id": "294d5371-3571-4461-afc0-90af7b7b3806",
"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-22T02:18:47.4439719+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "62272503-83a5-471b-b665-f2839a0f1741",
"sales_organization": {
"id": "0e015327-a939-43bd-ab93-56e2d20daa14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1516d62a-2291-4d47-8588-c3325eea74ac",
"db_currency_id": "60b5faaa-953f-4a71-8002-3105fa0725a3",
"db_language_id": "2fc4f3ce-62f1-4de8-bf8a-7de44c5903b6",
"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-22T02:18:47.4439719+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5d907181-0bbf-4424-b2ab-8a655ed042b1",
"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": "3cc04d84-57dd-4a28-9921-6109353aa955",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-22T02:18:47.4439719+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "980acfd2-b716-4042-acdb-0052547892c0"
},
"suggested_date_start": "2026-07-22T02:18:47.4439719+00:00",
"skill_id": "8dd4ae57-a9e9-4fa5-927a-aba9188462ff",
"skill_code": "sample string 32",
"skill": {
"id": "4325ba62-ae66-4f8c-8b59-f06426c9a348",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2ea67b1c-b72a-4e4d-bc9b-8c8c19ae60ab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0e015327-a939-43bd-ab93-56e2d20daa14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1516d62a-2291-4d47-8588-c3325eea74ac",
"db_currency_id": "60b5faaa-953f-4a71-8002-3105fa0725a3",
"db_language_id": "2fc4f3ce-62f1-4de8-bf8a-7de44c5903b6",
"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-22T02:18:47.4439719+00:00"
},
"modified_dateutc": "2026-07-22T02:18:47.4439719+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "28daa044-4ffd-495f-8f5d-81248f825136",
"date_reported_by_company": "2026-07-22T02:18:47.4439719+00:00",
"id2": 36,
"company_id": "4bb3bd77-7a82-4789-af66-ce2e907c2ac9",
"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": "f9262d20-b1ef-498e-a36e-66379c31b5f4",
"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-22T02:18:47.4439719+00:00"
},
"work_instruction_details_id": "7ef44066-6818-4368-9880-d154f631f600",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3407693f-e49c-43a0-b2d1-f74cb27639ba",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "76a4e91d-60d0-41ce-b310-1bb932352d7b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-22T02:18:47.4439719+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": "7c996354-aa21-4946-97d9-bd56aa09ea87",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-22T02:18:47.4439719+00:00"
}