Relativity

Relativity Relativity Pivot Module v1 API

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

GitHub OpenAPI

Documentation

📖
Documentation
https://platform.relativity.com/RelativityOne/Content/REST_API/REST_API.htm
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/rate-limits/relativity-rate-limits.yml
📖
Documentation
https://platform.relativity.com/RelativityOne/Content/Relativity_Platform/Platform_APIs.htm
📖
GettingStarted
https://platform.relativity.com/RelativityOne/Content/Getting_Started/Basic_REST_API_concepts.htm
📖
Documentation
https://help.relativity.com/RelativityOne/Content/Management_Console/Cost_Explorer.htm

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/openapi/relativity-relativity-pivot-module-v1-api-openapi.yml

Other Resources

🔗
Plans
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/plans/relativity-plans-pricing.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/finops/relativity-finops.yml
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/graphql/relativity-graphql.md

OpenAPI Specification

relativity-relativity-pivot-module-v1-api-openapi.yml Raw ↑ 
openapi: 3.0.1
info:
  title: Analytics.Conceptual.Service.Interfaces.Public.V1 AnnotationService Relativity Pivot Module v1 API
  description: Analytics.Conceptual.Service.Interfaces.Public
  version: V1
servers:
- url: /Relativity.REST/api
  description: The URL prefix for all Kepler services
tags:
- name: Relativity Pivot Module v1
paths:
  /relativity-pivot/v1/workspaces/{workspaceID}/fields/group-by/{artifactTypeID}:
    get:
      tags:
      - Relativity Pivot Module v1
      description: '[Public] IPivotFieldManager - '
      operationId: Relativity.Pivot.V1.IPivotFieldManager.GetFieldsForGroupByAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/artifactTypeID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FieldRef'
  /relativity-pivot/v1/workspaces/{workspaceID}/fields/pivot-on/{artifactTypeID}:
    get:
      tags:
      - Relativity Pivot Module v1
      description: '[Public] IPivotFieldManager - '
      operationId: Relativity.Pivot.V1.IPivotFieldManager.GetFieldsForPivotOnAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/artifactTypeID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FieldRef'
  /relativity-pivot/v1/workspaces/{workspaceID}/profiles/{pivotProfileID}/execute:
    post:
      tags:
      - Relativity Pivot Module v1
      description: '[Public] IPivotProfileManager - '
      operationId: Relativity.Pivot.V1.IPivotProfileManager.ExecutePivotProfileAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/pivotProfileID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Query'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PivotResultSet'
  /relativity-pivot/v1/workspaces/{workspaceID}/profiles/{pivotProfileID}:
    put:
      tags:
      - Relativity Pivot Module v1
      description: '[Public] IPivotProfileManager - '
      operationId: Relativity.Pivot.V1.IPivotProfileManager.UpdateProfileAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/pivotProfileID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PivotProfile'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PivotProfile'
  /relativity-pivot/v1/workspaces/{workspaceID}/profiles:
    post:
      tags:
      - Relativity Pivot Module v1
      description: '[Public] IPivotProfileManager - '
      operationId: Relativity.Pivot.V1.IPivotProfileManager.CreateProfileAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PivotProfile'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PivotProfile'
  /relativity-pivot/v1/workspaces/{workspaceID}/queries:
    post:
      tags:
      - Relativity Pivot Module v1
      description: '[Public] IPivotQueryManager - '
      operationId: Relativity.Pivot.V1.IPivotQueryManager.ExecuteAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PivotSettings'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PivotResultSet'
  /relativity-pivot/v1/workspaces/{workspaceID}/queries/export:
    post:
      tags:
      - Relativity Pivot Module v1
      description: '[Public] IPivotQueryManager - '
      operationId: Relativity.Pivot.V1.IPivotQueryManager.ExecuteExportAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dashboard'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PivotExportResult'
