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": "ea3daa01-194e-4e33-9317-c531f4b1c9ee",
"jobs_id": "2852c81a-717f-45ee-835d-75e113775be1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2e29a730-c841-43b6-836f-5dd066566288",
"_parent_id": "af148f4d-c64b-4a3b-be94-8db6e5cef74c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7148d10f-6c47-4589-a111-e52960b5d888",
"project_reference_back_office": "sample string 5",
"project": {
"id": "144cc388-fc36-4c90-a2fe-00adde2963c2",
"_parent_id": "e12b2f6e-e7f1-4883-b7c7-ad63f3b9ae40",
"root_parent_id": "7c88563e-5bd6-418e-a6a7-e069f19b3fb9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "df2843c3-4f83-4fb9-bd80-cf4177340860",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2c52a30a-0f4f-47f8-babf-8ae6ac2f4412",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d51de3ab-0ef0-4f9f-b537-50c7ff678949",
"_parent_code": "sample string 6",
"sales_organization_id": "78674e11-a53a-4a55-8d51-bd94652c667f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "926cef64-66fa-4621-8327-e9daecb82d3a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50120703-ed8a-4fad-88cd-c29416884d8a",
"db_currency_id": "61a38e59-71ac-4f1c-b0d8-7d554fc9c8d4",
"db_language_id": "e2b037bf-a324-49ad-b251-c4819824e7bd",
"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-11T13:02:30.2508646+00:00"
},
"modified_dateutc": "2025-12-11T13:02:30.2508646+00:00"
},
"equipment_model_id": "eaf486a5-0a5d-4867-b464-7dc04a68c90f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c55c2894-f14b-4c95-b1b6-763ce32b2d68",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4f6b1839-b1b1-415a-9ee8-2d1c153b1d33",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2ae5842f-bc99-4f5a-a390-000eb7beb467",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2ca1392b-9131-4857-8453-4419897873f5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "926cef64-66fa-4621-8327-e9daecb82d3a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50120703-ed8a-4fad-88cd-c29416884d8a",
"db_currency_id": "61a38e59-71ac-4f1c-b0d8-7d554fc9c8d4",
"db_language_id": "e2b037bf-a324-49ad-b251-c4819824e7bd",
"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-11T13:02:30.2508646+00:00"
},
"modified_dateutc": "2025-12-11T13:02:30.2508646+00:00"
},
"equipment_family_id": "67217d29-6046-4fbb-b4f0-c4fcfd19fc08",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2c52a30a-0f4f-47f8-babf-8ae6ac2f4412",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d51de3ab-0ef0-4f9f-b537-50c7ff678949",
"_parent_code": "sample string 6",
"sales_organization_id": "78674e11-a53a-4a55-8d51-bd94652c667f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "926cef64-66fa-4621-8327-e9daecb82d3a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50120703-ed8a-4fad-88cd-c29416884d8a",
"db_currency_id": "61a38e59-71ac-4f1c-b0d8-7d554fc9c8d4",
"db_language_id": "e2b037bf-a324-49ad-b251-c4819824e7bd",
"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-11T13:02:30.2508646+00:00"
},
"modified_dateutc": "2025-12-11T13:02:30.2508646+00:00"
},
"date_in_production_since": "2025-12-11T13:02:30.2508646+00:00",
"date_out_of_production_since": "2025-12-11T13:02:30.2508646+00:00",
"date_end_support": "2025-12-11T13:02:30.2508646+00:00",
"sales_organization_id": "d9d5daf0-a6bb-4f94-9612-218012401c3b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "926cef64-66fa-4621-8327-e9daecb82d3a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50120703-ed8a-4fad-88cd-c29416884d8a",
"db_currency_id": "61a38e59-71ac-4f1c-b0d8-7d554fc9c8d4",
"db_language_id": "e2b037bf-a324-49ad-b251-c4819824e7bd",
"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-11T13:02:30.2508646+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-11T13:02:30.2508646+00:00"
},
"project_status_id": "cd067b39-97d8-42bb-93b5-4857c30afc75",
"project_status_code": "sample string 10",
"project_status": {
"id": "2d37bd6e-6b36-490a-b395-9177bf87ac4e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "efdf7e28-8b43-4fc5-843c-fd9214d623ac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "926cef64-66fa-4621-8327-e9daecb82d3a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50120703-ed8a-4fad-88cd-c29416884d8a",
"db_currency_id": "61a38e59-71ac-4f1c-b0d8-7d554fc9c8d4",
"db_language_id": "e2b037bf-a324-49ad-b251-c4819824e7bd",
"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-11T13:02:30.2508646+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-11T13:02:30.2508646+00:00"
},
"company_id": "1a301eaa-21c0-4f2d-954a-5349dec9a7d9",
"company_code": "sample string 12",
"db_address_id": "ba814edd-0b29-4084-90cd-6252afcc5b70",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0953f807-a878-4083-ba17-dda46bf5138a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "20b89f6d-62e5-432e-95a4-cea898577e46",
"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-11T13:02:30.2508646+00:00",
"date_create": "2025-12-11T13:02:30.2508646+00:00",
"date_update": "2025-12-11T13:02:30.2508646+00:00",
"updated_by_user_id": "689a6a8d-daca-46d6-b351-80896908d5e7",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-11T13:02:30.2508646+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-11T13:02:30.2508646+00:00",
"date_last_job": "2025-12-11T13:02:30.2508646+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-11T13:02:30.2508646+00:00",
"modified_dateutc": "2025-12-11T13:02:30.2508646+00:00",
"is_mobile_installation": true
},
"job_type_id": "2f67a995-6bf1-442f-b9b8-b084cf80e9a9",
"job_type_code": "sample string 7",
"job_type": {
"id": "8e835d3c-7c5a-4649-9542-769726fc53ec",
"name": "sample string 2",
"sales_organization_id": "fd21ba49-b4ac-42e7-ac3c-dc43922445a0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-11T13:02:30.2508646+00:00",
"code": "sample string 7"
},
"job_priority_id": "c52caec2-a7ed-4d30-8384-4c665c3ed5f7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "45dbe06d-3f4a-4baa-bd65-21370049acdc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d31c1343-740b-4631-ad43-5473d275deaa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "926cef64-66fa-4621-8327-e9daecb82d3a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50120703-ed8a-4fad-88cd-c29416884d8a",
"db_currency_id": "61a38e59-71ac-4f1c-b0d8-7d554fc9c8d4",
"db_language_id": "e2b037bf-a324-49ad-b251-c4819824e7bd",
"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-11T13:02:30.2508646+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-11T13:02:30.2508646+00:00"
},
"job_status_id": "011de5b4-4f91-4714-8bee-a6889fad2ebc",
"job_status_code": "sample string 11",
"db_address_id": "8789fdda-7d4d-4e57-ba4d-6913e57aa4f0",
"contact_id": "2cdc5d36-437e-47d1-bfbb-2099a49741be",
"requested_by_company_id": "b17f6d28-13e0-4f2d-967f-35840205d6f5",
"requested_by_contact_id": "436fae76-651b-4747-829f-576b324a78bc",
"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-11T13:02:30.2508646+00:00",
"due_date": "2025-12-11T13:02:30.2508646+00:00",
"date_create": "2025-12-11T13:02:30.2508646+00:00",
"date_update": "2025-12-11T13:02:30.2508646+00:00",
"date_closed": "2025-12-11T13:02:30.2508646+00:00",
"suggested_user_id": "d1cf7390-af24-4a20-8059-42db3ce1441b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f8e2ce01-d951-4599-8a3b-8876c33da230",
"db_language_id": "e5595bcb-4f52-4653-a12c-bf08a0534a0b",
"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-11T13:02:30.2508646+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e8545432-d39c-47c2-b7e7-3dcd769a3327",
"sales_organization": {
"id": "926cef64-66fa-4621-8327-e9daecb82d3a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50120703-ed8a-4fad-88cd-c29416884d8a",
"db_currency_id": "61a38e59-71ac-4f1c-b0d8-7d554fc9c8d4",
"db_language_id": "e2b037bf-a324-49ad-b251-c4819824e7bd",
"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-11T13:02:30.2508646+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5fe433a6-0a6e-4897-9f70-137949a20ccd",
"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": "85c40e67-81bd-4832-bb18-ab1ab96c9fa8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-11T13:02:30.2508646+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8adb4a04-97bf-4707-9cf5-d3ab6b6d6bbc"
},
"suggested_date_start": "2025-12-11T13:02:30.2508646+00:00",
"skill_id": "b193f69d-6ad8-48a8-ad6c-64197ceb7c5a",
"skill_code": "sample string 32",
"skill": {
"id": "728c9837-3d4c-4881-b052-1c47791e0777",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a16a8ccd-6297-449a-a4ac-d27b2eaef57d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "926cef64-66fa-4621-8327-e9daecb82d3a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50120703-ed8a-4fad-88cd-c29416884d8a",
"db_currency_id": "61a38e59-71ac-4f1c-b0d8-7d554fc9c8d4",
"db_language_id": "e2b037bf-a324-49ad-b251-c4819824e7bd",
"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-11T13:02:30.2508646+00:00"
},
"modified_dateutc": "2025-12-11T13:02:30.2508646+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bde2d14c-0a4f-4d8f-a41c-3324d462ae63",
"date_reported_by_company": "2025-12-11T13:02:30.2508646+00:00",
"id2": 36,
"company_id": "78961ec4-cad6-473e-b3a2-726401b0c58c",
"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": "9a25c895-12e9-4a80-9e8c-430e86abf60d",
"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-11T13:02:30.2508646+00:00"
},
"work_instruction_details_id": "c91fda7b-0386-414a-8fbd-ce7c6ef232b2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "95eb5af1-7d83-440a-be1b-9005b6137626",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6bda0f77-2cbd-4f1a-b6f9-22e477f5365f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-11T13:02:30.2508646+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": "c3912f52-8bdf-4099-8e5c-68a6718b6a92",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-11T13:02:30.2508646+00:00"
}