Relativity

Relativity Object Manager v1 API

The Object Manager v1 API from Relativity — 12 operation(s) for object manager v1.

GitHub OpenAPI

Operations 12

POST /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/query Relativity object manager server object manager V1 manager IObject manager… #
POST /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/update Relativity object manager server object manager V1 manager IObject manager… #
POST /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/read Relativity object manager server object manager V1 manager IObject manager read… #
POST /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/delete Relativity object manager server object manager V1 manager IObject manager… #
POST /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/create Relativity object manager server object manager V1 manager IObject manager… #
POST /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/queryslim Relativity object manager server object manager V1 manager IObject manager… #
POST /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/streamlongtext Relativity object manager server object manager V1 manager IObject manager… #
POST /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/initializeexport Relativity object manager server object manager V1 manager IObject manager… #
POST /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/retrievenextresultsblockfromexport Relativity object manager server object manager V1 manager IObject manager… #
POST /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/retrieveresultsblockfromexport Relativity object manager server object manager V1 manager IObject manager… #
POST /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/updatelongtextfromstream Relativity object manager server object manager V1 manager IObject manager… #
POST /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/dependencylist Relativity object manager server object manager V1 manager IObject manager get… #

Documentation

📖
Documentation
https://platform.relativity.com/RelativityOne/Content/REST_API/REST_API.htm
📖
RateLimits
https://artifacts.apis.io/relativity/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://artifacts.apis.io/relativity/openapi/relativity-object-manager-v1-api-openapi.yml

Other Resources

🔗
Plans
https://artifacts.apis.io/relativity/plans/relativity-plans-pricing.yml
🔗
FinOps
https://artifacts.apis.io/relativity/finops/relativity-finops.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/relativity:relativity-object-manager-v1-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

relativity-object-manager-v1-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Relativity.ObjectManager.Server.ObjectManager.V1 Object…
  description: Relativity.ObjectManager.Server.ObjectManager
  version: V1
servers:
- url: /Relativity.REST/api
  description: The URL prefix for all Kepler services
tags:
- name: Object Manager v1
paths:
  /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/query:
    post:
      tags:
      - Object Manager v1
      description: '[Public] IObjectManager -'
      operationId: Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.QueryAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/length'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResult'
      summary: Relativity object manager server object manager V1 manager IObject manager…
      x-summary-source: derived
  /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/update:
    post:
      tags:
      - Object Manager v1
      description: '[Public] IObjectManager -'
      operationId: Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.UpdateAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateResult'
      summary: Relativity object manager server object manager V1 manager IObject manager…
      x-summary-source: derived
  /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/read:
    post:
      tags:
      - Object Manager v1
      description: '[Public] IObjectManager -'
      operationId: Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.ReadAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReadAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadResult'
      summary: Relativity object manager server object manager V1 manager IObject manager read…
      x-summary-source: derived
  /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/delete:
    post:
      tags:
      - Object Manager v1
      description: '[Public] IObjectManager -'
      operationId: Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.DeleteAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResult'
      summary: Relativity object manager server object manager V1 manager IObject manager…
      x-summary-source: derived
  /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/create:
    post:
      tags:
      - Object Manager v1
      description: '[Public] IObjectManager -'
      operationId: Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.CreateAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateResult'
      summary: Relativity object manager server object manager V1 manager IObject manager…
      x-summary-source: derived
  /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/queryslim:
    post:
      tags:
      - Object Manager v1
      description: '[Public] IObjectManager -'
      operationId: Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.QuerySlimAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/length'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QuerySlimAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResultSlim'
      summary: Relativity object manager server object manager V1 manager IObject manager…
      x-summary-source: derived
  /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/streamlongtext:
    post:
      tags:
      - Object Manager v1
      description: '[Public] IObjectManager -'
      operationId: Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.StreamLongTextAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StreamLongTextAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IKeplerStream'
      summary: Relativity object manager server object manager V1 manager IObject manager…
      x-summary-source: derived
  /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/initializeexport:
    post:
      tags:
      - Object Manager v1
      description: '[Public] IObjectManager -'
      operationId: Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.InitializeExportAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitializeExportAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportInitializationResults'
      summary: Relativity object manager server object manager V1 manager IObject manager…
      x-summary-source: derived
  /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/retrievenextresultsblockfromexport:
    post:
      tags:
      - Object Manager v1
      description: '[Public] IObjectManager -'
      operationId: Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.RetrieveNextResultsBlockFromExportAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/runID'
      - $ref: '#/components/parameters/batchSize'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RelativityObjectSlim'
      summary: Relativity object manager server object manager V1 manager IObject manager…
      x-summary-source: derived
  /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/retrieveresultsblockfromexport:
    post:
      tags:
      - Object Manager v1
      description: '[Public] IObjectManager -'
      operationId: Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.RetrieveResultsBlockFromExportAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/runID'
      - $ref: '#/components/parameters/resultsBlockSize'
      - $ref: '#/components/parameters/exportIndexID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RelativityObjectSlim'
      summary: Relativity object manager server object manager V1 manager IObject manager…
      x-summary-source: derived
  /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/updatelongtextfromstream:
    post:
      tags:
      - Object Manager v1
      description: '[Public] IObjectManager -'
      operationId: Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.UpdateLongTextFromStreamAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLongTextFromStreamAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
      summary: Relativity object manager server object manager V1 manager IObject manager…
      x-summary-source: derived
  /Relativity.ObjectManager/v1/workspace/{workspaceID}/object/dependencylist:
    post:
      tags:
      - Object Manager v1
      description: '[Public] IObjectManager -'
      operationId: Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.GetDependencyListAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDependencyListAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dependency'
      summary: Relativity object manager server object manager V1 manager IObject manager get…
      x-summary-source: derived
