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": "3f91d4e7-ab4d-4909-a95f-e1aeb2dd55d8",
"jobs_id": "a7381b2b-4fba-4dc6-9e1e-ddd367d7a6e8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2a03e022-6939-47ce-8a3b-b3cdea31bb1b",
"_parent_id": "fc9cd4a6-c748-454b-a8c2-8f7b21227af4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9a69ead7-e27d-4a6e-b039-65f247059d5b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "59fc9cf6-50e7-4a77-927e-8dbd47493012",
"_parent_id": "ebd5a2ed-3e95-43fe-978c-53fa8a28c425",
"root_parent_id": "49712755-44ad-4e79-b543-d6c739723497",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "28d203e5-4b4d-441f-9510-897117d0c8f7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "91176b6e-298f-41e9-a319-424af1eb9551",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1f173bb9-bab6-45f6-84ed-e6be2d99ee4d",
"_parent_code": "sample string 6",
"sales_organization_id": "014983b4-2623-4e3a-b3fc-2d31ed3fbc28",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5347edfa-b975-4844-90fc-e48d0492cb63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ecf377ca-6e9a-47a3-b7c6-9b88a7cd1b6c",
"db_currency_id": "23cc7fa9-327a-43df-8342-2a20ba46c0af",
"db_language_id": "d94890ff-18e9-4412-ab8a-b6c3ca405a3c",
"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-01-24T06:36:40.5370602+00:00"
},
"modified_dateutc": "2026-01-24T06:36:40.5370602+00:00"
},
"equipment_model_id": "94588ff4-122e-4c55-877f-d366dcff6b94",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8b56e7e6-f2cc-4f62-8817-e05c845d287b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e49a1d17-836b-44d6-b912-5efe85e60a0a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a7f804a9-4a3d-46d7-a312-84ed77cdd53b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1ca49cd1-2938-46da-bfd4-a586045b9411",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5347edfa-b975-4844-90fc-e48d0492cb63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ecf377ca-6e9a-47a3-b7c6-9b88a7cd1b6c",
"db_currency_id": "23cc7fa9-327a-43df-8342-2a20ba46c0af",
"db_language_id": "d94890ff-18e9-4412-ab8a-b6c3ca405a3c",
"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-01-24T06:36:40.5370602+00:00"
},
"modified_dateutc": "2026-01-24T06:36:40.5370602+00:00"
},
"equipment_family_id": "20c68891-c001-455c-8eed-20e0bf040ef5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "91176b6e-298f-41e9-a319-424af1eb9551",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1f173bb9-bab6-45f6-84ed-e6be2d99ee4d",
"_parent_code": "sample string 6",
"sales_organization_id": "014983b4-2623-4e3a-b3fc-2d31ed3fbc28",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5347edfa-b975-4844-90fc-e48d0492cb63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ecf377ca-6e9a-47a3-b7c6-9b88a7cd1b6c",
"db_currency_id": "23cc7fa9-327a-43df-8342-2a20ba46c0af",
"db_language_id": "d94890ff-18e9-4412-ab8a-b6c3ca405a3c",
"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-01-24T06:36:40.5370602+00:00"
},
"modified_dateutc": "2026-01-24T06:36:40.5370602+00:00"
},
"date_in_production_since": "2026-01-24T06:36:40.5370602+00:00",
"date_out_of_production_since": "2026-01-24T06:36:40.5370602+00:00",
"date_end_support": "2026-01-24T06:36:40.5370602+00:00",
"sales_organization_id": "81ae3256-5fa2-4bf2-9c04-5f7a0142a55c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5347edfa-b975-4844-90fc-e48d0492cb63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ecf377ca-6e9a-47a3-b7c6-9b88a7cd1b6c",
"db_currency_id": "23cc7fa9-327a-43df-8342-2a20ba46c0af",
"db_language_id": "d94890ff-18e9-4412-ab8a-b6c3ca405a3c",
"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-01-24T06:36:40.5370602+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-01-24T06:36:40.5370602+00:00"
},
"project_status_id": "02f58fa1-b39b-4427-91c0-a72c9f6961cd",
"project_status_code": "sample string 10",
"project_status": {
"id": "758a48d2-c300-4d90-801b-f7c29d46ca68",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d29da50c-3835-4596-ba70-ebfd4d577c90",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5347edfa-b975-4844-90fc-e48d0492cb63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ecf377ca-6e9a-47a3-b7c6-9b88a7cd1b6c",
"db_currency_id": "23cc7fa9-327a-43df-8342-2a20ba46c0af",
"db_language_id": "d94890ff-18e9-4412-ab8a-b6c3ca405a3c",
"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-01-24T06:36:40.5370602+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-24T06:36:40.5370602+00:00"
},
"company_id": "1b4ee7c2-c58f-487f-98fa-9c923c7b8930",
"company_code": "sample string 12",
"db_address_id": "70e1675b-55f8-4be8-b74a-88eaf25836a9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9b35263a-13df-4b8f-baca-fcb7618b2155",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d8929d60-c098-45b1-98c2-00f2c1c1031f",
"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-01-24T06:36:40.5370602+00:00",
"date_create": "2026-01-24T06:36:40.5370602+00:00",
"date_update": "2026-01-24T06:36:40.5370602+00:00",
"updated_by_user_id": "97dac816-d487-4424-8d80-e0b006d99c39",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-24T06:36:40.5370602+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-01-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-24T06:36:40.5370602+00:00",
"date_last_job": "2026-01-24T06:36:40.5370602+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-24T06:36:40.5370602+00:00",
"modified_dateutc": "2026-01-24T06:36:40.5370602+00:00",
"is_mobile_installation": true
},
"job_type_id": "aac20b08-1f09-4106-9829-59137fe040f1",
"job_type_code": "sample string 7",
"job_type": {
"id": "a4490af1-d13b-40db-b214-8fa458026183",
"name": "sample string 2",
"sales_organization_id": "cd391147-6aae-4b5b-93cb-150bc88f18b2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-24T06:36:40.5370602+00:00",
"code": "sample string 7"
},
"job_priority_id": "2b981134-485f-4cf2-9200-06d23f8aa52d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "65bcbb39-47dd-4b71-9a78-40b4bf5683bf",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fc0ef60a-1b2e-4376-97bb-03c20a42bd8a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5347edfa-b975-4844-90fc-e48d0492cb63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ecf377ca-6e9a-47a3-b7c6-9b88a7cd1b6c",
"db_currency_id": "23cc7fa9-327a-43df-8342-2a20ba46c0af",
"db_language_id": "d94890ff-18e9-4412-ab8a-b6c3ca405a3c",
"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-01-24T06:36:40.5370602+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-24T06:36:40.5370602+00:00"
},
"job_status_id": "9574c940-c567-4b60-ad34-503ad5dac1f8",
"job_status_code": "sample string 11",
"db_address_id": "6eb6bde3-a296-4d71-a086-6acdda96abc9",
"contact_id": "ee645c56-e371-4446-a700-1a8fccfaffbe",
"requested_by_company_id": "f7a58315-f81a-4fd6-bc9f-62a4c94f9ef7",
"requested_by_contact_id": "043394e6-b1cf-437c-8b3b-a08cd7414db9",
"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-01-24T06:36:40.5370602+00:00",
"due_date": "2026-01-24T06:36:40.5370602+00:00",
"date_create": "2026-01-24T06:36:40.5370602+00:00",
"date_update": "2026-01-24T06:36:40.5370602+00:00",
"date_closed": "2026-01-24T06:36:40.5370602+00:00",
"suggested_user_id": "29055060-af40-445f-ade4-c44149af01cb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4bd8a4ca-42cc-4cf1-937f-c157db9adda7",
"db_language_id": "5af04fa9-7328-4eb6-aaa2-1e12a1b4552f",
"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-01-24T06:36:40.5370602+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "552fe684-940f-4f02-916d-cc17ff918a1a",
"sales_organization": {
"id": "5347edfa-b975-4844-90fc-e48d0492cb63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ecf377ca-6e9a-47a3-b7c6-9b88a7cd1b6c",
"db_currency_id": "23cc7fa9-327a-43df-8342-2a20ba46c0af",
"db_language_id": "d94890ff-18e9-4412-ab8a-b6c3ca405a3c",
"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-01-24T06:36:40.5370602+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b21f39cb-8160-40ed-bf50-68d2226a4895",
"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": "e3473f1c-89e1-44cf-8ee7-b12a7bcff9d9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-24T06:36:40.5370602+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "67c0e854-3708-42f8-b342-ff65e7347f06"
},
"suggested_date_start": "2026-01-24T06:36:40.5370602+00:00",
"skill_id": "03de59e5-deea-40c6-8de9-bcb1c7869e24",
"skill_code": "sample string 32",
"skill": {
"id": "c1570fbd-c5b6-4317-b87d-42d2b43dfc16",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a28138da-d1ac-402e-887a-44331268af74",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5347edfa-b975-4844-90fc-e48d0492cb63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ecf377ca-6e9a-47a3-b7c6-9b88a7cd1b6c",
"db_currency_id": "23cc7fa9-327a-43df-8342-2a20ba46c0af",
"db_language_id": "d94890ff-18e9-4412-ab8a-b6c3ca405a3c",
"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-01-24T06:36:40.5370602+00:00"
},
"modified_dateutc": "2026-01-24T06:36:40.5370602+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "83d611be-7c4b-4514-8a52-449cb25a12a0",
"date_reported_by_company": "2026-01-24T06:36:40.5370602+00:00",
"id2": 36,
"company_id": "69d2bb38-c018-480c-9f08-0b988cc8fc09",
"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": "dc03735a-fe54-4d59-9d34-2623d1ac71a8",
"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-01-24T06:36:40.5370602+00:00"
},
"work_instruction_details_id": "b2ad9227-a7e9-44fd-a797-7124f5e52b19",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b29f4414-c3be-4bfb-967c-476ee8f6c201",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e0a49db5-dc1c-450f-b1c1-ab5eacc52c8f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-24T06:36:40.5370602+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": "422c8dc6-346d-4300-8a59-e2d08d83cf61",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-24T06:36:40.5370602+00:00"
}