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": "78411902-ae39-4fd4-9732-7cbe6306a7ed",
"jobs_id": "e0a5b2b1-31ec-4b96-b99e-c7cc5e754b10",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "85f4f1ad-1bad-4387-ae5a-869d6a97ea8c",
"_parent_id": "b9bf01ba-222b-45cd-8a75-1cc4d4193151",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6de81ad3-47ac-4be2-8254-34e22e52416b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "64f0d728-937c-4160-a4a9-9ef7c0eba7ca",
"_parent_id": "08047ec4-9dbd-487f-b387-03b944fa7388",
"root_parent_id": "76ca1875-4bcb-4043-9330-c9dbf416822c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "932db248-ef80-4b3b-a819-6c7150f7b0a7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d62dce44-73da-4122-a977-67f4a3985805",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5690eaa9-f86d-4f53-b2ae-8c108b9136f1",
"_parent_code": "sample string 6",
"sales_organization_id": "4aeeeb6d-9fb4-4e1e-8e23-0363414a6d3f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7a3a2971-b3b6-4ffe-beb4-55e954b7287f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "028b615a-60e8-4813-84ca-9ef367773bea",
"db_currency_id": "afb572bb-3b85-4b3a-a667-4a6757d86af5",
"db_language_id": "3c387ae8-c6c0-4084-9a4b-e9f788440be2",
"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-02-17T17:05:17.8277428+00:00"
},
"modified_dateutc": "2026-02-17T17:05:17.8277428+00:00"
},
"equipment_model_id": "d185dd22-b4d3-402c-9195-21f6a2444a49",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6de5da9b-73c3-4fac-800a-635c53e364d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5d11e29c-551d-4cde-bd26-047345766cfa",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f57b3a08-56ac-4ec7-8ec1-9991bae4a97a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cd6dfb29-beae-4ad2-9d0b-e5cea10cf712",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7a3a2971-b3b6-4ffe-beb4-55e954b7287f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "028b615a-60e8-4813-84ca-9ef367773bea",
"db_currency_id": "afb572bb-3b85-4b3a-a667-4a6757d86af5",
"db_language_id": "3c387ae8-c6c0-4084-9a4b-e9f788440be2",
"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-02-17T17:05:17.8277428+00:00"
},
"modified_dateutc": "2026-02-17T17:05:17.8277428+00:00"
},
"equipment_family_id": "16695526-46ab-47a0-aa0e-d58db387c7fc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d62dce44-73da-4122-a977-67f4a3985805",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5690eaa9-f86d-4f53-b2ae-8c108b9136f1",
"_parent_code": "sample string 6",
"sales_organization_id": "4aeeeb6d-9fb4-4e1e-8e23-0363414a6d3f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7a3a2971-b3b6-4ffe-beb4-55e954b7287f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "028b615a-60e8-4813-84ca-9ef367773bea",
"db_currency_id": "afb572bb-3b85-4b3a-a667-4a6757d86af5",
"db_language_id": "3c387ae8-c6c0-4084-9a4b-e9f788440be2",
"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-02-17T17:05:17.8277428+00:00"
},
"modified_dateutc": "2026-02-17T17:05:17.8277428+00:00"
},
"date_in_production_since": "2026-02-17T17:05:17.8277428+00:00",
"date_out_of_production_since": "2026-02-17T17:05:17.8277428+00:00",
"date_end_support": "2026-02-17T17:05:17.8277428+00:00",
"sales_organization_id": "1192c002-5024-4b4a-b69f-793aa985c97b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7a3a2971-b3b6-4ffe-beb4-55e954b7287f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "028b615a-60e8-4813-84ca-9ef367773bea",
"db_currency_id": "afb572bb-3b85-4b3a-a667-4a6757d86af5",
"db_language_id": "3c387ae8-c6c0-4084-9a4b-e9f788440be2",
"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-02-17T17:05:17.8277428+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-02-17T17:05:17.8277428+00:00"
},
"project_status_id": "c014c76c-3698-429b-8b95-8e1a151ddb2c",
"project_status_code": "sample string 10",
"project_status": {
"id": "74d11c99-3a9c-460f-b321-9284db4a384c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d3d3179e-0b86-4b94-a34f-0f039b3407ee",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7a3a2971-b3b6-4ffe-beb4-55e954b7287f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "028b615a-60e8-4813-84ca-9ef367773bea",
"db_currency_id": "afb572bb-3b85-4b3a-a667-4a6757d86af5",
"db_language_id": "3c387ae8-c6c0-4084-9a4b-e9f788440be2",
"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-02-17T17:05:17.8277428+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-17T17:05:17.8277428+00:00"
},
"company_id": "b1c1684a-1ecd-4571-b9bc-099d9676b5a5",
"company_code": "sample string 12",
"db_address_id": "374ab311-e1a2-4e33-a745-bf42fa02e776",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5efcf13f-7086-4423-93a0-03ebccb2d5a4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "624c92c7-3b34-4b90-a1b8-15dfefba721c",
"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-02-17T17:05:17.8277428+00:00",
"date_create": "2026-02-17T17:05:17.8277428+00:00",
"date_update": "2026-02-17T17:05:17.8277428+00:00",
"updated_by_user_id": "9e22922d-893f-4c52-a804-a2dd3df21378",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-17T17:05:17.8277428+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-02-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-17T17:05:17.8277428+00:00",
"date_last_job": "2026-02-17T17:05:17.8277428+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-17T17:05:17.8277428+00:00",
"modified_dateutc": "2026-02-17T17:05:17.8277428+00:00",
"is_mobile_installation": true
},
"job_type_id": "76024cf3-6999-48dc-bc4f-6775bad4aa97",
"job_type_code": "sample string 7",
"job_type": {
"id": "8a851ec8-eb73-47e1-b5f4-86b5d974e603",
"name": "sample string 2",
"sales_organization_id": "ea9d8752-ba50-4531-a66c-11386744b152",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-17T17:05:17.8277428+00:00",
"code": "sample string 7"
},
"job_priority_id": "c567c910-dfac-4088-b2a4-599ac6c989b7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bded9bd1-615f-40f0-a003-dc20e6982c91",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "64dcd418-c77d-4b1f-8434-946ddc9bd4c0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7a3a2971-b3b6-4ffe-beb4-55e954b7287f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "028b615a-60e8-4813-84ca-9ef367773bea",
"db_currency_id": "afb572bb-3b85-4b3a-a667-4a6757d86af5",
"db_language_id": "3c387ae8-c6c0-4084-9a4b-e9f788440be2",
"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-02-17T17:05:17.8277428+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-17T17:05:17.8277428+00:00"
},
"job_status_id": "82868a7a-b8e1-44fb-b84e-f5edf0a32956",
"job_status_code": "sample string 11",
"db_address_id": "7c075524-f2c4-498c-b761-e3364d0a6e43",
"contact_id": "e0ca061d-8b4c-4d5c-aea9-0255e42d45e0",
"requested_by_company_id": "f91a12aa-fe6a-4442-907a-0dbd80c552d1",
"requested_by_contact_id": "c6f19875-c00a-4bca-b140-35168587e0e6",
"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-02-17T17:05:17.8277428+00:00",
"due_date": "2026-02-17T17:05:17.8277428+00:00",
"date_create": "2026-02-17T17:05:17.8277428+00:00",
"date_update": "2026-02-17T17:05:17.8277428+00:00",
"date_closed": "2026-02-17T17:05:17.8277428+00:00",
"suggested_user_id": "40885d7c-5728-47c3-9e24-fbff0ddf8e69",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7a864aec-2034-4a7f-9433-6ee69faa7130",
"db_language_id": "9ad386f5-6d35-4801-b706-6727928e13a7",
"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-02-17T17:05:17.8433634+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "04d5fa53-1c1f-4233-a0b5-454812ed52f2",
"sales_organization": {
"id": "7a3a2971-b3b6-4ffe-beb4-55e954b7287f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "028b615a-60e8-4813-84ca-9ef367773bea",
"db_currency_id": "afb572bb-3b85-4b3a-a667-4a6757d86af5",
"db_language_id": "3c387ae8-c6c0-4084-9a4b-e9f788440be2",
"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-02-17T17:05:17.8277428+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5ab7bc20-3771-48d9-a1ec-2583bf8f7f8d",
"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": "715ebada-8e4e-43e5-9b3b-cca12cdf664a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-17T17:05:17.8433634+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e207f867-b145-4bbe-aa4c-0f874c93883a"
},
"suggested_date_start": "2026-02-17T17:05:17.8433634+00:00",
"skill_id": "0ceaf349-c0bc-4849-a856-34b7d0f8a2da",
"skill_code": "sample string 32",
"skill": {
"id": "300a5ad1-e199-4337-aee4-f9dc89722b22",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "801567e9-16da-473c-bf32-8de66aba1abd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7a3a2971-b3b6-4ffe-beb4-55e954b7287f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "028b615a-60e8-4813-84ca-9ef367773bea",
"db_currency_id": "afb572bb-3b85-4b3a-a667-4a6757d86af5",
"db_language_id": "3c387ae8-c6c0-4084-9a4b-e9f788440be2",
"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-02-17T17:05:17.8277428+00:00"
},
"modified_dateutc": "2026-02-17T17:05:17.8433634+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d4b3741f-e84a-4b29-981f-aab61976adcc",
"date_reported_by_company": "2026-02-17T17:05:17.8433634+00:00",
"id2": 36,
"company_id": "a7c2f122-6871-4031-9450-3d7ca1ee018c",
"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": "4932a1a3-3933-4402-af8b-4aa95df6332a",
"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-02-17T17:05:17.8433634+00:00"
},
"work_instruction_details_id": "17cb1cf6-155e-452f-944a-408571faca73",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f167a052-fe17-4854-a048-c6ca7f5bd131",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cc1b547c-f4bc-46db-a097-4dd24de69424",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-17T17:05:17.8433634+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": "a88f0027-2940-454a-b623-cbfe4f9d158f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-17T17:05:17.8433634+00:00"
}