components:
  schemas:
    DateTimeFormatInfo:
      title: DateTimeFormatInfo
      type: object
      properties:
        InvariantInfo:
          $ref: '#/components/schemas/DateTimeFormatInfo'
        CurrentInfo:
          $ref: '#/components/schemas/DateTimeFormatInfo'
        AMDesignator:
          type: string
        Calendar:
          $ref: '#/components/schemas/Calendar'
        DateSeparator:
          type: string
        FirstDayOfWeek:
          enum:
          - Sunday
          - Monday
          - Tuesday
          - Wednesday
          - Thursday
          - Friday
          - Saturday
          type: string
        CalendarWeekRule:
          enum:
          - FirstDay
          - FirstFullWeek
          - FirstFourDayWeek
          type: string
        FullDateTimePattern:
          type: string
        LongDatePattern:
          type: string
        LongTimePattern:
          type: string
        MonthDayPattern:
          type: string
        PMDesignator:
          type: string
        RFC1123Pattern:
          type: string
        ShortDatePattern:
          type: string
        ShortTimePattern:
          type: string
        SortableDateTimePattern:
          type: string
        TimeSeparator:
          type: string
        UniversalSortableDateTimePattern:
          type: string
        YearMonthPattern:
          type: string
        AbbreviatedDayNames:
          type: array
          items:
            type: string
        ShortestDayNames:
          type: array
          items:
            type: string
        DayNames:
          type: array
          items:
            type: string
        AbbreviatedMonthNames:
          type: array
          items:
            type: string
        MonthNames:
          type: array
          items:
            type: string
        IsReadOnly:
          type: boolean
        NativeCalendarName:
          type: string
        AbbreviatedMonthGenitiveNames:
          type: array
          items:
            type: string
        MonthGenitiveNames:
          type: array
          items:
            type: string
    SortVersion:
      title: SortVersion
      type: object
      properties:
        FullVersion:
          type: integer
        SortId:
          type: string
    CustomAttributeData:
      title: CustomAttributeData
      type: object
      properties:
        AttributeType:
          $ref: '#/components/schemas/Type'
        Constructor:
          $ref: '#/components/schemas/ConstructorInfo'
        ConstructorArguments:
          type: array
          items:
            $ref: '#/components/schemas/CustomAttributeTypedArgument'
        NamedArguments:
          type: array
          items:
            $ref: '#/components/schemas/CustomAttributeNamedArgument'
    DataTable:
      title: DataTable
      type: object
      properties:
        CaseSensitive:
          type: boolean
        IsInitialized:
          type: boolean
        RemotingFormat:
          enum:
          - Xml
          - Binary
          type: string
        ChildRelations:
          type: array
          items:
            type: string
            format: DataRelationCollection
        Columns:
          type: array
          items:
            type: string
            format: DataColumnCollection
        Constraints:
          type: array
          items:
            type: string
            format: ConstraintCollection
        DataSet:
          $ref: '#/components/schemas/DataSet'
        DefaultView:
          type: array
          items:
            type: string
            format: DataView
        DisplayExpression:
          type: string
        ExtendedProperties:
          type: array
          items:
            type: string
            format: PropertyCollection
        HasErrors:
          type: boolean
        Locale:
          $ref: '#/components/schemas/CultureInfo'
        MinimumCapacity:
          type: integer
        ParentRelations:
          type: array
          items:
            type: string
            format: DataRelationCollection
        PrimaryKey:
          type: array
          items:
            $ref: '#/components/schemas/DataColumn'
        Rows:
          type: array
          items:
            type: string
            format: DataRowCollection
        TableName:
          type: string
        Namespace:
          type: string
        Prefix:
          type: string
        Site:
          $ref: '#/components/schemas/ISite'
        Container:
          $ref: '#/components/schemas/IContainer'
        DesignMode:
          type: boolean
    Object:
      title: Object
      type: object
    TypeInfo:
      title: TypeInfo
      type: object
      properties:
        GenericTypeParameters:
          type: array
          items:
            $ref: '#/components/schemas/Type'
        DeclaredConstructors:
          type: array
          items:
            $ref: '#/components/schemas/ConstructorInfo'
        DeclaredEvents:
          type: array
          items:
            $ref: '#/components/schemas/EventInfo'
        DeclaredFields:
          type: array
          items:
            $ref: '#/components/schemas/FieldInfo'
        DeclaredMembers:
          type: array
          items:
            $ref: '#/components/schemas/MemberInfo'
        DeclaredMethods:
          type: array
          items:
            $ref: '#/components/schemas/MethodInfo'
        DeclaredNestedTypes:
          type: array
          items:
            $ref: '#/components/schemas/TypeInfo'
        DeclaredProperties:
          type: array
          items:
            $ref: '#/components/schemas/PropertyInfo'
        ImplementedInterfaces:
          type: array
          items:
            $ref: '#/components/schemas/Type'
        MemberType:
          enum:
          - Constructor
          - Event
          - Field
          - Method
          - Property
          - TypeInfo
          - Custom
          - NestedType
          - All
          type: string
        DeclaringType:
          $ref: '#/components/schemas/Type'
        DeclaringMethod:
          $ref: '#/components/schemas/MethodBase'
        ReflectedType:
          $ref: '#/components/schemas/Type'
        StructLayoutAttribute:
          $ref: '#/components/schemas/StructLayoutAttribute'
        GUID:
          type: string
        Module:
          $ref: '#/components/schemas/Module'
        Assembly:
          $ref: '#/components/schemas/Assembly'
        TypeHandle:
          $ref: '#/components/schemas/RuntimeTypeHandle'
        FullName:
          type: string
        Namespace:
          type: string
        AssemblyQualifiedName:
          type: string
        BaseType:
          $ref: '#/components/schemas/Type'
        TypeInitializer:
          $ref: '#/components/schemas/ConstructorInfo'
        IsNested:
          type: boolean
        Attributes:
          enum:
          - NotPublic
          - AutoLayout
          - AnsiClass
          - Class
          - Public
          - NestedPublic
          - NestedPrivate
          - NestedFamily
          - NestedAssembly
          - NestedFamANDAssem
          - NestedFamORAssem
          - VisibilityMask
          - SequentialLayout
          - ExplicitLayout
          - LayoutMask
          - Interface
          - ClassSemanticsMask
          - Abstract
          - Sealed
          - SpecialName
          - RTSpecialName
          - Import
          - Serializable
          - WindowsRuntime
          - UnicodeClass
          - AutoClass
          - StringFormatMask
          - CustomFormatClass
          - HasSecurity
          - ReservedMask
          - BeforeFieldInit
          - CustomFormatMask
          type: string
        GenericParameterAttributes:
          enum:
          - None
          - Covariant
          - Contravariant
          - VarianceMask
          - ReferenceTypeConstraint
          - NotNullableValueTypeConstraint
          - DefaultConstructorConstraint
          - SpecialConstraintMask
          type: string
        IsVisible:
          type: boolean
        IsNotPublic:
          type: boolean
        IsPublic:
          type: boolean
        IsNestedPublic:
          type: boolean
        IsNestedPrivate:
          type: boolean
        IsNestedFamily:
          type: boolean
        IsNestedAssembly:
          type: boolean
        IsNestedFamANDAssem:
          type: boolean
        IsNestedFamORAssem:
          type: boolean
        IsAutoLayout:
          type: boolean
        IsLayoutSequential:
          type: boolean
        IsExplicitLayout:
          type: boolean
        IsClass:
          type: boolean
        IsInterface:
          type: boolean
        IsValueType:
          type: boolean
        IsAbstract:
          type: boolean
        IsSealed:
          type: boolean
        IsEnum:
          type: boolean
        IsSpecialName:
          type: boolean
        IsImport:
          type: boolean
        IsSerializable:
          type: boolean
        IsAnsiClass:
          type: boolean
        IsUnicodeClass:
          type: boolean
        IsAutoClass:
          type: boolean
        IsArray:
          type: boolean
        IsGenericType:
          type: boolean
        IsGenericTypeDefinition:
          type: boolean
        IsConstructedGenericType:
          type: boolean
        IsGenericParameter:
          type: boolean
        GenericParameterPosition:
          type: integer
        ContainsGenericParameters:
          type: boolean
        IsByRef:
          type: boolean
        IsPointer:
          type: boolean
        IsPrimitive:
          type: boolean
        IsCOMObject:
          type: boolean
        HasElementType:
          type: boolean
        IsContextful:
          type: boolean
        IsMarshalByRef:
          type: boolean
        GenericTypeArguments:
          type: array
          items:
            $ref: '#/components/schemas/Type'
        IsSecurityCritical:
          type: boolean
        IsSecuritySafeCritical:
          type: boolean
        IsSecurityTransparent:
          type: boolean
        UnderlyingSystemType:
          $ref: '#/components/schemas/Type'
        Name:
          type: string
        CustomAttributes:
          type: array
          items:
            $ref: '#/components/schemas/CustomAttributeData'
        MetadataToken:
          type: integer
    DataColumn:
      title: DataColumn
      type: object
      properties:
        AllowDBNull:
          type: boolean
        AutoIncrement:
          type: boolean
        AutoIncrementSeed:
          type: integer
        AutoIncrementStep:
          type: integer
        Caption:
          type: string
        ColumnName:
          type: string
        Prefix:
          type: string
        DataType:
          $ref: '#/components/schemas/Type'
        DateTimeMode:
          enum:
          - Local
          - Unspecified
          - UnspecifiedLocal
          - Utc
          type: string
        DefaultValue:
          $ref: '#/components/schemas/Object'
        Expression:
          type: string
        ExtendedProperties:
          type: array
          items:
            type: string
            format: PropertyCollection
        MaxLength:
          type: integer
        Namespace:
          type: string
        Ordinal:
          type: integer
        ReadOnly:
          type: boolean
        Table:
          $ref: '#/components/schemas/DataTable'
        Unique:
          type: boolean
        ColumnMapping:
          enum:
          - Element
          - Attribute
          - SimpleContent
          - Hidden
          type: string
        Site:
          $ref: '#/components/schemas/ISite'
        Container:
          $ref: '#/components/schemas/IContainer'
        DesignMode:
          type: boolean
    PivotExportResult:
      title: PivotExportResult
      type: object
      properties:
        ContentType:
          type: string
        Content:
          type: string
        Success:
          type: boolean
    FieldRef:
      title: FieldRef
      type: object
      properties:
        ArtifactID:
          type: integer
        ViewFieldID:
          type: integer
        Guids:
          type: array
          items:
            type: string
        Name:
          type: string
    FieldInfo:
      title: FieldInfo
      type: object
      properties:
        MemberType:
          enum:
          - Constructor
          - Event
          - Field
          - Method
          - Property
          - TypeInfo
          - Custom
          - NestedType
          - All
          type: string
        FieldHandle:
          $ref: '#/components/schemas/RuntimeFieldHandle'
        FieldType:
          $ref: '#/components/schemas/Type'
        Attributes:
          enum:
          - PrivateScope
          - Private
          - FamANDAssem
          - Assembly
          - Family
          - FamORAssem
          - Public
          - FieldAccessMask
          - Static
          - InitOnly
          - Literal
          - NotSerialized
          - HasFieldRVA
          - SpecialName
          - RTSpecialName
          - HasFieldMarshal
          - PinvokeImpl
          - HasDefault
          - ReservedMask
          type: string
        IsPublic:
          type: boolean
        IsPrivate:
          type: boolean
        IsFamily:
          type: boolean
        IsAssembly:
          type: boolean
        IsFamilyAndAssembly:
          type: boolean
        IsFamilyOrAssembly:
          type: boolean
        IsStatic:
          type: boolean
        IsInitOnly:
          type: boolean
        IsLiteral:
          type: boolean
        IsNotSerialized:
          type: boolean
        IsSpecialName:
          type: boolean
        IsPinvokeImpl:
          type: boolean
        IsSecurityCritical:
          type: boolean
        IsSecuritySafeCritical:
          type: boolean
        IsSecurityTransparent:
          type: boolean
        Name:
          type: string
        DeclaringType:
          $ref: '#/components/schemas/Type'
        ReflectedType:
          $ref: '#/components/schemas/Type'
        CustomAttributes:
          type: array
          items:
            $ref: '#/components/schemas/CustomAttributeData'
        MetadataToken:
          type: integer
        Module:
          $ref: '#/components/schemas/Module'
    CompareInfo:
      title: CompareInfo
      type: object
      properties:
        Name:
          type: string
        LCID:
          type: integer
        Version:
          $ref: '#/components/schemas/SortVersion'
    SearchProviderCondition:
      title: SearchProviderCondition
      type: object
      properties:
        SearchIndex:
          $ref: '#/components/schemas/SearchIndexRef'
        Input:
          type: string
    MemberInfo:
      title: MemberInfo
      type: object
      properties:
        MemberType:
          enum:
          - Constructor
          - Event
          - Field
          - Method
          - Property
          - TypeInfo
          - Custom
          - NestedType
          - All
          type: string
        Name:
          type: string
        DeclaringType:
          $ref: '#/components/schemas/Type'
        ReflectedType:
          $ref: '#/components/schemas/Type'
        CustomAttributes:
          type: array
          items:
            $ref: '#/components/schemas/CustomAttributeData'
        MetadataToken:
          type: integer
        Module:
          $ref: '#/components/schemas/Module'
    IComponent:
      title: IComponent
      type: object
      properties:
        Site:
          $ref: '#/components/schemas/ISite'
    Query:
      title: Query
      type: object
      properties:
        Condition:
          type: string
        Sorts:
          type: array
          items:
            $ref: '#/components/schemas/Sort'
        RelationalField:
          $ref: '#/components/schemas/FieldRef'
        RowCondition:
          type: string
        SearchProviderCondition:
          $ref: '#/components/schemas/SearchProviderCondition'
        ExecutingSavedSearchID:
          type: integer
          nullable: true
        SampleParameters:
          $ref: '#/components/schemas/SampleParameters'
        IncludeIDWindow:
          type: boolean
          nullable: true
        RankSortOrder:
          type: string
        QueryHint:
          type: string
    SampleParameters:
      title: SampleParameters
      type: object
      properties:
        ExistingToken:
          type: string
        MarginOfError:
          type: number
        ConfidenceLevel:
          type: number
        FixedSampleSize:
          type: integer
        SamplingPercentage:
          type: number
    RuntimeTypeHandle:
      title: RuntimeTypeHandle
      type: object
      properties:
        Value:
          $ref: '#/components/schemas/IntPtr'
    TextInfo:
      title: TextInfo
      type: object
      properties:
        ANSICodePage:
          type: integer
        OEMCodePage:
          type: integer
        MacCodePage:
          type: integer
        EBCDICCodePage:
          type: integer
        LCID:
          type: integer
        CultureName:
          type: string
        IsReadOnly:
          type: boolean
        ListSeparator:
          type: string
        IsRightToLeft:
          type: boolean
    ICustomAttributeProvider:
      title: ICustomAttributeProvider
      type: object
    PropertyInfo:
      title: PropertyInfo
      type: object
      properties:
        MemberType:
          enum:
          - Constructor
          - Event
          - Field
          - Method
          - Property
          - TypeInfo
          - Custom
          - NestedType
          - All
          type: string
        PropertyType:
          $ref: '#/components/schemas/Type'
        Attributes:
          enum:
          - None
          - SpecialName
          - RTSpecialName
          - HasDefault
          - Reserved2
          - Reserved3
          - Reserved4
          - ReservedMask
          type: string
        CanRead:
          type: boolean
        CanWrite:
          type: boolean
        GetMethod:
          $ref: '#/components/schemas/MethodInfo'
        SetMethod:
          $ref: '#/components/schemas/MethodInfo'
        IsSpecialName:
          type: boolean
        Name:
          type: string
        DeclaringType:
          $ref: '#/components/schemas/Type'
        ReflectedType:
          $ref: '#/components/schemas/Type'
        CustomAttributes:
          type: array
          items:
            $ref: '#/components/schemas/CustomAttributeData'
        MetadataToken:
          type: integer
        Module:
          $ref: '#/components/schemas/Module'
    CultureInfo:
      title: CultureInfo
      type: object
      properties:
        CurrentCulture:
          $ref: '#/components/schemas/CultureInfo'
        CurrentUICulture:
          $ref: '#/components/schemas/CultureInfo'
        InstalledUICulture:
          $ref: '#/components/schemas/CultureInfo'
        DefaultThreadCurrentCulture:
          $ref: '#/components/schemas/CultureInfo'
        DefaultThreadCurrentUICulture:
          $ref: '#/components/schemas/CultureInfo'
        InvariantCulture:
          $ref: '#/components/schemas/CultureInfo'
        Parent:
          $ref: '#/components/schemas/CultureInfo'
        LCID:
          type: integer
        KeyboardLayoutId:
          type: integer
        Name:
          type: string
        IetfLanguageTag:
          type: string
        DisplayName:
          type: string
        NativeName:
          type: string
        EnglishName:
          type: string
        TwoLetterISOLanguageName:
          type: string
        ThreeLetterISOLanguageName:
          type: string
        ThreeLetterWindowsLanguageName:
          type: string
        CompareInfo:
          $ref: '#/components/schemas/CompareInfo'
        TextInfo:
          $ref: '#/components/schemas/TextInfo'
        IsNeutralCulture:
          type: boolean
        CultureTypes:
          enum:
          - NeutralCultures
          - SpecificCultures
          - InstalledWin32Cultures
          - AllCultures
          - UserCustomCulture
          - ReplacementCultures
          - WindowsOnlyCultures
          - FrameworkCultures
          type: string
        NumberFormat:
          $ref: '#/components/schemas/NumberFormatInfo'
        DateTimeFormat:
          $ref: '#/components/schemas/DateTimeFormatInfo'
        Calendar:
          $ref: '#/components/schemas/Calendar'
        OptionalCalendars:
          type: array
          items:
            $ref: '#/components/schemas/Calendar'
        UseUserOverride:
          type: boolean
        IsReadOnly:
          type: boolean
    PivotSettings:
      title: PivotSettings
      type: object
      properties:
        ObjectSetQuery:
          $ref: '#/components/schemas/Query'
        ArtifactTypeID:
          type: integer
        GroupBy:
          $ref: '#/components/schemas/FieldRef'
        PivotOn:
          $ref: '#/components/schemas/FieldRef'
        GroupByDateGrouping:
          enum:
          - Date
          - Month
          - Year
          - YearMonth
          - Week
          - TwoWeeks
          type: string
        PivotOnDateGrouping:
          enum:
          - Date
          - Month
          - Year
          - YearMonth
          - Week
          - TwoWeeks
          type: string
        MaximumNumberOfColumns:
          type: integer
        MaximumNumberOfRows:
          type: integer
        Timeout:
          type: integer
        RawDataOnly:
          type: boolean
        ConvertNumberFieldValuesToString:
          type: boolean
          nullable: true
    Sort:
      title: Sort
      type: object
      properties:
        FieldIdentifier:
          $ref: '#/components/schemas/FieldRef'
        Order:
          type: integer
        Direction:
          enum:
          - Ascending
          - Descending
          type: string
    Module:
      title: Module
      type: object
      properties:
        CustomAttributes:
          type: array
          items:
            $ref: '#/components/schemas/CustomAttributeData'
        MDStreamVersion:
          type: integer
        FullyQualifiedName:
          type: string
        ModuleVersionId:
          type: string
        MetadataToken:
          type: integer
        ScopeName:
          type: string
        Name:
          type: string
        Assembly:
          $ref: '#/components/schemas/Assembly'
        ModuleHandle:
          $ref: '#/components/schemas/ModuleHandle'
    DataSet:
      title: DataSet
      type: object
      properties:
        RemotingFormat:
          enum:
          - Xml
          - Binary
          type: string
        SchemaSerializationMode:
          enum:
          - IncludeSchema
          - ExcludeSchema
          type: string
        CaseSensitive:
          type: boolean
        DefaultViewManager:
          type: array
          items:
            type: string
            format: DataViewManager
        EnforceConstraints:
          type: boolean
        DataSetName:
          type: string
        Namespace:
          type: string
        Prefix:
          type: string
        ExtendedProperties:
          type: array
          items:
            type: string
            format: PropertyCollection
        HasErrors:
          type: boolean
        IsInitialized:
          type: boolean
        Locale:
          $ref: '#/components/schemas/CultureInfo'
        Site:
          $ref: '#/components/schemas/ISite'
        Relations:
          type: array
          items:
            type: string
            format: DataRelationCollection
        Tables:
          type: array
          items:
            type: string
            format: DataTableCollection
        Container:
          $ref: '#/components/schemas/IContainer'
        DesignMode:
          type: boolean
    EventInfo:
      title: EventInfo
      type: object
      properties:
        MemberType:
          enum:
          - Constructor
          - Event
          - Field
          - Method
          - Property
          - TypeInfo
          - Custom
          - NestedType
          - All
          type: string
        Attributes:
          enum:
          - None
          - SpecialName
          - ReservedMask
          - RTSpecialName
          type: string
        AddMethod:
          $ref: '#/components/schemas/MethodInfo'
        RemoveMethod:
          $ref: '#/components/schemas/MethodInfo'
        RaiseMethod:
          $ref: '#/components/schemas/MethodInfo'
        EventHandlerType:
          $ref: '#/components/schemas/Type'
        IsSpecialName:
          type: boolean
        IsMulticast:
          type: boolean
        Name:
          type: string
        DeclaringType:
          $ref: '#/components/schemas/Type'
        ReflectedType:
          $ref: '#/components/schemas/Type'
        CustomAttributes:
          type: array
          items:
            $ref: '#/components/schemas/CustomAttributeData'
        MetadataToken:
          type: integer
        Module:
          $ref: '#/components/schemas/Module'
    IContainer:
      title: IContainer
      type: object
      properties:
        Components:
          type: array
          items:
            type: string
            format: ComponentCollection
    CustomAttributeTypedArgument:
      title: CustomAttributeTypedArgument
      type: object
      properties:
        ArgumentType:
          $ref: '#/components/schemas/Type'
        Value:
          $ref: '#/components/schemas/Object'
    ISite:
      title: ISite
      type: object
      properties:
        Component:
          $ref: '#/components/schemas/IComponent'
        Container:
          $ref: '#/components/schemas/IContainer'
        DesignMode:
          type: boolean
        Name:
          type: string
    MethodInfo:
      title: MethodInfo
      type: object
      properties:
        MemberType:
          enum:
          - Constructor
          - Event
          - Field
          - Method
          - Property
          - TypeInfo
          - Custom
          - NestedType
          - All
          type: string
        ReturnType:
          $ref: '#/components/schemas/Type'
        ReturnParameter:
          $ref: '#/components/schemas/ParameterInfo'
        ReturnTypeCustomAttributes:
          $ref: '#/components/schemas/ICustomAttributeProvider'
        MethodImplementationFlags:
          enum:
          - IL
          - Managed
          - Native
          - OPTIL
          - Runtime
          - CodeTypeMask
          - Unmanaged
          - ManagedMask
          - NoInlining
          - ForwardRef
          - Synchronized
          - NoOptimization
          - PreserveSig
          - AggressiveInlining
          - SecurityMitigations
          - InternalCall
          - MaxMethodImplVal
          type: string
        MethodHandle:
          $ref: '#/components/schemas/RuntimeMethodHandle'
        Attr

# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/openapi/relativity-relativity-pivot-module-v1-api-openapi.yml