Retrieves all the job work instruction list.
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
job_work_instruction_listName | 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
{ "id": "ad19789b-d4ad-4917-aa88-7ebfd4e50e1e", "jobs_id": "e68d3afb-f7fc-4b1a-a127-17eb0411df83", "jobs_reference_back_office": "sample string 3", "jobs": { "id": "1e92ab96-8819-45c9-bf8e-b497cd58333f", "_parent_id": "239f435b-b3fb-4cdb-98e6-ed605ff2d1ce", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "4af10336-6a6d-4841-8b72-c33ea9b74ed6", "project_reference_back_office": "sample string 5", "project": { "id": "e1e81455-35f4-40b1-a08b-74605f9d5515", "_parent_id": "9ac82512-a275-4513-adb6-e74c6b7ac7ea", "root_parent_id": "d406d329-a2b5-41eb-baf7-b25abc2922d4", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "f325776c-a4ef-457e-8929-fe3da6624662", "equipment_family_code": "sample string 6", "equipment_family": { "id": "1399b87a-1d88-4fa1-bbf6-2f315df25394", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "89d23f4e-dbae-46ca-9c2f-7bddd084a6e7", "_parent_code": "sample string 6", "sales_organization_id": "e2c0c593-c5c2-4b92-ad37-be53ab253562", "sales_organization_code": "sample string 8", "sales_organization": { "id": "9050b2be-93ae-41c7-970c-0ef8188d5d36", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "aae2ae30-9d30-46b2-9696-5e2a54b97e8b", "db_currency_id": "f37b0ab8-6482-4ac5-8bf4-37801af05b99", "db_language_id": "e5d554fc-ba5e-486b-a70f-096020e89a35", "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-07-13T05:39:35.5621237+00:00" }, "modified_dateutc": "2025-07-13T05:39:35.5621237+00:00" }, "equipment_model_id": "da04a81d-3922-4d21-95ba-58b97b5ef13f", "equipment_model_code": "sample string 8", "equipment_model": { "id": "2a815e6f-9697-4376-bc9a-b11bfd3de946", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "9238acfa-e6a5-443c-998d-5b595ac223b3", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "a315ceba-80ed-4bb2-8a47-b8cebbaf8e91", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "3d835445-5500-4465-8f2a-9234e8cdfee4", "sales_organization_code": "sample string 5", "sales_organization": { "id": "9050b2be-93ae-41c7-970c-0ef8188d5d36", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "aae2ae30-9d30-46b2-9696-5e2a54b97e8b", "db_currency_id": "f37b0ab8-6482-4ac5-8bf4-37801af05b99", "db_language_id": "e5d554fc-ba5e-486b-a70f-096020e89a35", "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-07-13T05:39:35.5621237+00:00" }, "modified_dateutc": "2025-07-13T05:39:35.5621237+00:00" }, "equipment_family_id": "428f26ca-5c2d-47a5-987e-a48eef8b10f2", "equipment_family_code": "sample string 8", "equipment_family": { "id": "1399b87a-1d88-4fa1-bbf6-2f315df25394", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "89d23f4e-dbae-46ca-9c2f-7bddd084a6e7", "_parent_code": "sample string 6", "sales_organization_id": "e2c0c593-c5c2-4b92-ad37-be53ab253562", "sales_organization_code": "sample string 8", "sales_organization": { "id": "9050b2be-93ae-41c7-970c-0ef8188d5d36", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "aae2ae30-9d30-46b2-9696-5e2a54b97e8b", "db_currency_id": "f37b0ab8-6482-4ac5-8bf4-37801af05b99", "db_language_id": "e5d554fc-ba5e-486b-a70f-096020e89a35", "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-07-13T05:39:35.5621237+00:00" }, "modified_dateutc": "2025-07-13T05:39:35.5621237+00:00" }, "date_in_production_since": "2025-07-13T05:39:35.5621237+00:00", "date_out_of_production_since": "2025-07-13T05:39:35.5621237+00:00", "date_end_support": "2025-07-13T05:39:35.5621237+00:00", "sales_organization_id": "81e7b8f8-af15-46b3-a133-bcb783488ffb", "sales_organization_code": "sample string 13", "sales_organization": { "id": "9050b2be-93ae-41c7-970c-0ef8188d5d36", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "aae2ae30-9d30-46b2-9696-5e2a54b97e8b", "db_currency_id": "f37b0ab8-6482-4ac5-8bf4-37801af05b99", "db_language_id": "e5d554fc-ba5e-486b-a70f-096020e89a35", "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-07-13T05:39:35.5621237+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-07-13T05:39:35.6089998+00:00" }, "project_status_id": "9f458a78-7f12-45eb-8c20-9f44e60c9f12", "project_status_code": "sample string 10", "project_status": { "id": "a446f6bf-5774-43e8-a29f-cc0c79e4055e", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "b20206f6-b7e4-41c3-8bbc-dd95493d68ca", "sales_organization_code": "sample string 6", "sales_organization": { "id": "9050b2be-93ae-41c7-970c-0ef8188d5d36", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "aae2ae30-9d30-46b2-9696-5e2a54b97e8b", "db_currency_id": "f37b0ab8-6482-4ac5-8bf4-37801af05b99", "db_language_id": "e5d554fc-ba5e-486b-a70f-096020e89a35", "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-07-13T05:39:35.5621237+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-13T05:39:35.6089998+00:00" }, "company_id": "d55205bf-648c-41ce-a55a-db0859525d8d", "company_code": "sample string 12", "db_address_id": "3cc13338-a0ac-4b1c-8d7a-505055ea1b77", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "ede7b257-101b-49b5-9cd4-00c5278c2110", "contact_reference_back_office": "sample string 17", "owner_user_id": "fc0106ed-6c56-4692-bd57-4067cf2f5db0", "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-07-13T05:39:35.6089998+00:00", "date_create": "2025-07-13T05:39:35.6089998+00:00", "date_update": "2025-07-13T05:39:35.6089998+00:00", "updated_by_user_id": "965f4ca7-1569-4938-bd98-5353a1fe4d4c", "customer_reference": "sample string 28", "warranty_date_until": "2025-07-13T05:39:35.6089998+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-07-13T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-07-13T05:39:35.6089998+00:00", "date_last_job": "2025-07-13T05:39:35.6089998+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-07-13T05:39:35.6089998+00:00", "modified_dateutc": "2025-07-13T05:39:35.6089998+00:00", "is_mobile_installation": true }, "job_type_id": "496dc6fc-4f41-4b3c-b9cf-0ee71ec6e057", "job_type_code": "sample string 7", "job_type": { "id": "2a354f69-7e9c-4455-bf52-19d6db2dbe9b", "name": "sample string 2", "sales_organization_id": "e44f1e1d-a0ae-4b78-bf32-84a5b44626be", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-07-13T05:39:35.6089998+00:00", "code": "sample string 7" }, "job_priority_id": "0d1f1712-227e-4037-95c6-5719f8d008e2", "job_priority_code": "sample string 9", "job_priority": { "id": "2e623fee-6191-488c-b535-6638759e0081", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "e359e424-8f85-4f8d-9d55-fc72fd4dd44f", "sales_organization_code": "sample string 6", "sales_organization": { "id": "9050b2be-93ae-41c7-970c-0ef8188d5d36", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "aae2ae30-9d30-46b2-9696-5e2a54b97e8b", "db_currency_id": "f37b0ab8-6482-4ac5-8bf4-37801af05b99", "db_language_id": "e5d554fc-ba5e-486b-a70f-096020e89a35", "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-07-13T05:39:35.5621237+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-13T05:39:35.6089998+00:00" }, "job_status_id": "1d63d432-a184-4a73-80b0-3f58db2e3aac", "job_status_code": "sample string 11", "db_address_id": "03ef7036-8dff-4feb-972f-1e25b0f041b6", "contact_id": "e38e3013-5e62-4667-a48b-888a4d1db564", "requested_by_company_id": "dddc8830-e4d1-47c0-b602-66f56a981ca0", "requested_by_contact_id": "6baa4ff9-ad56-4bd3-8466-cfcb70cd87e1", "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-07-13T05:39:35.6089998+00:00", "due_date": "2025-07-13T05:39:35.6089998+00:00", "date_create": "2025-07-13T05:39:35.6089998+00:00", "date_update": "2025-07-13T05:39:35.6089998+00:00", "date_closed": "2025-07-13T05:39:35.6089998+00:00", "suggested_user_id": "a7eb0f93-5117-4273-b0b1-ca315c685f89", "suggested_user_code": "sample string 29", "suggested_user": { "id": "a88bcf72-359f-48d4-a262-566272cc2cf1", "db_language_id": "dfc22836-217c-4adf-a6e4-9b24c26bccb8", "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-07-13T05:39:35.6089998+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "6646e712-ef49-4366-9bbf-b8a5af8db1d3", "sales_organization": { "id": "9050b2be-93ae-41c7-970c-0ef8188d5d36", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "aae2ae30-9d30-46b2-9696-5e2a54b97e8b", "db_currency_id": "f37b0ab8-6482-4ac5-8bf4-37801af05b99", "db_language_id": "e5d554fc-ba5e-486b-a70f-096020e89a35", "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-07-13T05:39:35.5621237+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "e55d26d9-bd68-4e3d-b303-76034889d571", "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": "8bc55251-c259-4da6-9d76-359f821c2654", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-07-13T05:39:35.624629+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "519ad278-7d58-435d-9ae3-0608e2b86211" }, "suggested_date_start": "2025-07-13T05:39:35.624629+00:00", "skill_id": "1e46dd0c-f0ec-47a3-b1c6-fbc87f16f379", "skill_code": "sample string 32", "skill": { "id": "e53f2b77-d6e9-4f2f-819c-461b27929949", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "42550067-3157-4423-8e39-36a8f62fc987", "sales_organization_code": "sample string 6", "sales_organization": { "id": "9050b2be-93ae-41c7-970c-0ef8188d5d36", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "aae2ae30-9d30-46b2-9696-5e2a54b97e8b", "db_currency_id": "f37b0ab8-6482-4ac5-8bf4-37801af05b99", "db_language_id": "e5d554fc-ba5e-486b-a70f-096020e89a35", "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-07-13T05:39:35.5621237+00:00" }, "modified_dateutc": "2025-07-13T05:39:35.624629+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "15b88ab9-c697-42aa-99df-e5e03ac4b99b", "date_reported_by_company": "2025-07-13T05:39:35.624629+00:00", "id2": 36, "company_id": "d2f4ae46-a680-47b5-a527-8a6fa16c27f0", "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": "01946682-c20b-4b79-8bb2-60e0ab7b1852", "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-07-13T05:39:35.624629+00:00" }, "work_instruction_details_id": "419e3c32-5f47-462e-964c-a43d240330ca", "work_instruction_details_reference_back_office": "sample string 5", "user_id": "b3803c36-fb0b-4762-9e6f-b1fe130ef012", "work_instruction_action_type": "sample string 7", "work_instruction_id": "a5e41215-b1f0-4042-8878-ac6bb3dbd43d", "work_instruction_reference_back_office": "sample string 9", "name": "sample string 10", "status": "sample string 11", "date_done": "2025-07-13T05:39:35.624629+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": "85151589-03f9-4d53-9ed7-c43681b0702b", "db_report_type_name": "sample string 18", "modified_dateutc": "2025-07-13T05:39:35.624629+00:00" }