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 Elements API

Manage elements imported from connected cloud sources

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

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

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

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

3 operations 2 paths 10 schemas 1 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 Elements API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (ClientCredentials) using the clientCredentials flow.

Paths & Operations 3

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

Elements 3

Manage elements imported from connected cloud sources

POST
/elements
Import an existing connected-source table as an element
createElement body → 201400401403404422429500
GET
/elements/{alias}
Get an element by alias
getElement 1 param → 200400401403404422429500
PUT
/elements/{alias}
Update an element by alias
updateElement 1 param body → 200400401403404422429500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are ElementCreateRequest (22 properties), Aspect (13 properties), AspectFieldInput (10 properties), ElementUpdateRequest (10 properties). Each schema is shown below with its type and property counts.

AspectFieldInput
object
10 properties 2 required
AspectCategoryRef
object
2 properties
AspectSourceType
string
Where an aspect's data lives. ELEMENTUM = native; SNOWFLAKE = imported from a connected Snowflake table.
ElementCreateRequest
object
Body for POST /v1/elements. Three modes: (1) import — cloudLinkId + database/schema/table/idColumn/titleColumn; columns are discovered from the source table an…
22 properties 2 required
ElementUpdateRequest
object
Body for PUT /v1/elements/{alias}. Partial update: only the fields present are changed. Source binding (cloud link, source table, field schema) is fixed at cre…
10 properties
AspectFieldType
string
The Elementum field data type
CloudOptionsInput
object
1 property
Aspect
object
13 properties
SnowflakeOptionsInput
object
1 property
RecordCreateTypesInput
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elementum-elements-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 Flows API
Elementum Groups API
Elementum Records API
Elementum Related-items API
Elementum Search Tables API