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": "67707881-a145-4203-8930-e2fcfb44f3fc",
"jobs_id": "8d734485-1421-4e4b-ac11-a5b80ac36e89",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "12464d9e-5c5d-4681-8b8b-de27c8715217",
"_parent_id": "e52cae94-f761-42b1-bf2b-6fd039b44e72",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "71c10668-55c2-4812-a960-2a6d9a6bed88",
"project_reference_back_office": "sample string 5",
"project": {
"id": "09773389-1c71-4c03-b636-5cd2c3624cb4",
"_parent_id": "0edab687-216d-4a83-a3b8-1fc62a286fd4",
"root_parent_id": "5d627b05-11f0-4856-ab3f-b523f1d048a2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "71d8c31f-0b7a-431d-a864-750ded4aaa53",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "28066236-c869-4bf6-b613-fee6f23c9589",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cc566b2a-36cd-4a05-8699-279bf2481854",
"_parent_code": "sample string 6",
"sales_organization_id": "0f076380-3278-4e0a-90b2-877b1b884e8b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7f75f668-a3ed-463c-8542-685109cbd56d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de5b116e-42f1-4429-accf-ed2ce6415a47",
"db_currency_id": "b2f563cf-e13c-46f0-99f4-8fb52846a9a0",
"db_language_id": "a17709d5-dedf-4ee3-9ee0-068418517bd3",
"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-05-07T21:05:50.7912993+00:00"
},
"modified_dateutc": "2026-05-07T21:05:50.7912993+00:00"
},
"equipment_model_id": "1b02b3da-3ba1-416e-8a8e-27b14e805c0b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2842e7ed-7412-4537-a8f2-58925304ea1f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "36a8f6b5-403a-44be-b183-2f53f982f4d8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "decae631-2ccd-45b3-a139-526f2161ab32",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6a5cbd57-c600-43b5-8b14-f583d0c9cc55",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7f75f668-a3ed-463c-8542-685109cbd56d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de5b116e-42f1-4429-accf-ed2ce6415a47",
"db_currency_id": "b2f563cf-e13c-46f0-99f4-8fb52846a9a0",
"db_language_id": "a17709d5-dedf-4ee3-9ee0-068418517bd3",
"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-05-07T21:05:50.7912993+00:00"
},
"modified_dateutc": "2026-05-07T21:05:50.7912993+00:00"
},
"equipment_family_id": "9db7641f-d9e4-44e2-a3d4-8fb21426aac1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "28066236-c869-4bf6-b613-fee6f23c9589",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cc566b2a-36cd-4a05-8699-279bf2481854",
"_parent_code": "sample string 6",
"sales_organization_id": "0f076380-3278-4e0a-90b2-877b1b884e8b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7f75f668-a3ed-463c-8542-685109cbd56d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de5b116e-42f1-4429-accf-ed2ce6415a47",
"db_currency_id": "b2f563cf-e13c-46f0-99f4-8fb52846a9a0",
"db_language_id": "a17709d5-dedf-4ee3-9ee0-068418517bd3",
"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-05-07T21:05:50.7912993+00:00"
},
"modified_dateutc": "2026-05-07T21:05:50.7912993+00:00"
},
"date_in_production_since": "2026-05-07T21:05:50.7912993+00:00",
"date_out_of_production_since": "2026-05-07T21:05:50.7912993+00:00",
"date_end_support": "2026-05-07T21:05:50.7912993+00:00",
"sales_organization_id": "d63084e0-765e-430f-9e69-b3c8bd9ac384",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7f75f668-a3ed-463c-8542-685109cbd56d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de5b116e-42f1-4429-accf-ed2ce6415a47",
"db_currency_id": "b2f563cf-e13c-46f0-99f4-8fb52846a9a0",
"db_language_id": "a17709d5-dedf-4ee3-9ee0-068418517bd3",
"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-05-07T21:05:50.7912993+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-05-07T21:05:50.806924+00:00"
},
"project_status_id": "a975ec9c-d46a-47dc-a218-02ec3ae7444b",
"project_status_code": "sample string 10",
"project_status": {
"id": "de27accb-ba39-4979-ad56-9a425d121aa9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e36f59ce-4be8-4138-9ec6-9451bd8ead59",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7f75f668-a3ed-463c-8542-685109cbd56d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de5b116e-42f1-4429-accf-ed2ce6415a47",
"db_currency_id": "b2f563cf-e13c-46f0-99f4-8fb52846a9a0",
"db_language_id": "a17709d5-dedf-4ee3-9ee0-068418517bd3",
"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-05-07T21:05:50.7912993+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T21:05:50.806924+00:00"
},
"company_id": "856cfaa6-baa3-403d-ba92-bfe207784ea9",
"company_code": "sample string 12",
"db_address_id": "24aefb7b-be4d-4a44-9ed0-9dbb680bb244",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "190537a9-33c1-4de3-adee-e3a9a6b5424a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8352ae14-3e3b-4234-a510-4ec5493207fa",
"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-05-07T21:05:50.806924+00:00",
"date_create": "2026-05-07T21:05:50.806924+00:00",
"date_update": "2026-05-07T21:05:50.806924+00:00",
"updated_by_user_id": "d75ef3d3-7c1a-45ea-82af-f9be19786ede",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-07T21:05:50.806924+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-05-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-07T21:05:50.806924+00:00",
"date_last_job": "2026-05-07T21:05:50.806924+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-07T21:05:50.806924+00:00",
"modified_dateutc": "2026-05-07T21:05:50.806924+00:00",
"is_mobile_installation": true
},
"job_type_id": "7ed0eeaf-c474-47d6-80a4-2238479e8a17",
"job_type_code": "sample string 7",
"job_type": {
"id": "1f8aa8e1-2781-4dee-a228-e1b9b3c7dc96",
"name": "sample string 2",
"sales_organization_id": "e9d8cbd1-d8df-4718-b300-576dfb01754f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-07T21:05:50.806924+00:00",
"code": "sample string 7"
},
"job_priority_id": "a43bd000-1df7-4688-aab4-618e6b961eef",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "da62232d-f49a-4c63-99a0-5c40128e65a7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d816a8bb-1c55-42c7-98ac-84c497b4a725",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7f75f668-a3ed-463c-8542-685109cbd56d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de5b116e-42f1-4429-accf-ed2ce6415a47",
"db_currency_id": "b2f563cf-e13c-46f0-99f4-8fb52846a9a0",
"db_language_id": "a17709d5-dedf-4ee3-9ee0-068418517bd3",
"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-05-07T21:05:50.7912993+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T21:05:50.806924+00:00"
},
"job_status_id": "299cb81c-b9fb-4e44-8fde-eb66937f48d1",
"job_status_code": "sample string 11",
"db_address_id": "3e2443be-8450-4eeb-81eb-8388c376a766",
"contact_id": "8d2a294f-39e0-4e8a-9a65-8b34ac0091a9",
"requested_by_company_id": "43ad9d4b-7a26-4374-b64f-6b2c0e9f0c75",
"requested_by_contact_id": "01032d34-9087-47f9-b2a7-62c4e48a4c7c",
"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-05-07T21:05:50.806924+00:00",
"due_date": "2026-05-07T21:05:50.806924+00:00",
"date_create": "2026-05-07T21:05:50.806924+00:00",
"date_update": "2026-05-07T21:05:50.806924+00:00",
"date_closed": "2026-05-07T21:05:50.806924+00:00",
"suggested_user_id": "07730b52-2cc8-42f8-98e9-87f7f8872f4b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b32efb15-d540-494b-906e-e89d88367f95",
"db_language_id": "5e00d588-a0ae-43cf-bdc2-c6ac8019fc56",
"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-05-07T21:05:50.806924+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "99bed6a4-13c6-4c69-a6b8-21df20853fd7",
"sales_organization": {
"id": "7f75f668-a3ed-463c-8542-685109cbd56d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de5b116e-42f1-4429-accf-ed2ce6415a47",
"db_currency_id": "b2f563cf-e13c-46f0-99f4-8fb52846a9a0",
"db_language_id": "a17709d5-dedf-4ee3-9ee0-068418517bd3",
"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-05-07T21:05:50.7912993+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "669250c2-3b4b-407a-ae3c-60dc419c7fc0",
"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": "9e347f57-3327-4b47-9acc-697213a19301",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-07T21:05:50.806924+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "61afa7da-bbdf-4cbf-8e38-d934a1e0f267"
},
"suggested_date_start": "2026-05-07T21:05:50.806924+00:00",
"skill_id": "eacfcc04-ee58-4cb5-a582-91ab6aff73f2",
"skill_code": "sample string 32",
"skill": {
"id": "b37e1b4d-3bdf-46df-bafa-94f9142c5e0d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9ec0d0e3-8848-4a65-b8e9-efc194be982e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7f75f668-a3ed-463c-8542-685109cbd56d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de5b116e-42f1-4429-accf-ed2ce6415a47",
"db_currency_id": "b2f563cf-e13c-46f0-99f4-8fb52846a9a0",
"db_language_id": "a17709d5-dedf-4ee3-9ee0-068418517bd3",
"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-05-07T21:05:50.7912993+00:00"
},
"modified_dateutc": "2026-05-07T21:05:50.806924+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "863c4c75-b961-4368-8b36-b7934d390735",
"date_reported_by_company": "2026-05-07T21:05:50.806924+00:00",
"id2": 36,
"company_id": "9e331a79-0873-496a-b69a-7b175461ccca",
"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": "0e7ca992-5fe8-4f35-b0da-3c82e868d0bf",
"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-05-07T21:05:50.806924+00:00"
},
"work_instruction_details_id": "55ac2676-16fd-489f-bbc4-848da0546319",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "52e28047-edb9-4a78-876c-eaeac964a668",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b45dd692-1e03-43b8-bf3f-0e66d7cc404c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-07T21:05:50.806924+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": "505ecc6c-6ba0-4c33-bc71-2b170e6728a5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-07T21:05:50.806924+00:00"
}