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 Related-items API

Manage the related items of a record

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

Tagged areas include Related-items. 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 4 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 4 schemas 1 DELETE1 GET1 POST

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 Related-items 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 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Related-items 3

Manage the related items of a record

GET
/{recordType}/{alias}/{id}/related-items
Get the list of related items
getRecordRelations 3 params → 200400401403404422429500
POST
/{recordType}/{alias}/{id}/related-items
Add a related item
createRecordRelatedItems 3 params body → 201400401403404422429500
DELETE
/{recordType}/{alias}/{id}/related-items/{itemId}
Remove a related item
deleteRecordRelatedItems 4 params → 200400401403404422429500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are PagingState (4 properties), RelatedListItem (4 properties), RelatedPagedList (3 properties), RelatedItemInput (2 properties). Each schema is shown below with its type and property counts.

RelatedListItem
object
4 properties
PagingState
object
4 properties
RelatedPagedList
object
3 properties
RelatedItemInput
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elementum-related-items-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 Search Tables API