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 Pivot Module v1 API

The Relativity Pivot Module v1 API from Relativity — 7 operation(s) for relativity pivot module v1.

Relativity Relativity Pivot Module v1 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 Pivot Module v1. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and a getting-started guide.

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

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

7 operations 7 paths 53 schemas 2 GET4 POST1 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 7

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

Relativity Pivot Module v1 7
GET
/relativity-pivot/v1/workspaces/{workspaceID}/fields/group-by/{artifactTypeID}
[Public] IPivotFieldManager -
Relativity.Pivot.V1.IPivotFieldManager.GetFieldsForGroupByAsync 3 params → 200
GET
/relativity-pivot/v1/workspaces/{workspaceID}/fields/pivot-on/{artifactTypeID}
[Public] IPivotFieldManager -
Relativity.Pivot.V1.IPivotFieldManager.GetFieldsForPivotOnAsync 3 params → 200
POST
/relativity-pivot/v1/workspaces/{workspaceID}/profiles/{pivotProfileID}/execute
[Public] IPivotProfileManager -
Relativity.Pivot.V1.IPivotProfileManager.ExecutePivotProfileAsync 3 params body → 200
PUT
/relativity-pivot/v1/workspaces/{workspaceID}/profiles/{pivotProfileID}
[Public] IPivotProfileManager -
Relativity.Pivot.V1.IPivotProfileManager.UpdateProfileAsync 3 params body → 200
POST
/relativity-pivot/v1/workspaces/{workspaceID}/profiles
[Public] IPivotProfileManager -
Relativity.Pivot.V1.IPivotProfileManager.CreateProfileAsync 2 params body → 200
POST
/relativity-pivot/v1/workspaces/{workspaceID}/queries
[Public] IPivotQueryManager -
Relativity.Pivot.V1.IPivotQueryManager.ExecuteAsync 2 params body → 200
POST
/relativity-pivot/v1/workspaces/{workspaceID}/queries/export
[Public] IPivotQueryManager -
Relativity.Pivot.V1.IPivotQueryManager.ExecuteExportAsync 2 params body → 200

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are TypeInfo (72 properties), Type (64 properties), MethodInfo (33 properties), NumberFormatInfo (30 properties). Each schema is shown below with its type and property counts.

DateTimeFormatInfo
object
28 properties
SortVersion
object
2 properties
CustomAttributeData
object
4 properties
DataTable
object
22 properties
Object
object
TypeInfo
object
72 properties
DataColumn
object
22 properties
PivotExportResult
object
3 properties
FieldRef
object
4 properties
FieldInfo
object
25 properties
CompareInfo
object
3 properties
SearchProviderCondition
object
2 properties
MemberInfo
object
7 properties
IComponent
object
1 property
Query
object
10 properties
SampleParameters
object
5 properties
RuntimeTypeHandle
object
1 property
TextInfo
object
9 properties
ICustomAttributeProvider
object
PropertyInfo
object
14 properties
CultureInfo
object
27 properties
PivotSettings
object
11 properties
Sort
object
3 properties
Module
object
9 properties
DataSet
object
17 properties
EventInfo
object
14 properties
IContainer
object
1 property
CustomAttributeTypedArgument
object
2 properties
ISite
object
4 properties
MethodInfo
object
33 properties
DashboardPivot
object
6 properties
PivotResultSet
object
7 properties
Calendar
object
6 properties
NumberFormatInfo
object
30 properties
Binder
object
ParameterInfo
object
15 properties
IntPtr
object
1 property
Assembly
object
19 properties
ConstructorInfo
object
30 properties
Dashboard
object
12 properties
CustomAttributeNamedArgument
object
4 properties
RuntimeFieldHandle
object
1 property
MethodBase
object
30 properties
PivotProfile
object
18 properties
StructLayoutAttribute
object
2 properties
Type
object
64 properties
ModuleHandle
object
1 property
ToggleOptions
object
7 properties
HeaderSettings
object
6 properties
DisplayableObjectTypeIdentifier
object
4 properties
DashboardImage
object
6 properties
RuntimeMethodHandle
object
1 property
SearchIndexRef
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-relativity-pivot-module-v1-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