Retrieves all the job work instruction list.
Request Information
URI Parameters :
None.
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": "8fda8065-09c0-4718-94a8-7550b82e94e1",
"jobs_id": "464d34e0-8059-4610-9e7f-26afa9c4be01",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "39d6ff6c-5de2-48db-8963-bb9a1ffbd5d0",
"_parent_id": "aa7cd707-57e4-459e-b0d0-87e0bbbe3c12",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4c53dd25-6f3e-4821-9805-0a3e86e9adb8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4e58a3a6-1587-4369-9004-d242be83b876",
"_parent_id": "22a9c826-a01b-4b49-ad58-e14f9040be90",
"root_parent_id": "a28b8262-f441-42e1-b8fe-6dffef37639a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4f2b0f0a-a39a-4e1b-bce0-2f298979bbc9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "06481d23-840c-4de5-8a60-8f355e18fbeb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a2607311-0ace-4991-8de0-801bdc52a47c",
"_parent_code": "sample string 6",
"sales_organization_id": "c7904475-1f9b-4b71-9978-be69889b3c5f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ca577003-40cc-4527-9e9f-39d9a85bd2d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17053723-bfae-4a72-9804-77eecc42c237",
"db_currency_id": "9caca9af-2a7f-4dfb-a0e5-a2c49ef8f7a2",
"db_language_id": "e0ef0003-bd0c-4cdd-8278-25ba827a2e8a",
"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-08-14T07:29:01.8616352+00:00"
},
"modified_dateutc": "2026-08-14T07:29:01.8616352+00:00"
},
"equipment_model_id": "71821791-72e0-4f15-befe-fe592bc47cde",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3bf73193-fa06-43de-9ab3-3d1485b69887",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1d681c63-c491-4d39-b654-d444186bf05f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "cbdc48db-482f-4df2-b2ed-bf959bf00f63",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "11373e00-6bf0-4b1a-9988-115169f8155a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ca577003-40cc-4527-9e9f-39d9a85bd2d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17053723-bfae-4a72-9804-77eecc42c237",
"db_currency_id": "9caca9af-2a7f-4dfb-a0e5-a2c49ef8f7a2",
"db_language_id": "e0ef0003-bd0c-4cdd-8278-25ba827a2e8a",
"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-08-14T07:29:01.8616352+00:00"
},
"modified_dateutc": "2026-08-14T07:29:01.8616352+00:00"
},
"equipment_family_id": "aab31cbe-becd-4022-8f9a-8c855d875c59",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "06481d23-840c-4de5-8a60-8f355e18fbeb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a2607311-0ace-4991-8de0-801bdc52a47c",
"_parent_code": "sample string 6",
"sales_organization_id": "c7904475-1f9b-4b71-9978-be69889b3c5f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ca577003-40cc-4527-9e9f-39d9a85bd2d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17053723-bfae-4a72-9804-77eecc42c237",
"db_currency_id": "9caca9af-2a7f-4dfb-a0e5-a2c49ef8f7a2",
"db_language_id": "e0ef0003-bd0c-4cdd-8278-25ba827a2e8a",
"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-08-14T07:29:01.8616352+00:00"
},
"modified_dateutc": "2026-08-14T07:29:01.8616352+00:00"
},
"date_in_production_since": "2026-08-14T07:29:01.8616352+00:00",
"date_out_of_production_since": "2026-08-14T07:29:01.8616352+00:00",
"date_end_support": "2026-08-14T07:29:01.8616352+00:00",
"sales_organization_id": "67a1c545-cdde-4174-99b2-255dbb3b7458",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ca577003-40cc-4527-9e9f-39d9a85bd2d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17053723-bfae-4a72-9804-77eecc42c237",
"db_currency_id": "9caca9af-2a7f-4dfb-a0e5-a2c49ef8f7a2",
"db_language_id": "e0ef0003-bd0c-4cdd-8278-25ba827a2e8a",
"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-08-14T07:29:01.8616352+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-08-14T07:29:01.8616352+00:00"
},
"project_status_id": "76c56479-bde6-4354-833b-80b292533849",
"project_status_code": "sample string 10",
"project_status": {
"id": "9020aefe-a949-43d7-82a5-d7411b2d8536",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2ffe13c6-ce52-46d5-9073-0d93efa12948",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ca577003-40cc-4527-9e9f-39d9a85bd2d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17053723-bfae-4a72-9804-77eecc42c237",
"db_currency_id": "9caca9af-2a7f-4dfb-a0e5-a2c49ef8f7a2",
"db_language_id": "e0ef0003-bd0c-4cdd-8278-25ba827a2e8a",
"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-08-14T07:29:01.8616352+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-14T07:29:01.8616352+00:00"
},
"company_id": "90fc103a-5333-45e5-a619-b52b14162f56",
"company_code": "sample string 12",
"db_address_id": "c350fa83-5f31-46a7-b1b2-7468a3df54c3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "32c5ccb3-9498-41f3-9dbe-b9c125d32681",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "79bcae02-06b9-4324-ba1c-a02f47b414bf",
"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-08-14T07:29:01.8616352+00:00",
"date_create": "2026-08-14T07:29:01.8616352+00:00",
"date_update": "2026-08-14T07:29:01.8616352+00:00",
"updated_by_user_id": "e96862c2-1abf-49b3-959d-1b37aa02b0a7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-14T07:29:01.8616352+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-08-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-14T07:29:01.8616352+00:00",
"date_last_job": "2026-08-14T07:29:01.8616352+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-14T07:29:01.8616352+00:00",
"modified_dateutc": "2026-08-14T07:29:01.8616352+00:00",
"is_mobile_installation": true
},
"job_type_id": "7bb8d068-d3da-4320-9843-4b0e67da0092",
"job_type_code": "sample string 7",
"job_type": {
"id": "e6c9fc37-eb3b-42a9-9c45-45109a7f00a8",
"name": "sample string 2",
"sales_organization_id": "1adf3be1-8062-4d9c-b5c5-a92214a721c7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-14T07:29:01.8616352+00:00",
"code": "sample string 7"
},
"job_priority_id": "bf74f085-d814-447b-8b90-900318032709",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "71a16600-ce4b-44fd-9e38-61763a927a9a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2e76c58e-254f-4a8b-a3ed-249c211841cc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ca577003-40cc-4527-9e9f-39d9a85bd2d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17053723-bfae-4a72-9804-77eecc42c237",
"db_currency_id": "9caca9af-2a7f-4dfb-a0e5-a2c49ef8f7a2",
"db_language_id": "e0ef0003-bd0c-4cdd-8278-25ba827a2e8a",
"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-08-14T07:29:01.8616352+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-14T07:29:01.8616352+00:00"
},
"job_status_id": "7e8d7e21-5335-4dfe-918e-5c8d5a32b707",
"job_status_code": "sample string 11",
"db_address_id": "b181198e-16fd-4338-b6dd-606e88bcf017",
"contact_id": "2abb5c0b-5362-43d2-9357-0064cad9e07b",
"requested_by_company_id": "51891546-5527-4218-aa66-b5e87b0a8794",
"requested_by_contact_id": "2ae0ce0e-dda1-49cc-be17-1ce7c7e388a6",
"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-08-14T07:29:01.8772598+00:00",
"due_date": "2026-08-14T07:29:01.8772598+00:00",
"date_create": "2026-08-14T07:29:01.8772598+00:00",
"date_update": "2026-08-14T07:29:01.8772598+00:00",
"date_closed": "2026-08-14T07:29:01.8772598+00:00",
"suggested_user_id": "5a086732-d756-48f9-ac90-b88a7c1c6a91",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d253b156-e083-46ef-926e-8034cf211f34",
"db_language_id": "0549c321-aafc-43e7-98cd-ba50f2676f9f",
"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-08-14T07:29:01.8772598+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8eec9796-5fe4-4240-a760-7bc8f1588339",
"sales_organization": {
"id": "ca577003-40cc-4527-9e9f-39d9a85bd2d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17053723-bfae-4a72-9804-77eecc42c237",
"db_currency_id": "9caca9af-2a7f-4dfb-a0e5-a2c49ef8f7a2",
"db_language_id": "e0ef0003-bd0c-4cdd-8278-25ba827a2e8a",
"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-08-14T07:29:01.8616352+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "555d8b1a-5b24-4ce5-9704-616733207d8c",
"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": "822f2320-ba3e-4aa1-b09f-9ecb5636e13b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-14T07:29:01.8772598+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c5ac6bc5-7df4-46f0-8625-168aaad7d7dd"
},
"suggested_date_start": "2026-08-14T07:29:01.8772598+00:00",
"skill_id": "9e2b0887-5088-4d77-b75f-b3b416e2d2a6",
"skill_code": "sample string 32",
"skill": {
"id": "92663a8c-99fe-4ea4-b0c4-825f35823564",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a24202f2-492b-4acd-abed-a4ca97f22984",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ca577003-40cc-4527-9e9f-39d9a85bd2d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17053723-bfae-4a72-9804-77eecc42c237",
"db_currency_id": "9caca9af-2a7f-4dfb-a0e5-a2c49ef8f7a2",
"db_language_id": "e0ef0003-bd0c-4cdd-8278-25ba827a2e8a",
"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-08-14T07:29:01.8616352+00:00"
},
"modified_dateutc": "2026-08-14T07:29:01.8772598+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5407e467-8129-46d6-8941-be208bdd60df",
"date_reported_by_company": "2026-08-14T07:29:01.8772598+00:00",
"id2": 36,
"company_id": "187c83bf-409f-4060-b9b2-b3d65567cb73",
"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": "8cf62c47-3395-46a1-afdc-0bf51e7ba906",
"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-08-14T07:29:01.8772598+00:00"
},
"work_instruction_details_id": "d88fbe76-460a-4f3f-b454-f0874f0f468a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f51ae661-1755-4601-9ba8-389bd2b2364c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "87605c8a-e283-4a28-8a9f-0d56288dc0b0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-14T07:29:01.8772598+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": "62dc39b6-4aa9-4fae-8899-bb72c7bf93da",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-14T07:29:01.8772598+00:00"
}