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": "528659b6-ee2d-46b3-9590-5ae8ce124074",
"jobs_id": "69123ec3-ad6a-40f6-821f-98ff4a405cae",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "44bba502-b067-4f91-b0c0-fad75263abc2",
"_parent_id": "e4afd5bb-e375-4fb7-af23-dcb1aa643c15",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b97ff001-4703-4694-88f1-95141b90786e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c1fd1481-d689-4c1b-a31c-3c3cbd5a994a",
"_parent_id": "a95afd5e-fd23-4a3a-b654-4173a1fd8656",
"root_parent_id": "6f472b0c-cfa2-4b3d-a52c-0329a0c1bc1b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "dfddce1e-d6e5-475b-9f6a-70b626361329",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "19537501-77c1-45dd-912c-6810624e16a8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2c9327a0-9190-4f1a-8fc0-ff6064494dc4",
"_parent_code": "sample string 6",
"sales_organization_id": "e397b2f8-51e1-46c0-9b09-cc52d32e4c0a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "513f2bed-1ada-4e7b-b06e-4237e55f7bdf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4f3ebe1-aea7-4451-9355-6d64eb85154a",
"db_currency_id": "41919af9-bef2-43ba-857a-96b733abc93c",
"db_language_id": "1b59d446-8327-48c0-99a9-bce5dc6212ba",
"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-08-09T10:09:14.9466084+00:00"
},
"modified_dateutc": "2026-08-09T10:09:14.9466084+00:00"
},
"equipment_model_id": "68e84391-18df-493e-97e4-6b2437d081b3",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4dbdbfe0-7a56-49b5-ac3d-88ac9e9c8ebf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1199168e-7332-4b0c-87db-b1358a99a641",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "01a70c30-9764-4640-8014-5284e2383a0c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cecb4d18-a454-4b18-b089-286fd4d7f7fc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "513f2bed-1ada-4e7b-b06e-4237e55f7bdf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4f3ebe1-aea7-4451-9355-6d64eb85154a",
"db_currency_id": "41919af9-bef2-43ba-857a-96b733abc93c",
"db_language_id": "1b59d446-8327-48c0-99a9-bce5dc6212ba",
"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-08-09T10:09:14.9466084+00:00"
},
"modified_dateutc": "2026-08-09T10:09:14.9466084+00:00"
},
"equipment_family_id": "2d868933-5c66-462b-9e8d-5ae54763960a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "19537501-77c1-45dd-912c-6810624e16a8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2c9327a0-9190-4f1a-8fc0-ff6064494dc4",
"_parent_code": "sample string 6",
"sales_organization_id": "e397b2f8-51e1-46c0-9b09-cc52d32e4c0a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "513f2bed-1ada-4e7b-b06e-4237e55f7bdf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4f3ebe1-aea7-4451-9355-6d64eb85154a",
"db_currency_id": "41919af9-bef2-43ba-857a-96b733abc93c",
"db_language_id": "1b59d446-8327-48c0-99a9-bce5dc6212ba",
"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-08-09T10:09:14.9466084+00:00"
},
"modified_dateutc": "2026-08-09T10:09:14.9466084+00:00"
},
"date_in_production_since": "2026-08-09T10:09:14.9466084+00:00",
"date_out_of_production_since": "2026-08-09T10:09:14.9466084+00:00",
"date_end_support": "2026-08-09T10:09:14.9466084+00:00",
"sales_organization_id": "06fdfd1d-ebc0-46b3-bc5b-771a3c128abe",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "513f2bed-1ada-4e7b-b06e-4237e55f7bdf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4f3ebe1-aea7-4451-9355-6d64eb85154a",
"db_currency_id": "41919af9-bef2-43ba-857a-96b733abc93c",
"db_language_id": "1b59d446-8327-48c0-99a9-bce5dc6212ba",
"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-08-09T10:09:14.9466084+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-08-09T10:09:14.9466084+00:00"
},
"project_status_id": "5e7e1314-8dbb-4142-9951-8015d6e380ea",
"project_status_code": "sample string 10",
"project_status": {
"id": "62808871-6214-411f-a4db-8b3140e0b3cf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f53a3f67-ad33-4973-b049-e0327c22ee1b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "513f2bed-1ada-4e7b-b06e-4237e55f7bdf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4f3ebe1-aea7-4451-9355-6d64eb85154a",
"db_currency_id": "41919af9-bef2-43ba-857a-96b733abc93c",
"db_language_id": "1b59d446-8327-48c0-99a9-bce5dc6212ba",
"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-08-09T10:09:14.9466084+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-09T10:09:14.9466084+00:00"
},
"company_id": "fecb557d-9d0c-46df-8638-541df64efe02",
"company_code": "sample string 12",
"db_address_id": "a84799a1-9179-4b61-be0f-d8e4bca1ecb5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "48e2733b-2f7c-4062-9406-ab5d65f113af",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6be3eca8-1c09-467f-8c78-2746165a7225",
"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-08-09T10:09:14.9466084+00:00",
"date_create": "2026-08-09T10:09:14.9466084+00:00",
"date_update": "2026-08-09T10:09:14.9466084+00:00",
"updated_by_user_id": "31032c1b-c4dc-4d28-b6b3-c27aeff1071e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-09T10:09:14.9466084+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-08-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-09T10:09:14.9466084+00:00",
"date_last_job": "2026-08-09T10:09:14.9466084+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-09T10:09:14.9466084+00:00",
"modified_dateutc": "2026-08-09T10:09:14.9466084+00:00",
"is_mobile_installation": true
},
"job_type_id": "2bef2eec-ade1-4035-8b85-5769c4484659",
"job_type_code": "sample string 7",
"job_type": {
"id": "4c43246a-bc73-4d8a-a962-3a1e1eda1343",
"name": "sample string 2",
"sales_organization_id": "3137c6ff-a1e1-4f20-b035-eb262ba37608",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-09T10:09:14.9466084+00:00",
"code": "sample string 7"
},
"job_priority_id": "37cc60b4-18d6-4eee-9d1e-8cee4a290602",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "05532d3c-c0ee-4919-a371-f2abb280cd6b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2b81cbe8-cc28-4b53-b321-f9d2caa3a9a5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "513f2bed-1ada-4e7b-b06e-4237e55f7bdf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4f3ebe1-aea7-4451-9355-6d64eb85154a",
"db_currency_id": "41919af9-bef2-43ba-857a-96b733abc93c",
"db_language_id": "1b59d446-8327-48c0-99a9-bce5dc6212ba",
"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-08-09T10:09:14.9466084+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-09T10:09:14.9466084+00:00"
},
"job_status_id": "4eaaa14c-ab5f-440c-84ec-9b8e30c2c9f9",
"job_status_code": "sample string 11",
"db_address_id": "8baacc0d-c676-4136-b131-c4a769ba5976",
"contact_id": "b5490f6a-f53b-4920-8f85-e469e9c9a7a7",
"requested_by_company_id": "90ff5ebb-04ce-444d-904a-f96ba13758a1",
"requested_by_contact_id": "4724869b-2c00-4797-8e7c-32889b54089f",
"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-08-09T10:09:14.9466084+00:00",
"due_date": "2026-08-09T10:09:14.9466084+00:00",
"date_create": "2026-08-09T10:09:14.9466084+00:00",
"date_update": "2026-08-09T10:09:14.9466084+00:00",
"date_closed": "2026-08-09T10:09:14.9466084+00:00",
"suggested_user_id": "0283ccb5-2b49-408f-b785-c04c2327613a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c63af2aa-970d-4c16-a3e3-38666a05d30d",
"db_language_id": "1bfbe840-0800-4681-9277-c47d4e941517",
"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-08-09T10:09:14.9466084+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ee4532a9-219f-4204-8dcf-3b59607162a7",
"sales_organization": {
"id": "513f2bed-1ada-4e7b-b06e-4237e55f7bdf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4f3ebe1-aea7-4451-9355-6d64eb85154a",
"db_currency_id": "41919af9-bef2-43ba-857a-96b733abc93c",
"db_language_id": "1b59d446-8327-48c0-99a9-bce5dc6212ba",
"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-08-09T10:09:14.9466084+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8b56b331-55ba-4001-a70b-37cf60275e4d",
"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": "0aaa14fd-07c6-4dae-be4b-76e0eb3b3b71",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-09T10:09:14.9466084+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "46606ca1-f386-476d-b489-b5528eaa610b"
},
"suggested_date_start": "2026-08-09T10:09:14.9466084+00:00",
"skill_id": "ac90ae77-4244-4f93-8ff7-96e9f9c4744c",
"skill_code": "sample string 32",
"skill": {
"id": "ec78cf8a-0137-4155-87ac-cc324ff0f59c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "eae46f70-1d03-4fa7-9968-80b7071bb0c9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "513f2bed-1ada-4e7b-b06e-4237e55f7bdf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4f3ebe1-aea7-4451-9355-6d64eb85154a",
"db_currency_id": "41919af9-bef2-43ba-857a-96b733abc93c",
"db_language_id": "1b59d446-8327-48c0-99a9-bce5dc6212ba",
"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-08-09T10:09:14.9466084+00:00"
},
"modified_dateutc": "2026-08-09T10:09:14.9466084+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5bc65069-0fb5-46b3-a2c3-703828eea3e0",
"date_reported_by_company": "2026-08-09T10:09:14.9466084+00:00",
"id2": 36,
"company_id": "36a53d20-0c8b-483c-b1a0-254b99749d3d",
"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": "706fbf59-d337-423d-aec9-9f73cc30cc51",
"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-08-09T10:09:14.9466084+00:00"
},
"work_instruction_details_id": "3dfb0345-e2e5-4000-84a2-d2769bf52fb7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d34c2dc6-b07b-42a0-911b-4fb04a531a0f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d6afbfc2-02e0-4160-833d-e6f3d53113f4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-09T10:09:14.9466084+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": "7ee62d3a-1020-4742-b5c1-ecdfe2cdcef2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-09T10:09:14.9466084+00:00"
}