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

Zaius Relationships schema API

The Relationships schema API from Zaius — 2 operation(s) for relationships schema.

Zaius Relationships schema API is one of 17 APIs that Zaius publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Relationships schema. The published artifact set on APIs.io includes an OpenAPI specification.

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

Requests are made against 3 base URLs: https://api.us1.odp.optimizely.com/v3, https://api.eu1.odp.optimizely.com/v3, https://api.au1.odp.optimizely.com/v3.

3 operations 2 paths 3 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v3
Base URL
https://api.us1.odp.optimizely.com/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Zaius Relationships schema API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (x-api-key). By default, every request must be authenticated.

Paths & Operations 3

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

Relationships schema 3
POST
/schema/objects/{object_name}/relations
Create relationship
create-relationship 1 param body → 200400403
GET
/schema/objects/{object_name}/relations
List relations
list-relations 1 param → 200400403
GET
/schema/objects/{object_name}/relations/{relation_name}
Get relation
get-relation 2 params → 200400403

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Object (6 properties), Relation (5 properties), Error (4 properties). Each schema is shown below with its type and property counts.

Object
object
6 properties 5 required
Relation
object
5 properties 5 required
Error
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zaius-relationships-schema-api-openapi.yml Raw ↑

Other APIs Zaius publishes across the network.

Zaius Compliance API
Zaius Consent API
Zaius Consent (Legacy) API
Zaius Customers API
Zaius Events API
Zaius Exports API
Zaius Fields schema API
Zaius Identifiers API
Zaius Lists API
Zaius Object schema API
Zaius Objects API
Zaius Orders API