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": "e6df79f4-a3f5-4155-9515-dc1e0afcc446",
"jobs_id": "6e4ce780-4a3b-47d2-a654-3d5c59df437a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6af71a83-65bf-4558-95c0-cab7d15ee436",
"_parent_id": "7d7088fc-195a-40bd-8c90-56365874c625",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "07c3ab83-95e7-4420-a3a5-f2c77f04edb4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4c3758b4-2c2e-4a89-8d03-aaa7019de09c",
"_parent_id": "2b5fe4b6-b199-4e79-8d52-46312b1dcaa7",
"root_parent_id": "a1b4b867-5727-4d63-80db-e531836d87b8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "92532d0c-8365-43c6-b89e-cd2b048fd4f4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "94f16651-c7d0-4ce1-a2bb-e49d01aa9ed5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5017fd3a-c6e6-471e-a4ca-3f715a29cb2f",
"_parent_code": "sample string 6",
"sales_organization_id": "9c7b1dbf-b283-49c2-a6f6-311858821c67",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6345c8fb-884f-4fe4-a98d-646e68616b83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7151e04-a937-4cfd-8815-e3f227564b32",
"db_currency_id": "d02889e2-32c6-4672-89bb-f51a46cd4a34",
"db_language_id": "7a47836b-3d79-4749-92e7-0d4d20c6b6ab",
"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-05T14:35:21.5237514+00:00"
},
"modified_dateutc": "2025-12-05T14:35:21.5237514+00:00"
},
"equipment_model_id": "c4d4618a-b4ea-46fc-b260-ad2ad538d9a1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "582d0ac2-7b66-4998-952a-87d8cf9ae476",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f7215345-7bc1-4cdd-83bf-1d118a35e4ac",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fe010596-acbe-4dbd-8442-d8ca66e4be42",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "39326a10-f31c-4d64-aebf-898af110e797",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6345c8fb-884f-4fe4-a98d-646e68616b83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7151e04-a937-4cfd-8815-e3f227564b32",
"db_currency_id": "d02889e2-32c6-4672-89bb-f51a46cd4a34",
"db_language_id": "7a47836b-3d79-4749-92e7-0d4d20c6b6ab",
"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-05T14:35:21.5237514+00:00"
},
"modified_dateutc": "2025-12-05T14:35:21.5237514+00:00"
},
"equipment_family_id": "b2cab662-7ed3-487b-9e09-c28195ff050e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "94f16651-c7d0-4ce1-a2bb-e49d01aa9ed5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5017fd3a-c6e6-471e-a4ca-3f715a29cb2f",
"_parent_code": "sample string 6",
"sales_organization_id": "9c7b1dbf-b283-49c2-a6f6-311858821c67",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6345c8fb-884f-4fe4-a98d-646e68616b83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7151e04-a937-4cfd-8815-e3f227564b32",
"db_currency_id": "d02889e2-32c6-4672-89bb-f51a46cd4a34",
"db_language_id": "7a47836b-3d79-4749-92e7-0d4d20c6b6ab",
"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-05T14:35:21.5237514+00:00"
},
"modified_dateutc": "2025-12-05T14:35:21.5237514+00:00"
},
"date_in_production_since": "2025-12-05T14:35:21.5237514+00:00",
"date_out_of_production_since": "2025-12-05T14:35:21.5237514+00:00",
"date_end_support": "2025-12-05T14:35:21.5237514+00:00",
"sales_organization_id": "bf2b7ca5-34b8-4088-a122-abd519a635dd",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6345c8fb-884f-4fe4-a98d-646e68616b83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7151e04-a937-4cfd-8815-e3f227564b32",
"db_currency_id": "d02889e2-32c6-4672-89bb-f51a46cd4a34",
"db_language_id": "7a47836b-3d79-4749-92e7-0d4d20c6b6ab",
"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-05T14:35:21.5237514+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-05T14:35:21.5237514+00:00"
},
"project_status_id": "a8c07f40-f343-42c8-a749-2622198cb967",
"project_status_code": "sample string 10",
"project_status": {
"id": "f6234ae8-7320-432d-9dca-91fd7b94a1d3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "762ee557-3f94-4857-8ce7-ead2f3f7a677",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6345c8fb-884f-4fe4-a98d-646e68616b83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7151e04-a937-4cfd-8815-e3f227564b32",
"db_currency_id": "d02889e2-32c6-4672-89bb-f51a46cd4a34",
"db_language_id": "7a47836b-3d79-4749-92e7-0d4d20c6b6ab",
"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-05T14:35:21.5237514+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-05T14:35:21.5237514+00:00"
},
"company_id": "9c19c288-c3c2-4fd3-b336-1599bd3411b7",
"company_code": "sample string 12",
"db_address_id": "c52dd6e7-0072-4a95-91bd-6640a68e2dd2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "42d7c6c3-37a7-4ddd-92de-56d8e17a6881",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "10777b6d-7154-4885-9ae0-cddf8c108872",
"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-05T14:35:21.5237514+00:00",
"date_create": "2025-12-05T14:35:21.5237514+00:00",
"date_update": "2025-12-05T14:35:21.5237514+00:00",
"updated_by_user_id": "591429d8-6e51-421a-85dd-05e5bce1ca63",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-05T14:35:21.5237514+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-05T14:35:21.5237514+00:00",
"date_last_job": "2025-12-05T14:35:21.5237514+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-05T14:35:21.5237514+00:00",
"modified_dateutc": "2025-12-05T14:35:21.5237514+00:00",
"is_mobile_installation": true
},
"job_type_id": "8d524eab-81c6-45ef-a704-3c431913c8ed",
"job_type_code": "sample string 7",
"job_type": {
"id": "ce6de2b4-8acc-4993-8d35-ff008d23ec96",
"name": "sample string 2",
"sales_organization_id": "90727c48-767e-4481-8d40-d94b64c3270e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-05T14:35:21.5237514+00:00",
"code": "sample string 7"
},
"job_priority_id": "d513ded6-2132-4a10-9938-9cfe88be0b95",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "79bc8319-5146-4d1b-ac5d-411c43634ad4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1172f887-a527-4114-b209-9d88cecd8903",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6345c8fb-884f-4fe4-a98d-646e68616b83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7151e04-a937-4cfd-8815-e3f227564b32",
"db_currency_id": "d02889e2-32c6-4672-89bb-f51a46cd4a34",
"db_language_id": "7a47836b-3d79-4749-92e7-0d4d20c6b6ab",
"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-05T14:35:21.5237514+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-05T14:35:21.5237514+00:00"
},
"job_status_id": "9103f750-92bf-4420-8d1d-48216bae122d",
"job_status_code": "sample string 11",
"db_address_id": "c2658134-cedb-4de8-9d40-08ac879477c4",
"contact_id": "12e8787d-13c8-44b5-9c04-a112335a539d",
"requested_by_company_id": "87ea2496-70d6-48a6-818d-67724c22c08a",
"requested_by_contact_id": "da3ee221-0ce1-4bc3-829b-a499fd17192d",
"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-05T14:35:21.5237514+00:00",
"due_date": "2025-12-05T14:35:21.5237514+00:00",
"date_create": "2025-12-05T14:35:21.5237514+00:00",
"date_update": "2025-12-05T14:35:21.5237514+00:00",
"date_closed": "2025-12-05T14:35:21.5237514+00:00",
"suggested_user_id": "0b3537de-fc24-47d1-97c0-5fe8eb8a07e2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9eb6f13e-f2b3-4d56-b3b2-daea3f173f15",
"db_language_id": "e25a5690-a4c6-4ca8-99b4-8c36a40a102c",
"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-05T14:35:21.5237514+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a931056f-2c55-419f-bab7-68b6bfb338ec",
"sales_organization": {
"id": "6345c8fb-884f-4fe4-a98d-646e68616b83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7151e04-a937-4cfd-8815-e3f227564b32",
"db_currency_id": "d02889e2-32c6-4672-89bb-f51a46cd4a34",
"db_language_id": "7a47836b-3d79-4749-92e7-0d4d20c6b6ab",
"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-05T14:35:21.5237514+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "401ca627-aa28-43ee-80ed-9330772db356",
"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": "6e5f4ba0-e040-4821-b0a0-ec4c1a3ad12e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-05T14:35:21.5237514+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "632e0e77-32a8-44d6-aebd-a8c48277e43f"
},
"suggested_date_start": "2025-12-05T14:35:21.5237514+00:00",
"skill_id": "956f22b5-439c-4e3f-99b5-81795a943eea",
"skill_code": "sample string 32",
"skill": {
"id": "a2333475-fdf3-45b3-9eeb-026f134399e2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "932c68f1-be6a-4408-aa17-51af1a4e451e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6345c8fb-884f-4fe4-a98d-646e68616b83",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7151e04-a937-4cfd-8815-e3f227564b32",
"db_currency_id": "d02889e2-32c6-4672-89bb-f51a46cd4a34",
"db_language_id": "7a47836b-3d79-4749-92e7-0d4d20c6b6ab",
"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-05T14:35:21.5237514+00:00"
},
"modified_dateutc": "2025-12-05T14:35:21.5237514+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "482c0152-a84e-4084-b218-e0cd8471d14f",
"date_reported_by_company": "2025-12-05T14:35:21.5237514+00:00",
"id2": 36,
"company_id": "e7ba4590-ca4f-4e68-ab8a-c04bae63bcf0",
"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": "0b09e34e-89b1-4e85-86ec-48594041dfb0",
"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-05T14:35:21.5237514+00:00"
},
"work_instruction_details_id": "b1f6f777-fc48-4410-b53c-25a7741aa531",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3f585c55-3b7e-42c3-bd27-55d936ee40e5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "92172b3f-7db8-420e-9753-e8784a65ea33",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-05T14:35:21.5237514+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": "fca14ccd-8ea6-470a-8de7-3d58bd837fef",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-05T14:35:21.5237514+00:00"
}