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": "1a908bfe-e60e-460e-a571-a4605bddb62d",
"jobs_id": "8fdf5933-05b7-442a-a59c-743708849b04",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6129cbe4-72c1-4bea-8783-38b1d71b82a3",
"_parent_id": "689808d2-24dd-4a8a-a2ec-e7833d870875",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "792a2eff-647f-42c6-9af5-cba3792f59fb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3a56b317-5d13-409e-b57d-a130b320bb48",
"_parent_id": "de81210b-9a7c-4437-aecf-9bbc117c1c10",
"root_parent_id": "3569f0af-787a-4485-b5b7-d4f2d12b8081",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3f0a9c6a-4322-4e5d-918a-fb1aac56ec1d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8faf117f-dc0a-4b39-8254-91321fbfec44",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d66fc52c-b436-46c5-a65d-5eea1f1e751d",
"_parent_code": "sample string 6",
"sales_organization_id": "cb41b433-be84-4435-b4bb-e26292a8d2d1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7b662400-ef40-4e62-8468-02647893686f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d338d689-71db-42c5-a4cb-4402401c8e93",
"db_currency_id": "2664e4a1-4678-413e-ad12-8df4046e3ea5",
"db_language_id": "6181520a-c2dc-4cd7-bf61-71fd7fe5dc4a",
"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-12-23T20:48:19.2727405+00:00"
},
"modified_dateutc": "2025-12-23T20:48:19.2727405+00:00"
},
"equipment_model_id": "716bc449-4084-4646-b133-a454109dfeb0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ce9d2b55-eac9-4825-aa65-dc247b814a49",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f19e7a3f-8084-4526-96b6-14ea7665e7f6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b334ffdc-8872-49a7-87d7-f43a1ead3a9e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "512ca001-f73a-4d96-b850-70f5cf28f414",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7b662400-ef40-4e62-8468-02647893686f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d338d689-71db-42c5-a4cb-4402401c8e93",
"db_currency_id": "2664e4a1-4678-413e-ad12-8df4046e3ea5",
"db_language_id": "6181520a-c2dc-4cd7-bf61-71fd7fe5dc4a",
"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-12-23T20:48:19.2727405+00:00"
},
"modified_dateutc": "2025-12-23T20:48:19.2727405+00:00"
},
"equipment_family_id": "4d6d2db2-01c4-43bc-9c06-0be7c30853a6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8faf117f-dc0a-4b39-8254-91321fbfec44",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d66fc52c-b436-46c5-a65d-5eea1f1e751d",
"_parent_code": "sample string 6",
"sales_organization_id": "cb41b433-be84-4435-b4bb-e26292a8d2d1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7b662400-ef40-4e62-8468-02647893686f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d338d689-71db-42c5-a4cb-4402401c8e93",
"db_currency_id": "2664e4a1-4678-413e-ad12-8df4046e3ea5",
"db_language_id": "6181520a-c2dc-4cd7-bf61-71fd7fe5dc4a",
"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-12-23T20:48:19.2727405+00:00"
},
"modified_dateutc": "2025-12-23T20:48:19.2727405+00:00"
},
"date_in_production_since": "2025-12-23T20:48:19.2727405+00:00",
"date_out_of_production_since": "2025-12-23T20:48:19.2727405+00:00",
"date_end_support": "2025-12-23T20:48:19.2727405+00:00",
"sales_organization_id": "8919aa17-aa45-49ff-a5fc-5b5ac51997fc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7b662400-ef40-4e62-8468-02647893686f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d338d689-71db-42c5-a4cb-4402401c8e93",
"db_currency_id": "2664e4a1-4678-413e-ad12-8df4046e3ea5",
"db_language_id": "6181520a-c2dc-4cd7-bf61-71fd7fe5dc4a",
"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-12-23T20:48:19.2727405+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-12-23T20:48:19.2727405+00:00"
},
"project_status_id": "adb09a25-4d3e-485c-b206-e294eb5c13ce",
"project_status_code": "sample string 10",
"project_status": {
"id": "2ee8bde0-4944-48d2-9626-83f6bac340c7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8e0801fa-06e5-433b-b48d-794cb0bf64ce",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7b662400-ef40-4e62-8468-02647893686f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d338d689-71db-42c5-a4cb-4402401c8e93",
"db_currency_id": "2664e4a1-4678-413e-ad12-8df4046e3ea5",
"db_language_id": "6181520a-c2dc-4cd7-bf61-71fd7fe5dc4a",
"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-12-23T20:48:19.2727405+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-23T20:48:19.2727405+00:00"
},
"company_id": "d7a3945a-2030-4ed2-94b8-6f1c367a39f8",
"company_code": "sample string 12",
"db_address_id": "222d8031-1e34-4273-992f-c06e44746da2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c8324606-9d86-4ee8-ad90-e0291406e731",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f037a0e1-5d53-4af6-abf2-e617ff232439",
"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-12-23T20:48:19.2727405+00:00",
"date_create": "2025-12-23T20:48:19.2727405+00:00",
"date_update": "2025-12-23T20:48:19.2727405+00:00",
"updated_by_user_id": "050e87cd-8e84-4ee4-ad02-f9c71ece165e",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-23T20:48:19.2727405+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-12-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-23T20:48:19.2727405+00:00",
"date_last_job": "2025-12-23T20:48:19.2727405+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-23T20:48:19.2727405+00:00",
"modified_dateutc": "2025-12-23T20:48:19.2727405+00:00",
"is_mobile_installation": true
},
"job_type_id": "034fc76c-b128-4328-857e-965c935d3a81",
"job_type_code": "sample string 7",
"job_type": {
"id": "a678f419-0030-4b17-a0a1-06cd56e2923e",
"name": "sample string 2",
"sales_organization_id": "50b675d3-b63d-4919-a865-fa1bae097225",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-23T20:48:19.2727405+00:00",
"code": "sample string 7"
},
"job_priority_id": "84f6d2b7-2d28-4556-a503-de74dc95e5d5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7119636c-2d97-410c-a0b2-964ef79aec4c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3a1775d5-2f2f-43ac-9463-3dbbc197c9a3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7b662400-ef40-4e62-8468-02647893686f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d338d689-71db-42c5-a4cb-4402401c8e93",
"db_currency_id": "2664e4a1-4678-413e-ad12-8df4046e3ea5",
"db_language_id": "6181520a-c2dc-4cd7-bf61-71fd7fe5dc4a",
"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-12-23T20:48:19.2727405+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-23T20:48:19.2727405+00:00"
},
"job_status_id": "1bf5e4ac-88a3-4baa-b360-9182f409c107",
"job_status_code": "sample string 11",
"db_address_id": "bea0f045-6bd4-4ec7-a10c-e7b62a393895",
"contact_id": "135b116e-5bcc-4f08-b842-50d259c2f583",
"requested_by_company_id": "8eb84c5f-74f8-4f03-bd9f-37d43738a1f8",
"requested_by_contact_id": "d590e411-73ea-4fc9-9cd0-cf73563acc24",
"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-12-23T20:48:19.2727405+00:00",
"due_date": "2025-12-23T20:48:19.2727405+00:00",
"date_create": "2025-12-23T20:48:19.2727405+00:00",
"date_update": "2025-12-23T20:48:19.2727405+00:00",
"date_closed": "2025-12-23T20:48:19.2727405+00:00",
"suggested_user_id": "1f3b9b1e-73a5-4978-aec4-c1ab90f7df57",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c182cbb8-dfbe-46a6-934a-b7d564385dae",
"db_language_id": "03d35feb-f003-4547-a4e6-6cb2b2494516",
"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-12-23T20:48:19.2727405+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ed3f0ed8-8489-4155-b0b1-e725b89e2468",
"sales_organization": {
"id": "7b662400-ef40-4e62-8468-02647893686f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d338d689-71db-42c5-a4cb-4402401c8e93",
"db_currency_id": "2664e4a1-4678-413e-ad12-8df4046e3ea5",
"db_language_id": "6181520a-c2dc-4cd7-bf61-71fd7fe5dc4a",
"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-12-23T20:48:19.2727405+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f0172d13-c168-4cdc-a191-0b015a15c827",
"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": "c8b3fc09-8d1e-4155-8d70-c0e4b147e860",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-23T20:48:19.2727405+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "05ec88c6-c895-4306-b432-0d9c3d9a90a2"
},
"suggested_date_start": "2025-12-23T20:48:19.2727405+00:00",
"skill_id": "71234c87-3b21-43d7-a1f8-38dbf74a5e71",
"skill_code": "sample string 32",
"skill": {
"id": "8decb4f6-8a73-419a-b355-916a9ebd6a14",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "698eca39-b729-4dfb-93bb-01c75cf9f893",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7b662400-ef40-4e62-8468-02647893686f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d338d689-71db-42c5-a4cb-4402401c8e93",
"db_currency_id": "2664e4a1-4678-413e-ad12-8df4046e3ea5",
"db_language_id": "6181520a-c2dc-4cd7-bf61-71fd7fe5dc4a",
"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-12-23T20:48:19.2727405+00:00"
},
"modified_dateutc": "2025-12-23T20:48:19.2727405+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "280481d1-825a-4afd-bea6-0e14093075f7",
"date_reported_by_company": "2025-12-23T20:48:19.2727405+00:00",
"id2": 36,
"company_id": "a6aefaca-442e-4890-92e0-d985dd759c51",
"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": "3d7477e3-b658-4bd9-b2f3-c309eb4d92b3",
"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-12-23T20:48:19.2727405+00:00"
},
"work_instruction_details_id": "c3286fea-867f-46fe-aead-c6e9214bc89f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ed904fe2-86e9-4fb4-9d73-4192e5bc8046",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "294e6a01-9af8-4af3-a448-4e4ce201d56f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-23T20:48:19.2727405+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": "f4067e5f-9c8c-49fc-8c5f-5bfe3e61ced2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-23T20:48:19.2727405+00:00"
}