components:
  schemas:
    ReadOptions:
      title: ReadOptions
      type: object
      properties:
        MaxCharactersForLongTextValues:
          type:
          - integer
          - 'null'
        LongTextBehavior:
          enum:
          - Default
          - Tokenized
          - DefaultWithErrors
          - TokenizedWithErrors
          type: string
        FieldTypesToReturnAsString:
          type: array
          items:
            enum:
            - FixedLengthText
            - WholeNumber
            - Date
            - YesNo
            - LongText
            - SingleChoice
            - Decimal
            - Currency
            - MultipleChoice
            - File
            - SingleObject
            - User
            - MultipleObject
            - Empty
            type: string
        CallingContext:
          $ref: '#/components/schemas/CallingContext'
    FieldValuePair:
      title: FieldValuePair
      type: object
      properties:
        Value:
          $ref: '#/components/schemas/Object'
        Field:
          $ref: '#/components/schemas/Field'
    QuerySlimAsync_RequestBody:
      title: QuerySlimAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/QueryRequest'
    QueryAsync_RequestBody:
      title: QueryAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/QueryRequest'
    UpdateLongTextFromStreamAsync_RequestBody:
      title: UpdateLongTextFromStreamAsync_RequestBody
      type: object
      properties:
        updateLongTextFromStreamRequest:
          $ref: '#/components/schemas/UpdateLongTextFromStreamRequest'
        keplerStream:
          $ref: '#/components/schemas/IKeplerStream'
    RelativityObject:
      title: RelativityObject
      type: object
      properties:
        ParentObject:
          $ref: '#/components/schemas/RelativityObjectRef'
        Name:
          type: string
        FieldValues:
          type: array
          items:
            $ref: '#/components/schemas/FieldValuePair'
        ArtifactID:
          type: integer
        Guids:
          type: array
          items:
            type: string
        Item:
          $ref: '#/components/schemas/FieldValuePair'
    FieldRef:
      title: FieldRef
      type: object
      properties:
        ViewFieldID:
          type: integer
        ArtifactID:
          type: integer
        Guid:
          type:
          - string
          - 'null'
        Name:
          type: string
    CreateRequest:
      title: CreateRequest
      type: object
      properties:
        ParentObject:
          $ref: '#/components/schemas/RelativityObjectRef'
        ObjectType:
          $ref: '#/components/schemas/ObjectTypeRef'
        FieldValues:
          type: array
          items:
            $ref: '#/components/schemas/FieldRefValuePair'
    DependencyListByObjectIdentifiersRequest:
      title: DependencyListByObjectIdentifiersRequest
      type: object
      properties:
        Objects:
          type: array
          items:
            $ref: '#/components/schemas/RelativityObjectRef'
    FieldMetadata:
      title: FieldMetadata
      type: object
      properties:
        FieldType:
          enum:
          - FixedLengthText
          - WholeNumber
          - Date
          - YesNo
          - LongText
          - SingleChoice
          - Decimal
          - Currency
          - MultipleChoice
          - File
          - SingleObject
          - User
          - MultipleObject
          - Empty
          type: string
        ArtifactID:
          type: integer
        ViewFieldID:
          type: integer
        Guids:
          type: array
          items:
            type: string
        Name:
          type: string
    IKeplerStream:
      title: IKeplerStream
      type: object
      properties:
        ContentType:
          type: string
        ContentDisposition:
          type: string
        CacheControl:
          type: string
        StatusCode:
          enum:
          - Continue
          - SwitchingProtocols
          - OK
          - Created
          - Accepted
          - NonAuthoritativeInformation
          - NoContent
          - ResetContent
          - PartialContent
          - MultipleChoices
          - Ambiguous
          - MovedPermanently
          - Moved
          - Found
          - Redirect
          - SeeOther
          - RedirectMethod
          - NotModified
          - UseProxy
          - Unused
          - TemporaryRedirect
          - RedirectKeepVerb
          - BadRequest
          - Unauthorized
          - PaymentRequired
          - Forbidden
          - NotFound
          - MethodNotAllowed
          - NotAcceptable
          - ProxyAuthenticationRequired
          - RequestTimeout
          - Conflict
          - Gone
          - LengthRequired
          - PreconditionFailed
          - RequestEntityTooLarge
          - RequestUriTooLong
          - UnsupportedMediaType
          - RequestedRangeNotSatisfiable
          - ExpectationFailed
          - UpgradeRequired
          - InternalServerError
          - NotImplemented
          - BadGateway
          - ServiceUnavailable
          - GatewayTimeout
          - HttpVersionNotSupported
          type:
          - string
          - 'null'
        Headers:
          type: array
          items:
            type: string
            format: NameValueCollection
    CallingContext:
      title: CallingContext
      type: object
      properties:
        Layout:
          $ref: '#/components/schemas/LayoutRef'
        Referrer:
          type: string
        PageMode:
          enum:
          - Unknown
          - View
          - Edit
          - List
          type: string
    Field:
      title: Field
      type: object
      properties:
        FieldCategory:
          enum:
          - Generic
          - FullText
          - Identifier
          - Reflected
          - Comments
          - Relational
          - ProductionMarker
          - AutoCreate
          - FileSize
          - FolderName
          - FileInfo
          - ParentArtifact
          - MarkupSetMarker
          - GenericSystem
          - MultiReflected
          - Batch
          type: string
        FieldType:
          enum:
          - FixedLengthText
          - WholeNumber
          - Date
          - YesNo
          - LongText
          - SingleChoice
          - Decimal
          - Currency
          - MultipleChoice
          - File
          - SingleObject
          - User
          - MultipleObject
          - Empty
          type: string
        ViewFieldID:
          type: integer
        ArtifactID:
          type: integer
        Guids:
          type: array
          items:
            type: string
        Name:
          type: string
    DeleteRequest:
      title: DeleteRequest
      type: object
      properties:
        Object:
          $ref: '#/components/schemas/RelativityObjectRef'
    ReadRequest:
      title: ReadRequest
      type: object
      properties:
        Object:
          $ref: '#/components/schemas/RelativityObjectRef'
        Fields:
          type: array
          items:
            $ref: '#/components/schemas/FieldRef'
    QueryResult:
      title: QueryResult
      type: object
      properties:
        TotalCount:
          type: integer
        Objects:
          type: array
          items:
            $ref: '#/components/schemas/RelativityObject'
        IDWindow:
          type: array
          items:
            type: integer
        CurrentStartIndex:
          type: integer
        ResultCount:
          type: integer
        ObjectType:
          $ref: '#/components/schemas/ObjectType'
        SampleDetails:
          $ref: '#/components/schemas/SampleDetails'
        RankWindow:
          type: array
          items:
            type: number
        RelationalField:
          $ref: '#/components/schemas/Field'
    DisplayableObjectIdentifier:
      title: DisplayableObjectIdentifier
      type: object
      properties:
        Name:
          type: string
        ArtifactID:
          type: integer
        Guids:
          type: array
          items:
            type: string
    ObjectTypeRef:
      title: ObjectTypeRef
      type: object
      properties:
        ArtifactID:
          type: integer
        Name:
          type: string
        Guid:
          type:
          - string
          - 'null'
        ArtifactTypeID:
          type: integer
    OperationOptions:
      title: OperationOptions
      type: object
      properties:
        CallingContext:
          $ref: '#/components/schemas/CallingContext'
    SampleParameters:
      title: SampleParameters
      type: object
      properties:
        ExistingToken:
          type:
          - string
          - 'null'
        MarginOfError:
          type: number
        ConfidenceLevel:
          type: number
        FixedSampleSize:
          type: integer
        SamplingPercentage:
          type: number
    EventHandlerStatus:
      title: EventHandlerStatus
      type: object
      properties:
        Success:
          type: boolean
        Message:
          type: string
        FailingEventHandler:
          $ref: '#/components/schemas/EventHandlerRef'
    QueryRequest:
      title: QueryRequest
      type: object
      properties:
        ObjectType:
          $ref: '#/components/schemas/ObjectTypeRef'
        Condition:
          type: string
        Sorts:
          type: array
          items:
            $ref: '#/components/schemas/Sort'
        RelationalField:
          $ref: '#/components/schemas/FieldRef'
        RowCondition:
          type: string
        SearchProviderCondition:
          $ref: '#/components/schemas/SearchProviderCondition'
        SampleParameters:
          $ref: '#/components/schemas/SampleParameters'
        IncludeIDWindow:
          type:
          - boolean
          - 'null'
        RankSortOrder:
          enum:
          - Ascending
          - Descending
          type:
          - string
          - 'null'
        QueryHint:
          type: string
        Fields:
          type: array
          items:
            $ref: '#/components/schemas/FieldRef'
        IsAdhocQuery:
          type:
          - boolean
          - 'null'
        ConvertNumberFieldValuesToString:
          type:
          - boolean
          - 'null'
        IncludeNameInQueryResult:
          type:
          - boolean
          - 'null'
        ExecutingSavedSearchID:
          type:
          - integer
          - 'null'
        ExecutingViewID:
          type:
          - integer
          - 'null'
        ActiveArtifactID:
          type:
          - integer
          - 'null'
        MaxCharactersForLongTextValues:
          type:
          - integer
          - 'null'
        LongTextBehavior:
          enum:
          - Default
          - Tokenized
          - DefaultWithErrors
          - TokenizedWithErrors
          type: string
    LayoutRef:
      title: LayoutRef
      type: object
      properties:
        ArtifactID:
          type: integer
        Guid:
          type:
          - string
          - 'null'
    DeleteAsync_RequestBody:
      title: DeleteAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/DeleteRequest'
    UpdateOptions:
      title: UpdateOptions
      type: object
      properties:
        UpdateBehavior:
          enum:
          - Replace
          - Merge
          - Remove
          type: string
        CallingContext:
          $ref: '#/components/schemas/CallingContext'
    QueryResultSlim:
      title: QueryResultSlim
      type: object
      properties:
        TotalCount:
          type: integer
        Objects:
          type: array
          items:
            $ref: '#/components/schemas/RelativityObjectSlim'
        IDWindow:
          type: array
          items:
            type: integer
        CurrentStartIndex:
          type: integer
        ResultCount:
          type: integer
        ObjectType:
          $ref: '#/components/schemas/ObjectType'
        SampleDetails:
          $ref: '#/components/schemas/SampleDetails'
        RankWindow:
          type: array
          items:
            type: number
        RelationalField:
          $ref: '#/components/schemas/Field'
        Fields:
          type: array
          items:
            $ref: '#/components/schemas/Field'
    ReadAsync_RequestBody:
      title: ReadAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/ReadRequest'
        readOptions:
          $ref: '#/components/schemas/ReadOptions'
    InitializeExportAsync_RequestBody:
      title: InitializeExportAsync_RequestBody
      type: object
      properties:
        queryRequest:
          $ref: '#/components/schemas/QueryRequest'
    CreateResult:
      title: CreateResult
      type: object
      properties:
        Object:
          $ref: '#/components/schemas/RelativityObject'
        EventHandlerStatuses:
          type: array
          items:
            $ref: '#/components/schemas/EventHandlerStatus'
    UpdateAsync_RequestBody:
      title: UpdateAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/UpdateRequest'
        operationOptions:
          $ref: '#/components/schemas/UpdateOptions'
    DeleteItem:
      title: DeleteItem
      type: object
      properties:
        ObjectTypeName:
          type: string
        Action:
          type: string
        Count:
          type: integer
        Connection:
          type: string
    GetDependencyListAsync_RequestBody:
      title: GetDependencyListAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/DependencyListByObjectIdentifiersRequest'
    EventHandlerRef:
      title: EventHandlerRef
      type: object
      properties:
        ClassName:
          type: string
        EventHandlerType:
          enum:
          - PostSave
          - PreCascadeDelete
          - PreDelete
          - PreLoad
          - PreMassDelete
          - PreSave
          type: string
        Application:
          $ref: '#/components/schemas/DisplayableObjectIdentifier'
    SearchIndexRef:
      title: SearchIndexRef
      type: object
      properties:
        ArtifactID:
          type: integer
        Name:
          type: string
    Securable1:
      title: Securable`1
      type: object
      properties:
        Secured:
          type: boolean
        Value:
          type: string
    SearchProviderCondition:
      title: SearchProviderCondition
      type: object
      properties:
        SearchIndex:
          $ref: '#/components/schemas/SearchIndexRef'
        Input:
          type: string
    ObjectType:
      title: ObjectType
      type: object
      properties:
        ArtifactID:
          type: integer
        Name:
          type: string
        Guids:
          type: array
          items:
            type: string
        ArtifactTypeID:
          type: integer
    RelativityObjectRef:
      title: RelativityObjectRef
      type: object
      properties:
        ArtifactID:
          type: integer
        Guid:
          type:
          - string
          - 'null'
    UpdateResult:
      title: UpdateResult
      type: object
      properties:
        EventHandlerStatuses:
          type: array
          items:
            $ref: '#/components/schemas/EventHandlerStatus'
    CreateAsync_RequestBody:
      title: CreateAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/CreateRequest'
        operationOptions:
          $ref: '#/components/schemas/OperationOptions'
    DeleteReport:
      title: DeleteReport
      type: object
      properties:
        DeletedItems:
          type: array
          items:
            $ref: '#/components/schemas/DeleteItem'
    ReadResult:
      title: ReadResult
      type: object
      properties:
        Message:
          type: string
        FailingEventHandler:
          $ref: '#/components/schemas/EventHandlerRef'
        Object:
          $ref: '#/components/schemas/RelativityObject'
        ObjectType:
          $ref: '#/components/schemas/ObjectType'
        ObjectVersionToken:
          type: string
    Dependency:
      title: Dependency
      type: object
      properties:
        ObjectType:
          $ref: '#/components/schemas/Securable1'
        Action:
          type: string
        Count:
          $ref: '#/components/schemas/Securable1'
        Connection:
          $ref: '#/components/schemas/Securable1'
        HierarchicLevel:
          type: integer
    UpdateRequest:
      title: UpdateRequest
      type: object
      properties:
        Object:
          $ref: '#/components/schemas/RelativityObjectRef'
        FieldValues:
          type: array
          items:
            $ref: '#/components/schemas/FieldRefValuePair'
        ObjectVersionToken:
          type: string
    FieldRefValuePair:
      title: FieldRefValuePair
      type: object
      properties:
        Value:
          $ref: '#/components/schemas/Object'
        Field:
          $ref: '#/components/schemas/FieldRef'
    DeleteResult:
      title: DeleteResult
      type: object
      properties:
        Report:
          $ref: '#/components/schemas/DeleteReport'
    Object:
      title: Object
      type: object
    UpdateLongTextFromStreamRequest:
      title: UpdateLongTextFromStreamRequest
      type: object
      properties:
        Object:
          $ref: '#/components/schemas/RelativityObjectRef'
        Field:
          $ref: '#/components/schemas/FieldRef'
    ExportInitializationResults:
      title: ExportInitializationResults
      type: object
      properties:
        RunID:
          type: string
        RecordCount:
          type: integer
        FieldData:
          type: array
          items:
            $ref: '#/components/schemas/FieldMetadata'
    Sort:
      title: Sort
      type: object
      properties:
        FieldIdentifier:
          $ref: '#/components/schemas/FieldRef'
        Order:
          type: integer
        Direction:
          enum:
          - Ascending
          - Descending
          type: string
    StreamLongTextAsync_RequestBody:
      title: StreamLongTextAsync_RequestBody
      type: object
      properties:
        exportObject:
          $ref: '#/components/schemas/RelativityObjectRef'
        longTextField:
          $ref: '#/components/schemas/FieldRef'
    RelativityObjectSlim:
      title: RelativityObjectSlim
      type: object
      properties:
        ArtifactID:
          type: integer
        Values:
          type: array
          items:
            $ref: '#/components/schemas/Object'
    SampleDetails:
      title: SampleDetails
      type: object
      properties:
        SampleSize:
          type:
          - integer
          - 'null'
        UniverseSize:
          type:
          - integer
          - 'null'
        Token:
          type: string
  parameters:
    runID:
      name: runID
      in: query
      description: ''
      required: true
      schema:
        type: string
    start:
      name: start
      in: query
      description: ''
      required: true
      schema:
        type: integer
    workspaceID:
      name: workspaceID
      in: path
      description: ''
      required: true
      schema:
        type: integer
    x-csrf-header:
      name: x-csrf-header
      in: header
      description: ''
      required: true
      schema:
        type: string
        default: '-'
    batchSize:
      name: batchSize
      in: query
      description: ''
      required: true
      schema:
        type: integer
    length:
      name: length
      in: query
      description: ''
      required: true
      schema:
        type: integer
    exportIndexID:
      name: exportIndexID
      in: query
      description: ''
      required: true
      schema:
        type: integer
    resultsBlockSize:
      name: resultsBlockSize
      in: query
      description: ''
      required: true
      schema:
        type: integer