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

Relativity Relativity Automated Workflows API

The Relativity Automated Workflows API from Relativity — 4 operation(s) for relativity automated workflows.

Relativity Relativity Automated Workflows API is one of 51 APIs that Relativity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Relativity Automated Workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and a getting-started guide.

This API exposes 6 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 3.0.1, at version V1.

Requests are made against a single base URL, /Relativity.REST/api.

6 operations 4 paths 7 schemas 2 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
V1
Base URL
https://{host}/Relativity.REST/api/relativity-object-model/v1
Resource Areas
1

Paths & Operations 6

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

Relativity Automated Workflows 6
POST
/relativity-automated-workflows/v2/workspaces/{workspaceID}/notifiers/trigger
Notifies the given workspace a trigger has happened
1 param → 200
GET
/relativity-automated-workflows/v2/workspaces/{workspaceID}/actions
List Triggers in a Workspace
1 param → 200
PUT
/relativity-automated-workflows/v2/workspaces/{workspaceID}/actions
Creates or Updates an Action
1 param body → 200400default
GET
/relativity-automated-workflows/v2/workspaces/{workspaceID}/triggers
List Triggers in a Workspace
1 param → 200
PUT
/relativity-automated-workflows/v2/workspaces/{workspaceID}/triggers
Creates or Updates a Trigger
1 param body → 200400default
POST
/relativity-automated-workflows/v2/language/expressions/run
Run/Debug Language Expression
body → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ActionModel (7 properties), TriggerModel (6 properties), ExpressionRunResult (4 properties), GenericResponse (4 properties). Each schema is shown below with its type and property counts.

RedirectPath
object
CDN-hosted MFE path for a custom input UI. AW builds the full path as /{MfeAppName}/{Path}, adding slashes where missing.
2 properties
HttpInputSourceDefinition
object
HTTP GET endpoint used as a dynamic input source. Can be set alongside ObjectManagerQueryInputSource to enable RDO fallback if the HTTP endpoint fails.
3 properties
GenericResponse
object
4 properties 2 required
CidAuth
object
The CID authorization details for this endpoint, declared when the integrator registered their service with CID during BFF setup. AW uses these to authenticate…
2 properties
ExpressionRunResult
object
4 properties 1 required
TriggerModel
object
The root schema comprises the entire JSON document.
6 properties 6 required
ActionModel
object
The root schema comprises the entire JSON document.
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-relativity-automated-workflows-api-openapi.yml Raw ↑

Other APIs Relativity publishes across the network.

Relativity AnnotationService API
Relativity ArchiveJobs API
Relativity ARM Module v1 API
Relativity ARM Module v3 API
Relativity BillableSummaryReports API
Relativity BillingConfiguration API
Relativity BillingInsights API
Relativity Client Side Libraries Module API
Relativity ColdStorage API
Relativity CollectAPI API
Relativity Conceptual Analytics v1 API
Relativity Directory API