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": "a99d651f-d1ea-4ccf-b505-bbbc96e5ce63",
"jobs_id": "2b05048a-4eac-46cc-90a7-6cc885b1b700",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7c734ec2-b75d-44cc-8230-718647574af5",
"_parent_id": "f5752e73-3068-414a-aef9-67ea73ba0395",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "527a7d91-ea15-44c1-856e-916ad9647b87",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d75ec1d9-89d3-4104-92e1-8b2a95ae34f7",
"_parent_id": "ee34acfe-8de9-4ffa-805a-9a6743e83901",
"root_parent_id": "a2a0f923-4804-437b-9c5d-0b4d29bc1d7d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "eb78b46a-755d-477d-9720-bf974b9ca216",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4510dba3-30ad-4967-8134-969ac2379240",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e94e7e3f-aa30-49fb-bfd5-5923994eec36",
"_parent_code": "sample string 6",
"sales_organization_id": "04b04502-41d8-4a81-b07e-571bf6f5b0b9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8ee74cfa-2776-4df6-b7e3-c7f7e5de30ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b734de4-6f52-40ca-9e45-a3665429646e",
"db_currency_id": "9d28ca12-6e86-4bab-9a65-d1794ecd8648",
"db_language_id": "5ef81d66-8af3-4a42-82b2-dcd8fbaf8e04",
"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-02-10T14:51:19.777211+00:00"
},
"modified_dateutc": "2026-02-10T14:51:19.777211+00:00"
},
"equipment_model_id": "37b1a6c2-dd5e-4389-a9a4-1a17cc91c8b9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7a236a8c-21ef-427a-9ec8-7216f82c9f55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0dacf7fb-dbdb-4b34-81da-de928a92c7b4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "91d8da86-35a5-45f2-bbc7-9b26ca6dbac0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "abbcd044-9c8f-49a6-b87c-017191d1305b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8ee74cfa-2776-4df6-b7e3-c7f7e5de30ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b734de4-6f52-40ca-9e45-a3665429646e",
"db_currency_id": "9d28ca12-6e86-4bab-9a65-d1794ecd8648",
"db_language_id": "5ef81d66-8af3-4a42-82b2-dcd8fbaf8e04",
"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-02-10T14:51:19.777211+00:00"
},
"modified_dateutc": "2026-02-10T14:51:19.777211+00:00"
},
"equipment_family_id": "aef3df28-0ffa-4773-b384-29658e4456fe",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4510dba3-30ad-4967-8134-969ac2379240",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e94e7e3f-aa30-49fb-bfd5-5923994eec36",
"_parent_code": "sample string 6",
"sales_organization_id": "04b04502-41d8-4a81-b07e-571bf6f5b0b9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8ee74cfa-2776-4df6-b7e3-c7f7e5de30ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b734de4-6f52-40ca-9e45-a3665429646e",
"db_currency_id": "9d28ca12-6e86-4bab-9a65-d1794ecd8648",
"db_language_id": "5ef81d66-8af3-4a42-82b2-dcd8fbaf8e04",
"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-02-10T14:51:19.777211+00:00"
},
"modified_dateutc": "2026-02-10T14:51:19.777211+00:00"
},
"date_in_production_since": "2026-02-10T14:51:19.777211+00:00",
"date_out_of_production_since": "2026-02-10T14:51:19.777211+00:00",
"date_end_support": "2026-02-10T14:51:19.777211+00:00",
"sales_organization_id": "6b18a659-0d2b-4b16-90b9-8d2d7ce29817",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8ee74cfa-2776-4df6-b7e3-c7f7e5de30ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b734de4-6f52-40ca-9e45-a3665429646e",
"db_currency_id": "9d28ca12-6e86-4bab-9a65-d1794ecd8648",
"db_language_id": "5ef81d66-8af3-4a42-82b2-dcd8fbaf8e04",
"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-02-10T14:51:19.777211+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-02-10T14:51:19.777211+00:00"
},
"project_status_id": "16154c0d-9fea-4687-8938-4dde1ac19d54",
"project_status_code": "sample string 10",
"project_status": {
"id": "c1cd47b8-5c03-4a37-ab8a-1ce1bace81b0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "483f59b5-4864-45dd-9fb0-6987a2b1fb78",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8ee74cfa-2776-4df6-b7e3-c7f7e5de30ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b734de4-6f52-40ca-9e45-a3665429646e",
"db_currency_id": "9d28ca12-6e86-4bab-9a65-d1794ecd8648",
"db_language_id": "5ef81d66-8af3-4a42-82b2-dcd8fbaf8e04",
"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-02-10T14:51:19.777211+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-10T14:51:19.777211+00:00"
},
"company_id": "185341c3-9ea2-4139-b579-fa14f0beae62",
"company_code": "sample string 12",
"db_address_id": "a46b42b6-9963-4fe0-b3df-89d02251078d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "314f2c55-7998-4b71-a124-7b31fc734c72",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0607c97f-6788-491b-b310-0ba9d79b0eff",
"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-02-10T14:51:19.777211+00:00",
"date_create": "2026-02-10T14:51:19.777211+00:00",
"date_update": "2026-02-10T14:51:19.777211+00:00",
"updated_by_user_id": "ce5c5705-8cf7-438f-b4f9-f9b6c4873a19",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-10T14:51:19.777211+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-02-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-10T14:51:19.777211+00:00",
"date_last_job": "2026-02-10T14:51:19.777211+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-10T14:51:19.777211+00:00",
"modified_dateutc": "2026-02-10T14:51:19.777211+00:00",
"is_mobile_installation": true
},
"job_type_id": "6cba3ade-a0a0-4c74-8b76-2fdc22052c33",
"job_type_code": "sample string 7",
"job_type": {
"id": "3ad6453b-cec5-47e2-bdb3-c6c84e446322",
"name": "sample string 2",
"sales_organization_id": "9ba1c4ee-d572-4aa9-b016-27a1036d12a7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-10T14:51:19.777211+00:00",
"code": "sample string 7"
},
"job_priority_id": "16eab9f2-b1f3-46d9-93d4-3674c909e9dc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5c384480-ec31-4bf4-9f6b-874f36ab6c02",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "72f8b82c-1726-4449-8bf0-d4d1b525dc88",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8ee74cfa-2776-4df6-b7e3-c7f7e5de30ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b734de4-6f52-40ca-9e45-a3665429646e",
"db_currency_id": "9d28ca12-6e86-4bab-9a65-d1794ecd8648",
"db_language_id": "5ef81d66-8af3-4a42-82b2-dcd8fbaf8e04",
"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-02-10T14:51:19.777211+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-10T14:51:19.777211+00:00"
},
"job_status_id": "7cdef113-ad1c-43ea-80f7-23b01f2047f5",
"job_status_code": "sample string 11",
"db_address_id": "ba4f4865-ccb9-453f-a4ed-ec2e0ce9ea83",
"contact_id": "0dfc3723-bc66-431f-9b3d-818bea1bb9fe",
"requested_by_company_id": "70402c1f-804b-4203-94ff-ce5548ba05de",
"requested_by_contact_id": "a56e000f-9214-4198-8e24-a71a340b7811",
"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-02-10T14:51:19.777211+00:00",
"due_date": "2026-02-10T14:51:19.777211+00:00",
"date_create": "2026-02-10T14:51:19.777211+00:00",
"date_update": "2026-02-10T14:51:19.777211+00:00",
"date_closed": "2026-02-10T14:51:19.777211+00:00",
"suggested_user_id": "fccf55dc-08ad-4b41-b3d2-456c2180c202",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7edac0a9-a3c7-44b2-bdb7-10dd01e40198",
"db_language_id": "f80e6bc0-3b3a-48dd-b6aa-161d17a17441",
"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-02-10T14:51:19.777211+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f22e60f3-36e9-453c-b7e0-64d8ad2f5d5e",
"sales_organization": {
"id": "8ee74cfa-2776-4df6-b7e3-c7f7e5de30ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b734de4-6f52-40ca-9e45-a3665429646e",
"db_currency_id": "9d28ca12-6e86-4bab-9a65-d1794ecd8648",
"db_language_id": "5ef81d66-8af3-4a42-82b2-dcd8fbaf8e04",
"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-02-10T14:51:19.777211+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d4c15fa4-2168-4904-90db-7728f6b9a65f",
"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": "f3fc0a17-2065-46bd-9c09-c4538cca2e95",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-10T14:51:19.777211+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0d5f36a8-2065-45d4-8130-51232fd632e6"
},
"suggested_date_start": "2026-02-10T14:51:19.777211+00:00",
"skill_id": "7eb36d04-7dd9-408f-b106-15b12563d416",
"skill_code": "sample string 32",
"skill": {
"id": "1fbd4317-20d1-43ab-a53e-75db88166564",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5af193ce-2890-46a1-88be-a628f8706d57",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8ee74cfa-2776-4df6-b7e3-c7f7e5de30ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b734de4-6f52-40ca-9e45-a3665429646e",
"db_currency_id": "9d28ca12-6e86-4bab-9a65-d1794ecd8648",
"db_language_id": "5ef81d66-8af3-4a42-82b2-dcd8fbaf8e04",
"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-02-10T14:51:19.777211+00:00"
},
"modified_dateutc": "2026-02-10T14:51:19.777211+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "59a90e04-594e-4704-b4a9-a3003797e00c",
"date_reported_by_company": "2026-02-10T14:51:19.777211+00:00",
"id2": 36,
"company_id": "11571a09-4fdc-4f0f-a4d3-b00d7f0f2b53",
"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": "82770661-e94e-49c7-a176-53814fcefc66",
"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-02-10T14:51:19.777211+00:00"
},
"work_instruction_details_id": "0f7bae6f-70b0-4ea1-a1b3-3b541fe8bbdd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "363814ed-3938-40c5-9eae-0515b1ac7ca8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d647de89-ae24-4249-9cf7-027c9cb0193c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-10T14:51:19.777211+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": "2fc7b775-db34-41c8-ad3e-fc4e50592a31",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-10T14:51:19.777211+00:00"
}