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": "089231bd-72b1-4066-9fe3-57d0c8815319",
"jobs_id": "c6f94cad-d4da-43aa-90e5-11f5515408e8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "42bb94c8-3987-4ef5-821b-2ee195b1e00e",
"_parent_id": "ee2532d3-5289-480a-893f-3112b5f0120b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "45e47fc0-3c54-445d-9e42-da0fca943639",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d192e467-0981-477c-8002-ec7fb628ef73",
"_parent_id": "d927664a-178e-4eb5-9dc4-2026d4186a5a",
"root_parent_id": "d3ee3c06-4417-419d-aa82-1cccbfab995a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "67317760-2ff4-42da-a88d-34262e1774af",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8cccd04b-0130-45a3-9db4-c80bedf00c75",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8eb7438e-4498-4b03-880f-529150d8d73c",
"_parent_code": "sample string 6",
"sales_organization_id": "56714b51-ffa7-48cf-b0d8-2e6f2fe8b338",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e709357a-a13c-48f0-9fd3-c65963ca1d08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a14ff540-f417-4554-933f-15c2ca09fb75",
"db_currency_id": "f7e0b42e-b261-4a0e-9183-bc193b0f2062",
"db_language_id": "a37535bb-b623-4df0-af30-873c4838ae15",
"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-12-11T14:45:05.7012956+00:00"
},
"modified_dateutc": "2025-12-11T14:45:05.7012956+00:00"
},
"equipment_model_id": "c4cb13cd-c6c0-4b5f-b731-67ee7d8d3791",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5ce58ea6-b7c7-4224-8134-528e94a7f527",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c9b2ae21-de04-468e-95e2-7166bd58e01f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "32ea2a0c-347e-47e3-b32a-1f49e98afe89",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a0007cf0-8240-4268-a86a-b2355bc6471a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e709357a-a13c-48f0-9fd3-c65963ca1d08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a14ff540-f417-4554-933f-15c2ca09fb75",
"db_currency_id": "f7e0b42e-b261-4a0e-9183-bc193b0f2062",
"db_language_id": "a37535bb-b623-4df0-af30-873c4838ae15",
"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-12-11T14:45:05.7012956+00:00"
},
"modified_dateutc": "2025-12-11T14:45:05.7012956+00:00"
},
"equipment_family_id": "2eee4cab-cc64-45fc-bff0-5212b2d14d88",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8cccd04b-0130-45a3-9db4-c80bedf00c75",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8eb7438e-4498-4b03-880f-529150d8d73c",
"_parent_code": "sample string 6",
"sales_organization_id": "56714b51-ffa7-48cf-b0d8-2e6f2fe8b338",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e709357a-a13c-48f0-9fd3-c65963ca1d08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a14ff540-f417-4554-933f-15c2ca09fb75",
"db_currency_id": "f7e0b42e-b261-4a0e-9183-bc193b0f2062",
"db_language_id": "a37535bb-b623-4df0-af30-873c4838ae15",
"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-12-11T14:45:05.7012956+00:00"
},
"modified_dateutc": "2025-12-11T14:45:05.7012956+00:00"
},
"date_in_production_since": "2025-12-11T14:45:05.7012956+00:00",
"date_out_of_production_since": "2025-12-11T14:45:05.7012956+00:00",
"date_end_support": "2025-12-11T14:45:05.7012956+00:00",
"sales_organization_id": "164d9be2-afe2-444c-840d-a5ef9fd513a8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e709357a-a13c-48f0-9fd3-c65963ca1d08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a14ff540-f417-4554-933f-15c2ca09fb75",
"db_currency_id": "f7e0b42e-b261-4a0e-9183-bc193b0f2062",
"db_language_id": "a37535bb-b623-4df0-af30-873c4838ae15",
"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-12-11T14:45:05.7012956+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-12-11T14:45:05.7012956+00:00"
},
"project_status_id": "c5986899-1c40-41f0-b7d8-458d385f62a8",
"project_status_code": "sample string 10",
"project_status": {
"id": "f9b86277-378b-4298-9705-5c48869d37cb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "768fd760-1b08-48bd-adfc-bb360762784e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e709357a-a13c-48f0-9fd3-c65963ca1d08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a14ff540-f417-4554-933f-15c2ca09fb75",
"db_currency_id": "f7e0b42e-b261-4a0e-9183-bc193b0f2062",
"db_language_id": "a37535bb-b623-4df0-af30-873c4838ae15",
"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-12-11T14:45:05.7012956+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-11T14:45:05.7012956+00:00"
},
"company_id": "f4397702-f7fe-4149-9436-ac001ab9f3b7",
"company_code": "sample string 12",
"db_address_id": "8376c489-e545-4e41-88e1-7670a1ff25ed",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cf02fb5d-647b-48e7-bbab-51e7fd6db68e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f1dde5d1-b210-47c6-912d-400a82e80d73",
"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-12-11T14:45:05.7012956+00:00",
"date_create": "2025-12-11T14:45:05.7012956+00:00",
"date_update": "2025-12-11T14:45:05.7012956+00:00",
"updated_by_user_id": "e5972123-c419-4732-a955-8c8086e9d41e",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-11T14:45:05.7012956+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-12-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-11T14:45:05.7012956+00:00",
"date_last_job": "2025-12-11T14:45:05.7012956+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-11T14:45:05.7012956+00:00",
"modified_dateutc": "2025-12-11T14:45:05.7012956+00:00",
"is_mobile_installation": true
},
"job_type_id": "5182e533-d59d-42c2-8368-169174e46304",
"job_type_code": "sample string 7",
"job_type": {
"id": "b133872e-f6b8-41dd-a957-61fd480eb504",
"name": "sample string 2",
"sales_organization_id": "53c0bb00-373f-4e98-98a0-3c14259cc358",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-11T14:45:05.7169145+00:00",
"code": "sample string 7"
},
"job_priority_id": "23a65816-bd49-497b-afbc-3e0e800fdc1d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "752e5dea-fe09-439a-9671-dee7efd367c6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1edcce6c-741f-4b24-a11e-01c37e094a0e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e709357a-a13c-48f0-9fd3-c65963ca1d08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a14ff540-f417-4554-933f-15c2ca09fb75",
"db_currency_id": "f7e0b42e-b261-4a0e-9183-bc193b0f2062",
"db_language_id": "a37535bb-b623-4df0-af30-873c4838ae15",
"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-12-11T14:45:05.7012956+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-11T14:45:05.7169145+00:00"
},
"job_status_id": "6a34974d-b822-4d7d-a2ac-66882c863b08",
"job_status_code": "sample string 11",
"db_address_id": "2ac7ab10-01fd-4767-b225-b65d35cb293c",
"contact_id": "66c86d9b-1fa3-4b2e-9e7d-304020c4af76",
"requested_by_company_id": "fdd72a8c-a53f-4e49-b1e5-e6be65ab7579",
"requested_by_contact_id": "cd711da6-d928-4013-8db0-440169d8d220",
"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-12-11T14:45:05.7169145+00:00",
"due_date": "2025-12-11T14:45:05.7169145+00:00",
"date_create": "2025-12-11T14:45:05.7169145+00:00",
"date_update": "2025-12-11T14:45:05.7169145+00:00",
"date_closed": "2025-12-11T14:45:05.7169145+00:00",
"suggested_user_id": "f5690b39-bf8b-49be-916d-aed54edf16dc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "98e0b044-5039-4f5f-93ca-fdc74030b2cb",
"db_language_id": "d4cf04a1-0ae8-4049-b77c-3162c192ed37",
"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-12-11T14:45:05.7169145+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d03de503-4ba5-4e21-9c95-944d90dcbe8a",
"sales_organization": {
"id": "e709357a-a13c-48f0-9fd3-c65963ca1d08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a14ff540-f417-4554-933f-15c2ca09fb75",
"db_currency_id": "f7e0b42e-b261-4a0e-9183-bc193b0f2062",
"db_language_id": "a37535bb-b623-4df0-af30-873c4838ae15",
"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-12-11T14:45:05.7012956+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "35315852-413f-4101-8af5-f532c36f9a62",
"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": "406c4475-6fac-49f4-9e4d-c806881ecbd2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-11T14:45:05.7169145+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "37fb65da-eedc-4c49-8891-9d76777c8dbe"
},
"suggested_date_start": "2025-12-11T14:45:05.7169145+00:00",
"skill_id": "d1d5b951-e370-4a25-b2af-745700ba3912",
"skill_code": "sample string 32",
"skill": {
"id": "c922504c-0a3f-4ade-9f56-22a0f0c92a6c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9d7835a3-666e-4025-9931-cac5edeffbc3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e709357a-a13c-48f0-9fd3-c65963ca1d08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a14ff540-f417-4554-933f-15c2ca09fb75",
"db_currency_id": "f7e0b42e-b261-4a0e-9183-bc193b0f2062",
"db_language_id": "a37535bb-b623-4df0-af30-873c4838ae15",
"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-12-11T14:45:05.7012956+00:00"
},
"modified_dateutc": "2025-12-11T14:45:05.7169145+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9f13c6c1-73a0-4de7-8dba-be23a1d104ff",
"date_reported_by_company": "2025-12-11T14:45:05.7169145+00:00",
"id2": 36,
"company_id": "8c3fe473-7c98-4202-b018-0d4a0ee54c08",
"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": "2db2da8b-b8a6-4e7e-8d80-5e6fbf80fa21",
"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-12-11T14:45:05.7169145+00:00"
},
"work_instruction_details_id": "6a3115a9-b529-4d06-9377-6e3a6e683b86",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8445096c-a23e-478b-a49a-743960ec4b30",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "03b12a74-d4a9-48be-80f0-b36da67e79e8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-11T14:45:05.7169145+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": "dc9e38b2-cb6d-4815-9aa9-fcefe67ea57b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-11T14:45:05.7169145+00:00"
}