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": "c73a65c9-9601-4812-a75d-453409b293a8",
"jobs_id": "2e9189e8-7412-404f-b2eb-4f2bce14c491",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ef0ff56e-62f4-41dd-81b8-ce0c61071dc3",
"_parent_id": "9a584a0d-eedb-405e-9aef-0a3e6e7e22ec",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2b72b0f5-23f2-42a2-accc-af8ac2bda18a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "bf9e9446-1c4f-4572-acf6-d894862db79e",
"_parent_id": "80b59e6e-153e-428a-a5ca-3ef1755de279",
"root_parent_id": "d6c99392-2d44-455b-bb4a-1020ecc5e21b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bb2b52a7-27f6-42ec-9f26-9f108e3d09e5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fb028822-65c4-4c7a-b19f-6eb28b72bfd8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "333f5942-655b-4264-91c0-039ebb00cbaf",
"_parent_code": "sample string 6",
"sales_organization_id": "cdae752a-ec01-476e-9d5c-19bddee0712d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a826dda1-54ed-41b6-a8a0-b4be2898b34c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b936e63-3bc4-45a7-957d-d03d4d41a713",
"db_currency_id": "5287f52a-7ed8-4495-b729-1d2f6ddecc53",
"db_language_id": "5e154219-2b41-4983-845a-b1e8676b46ae",
"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-04-09T01:48:04.4614128+00:00"
},
"modified_dateutc": "2026-04-09T01:48:04.4614128+00:00"
},
"equipment_model_id": "4957a156-641a-43c3-a223-75c6e3dd00b7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e2a9d035-fe52-47c2-8cd5-493d21b1c1f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "08cc6fc7-a59f-43ef-8388-78a2e004c068",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "54ef2530-4996-4606-a5b4-16eee306d38c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "eefceb10-a49c-4e3f-9f03-d4b5b1151ce9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a826dda1-54ed-41b6-a8a0-b4be2898b34c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b936e63-3bc4-45a7-957d-d03d4d41a713",
"db_currency_id": "5287f52a-7ed8-4495-b729-1d2f6ddecc53",
"db_language_id": "5e154219-2b41-4983-845a-b1e8676b46ae",
"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-04-09T01:48:04.4614128+00:00"
},
"modified_dateutc": "2026-04-09T01:48:04.4614128+00:00"
},
"equipment_family_id": "ebdfcb71-4cd7-41d2-8b84-b2660aa0b71a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fb028822-65c4-4c7a-b19f-6eb28b72bfd8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "333f5942-655b-4264-91c0-039ebb00cbaf",
"_parent_code": "sample string 6",
"sales_organization_id": "cdae752a-ec01-476e-9d5c-19bddee0712d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a826dda1-54ed-41b6-a8a0-b4be2898b34c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b936e63-3bc4-45a7-957d-d03d4d41a713",
"db_currency_id": "5287f52a-7ed8-4495-b729-1d2f6ddecc53",
"db_language_id": "5e154219-2b41-4983-845a-b1e8676b46ae",
"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-04-09T01:48:04.4614128+00:00"
},
"modified_dateutc": "2026-04-09T01:48:04.4614128+00:00"
},
"date_in_production_since": "2026-04-09T01:48:04.4614128+00:00",
"date_out_of_production_since": "2026-04-09T01:48:04.4614128+00:00",
"date_end_support": "2026-04-09T01:48:04.4614128+00:00",
"sales_organization_id": "cf6bd1a1-83e1-4274-bb2c-9e1d4bad5a08",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a826dda1-54ed-41b6-a8a0-b4be2898b34c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b936e63-3bc4-45a7-957d-d03d4d41a713",
"db_currency_id": "5287f52a-7ed8-4495-b729-1d2f6ddecc53",
"db_language_id": "5e154219-2b41-4983-845a-b1e8676b46ae",
"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-04-09T01:48:04.4614128+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-04-09T01:48:04.4614128+00:00"
},
"project_status_id": "a178b9cf-7471-4163-994e-97fdfcb30799",
"project_status_code": "sample string 10",
"project_status": {
"id": "dfba5ff2-d51c-4247-874b-e010084a7db7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "22cac1fb-0339-4b77-8c21-76f62b009633",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a826dda1-54ed-41b6-a8a0-b4be2898b34c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b936e63-3bc4-45a7-957d-d03d4d41a713",
"db_currency_id": "5287f52a-7ed8-4495-b729-1d2f6ddecc53",
"db_language_id": "5e154219-2b41-4983-845a-b1e8676b46ae",
"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-04-09T01:48:04.4614128+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-09T01:48:04.4614128+00:00"
},
"company_id": "134e74f6-7bec-4940-b025-d80ad73ad32d",
"company_code": "sample string 12",
"db_address_id": "7c761fac-dee8-4662-a570-871f9c8f7efb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "35b74244-0404-4e20-a9c5-e7c391766505",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0448fe92-6dc0-4015-b002-3df70a95be30",
"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-04-09T01:48:04.4614128+00:00",
"date_create": "2026-04-09T01:48:04.4614128+00:00",
"date_update": "2026-04-09T01:48:04.4614128+00:00",
"updated_by_user_id": "56b9996b-7c84-4c86-b891-2fa8689835e6",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-09T01:48:04.4614128+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-04-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-09T01:48:04.4614128+00:00",
"date_last_job": "2026-04-09T01:48:04.4614128+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-09T01:48:04.4614128+00:00",
"modified_dateutc": "2026-04-09T01:48:04.4614128+00:00",
"is_mobile_installation": true
},
"job_type_id": "17dcec30-02cf-4cda-b4e3-c77381a51fec",
"job_type_code": "sample string 7",
"job_type": {
"id": "0bdc18b3-cdeb-4fcf-abaa-3f1b5767dd92",
"name": "sample string 2",
"sales_organization_id": "b2d627f9-962f-480f-8728-d45cbc4389b7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-09T01:48:04.4614128+00:00",
"code": "sample string 7"
},
"job_priority_id": "dfc01e28-61ef-4255-8bb7-0367f8025fad",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "83810b8c-bc7c-4e8a-9040-14fe545f36a2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "90160e4a-246c-4069-9294-ce8b3a3f859a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a826dda1-54ed-41b6-a8a0-b4be2898b34c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b936e63-3bc4-45a7-957d-d03d4d41a713",
"db_currency_id": "5287f52a-7ed8-4495-b729-1d2f6ddecc53",
"db_language_id": "5e154219-2b41-4983-845a-b1e8676b46ae",
"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-04-09T01:48:04.4614128+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-09T01:48:04.4614128+00:00"
},
"job_status_id": "fe510faa-552a-410c-8502-99c543c2baf5",
"job_status_code": "sample string 11",
"db_address_id": "02d866a8-c8bc-4320-89a4-4762cc6ab53f",
"contact_id": "a92a0c15-2e2c-45c0-8de4-64abc12e422a",
"requested_by_company_id": "927c3f54-d4b6-4f39-b323-3d6950e17f7d",
"requested_by_contact_id": "67d02e55-acbe-4c05-8bed-a654bd87bb13",
"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-04-09T01:48:04.4614128+00:00",
"due_date": "2026-04-09T01:48:04.4614128+00:00",
"date_create": "2026-04-09T01:48:04.4614128+00:00",
"date_update": "2026-04-09T01:48:04.4614128+00:00",
"date_closed": "2026-04-09T01:48:04.4614128+00:00",
"suggested_user_id": "39dbbaa1-4251-4857-9ec2-6acee66a64ca",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "106282a0-46e5-40f8-b2fd-f9e4641046ab",
"db_language_id": "051c9c03-191f-4702-bd05-07d4a4da892e",
"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-04-09T01:48:04.4614128+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f08d898d-7456-4aad-ad4c-5dfe28d00897",
"sales_organization": {
"id": "a826dda1-54ed-41b6-a8a0-b4be2898b34c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b936e63-3bc4-45a7-957d-d03d4d41a713",
"db_currency_id": "5287f52a-7ed8-4495-b729-1d2f6ddecc53",
"db_language_id": "5e154219-2b41-4983-845a-b1e8676b46ae",
"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-04-09T01:48:04.4614128+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c8db8fbf-1493-4b41-809b-6935be08991d",
"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": "fae4d8b6-d400-4244-b839-b439e18ce154",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-09T01:48:04.4614128+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8bf82e28-ea31-4197-86c0-bc828e7ad2a1"
},
"suggested_date_start": "2026-04-09T01:48:04.4614128+00:00",
"skill_id": "5a8e4275-cb07-47dd-8556-a26de168aa24",
"skill_code": "sample string 32",
"skill": {
"id": "c6f6df14-a693-4480-a715-5ad3ed534778",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2b5a3c62-adae-42e0-9741-a817c5ea5c8e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a826dda1-54ed-41b6-a8a0-b4be2898b34c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b936e63-3bc4-45a7-957d-d03d4d41a713",
"db_currency_id": "5287f52a-7ed8-4495-b729-1d2f6ddecc53",
"db_language_id": "5e154219-2b41-4983-845a-b1e8676b46ae",
"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-04-09T01:48:04.4614128+00:00"
},
"modified_dateutc": "2026-04-09T01:48:04.4614128+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f67a91ac-8cd6-4f02-8c42-c0423cc1ebaf",
"date_reported_by_company": "2026-04-09T01:48:04.4614128+00:00",
"id2": 36,
"company_id": "19572b17-cbf6-449e-a145-d246b5cc6701",
"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": "ebb96350-dc80-494d-a6e4-6d304386885d",
"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-04-09T01:48:04.4614128+00:00"
},
"work_instruction_details_id": "3418d1bb-7f65-4aff-868b-0a74653f68c8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "39cf462b-a285-450d-bdc0-e7c5f101f0f8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b175a0e8-25b4-4e28-8b1e-79f540b73454",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-09T01:48:04.4614128+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": "9fa85f0f-b968-4549-8b58-005e667c5dea",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-09T01:48:04.4614128+00:00"
}