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
{
"id": "ea498b07-bed5-4688-af66-3a811386b9fb",
"jobs_id": "a505673e-56fb-4e6b-a5b9-0578e58a0b74",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "dd168c7d-540f-49f1-b112-bdfdf15a92e9",
"_parent_id": "623eca78-b4db-4547-acc6-f69bd4d33292",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0f44a934-74a7-422f-9919-b14cbc01367e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "054aa1d3-0945-46d9-9ac4-02567c61eaa8",
"_parent_id": "4ccc50ce-adf9-4b97-bdae-0b7586f51066",
"root_parent_id": "731d8603-c4fc-449d-8ff0-9c7a06a66d3e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "58ae0aa8-9a28-4157-93da-ef7b2d8540a9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9012f7e3-5422-4700-9a16-6f98ae851e26",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "037efc75-d2a1-4e38-9c11-b48b3c09efda",
"_parent_code": "sample string 6",
"sales_organization_id": "a21fb1e1-83da-450f-b26e-10a7c5f7bfdb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "09b6be99-d6c7-4cfd-9beb-ceab614cd2f6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e43bf45-8610-47e1-aa62-46489e325f4f",
"db_currency_id": "9e01d2f2-8d8c-4aaa-be26-c3216aa8e3e5",
"db_language_id": "c9528041-4c4c-403a-872d-ba44ccfcd5b9",
"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-11-22T18:12:01.5214943+00:00"
},
"modified_dateutc": "2026-11-22T18:12:01.5214943+00:00"
},
"equipment_model_id": "dba7867b-9ef4-4312-8d72-8eedf91d0cef",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d99492fe-5ef9-4086-9274-7abca31879c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d070822d-35a7-4b1f-964c-5bcae86c8ba3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "be23de2e-7931-4fed-bcd7-c40a24cf942e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d2de1793-bdaf-463c-b37b-b75897421fd6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "09b6be99-d6c7-4cfd-9beb-ceab614cd2f6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e43bf45-8610-47e1-aa62-46489e325f4f",
"db_currency_id": "9e01d2f2-8d8c-4aaa-be26-c3216aa8e3e5",
"db_language_id": "c9528041-4c4c-403a-872d-ba44ccfcd5b9",
"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-11-22T18:12:01.5214943+00:00"
},
"modified_dateutc": "2026-11-22T18:12:01.5214943+00:00"
},
"equipment_family_id": "8edcf3d9-e297-4e35-a715-7002c86e7097",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9012f7e3-5422-4700-9a16-6f98ae851e26",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "037efc75-d2a1-4e38-9c11-b48b3c09efda",
"_parent_code": "sample string 6",
"sales_organization_id": "a21fb1e1-83da-450f-b26e-10a7c5f7bfdb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "09b6be99-d6c7-4cfd-9beb-ceab614cd2f6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e43bf45-8610-47e1-aa62-46489e325f4f",
"db_currency_id": "9e01d2f2-8d8c-4aaa-be26-c3216aa8e3e5",
"db_language_id": "c9528041-4c4c-403a-872d-ba44ccfcd5b9",
"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-11-22T18:12:01.5214943+00:00"
},
"modified_dateutc": "2026-11-22T18:12:01.5214943+00:00"
},
"date_in_production_since": "2026-11-22T18:12:01.5214943+00:00",
"date_out_of_production_since": "2026-11-22T18:12:01.5214943+00:00",
"date_end_support": "2026-11-22T18:12:01.5214943+00:00",
"sales_organization_id": "efcbd009-2503-4f67-879d-9c82d1429258",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "09b6be99-d6c7-4cfd-9beb-ceab614cd2f6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e43bf45-8610-47e1-aa62-46489e325f4f",
"db_currency_id": "9e01d2f2-8d8c-4aaa-be26-c3216aa8e3e5",
"db_language_id": "c9528041-4c4c-403a-872d-ba44ccfcd5b9",
"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-11-22T18:12:01.5214943+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-11-22T18:12:01.5405726+00:00"
},
"project_status_id": "455f1d80-05d0-4a9e-a21f-78c6cac70555",
"project_status_code": "sample string 10",
"project_status": {
"id": "0e5825dd-0812-4a91-99c4-0f0f34a978e0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f54c2efe-fa47-46a1-8ad3-1f872e0300e3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "09b6be99-d6c7-4cfd-9beb-ceab614cd2f6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e43bf45-8610-47e1-aa62-46489e325f4f",
"db_currency_id": "9e01d2f2-8d8c-4aaa-be26-c3216aa8e3e5",
"db_language_id": "c9528041-4c4c-403a-872d-ba44ccfcd5b9",
"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-11-22T18:12:01.5214943+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-22T18:12:01.5405726+00:00"
},
"company_id": "2ab6cddd-096a-4ef3-b8cf-8bfd45c47c6a",
"company_code": "sample string 12",
"db_address_id": "7afff027-b414-4749-8c8e-944558bf8ec3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "10d07b73-8bda-4ede-90c8-6278b495b201",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9bb404a4-ee24-4171-872b-263744e81f83",
"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-11-22T18:12:01.5405726+00:00",
"date_create": "2026-11-22T18:12:01.5405726+00:00",
"date_update": "2026-11-22T18:12:01.5405726+00:00",
"updated_by_user_id": "c911cd18-54f8-43fe-a9e2-ef5969b4ff2c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-22T18:12:01.5405726+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-11-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-22T18:12:01.5405726+00:00",
"date_last_job": "2026-11-22T18:12:01.5405726+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-22T18:12:01.5405726+00:00",
"modified_dateutc": "2026-11-22T18:12:01.5405726+00:00",
"is_mobile_installation": true
},
"job_type_id": "af293724-8c69-4b0a-9a18-210b8f418f9a",
"job_type_code": "sample string 7",
"job_type": {
"id": "63f69c2a-acdb-4b94-b866-764704eeb29e",
"name": "sample string 2",
"sales_organization_id": "4e432267-293f-42da-94d1-798045abbfd0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-22T18:12:01.5519259+00:00",
"code": "sample string 7"
},
"job_priority_id": "0468ae44-9de0-4dcb-a942-f4c62c10d2c6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2622d38f-76c5-4444-8150-25b6ac70cc60",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a160278b-4919-411d-915d-e5b8cdd05674",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "09b6be99-d6c7-4cfd-9beb-ceab614cd2f6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e43bf45-8610-47e1-aa62-46489e325f4f",
"db_currency_id": "9e01d2f2-8d8c-4aaa-be26-c3216aa8e3e5",
"db_language_id": "c9528041-4c4c-403a-872d-ba44ccfcd5b9",
"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-11-22T18:12:01.5214943+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-22T18:12:01.5519259+00:00"
},
"job_status_id": "d64dc843-d501-4380-8a22-8c72d642d672",
"job_status_code": "sample string 11",
"db_address_id": "f4a5a4f3-c2f9-4ad7-b258-355fbb9abf32",
"contact_id": "071084b0-0e03-4f81-a33e-047adbf9a4ff",
"requested_by_company_id": "835ac161-e3c7-472e-bf1e-deefbed8dd7d",
"requested_by_contact_id": "c87d934d-fbd6-4025-a6d7-41fb37cceb26",
"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-11-22T18:12:01.5519259+00:00",
"due_date": "2026-11-22T18:12:01.5519259+00:00",
"date_create": "2026-11-22T18:12:01.5519259+00:00",
"date_update": "2026-11-22T18:12:01.5519259+00:00",
"date_closed": "2026-11-22T18:12:01.5519259+00:00",
"suggested_user_id": "d62c64a4-1b58-4fb7-b920-89a06c4f5338",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0c39d16e-b7c2-48c4-9b63-7dddcef34c4c",
"db_language_id": "80fa32c1-f409-4dbe-9f8c-d45418faceaf",
"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-11-22T18:12:01.5519259+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "51955a45-05af-4cfa-87b4-50be5b891749",
"sales_organization": {
"id": "09b6be99-d6c7-4cfd-9beb-ceab614cd2f6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e43bf45-8610-47e1-aa62-46489e325f4f",
"db_currency_id": "9e01d2f2-8d8c-4aaa-be26-c3216aa8e3e5",
"db_language_id": "c9528041-4c4c-403a-872d-ba44ccfcd5b9",
"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-11-22T18:12:01.5214943+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d20807e2-1842-488a-97f0-3f9bcdd9fb86",
"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": "ad61decd-530c-47dd-8b18-46be3aa3bc46",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-22T18:12:01.5519259+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7848131e-6ca6-418e-9301-be894e44d39b"
},
"suggested_date_start": "2026-11-22T18:12:01.5519259+00:00",
"skill_id": "40013c04-0fd9-445d-b4ee-4806dba03545",
"skill_code": "sample string 32",
"skill": {
"id": "5b07fe42-c69e-4732-aaf8-3e6847d191dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5214da45-b440-49a1-a34e-f480a63f4ba5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "09b6be99-d6c7-4cfd-9beb-ceab614cd2f6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e43bf45-8610-47e1-aa62-46489e325f4f",
"db_currency_id": "9e01d2f2-8d8c-4aaa-be26-c3216aa8e3e5",
"db_language_id": "c9528041-4c4c-403a-872d-ba44ccfcd5b9",
"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-11-22T18:12:01.5214943+00:00"
},
"modified_dateutc": "2026-11-22T18:12:01.5519259+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a5e2f5d3-01da-44a3-84b1-bada343fceca",
"date_reported_by_company": "2026-11-22T18:12:01.5519259+00:00",
"id2": 36,
"company_id": "b28990fa-5325-4746-a5ed-10816b614f48",
"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": "c827e36b-71ab-46bc-bd73-37d8bbf0f9a9",
"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-11-22T18:12:01.5519259+00:00"
},
"work_instruction_details_id": "1c844e19-4de7-4cc0-a852-2315ddd183be",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6f4151fa-601a-4131-bbd7-ab8fe701bec3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ee2f9a76-b8c5-430e-9d71-7b52bae495b7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-22T18:12:01.5519259+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": "68008851-b6e0-4dd3-a048-14b46e544346",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-22T18:12:01.5519259+00:00"
}