Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elementum Views API

Manage app views

Elementum Views API is one of 18 APIs that Elementum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Views. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 2 paths, and defines 12 schemas. It is described by OpenAPI 3.0.1, at version 0.0.1.

Requests are made against a single base URL, /v1.

4 operations 2 paths 12 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
0.0.1
Base URL
https://api.elementum.io/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Elementum Views API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (ClientCredentials) using the clientCredentials flow.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Views 4

Manage app views

GET
/apps/{alias}/views
List views under an app
listViews 5 params → 200400401403404422429500
POST
/apps/{alias}/views
Create a view under an app
createView 1 param body → 201400401403404422429500
GET
/apps/{alias}/views/{id}
Get a view by ID
getView 2 params → 200400401403404422429500
PUT
/apps/{alias}/views/{id}
Update a view under an app
updateView 2 params body → 200400401403404422429500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are AspectView (15 properties), Group (8 properties), User (6 properties), AspectViewInput (5 properties). Each schema is shown below with its type and property counts.

AspectViewUpdateRequest
object
View update body: the full desired view state plus an optional share set (the view's handle is on the path).
2 properties 1 required
AspectViewVariantInput
object
View configuration. Common fields are listed; type-specific fields (columns, density, rows, displayByField, allowedFilterFields, agentId, dashboardId) are acce…
4 properties
PagingState
object
4 properties
PassthroughObject
object
Free-form JSON object forwarded to/from the downstream service.
AspectViewCreateRequest
object
View create body: the handle that names the view, its full desired state, plus an optional share set.
3 properties 2 required
Group
object
8 properties
GroupDomain
object
2 properties
AspectView
object
An app view returned by the views endpoints.
15 properties
AspectViewPagedList
object
3 properties
AspectViewShareInput
object
Declarative share set. Omit to leave sharing untouched; present is a full-replace resync.
2 properties
AspectViewInput
object
Discriminator wrapper. Exactly one variant field (list, kanban, calendar, dashboard, agent) must be populated.
5 properties
User
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elementum-views-api-openapi.yml Raw ↑

Other APIs Elementum publishes across the network.

Elementum Access Token API
Elementum Agents API
Elementum Apps API
Elementum Attachments API
Elementum Automations API
Elementum Comments API
Elementum Domains API
Elementum Elements API
Elementum Flows API
Elementum Groups API
Elementum Records API
Elementum Related-items API