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": "329cf62b-674d-4d85-b227-5e5fc92dd734",
"jobs_id": "f2e94d10-6709-413f-a219-d2eee5cfa462",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "45bd3536-8e2d-4512-8c20-9710746f03a1",
"_parent_id": "feeef8c6-c6ef-47b7-adbc-893115c4312c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b7645d64-d7d1-4366-a719-1c33f4c4094f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d7493767-ab32-4a17-ad3f-5eacc4a878f8",
"_parent_id": "c1efbab9-d65f-49b8-93a7-0b8bd3ff553b",
"root_parent_id": "aceb1c73-262c-4391-9ac4-6f6d6c6fb2d2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a5315417-9004-4943-b3e0-9e396545bcfb",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "473577e8-4d8d-409d-88c6-06bbc0ad46de",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "040ec108-c00a-4cf8-92f5-565af63bb3f0",
"_parent_code": "sample string 6",
"sales_organization_id": "1a774785-9d62-4352-9b98-fe13af385f94",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "efbe4e2a-1f76-4b4f-b0c4-83d8731c9b41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0554ec1-3d2e-4c1e-8370-d534f62a176a",
"db_currency_id": "285c3e32-6348-458b-a671-845a9297f9b6",
"db_language_id": "7cf49697-457d-4c2e-ad57-a4d0b426abfd",
"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-16T02:40:07.5052585+00:00"
},
"modified_dateutc": "2026-07-16T02:40:07.5052585+00:00"
},
"equipment_model_id": "918c1b59-1b38-49b8-8e1b-4fa8b6dd7ee8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "99d611e9-eed3-4fda-b7b3-214ddb6a438f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a1e590d3-db56-4b1c-a7c0-ac27621ee03d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "daacefa8-73b7-4e36-a96a-3155720486bc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "941d36f5-ef1d-4cdb-a6f0-08f53bfc9a94",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "efbe4e2a-1f76-4b4f-b0c4-83d8731c9b41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0554ec1-3d2e-4c1e-8370-d534f62a176a",
"db_currency_id": "285c3e32-6348-458b-a671-845a9297f9b6",
"db_language_id": "7cf49697-457d-4c2e-ad57-a4d0b426abfd",
"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-16T02:40:07.5052585+00:00"
},
"modified_dateutc": "2026-07-16T02:40:07.5052585+00:00"
},
"equipment_family_id": "538be1e3-de6d-46d6-81c1-f25e49f640df",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "473577e8-4d8d-409d-88c6-06bbc0ad46de",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "040ec108-c00a-4cf8-92f5-565af63bb3f0",
"_parent_code": "sample string 6",
"sales_organization_id": "1a774785-9d62-4352-9b98-fe13af385f94",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "efbe4e2a-1f76-4b4f-b0c4-83d8731c9b41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0554ec1-3d2e-4c1e-8370-d534f62a176a",
"db_currency_id": "285c3e32-6348-458b-a671-845a9297f9b6",
"db_language_id": "7cf49697-457d-4c2e-ad57-a4d0b426abfd",
"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-16T02:40:07.5052585+00:00"
},
"modified_dateutc": "2026-07-16T02:40:07.5052585+00:00"
},
"date_in_production_since": "2026-07-16T02:40:07.5052585+00:00",
"date_out_of_production_since": "2026-07-16T02:40:07.5052585+00:00",
"date_end_support": "2026-07-16T02:40:07.5052585+00:00",
"sales_organization_id": "8004c63e-12fd-474e-a558-2d34b4008a62",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "efbe4e2a-1f76-4b4f-b0c4-83d8731c9b41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0554ec1-3d2e-4c1e-8370-d534f62a176a",
"db_currency_id": "285c3e32-6348-458b-a671-845a9297f9b6",
"db_language_id": "7cf49697-457d-4c2e-ad57-a4d0b426abfd",
"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-16T02:40:07.5052585+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-16T02:40:07.5052585+00:00"
},
"project_status_id": "82dade57-a7be-460f-a8cf-6704111503e4",
"project_status_code": "sample string 10",
"project_status": {
"id": "519e2429-3a8e-4712-92c1-063df5a67487",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f12aeb1e-d3f6-409f-9d1b-eca5548f458e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "efbe4e2a-1f76-4b4f-b0c4-83d8731c9b41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0554ec1-3d2e-4c1e-8370-d534f62a176a",
"db_currency_id": "285c3e32-6348-458b-a671-845a9297f9b6",
"db_language_id": "7cf49697-457d-4c2e-ad57-a4d0b426abfd",
"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-16T02:40:07.5052585+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-16T02:40:07.5052585+00:00"
},
"company_id": "e16320c8-b20d-495e-90bf-a08c2ea2ca4d",
"company_code": "sample string 12",
"db_address_id": "28a9e791-b456-45ba-b70d-f5a5476aedf5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "31394b64-0a4b-4029-be28-f5e3b3a8b5f1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ec960906-8601-4752-9361-30a01f8b447e",
"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-16T02:40:07.5052585+00:00",
"date_create": "2026-07-16T02:40:07.5052585+00:00",
"date_update": "2026-07-16T02:40:07.5052585+00:00",
"updated_by_user_id": "d173629c-bdc3-4f12-8dd4-958ddd0de9b9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-16T02:40:07.5052585+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-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-16T02:40:07.5052585+00:00",
"date_last_job": "2026-07-16T02:40:07.5052585+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-16T02:40:07.5052585+00:00",
"modified_dateutc": "2026-07-16T02:40:07.5052585+00:00",
"is_mobile_installation": true
},
"job_type_id": "d4d69ba7-21f0-4e74-9d50-36033c494594",
"job_type_code": "sample string 7",
"job_type": {
"id": "de0a5788-708c-43b2-bf73-a717c06140f8",
"name": "sample string 2",
"sales_organization_id": "c3e04bc4-ac8e-48f3-81f1-0de17279584c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-16T02:40:07.5052585+00:00",
"code": "sample string 7"
},
"job_priority_id": "5300ee03-468c-4ef0-94b7-cf61e61dcc50",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8383a698-2c65-4e0c-b2e4-2204e2515a32",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a266472e-c371-4279-96da-5b65547c56a0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "efbe4e2a-1f76-4b4f-b0c4-83d8731c9b41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0554ec1-3d2e-4c1e-8370-d534f62a176a",
"db_currency_id": "285c3e32-6348-458b-a671-845a9297f9b6",
"db_language_id": "7cf49697-457d-4c2e-ad57-a4d0b426abfd",
"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-16T02:40:07.5052585+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-16T02:40:07.5052585+00:00"
},
"job_status_id": "a9ed4fe4-3145-4617-bb44-6abea6c710f7",
"job_status_code": "sample string 11",
"db_address_id": "51405f56-9204-4677-a145-5b2ec0230782",
"contact_id": "68f12bb3-a552-4ccc-8418-df197d7dc164",
"requested_by_company_id": "214bade8-507d-4350-b595-ec33fe0ed27c",
"requested_by_contact_id": "e6acf3ad-2368-4712-bca2-99686cd7beb1",
"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-16T02:40:07.5052585+00:00",
"due_date": "2026-07-16T02:40:07.5052585+00:00",
"date_create": "2026-07-16T02:40:07.5052585+00:00",
"date_update": "2026-07-16T02:40:07.5052585+00:00",
"date_closed": "2026-07-16T02:40:07.5052585+00:00",
"suggested_user_id": "19d46942-10cc-4625-b586-d13ba17313fb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b60cf822-72aa-4107-bf97-43f39f4e3765",
"db_language_id": "c3a32d78-1a4b-4d72-a3a4-89c40f877ba8",
"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-16T02:40:07.5052585+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cc010de7-30d5-456f-b7d8-4deadb4d971c",
"sales_organization": {
"id": "efbe4e2a-1f76-4b4f-b0c4-83d8731c9b41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0554ec1-3d2e-4c1e-8370-d534f62a176a",
"db_currency_id": "285c3e32-6348-458b-a671-845a9297f9b6",
"db_language_id": "7cf49697-457d-4c2e-ad57-a4d0b426abfd",
"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-16T02:40:07.5052585+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d0b87fb7-3f53-46c7-aa4f-152dfb68ab85",
"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": "6ef4c5ac-e096-4589-98c7-004d1583253b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-16T02:40:07.5052585+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0dea0e29-deaf-4884-9539-32ac6c4e7592"
},
"suggested_date_start": "2026-07-16T02:40:07.5052585+00:00",
"skill_id": "284b5194-8851-4c12-8010-3092d72a9775",
"skill_code": "sample string 32",
"skill": {
"id": "917ebc2b-a6cc-4e58-bf33-eccb80c0a627",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9026ce5e-58cd-4988-8b25-65b6b01766f9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "efbe4e2a-1f76-4b4f-b0c4-83d8731c9b41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0554ec1-3d2e-4c1e-8370-d534f62a176a",
"db_currency_id": "285c3e32-6348-458b-a671-845a9297f9b6",
"db_language_id": "7cf49697-457d-4c2e-ad57-a4d0b426abfd",
"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-16T02:40:07.5052585+00:00"
},
"modified_dateutc": "2026-07-16T02:40:07.5052585+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2d2bc664-24f9-4b71-8d22-d5399c823a24",
"date_reported_by_company": "2026-07-16T02:40:07.5052585+00:00",
"id2": 36,
"company_id": "91817bea-2b94-471e-9923-430943535980",
"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": "a01c7684-423d-4aec-8025-35f4d46abe6e",
"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-16T02:40:07.5052585+00:00"
},
"work_instruction_details_id": "63a5f668-bd91-4b30-b0d1-715c96cb606e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f5ee4410-0e03-4e4f-8b4b-a36cef5590e8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "299b003f-3568-4cff-94ae-6f1a86bfdac1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-16T02:40:07.5052585+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": "fecceb8e-7646-448e-94a7-9237d67acd68",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-16T02:40:07.5052585+00:00"
}