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": "a92f6298-644e-4f87-9f3f-233c322f5f25",
"jobs_id": "9c12fb31-5b14-44a3-a912-365bd54a6b2c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9686c2e6-273b-45ae-bcb1-5f4e5abf51e5",
"_parent_id": "91438c12-d73f-4cda-adc2-3f80f95b63e1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cc546742-d3de-4a03-99da-341210344c56",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a0e44e4c-3ae9-4681-83b1-a2b70b5f7cca",
"_parent_id": "82c76916-3c8f-4bdd-a62e-9a88412815ec",
"root_parent_id": "81bc9bb8-93b0-415c-b1da-564e267b602d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f9cd4d73-87e3-4b12-a30c-dc61750fd84a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "864804ee-c8d8-40f7-ab67-eaa324c304f1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "45b8c694-f1fb-4c38-b638-e889e423cbf4",
"_parent_code": "sample string 6",
"sales_organization_id": "1ca8427f-716b-4094-95ef-c48730887fff",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "687aab62-b8f2-4ef9-8e7e-3bc07c7955d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f508ab7-9bfe-40ca-8014-18031db431b1",
"db_currency_id": "629a6644-e0aa-4db2-853e-623500cab493",
"db_language_id": "4e6a743c-f7bb-4b81-a538-9bdca1dbfc35",
"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-07-05T06:47:23.525702+00:00"
},
"modified_dateutc": "2026-07-05T06:47:23.525702+00:00"
},
"equipment_model_id": "0fd2bb1a-b9fc-480d-b589-21d93bf8d5c6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8e59ab74-4a9d-4964-9619-f3f4d9ab3aa5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7b541d31-b8b3-42ed-a166-5bf88315daff",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6bad47bc-6ea1-43cb-9c84-eec2cf7b04fb",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e07373b9-4a3e-4eb7-8cd1-77093e89cc74",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "687aab62-b8f2-4ef9-8e7e-3bc07c7955d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f508ab7-9bfe-40ca-8014-18031db431b1",
"db_currency_id": "629a6644-e0aa-4db2-853e-623500cab493",
"db_language_id": "4e6a743c-f7bb-4b81-a538-9bdca1dbfc35",
"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-07-05T06:47:23.525702+00:00"
},
"modified_dateutc": "2026-07-05T06:47:23.525702+00:00"
},
"equipment_family_id": "4f879bc8-22c7-4785-bc4f-a1eb4a962fb8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "864804ee-c8d8-40f7-ab67-eaa324c304f1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "45b8c694-f1fb-4c38-b638-e889e423cbf4",
"_parent_code": "sample string 6",
"sales_organization_id": "1ca8427f-716b-4094-95ef-c48730887fff",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "687aab62-b8f2-4ef9-8e7e-3bc07c7955d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f508ab7-9bfe-40ca-8014-18031db431b1",
"db_currency_id": "629a6644-e0aa-4db2-853e-623500cab493",
"db_language_id": "4e6a743c-f7bb-4b81-a538-9bdca1dbfc35",
"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-07-05T06:47:23.525702+00:00"
},
"modified_dateutc": "2026-07-05T06:47:23.525702+00:00"
},
"date_in_production_since": "2026-07-05T06:47:23.525702+00:00",
"date_out_of_production_since": "2026-07-05T06:47:23.525702+00:00",
"date_end_support": "2026-07-05T06:47:23.525702+00:00",
"sales_organization_id": "e1952db0-1fa7-4851-9021-57c146c46398",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "687aab62-b8f2-4ef9-8e7e-3bc07c7955d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f508ab7-9bfe-40ca-8014-18031db431b1",
"db_currency_id": "629a6644-e0aa-4db2-853e-623500cab493",
"db_language_id": "4e6a743c-f7bb-4b81-a538-9bdca1dbfc35",
"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-07-05T06:47:23.525702+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-07-05T06:47:23.525702+00:00"
},
"project_status_id": "f975c318-eb75-4cde-a92e-14d3d51f09bc",
"project_status_code": "sample string 10",
"project_status": {
"id": "9ae6f4ee-dbc4-4781-8ac4-a1dead350969",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7a0d0a3e-25f2-4864-afa5-d11cd0c2c30a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "687aab62-b8f2-4ef9-8e7e-3bc07c7955d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f508ab7-9bfe-40ca-8014-18031db431b1",
"db_currency_id": "629a6644-e0aa-4db2-853e-623500cab493",
"db_language_id": "4e6a743c-f7bb-4b81-a538-9bdca1dbfc35",
"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-07-05T06:47:23.525702+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-05T06:47:23.525702+00:00"
},
"company_id": "d41a7d78-11ff-45af-b973-ca0aa897e077",
"company_code": "sample string 12",
"db_address_id": "d8ab7a64-7820-4f2a-99c3-6f5b100b35c0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "20c549b7-620a-4311-ad74-a03a56573b42",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bd028722-ace3-411f-b61a-d00ddc130531",
"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-07-05T06:47:23.525702+00:00",
"date_create": "2026-07-05T06:47:23.525702+00:00",
"date_update": "2026-07-05T06:47:23.525702+00:00",
"updated_by_user_id": "66e4ea74-a9c9-493b-85b1-03f27b9e6ea3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-05T06:47:23.525702+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-07-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-05T06:47:23.525702+00:00",
"date_last_job": "2026-07-05T06:47:23.525702+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-05T06:47:23.525702+00:00",
"modified_dateutc": "2026-07-05T06:47:23.525702+00:00",
"is_mobile_installation": true
},
"job_type_id": "9ea7ee74-e8d3-4288-b26e-4adf12a1d4b5",
"job_type_code": "sample string 7",
"job_type": {
"id": "9ab3e8ce-cdab-4e1b-a310-4ec740ca0ba3",
"name": "sample string 2",
"sales_organization_id": "8c0ebbef-37bd-4c91-adc6-28baa20ac92b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-05T06:47:23.525702+00:00",
"code": "sample string 7"
},
"job_priority_id": "91986fea-1769-4e13-b3bc-8583d847b9bc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c6695e49-1456-4483-8e07-45fd747e32f0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f8126d8d-ce4e-498a-a761-e89c89c1ac22",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "687aab62-b8f2-4ef9-8e7e-3bc07c7955d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f508ab7-9bfe-40ca-8014-18031db431b1",
"db_currency_id": "629a6644-e0aa-4db2-853e-623500cab493",
"db_language_id": "4e6a743c-f7bb-4b81-a538-9bdca1dbfc35",
"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-07-05T06:47:23.525702+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-05T06:47:23.525702+00:00"
},
"job_status_id": "4a165f0c-e02f-4bcf-a24b-3111dd119661",
"job_status_code": "sample string 11",
"db_address_id": "3b338346-4080-4762-b7c0-c1536da46490",
"contact_id": "8ad08717-dd36-4873-b554-b827b572012f",
"requested_by_company_id": "4ec2020d-42e4-4b9b-8b6e-d2317f84dbb0",
"requested_by_contact_id": "2bca8ee4-6d42-4eaa-bc82-13d89d009fbd",
"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-07-05T06:47:23.525702+00:00",
"due_date": "2026-07-05T06:47:23.525702+00:00",
"date_create": "2026-07-05T06:47:23.525702+00:00",
"date_update": "2026-07-05T06:47:23.525702+00:00",
"date_closed": "2026-07-05T06:47:23.525702+00:00",
"suggested_user_id": "4c4702b4-6d9b-41d1-bfc6-7ae562be74ad",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "653e8bb7-c010-4543-811a-30aedf6e9a0f",
"db_language_id": "39eb8478-a56d-4ded-a368-12ee3f3c0783",
"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-07-05T06:47:23.525702+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "11847058-63cf-4c5e-8512-283f72f8611d",
"sales_organization": {
"id": "687aab62-b8f2-4ef9-8e7e-3bc07c7955d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f508ab7-9bfe-40ca-8014-18031db431b1",
"db_currency_id": "629a6644-e0aa-4db2-853e-623500cab493",
"db_language_id": "4e6a743c-f7bb-4b81-a538-9bdca1dbfc35",
"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-07-05T06:47:23.525702+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9293f3a1-4141-4a78-b56f-a80f42d3b947",
"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": "00ea2416-8b68-416f-8275-aaf7ac836332",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-05T06:47:23.525702+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "45caab5c-18a2-4a2b-a71a-f1531a8bbb1c"
},
"suggested_date_start": "2026-07-05T06:47:23.525702+00:00",
"skill_id": "2591cdc3-2394-43f7-8152-26c97ffa5959",
"skill_code": "sample string 32",
"skill": {
"id": "95d30a2e-62f2-4251-b7b9-44be5406d709",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "46607757-34e6-4a33-b1ca-3ed279503207",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "687aab62-b8f2-4ef9-8e7e-3bc07c7955d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f508ab7-9bfe-40ca-8014-18031db431b1",
"db_currency_id": "629a6644-e0aa-4db2-853e-623500cab493",
"db_language_id": "4e6a743c-f7bb-4b81-a538-9bdca1dbfc35",
"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-07-05T06:47:23.525702+00:00"
},
"modified_dateutc": "2026-07-05T06:47:23.525702+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b452158f-5d85-4ca2-99e7-45b01ecf9ae3",
"date_reported_by_company": "2026-07-05T06:47:23.525702+00:00",
"id2": 36,
"company_id": "43f8a97f-fc3c-460d-8ddd-ec5c283e557a",
"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": "f97070e7-b4ef-4824-b875-96666c7e365e",
"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-07-05T06:47:23.525702+00:00"
},
"work_instruction_details_id": "b49af98b-879c-403e-9772-489e6ae00338",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "90d10e86-d5fb-4811-90fd-25a0adc10c92",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ea7a94a3-095f-49be-88d2-4563757f7b64",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-05T06:47:23.525702+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": "7d216e70-afb9-4460-bff3-f1dc1c07bbad",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-05T06:47:23.525702+00:00"
}