Views

Views provide a flexible method for displaying data within the system. Unlike pre-defined views, they are configured by the client to meet specific needs. They utilize existing data services and client-side rendering to create tailored interfaces.

View Structure

A View is defined using a JSON object. The table below outlines the key properties of this object:

Parameter	Type	Description
id	integer	Unique identifier of the View.
name	string	User-friendly name for the View.
description	string	Detailed description of the View’s purpose.
view_type	string	Type of view: Entity or Panel.
active	boolean	Indicates whether the View is currently active.
shareable	boolean	Indicates whether the View can be shared.
created_at	string	Timestamp indicating when the View was created.
last_modified	string	Timestamp indicating when the View was last modified.
domain_id	integer	Identifier of the domain to which the View belongs.
created_by	integer	Identifier of the user who created the View.
last_modified_by	integer	Identifier of the user who last modified the View.

View Types

Views can be one of the following types:

• Panel: A container for displaying multiple widgets (tables, charts, forms) in a grid layout. Suited for dashboards and customizable interfaces.
• Entity: Designed to display the entity’s default table. It uses the TableLayout and system data services. Applying an Entity view reloads entity data from the server, incorporating filters and sorting from the view config.
• Table: A view for displaying data in a tabular format. It uses the TableLayout and system data services.
• Form: (Not implemented) A view to display data using forms.

Note: Table, and Form views can also be embedded as widgets within Panel or Entity views.

API Endpoints

The following API endpoints are used for managing Views. Ensure to include a domain header with the appropriate domain ID.

Method	URI	Description
GET	/api/v1/views/:entity	Retrieve all Views for a specified entity.
GET	/api/v1/views/:entity/:viewId	Retrieve a specific View by its ID.
POST	/api/v1/views/:entity	Create a new View.
PUT	/api/v1/views/:entity/:viewId	Update an existing View.
DELETE	/api/v1/views/:entity/:viewId	Delete a View.

Get all views for an entity

GET /api/v1/views/:entity HTTP/1.1
domain: :domain_id

Get a view by ID

GET /api/v1/views/:entity/:viewId HTTP/1.1
domain: :domain_id

Create a new view

• Request:

POST /api/v1/views/:entity HTTP/1.1
domain: :domain_id
Content-Type: application/json

• Payload (Example):

{
  "name": "My Created View",
  "active": true,
  "shareable": false,
  "description": "This is an created View",
  "view_type": "Panel",
  "view_data": {
    "title": "My View Title Created",
    "columns": 1,
    "widgets": [
      {
        "type": "TableLayout",
        "data": {
          "entity": ":entity",
          "fields": [ "name", "registration_number", "date_of_birth"],
          "search": "",
          "filters": [
            {
              "field": "color",
              "value": "Brown",
              "operator": "eq"
            }
          ],
          "sorting": [
            {
              "field": "date_of_birth",
              "direction": "asc"
            }
          ],
          "grouping": {},
          "relationships": []
        }
      }
    ]
  }
}

Update an existing view

• Request:

PUT /api/v1/views/:entity/:viewId HTTP/1.1
domain: :domain_id
Content-Type: application/json

• Payload (Example):

{
    "id": 22,
    "name": "My Updated View",
    "active": true,
    "shareable": false,
    "description": "This is an updated View",
    "view_type": "Panel",
    "view_data": {
        "title": "My View Title Updated",
        "columns": 1,
        "widgets": [
            {
                "type": "TableLayout",
                "data": {
                    "entity": ":entity",
                    "fields": [
                         "name",
                         "registration_number",
                         "color"
                    ],
                    "search": "",
                    "filters": [
                        {
                            "field": "color",
                            "value": "Orange",
                            "operator": "eq"
                        }
                    ],
                    "sorting": [
                        {
                            "field": "date_of_birth",
                            "direction": "asc"
                        }
                    ],
                    "grouping": {},
                    "relationships": []
                }
            }
        ]
    }
}

Delete a view

DELETE /api/v1/views/:entity/:viewId HTTP/1.1
domain: :domain_id