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": "c70ac0be-e838-40f1-986a-9ca31fbd1b40",
"jobs_id": "a15e1f8c-d7af-4302-9bcb-196e556fe1d6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "dc368782-1f56-4969-b186-3291614a4297",
"_parent_id": "68a22b2b-f72d-4269-889b-51b913f945f7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c3e42269-1544-465e-8c28-409933570fd3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "78676318-1eee-4d7c-af9b-d71d787f82b1",
"_parent_id": "1ba52d1f-ffc7-4607-aeb1-ce9915794024",
"root_parent_id": "d87456c4-e45a-4a67-8d6c-b33acd3aa639",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "846bd135-dafe-4e9f-8f45-51ea42124d73",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3cc1badd-c49b-4f38-a810-8b395069123d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "03dad283-d58c-417a-a58b-db853551b51f",
"_parent_code": "sample string 6",
"sales_organization_id": "db48692e-de94-4e7f-8528-73da51bdd4ee",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a2e9154f-4f5e-4397-9de0-498329ed8109",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "60bc7186-bdb9-4d95-bb9e-a195b72b22ae",
"db_currency_id": "da54c601-ec03-4a2b-8032-53ac9bc9c5eb",
"db_language_id": "12380905-e78d-46c6-8bb8-be2196678df7",
"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-08-06T10:10:24.4076481+00:00"
},
"modified_dateutc": "2026-08-06T10:10:24.4076481+00:00"
},
"equipment_model_id": "f65e0acd-5f82-4516-b095-141d245174b7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7eef8225-cad0-4513-8805-72959d05da62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5a29b315-0e9b-4307-b2c9-2488dd1ef225",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "942a5482-e06a-4e5f-b680-b7d2e6301bd7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ababd7f7-d07b-4686-b1a9-74e2619c74ad",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a2e9154f-4f5e-4397-9de0-498329ed8109",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "60bc7186-bdb9-4d95-bb9e-a195b72b22ae",
"db_currency_id": "da54c601-ec03-4a2b-8032-53ac9bc9c5eb",
"db_language_id": "12380905-e78d-46c6-8bb8-be2196678df7",
"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-08-06T10:10:24.4076481+00:00"
},
"modified_dateutc": "2026-08-06T10:10:24.4076481+00:00"
},
"equipment_family_id": "db4527e3-a282-494a-ad5d-6b92bd642337",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3cc1badd-c49b-4f38-a810-8b395069123d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "03dad283-d58c-417a-a58b-db853551b51f",
"_parent_code": "sample string 6",
"sales_organization_id": "db48692e-de94-4e7f-8528-73da51bdd4ee",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a2e9154f-4f5e-4397-9de0-498329ed8109",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "60bc7186-bdb9-4d95-bb9e-a195b72b22ae",
"db_currency_id": "da54c601-ec03-4a2b-8032-53ac9bc9c5eb",
"db_language_id": "12380905-e78d-46c6-8bb8-be2196678df7",
"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-08-06T10:10:24.4076481+00:00"
},
"modified_dateutc": "2026-08-06T10:10:24.4076481+00:00"
},
"date_in_production_since": "2026-08-06T10:10:24.4076481+00:00",
"date_out_of_production_since": "2026-08-06T10:10:24.4076481+00:00",
"date_end_support": "2026-08-06T10:10:24.4076481+00:00",
"sales_organization_id": "c0f96a48-6846-4ad0-bf6e-049d148996b8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a2e9154f-4f5e-4397-9de0-498329ed8109",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "60bc7186-bdb9-4d95-bb9e-a195b72b22ae",
"db_currency_id": "da54c601-ec03-4a2b-8032-53ac9bc9c5eb",
"db_language_id": "12380905-e78d-46c6-8bb8-be2196678df7",
"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-08-06T10:10:24.4076481+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-08-06T10:10:24.4076481+00:00"
},
"project_status_id": "318372f4-807b-44d6-be56-a6ef9bbadf38",
"project_status_code": "sample string 10",
"project_status": {
"id": "764694da-4fe9-44c0-9602-eef1eed6bf93",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5d79a914-3ec5-4d85-94bd-0e66d2a47440",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2e9154f-4f5e-4397-9de0-498329ed8109",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "60bc7186-bdb9-4d95-bb9e-a195b72b22ae",
"db_currency_id": "da54c601-ec03-4a2b-8032-53ac9bc9c5eb",
"db_language_id": "12380905-e78d-46c6-8bb8-be2196678df7",
"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-08-06T10:10:24.4076481+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-06T10:10:24.4076481+00:00"
},
"company_id": "bf889a9c-d9be-4691-8ad9-a7925470b1b6",
"company_code": "sample string 12",
"db_address_id": "30740fd5-adb8-423b-9cc7-19bd095985c2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "17f0314f-ca2d-497d-81c2-8a62763cc718",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1afaafab-6ae0-4d6e-88a8-8c9107459885",
"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-08-06T10:10:24.4076481+00:00",
"date_create": "2026-08-06T10:10:24.4076481+00:00",
"date_update": "2026-08-06T10:10:24.4076481+00:00",
"updated_by_user_id": "047967ca-45ea-4b36-8258-5d617452f6a9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-06T10:10:24.4076481+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-08-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-06T10:10:24.4076481+00:00",
"date_last_job": "2026-08-06T10:10:24.4076481+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-06T10:10:24.4076481+00:00",
"modified_dateutc": "2026-08-06T10:10:24.4076481+00:00",
"is_mobile_installation": true
},
"job_type_id": "9dbffd95-e880-4924-8aad-4d256c334fb8",
"job_type_code": "sample string 7",
"job_type": {
"id": "3e418710-eb47-475d-a23a-b8d8b92b75dc",
"name": "sample string 2",
"sales_organization_id": "77812d90-7727-477c-bd9f-d00eacc70738",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-06T10:10:24.4076481+00:00",
"code": "sample string 7"
},
"job_priority_id": "e746ac72-7684-4e09-9ce4-66cd0839983b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "dae5c398-66d6-470d-b46d-74db97301ffa",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ee154bb0-c4d8-4691-bbe7-733d07cfb1b9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2e9154f-4f5e-4397-9de0-498329ed8109",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "60bc7186-bdb9-4d95-bb9e-a195b72b22ae",
"db_currency_id": "da54c601-ec03-4a2b-8032-53ac9bc9c5eb",
"db_language_id": "12380905-e78d-46c6-8bb8-be2196678df7",
"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-08-06T10:10:24.4076481+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-06T10:10:24.4076481+00:00"
},
"job_status_id": "cbc0de82-7a9f-4ba5-bdec-54957d067d74",
"job_status_code": "sample string 11",
"db_address_id": "2c755731-cf3a-451a-9251-1808a0f7fce8",
"contact_id": "9382ba80-2091-44ac-83e9-f6e9a70b666b",
"requested_by_company_id": "00593248-04c0-4371-a32e-66b2d8d69f20",
"requested_by_contact_id": "02f8031f-2a65-4ec3-97bf-771a65d7c133",
"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-08-06T10:10:24.4076481+00:00",
"due_date": "2026-08-06T10:10:24.4076481+00:00",
"date_create": "2026-08-06T10:10:24.4076481+00:00",
"date_update": "2026-08-06T10:10:24.4076481+00:00",
"date_closed": "2026-08-06T10:10:24.4076481+00:00",
"suggested_user_id": "e43d9085-3db8-42d8-ab14-912bd7a72d47",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "eef20078-fd5b-42b3-8367-41023a8b53a1",
"db_language_id": "9a4afb73-9fef-423e-9695-5644826642ba",
"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-08-06T10:10:24.4076481+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6670f752-b40d-4985-85b9-f95eda3b4d33",
"sales_organization": {
"id": "a2e9154f-4f5e-4397-9de0-498329ed8109",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "60bc7186-bdb9-4d95-bb9e-a195b72b22ae",
"db_currency_id": "da54c601-ec03-4a2b-8032-53ac9bc9c5eb",
"db_language_id": "12380905-e78d-46c6-8bb8-be2196678df7",
"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-08-06T10:10:24.4076481+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "eb751eec-dc3f-4ee2-bac5-d84c172f4b8c",
"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": "c91c65c4-b024-4036-9390-a340c5f065a9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-06T10:10:24.4076481+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5b18320f-d43e-40da-9e87-1244af36c025"
},
"suggested_date_start": "2026-08-06T10:10:24.4232708+00:00",
"skill_id": "21b7cef6-6474-4349-aa80-3020b39d77a1",
"skill_code": "sample string 32",
"skill": {
"id": "a51cf700-ca87-4d22-82ac-13503430076c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f593e423-9dcb-4693-9373-c4310a8947a6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2e9154f-4f5e-4397-9de0-498329ed8109",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "60bc7186-bdb9-4d95-bb9e-a195b72b22ae",
"db_currency_id": "da54c601-ec03-4a2b-8032-53ac9bc9c5eb",
"db_language_id": "12380905-e78d-46c6-8bb8-be2196678df7",
"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-08-06T10:10:24.4076481+00:00"
},
"modified_dateutc": "2026-08-06T10:10:24.4232708+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "db21b821-9347-43fc-9030-d01f2db4982c",
"date_reported_by_company": "2026-08-06T10:10:24.4232708+00:00",
"id2": 36,
"company_id": "ef3995e6-e1e9-4fbe-a817-2242925c725f",
"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": "1769da17-81e0-4c3e-99dd-f4451d24a724",
"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-08-06T10:10:24.4232708+00:00"
},
"work_instruction_details_id": "c896e444-b5b0-414d-9ee2-7b152bff3f02",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1e473ca8-b700-4a38-b4c6-8ff0515e3fc7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1e8f86bc-965d-4f02-9996-4e9768a441de",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-06T10:10:24.4232708+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": "d6480d41-8d53-49c1-9a64-42de012efefa",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-06T10:10:24.4232708+00:00"
}