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": "9acc2f90-6b18-4ce9-8d1e-bd1a10331a55",
"jobs_id": "bf2c0dc7-186c-477d-a30d-bbb840c00cad",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "df7fc4f9-0052-40b0-8f75-01d58c846f15",
"_parent_id": "48a0ecfb-105e-42c3-9a65-46cebd42453e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c14a5ef5-11f6-43d7-82d4-0be6bb26e73e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c8cba657-b2c8-4ecd-946d-cb3e6976d59b",
"_parent_id": "8e442708-a223-4b90-a3f3-4c0551b91999",
"root_parent_id": "ea779aaa-ed3b-4dae-91fa-dbbc4abcfffb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cadcdabf-f39f-4c8e-bd05-a4ba0aa128ba",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2185a20d-a510-40da-8778-cf6a9c1fccf3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8ffcc1e4-e25c-4a62-b410-0c9b79813ad5",
"_parent_code": "sample string 6",
"sales_organization_id": "7dd69bdf-a035-4a5b-95eb-d451ca6b816e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4e63fc09-44af-4581-ab29-c556f6c2b0b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3650a540-0fb6-4d1a-9997-02cd24c1b119",
"db_currency_id": "172907b4-9818-4d31-a400-6d78e1ecd6ef",
"db_language_id": "4c1532b7-09b9-43b7-bfce-8391ec759dbd",
"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-11-29T13:25:53.1436385+00:00"
},
"modified_dateutc": "2025-11-29T13:25:53.1436385+00:00"
},
"equipment_model_id": "d540e3b1-4f48-49d8-858d-c74e87b139ae",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f541c4fb-bf3b-4780-83c0-9ff82791d972",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0a57938f-1dd6-47dd-bc09-1a065d0dbd4a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e1d7fa2d-911a-4772-b2fa-6327ed80bb8a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f161005c-44ed-42ca-af80-d9ea334a8ed9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4e63fc09-44af-4581-ab29-c556f6c2b0b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3650a540-0fb6-4d1a-9997-02cd24c1b119",
"db_currency_id": "172907b4-9818-4d31-a400-6d78e1ecd6ef",
"db_language_id": "4c1532b7-09b9-43b7-bfce-8391ec759dbd",
"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-11-29T13:25:53.1436385+00:00"
},
"modified_dateutc": "2025-11-29T13:25:53.1436385+00:00"
},
"equipment_family_id": "2ca8e63c-bc28-4622-896b-a72182911226",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2185a20d-a510-40da-8778-cf6a9c1fccf3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8ffcc1e4-e25c-4a62-b410-0c9b79813ad5",
"_parent_code": "sample string 6",
"sales_organization_id": "7dd69bdf-a035-4a5b-95eb-d451ca6b816e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4e63fc09-44af-4581-ab29-c556f6c2b0b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3650a540-0fb6-4d1a-9997-02cd24c1b119",
"db_currency_id": "172907b4-9818-4d31-a400-6d78e1ecd6ef",
"db_language_id": "4c1532b7-09b9-43b7-bfce-8391ec759dbd",
"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-11-29T13:25:53.1436385+00:00"
},
"modified_dateutc": "2025-11-29T13:25:53.1436385+00:00"
},
"date_in_production_since": "2025-11-29T13:25:53.1436385+00:00",
"date_out_of_production_since": "2025-11-29T13:25:53.1436385+00:00",
"date_end_support": "2025-11-29T13:25:53.1436385+00:00",
"sales_organization_id": "802943d9-31e8-474b-a533-30cde4b936b9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4e63fc09-44af-4581-ab29-c556f6c2b0b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3650a540-0fb6-4d1a-9997-02cd24c1b119",
"db_currency_id": "172907b4-9818-4d31-a400-6d78e1ecd6ef",
"db_language_id": "4c1532b7-09b9-43b7-bfce-8391ec759dbd",
"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-11-29T13:25:53.1436385+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-11-29T13:25:53.1592611+00:00"
},
"project_status_id": "ceff92a3-eb0f-4ff2-bd3b-13a34ab3f49e",
"project_status_code": "sample string 10",
"project_status": {
"id": "488e6639-c5ef-4b0d-8ac6-00bf73f7fe5b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "87ed5ddf-ff79-4f32-aa62-5b441449dbee",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4e63fc09-44af-4581-ab29-c556f6c2b0b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3650a540-0fb6-4d1a-9997-02cd24c1b119",
"db_currency_id": "172907b4-9818-4d31-a400-6d78e1ecd6ef",
"db_language_id": "4c1532b7-09b9-43b7-bfce-8391ec759dbd",
"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-11-29T13:25:53.1436385+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-29T13:25:53.1592611+00:00"
},
"company_id": "14f4222c-6a16-4ea6-8f0b-5fd498c1a3b6",
"company_code": "sample string 12",
"db_address_id": "9a327e39-0b28-4645-a3a3-2259e3fca06f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6b697181-581c-4cac-9729-c048deab6097",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b88132f1-b3b6-463c-a83b-98f9b4c0cc17",
"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-11-29T13:25:53.1592611+00:00",
"date_create": "2025-11-29T13:25:53.1592611+00:00",
"date_update": "2025-11-29T13:25:53.1592611+00:00",
"updated_by_user_id": "88ba55b4-80d4-46e8-87eb-99fe45360c17",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-29T13:25:53.1592611+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-11-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-29T13:25:53.1592611+00:00",
"date_last_job": "2025-11-29T13:25:53.1592611+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-29T13:25:53.1592611+00:00",
"modified_dateutc": "2025-11-29T13:25:53.1592611+00:00",
"is_mobile_installation": true
},
"job_type_id": "148a72e3-f0c9-4488-9bbd-07024dc1c04c",
"job_type_code": "sample string 7",
"job_type": {
"id": "7f45617f-de0d-4522-8aef-291cc04df64c",
"name": "sample string 2",
"sales_organization_id": "fd0f9d90-2a59-4efd-90d9-cc7f6be27d41",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-29T13:25:53.1592611+00:00",
"code": "sample string 7"
},
"job_priority_id": "00d1e99b-2aad-4e66-9dab-160c80d0a41a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d90b0ddf-a5ca-4024-8b9d-a550bce2f8e3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b046a1ea-2626-4a68-849e-9efb1d3dba30",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4e63fc09-44af-4581-ab29-c556f6c2b0b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3650a540-0fb6-4d1a-9997-02cd24c1b119",
"db_currency_id": "172907b4-9818-4d31-a400-6d78e1ecd6ef",
"db_language_id": "4c1532b7-09b9-43b7-bfce-8391ec759dbd",
"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-11-29T13:25:53.1436385+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-29T13:25:53.1592611+00:00"
},
"job_status_id": "61f2769d-6f78-437d-a3e6-e3f74613fd18",
"job_status_code": "sample string 11",
"db_address_id": "11ac4dd7-d7ec-491b-8fef-2b0a2bfc9232",
"contact_id": "2e839ae8-947a-41a0-a78b-845c8d2308d2",
"requested_by_company_id": "b6c58fa2-8c90-4d41-9c92-1ff20cb6a902",
"requested_by_contact_id": "e47d2ffe-309d-4187-a64e-ab49c911489b",
"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-11-29T13:25:53.1592611+00:00",
"due_date": "2025-11-29T13:25:53.1592611+00:00",
"date_create": "2025-11-29T13:25:53.1592611+00:00",
"date_update": "2025-11-29T13:25:53.1592611+00:00",
"date_closed": "2025-11-29T13:25:53.1592611+00:00",
"suggested_user_id": "44c8418f-ca35-490e-b04b-f67b9fe48eb7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3e3885d8-0cc1-49f6-90aa-abea59c49187",
"db_language_id": "d46c482e-4186-433f-bb44-116c040eef06",
"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-11-29T13:25:53.1592611+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9f1b5931-f1c5-4ca1-b505-aa22430351a1",
"sales_organization": {
"id": "4e63fc09-44af-4581-ab29-c556f6c2b0b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3650a540-0fb6-4d1a-9997-02cd24c1b119",
"db_currency_id": "172907b4-9818-4d31-a400-6d78e1ecd6ef",
"db_language_id": "4c1532b7-09b9-43b7-bfce-8391ec759dbd",
"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-11-29T13:25:53.1436385+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "81c5bb3a-2158-4aab-a4f8-b8a8ecec28ff",
"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": "b73c678b-d6cd-48c4-9cb1-02612e53d269",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-29T13:25:53.1592611+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0ed7563c-b047-4deb-9a3b-b48b4df24920"
},
"suggested_date_start": "2025-11-29T13:25:53.1592611+00:00",
"skill_id": "81a2a0ad-a047-4e91-8f16-5f05c912f711",
"skill_code": "sample string 32",
"skill": {
"id": "e057e97f-2b67-49be-8a3f-d7d9a16c9872",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3bff0c03-062e-48c7-b6b5-e8f4124e99f2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4e63fc09-44af-4581-ab29-c556f6c2b0b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3650a540-0fb6-4d1a-9997-02cd24c1b119",
"db_currency_id": "172907b4-9818-4d31-a400-6d78e1ecd6ef",
"db_language_id": "4c1532b7-09b9-43b7-bfce-8391ec759dbd",
"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-11-29T13:25:53.1436385+00:00"
},
"modified_dateutc": "2025-11-29T13:25:53.1592611+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3241ca20-d060-49db-97af-ce4e45655b2c",
"date_reported_by_company": "2025-11-29T13:25:53.1592611+00:00",
"id2": 36,
"company_id": "edce026a-96be-43f0-8fe6-8fee7706502a",
"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": "81a54b3b-2c6b-413f-9b98-38070fc16c3d",
"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-11-29T13:25:53.1592611+00:00"
},
"work_instruction_details_id": "f4150d1f-a563-4491-862c-e00709feaeb7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "59f4ba71-349f-437c-8144-9b7b15863ac8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3ae1b22f-f37b-47a0-a2c8-b413d3736ab6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-29T13:25:53.1592611+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": "5666dcd5-0037-4d02-90fc-18deb4d63b7d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-29T13:25:53.1592611+00:00"
}