Relativity

Relativity TransferControllerV2 API

The TransferControllerV2 API from Relativity — 3 operation(s) for transfercontrollerv2.

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-transfercontrollerv2-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-transfercontrollerv2-api-openapi.yml Raw ↑ 
openapi: 3.0.1
info:
  title: Analytics.Conceptual.Service.Interfaces.Public.V1 AnnotationService TransferControllerV2 API
  description: Analytics.Conceptual.Service.Interfaces.Public
  version: V1
servers:
- url: /Relativity.REST/api
  description: The URL prefix for all Kepler services
tags:
- name: TransferControllerV2
paths:
  /v2/transfer/jobs:
    post:
      tags:
      - TransferControllerV2
      parameters:
      - name: correlation-id
        in: header
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTransferRequestV2'
          text/json:
            schema:
              $ref: '#/components/schemas/CreateTransferRequestV2'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CreateTransferRequestV2'
      responses:
        '200':
          description: Success
  /v2/transfer/jobs/{jobId}:
    get:
      tags:
      - TransferControllerV2
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: correlation-id
        in: header
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GetJobResultV2'
            application/json:
              schema:
                $ref: '#/components/schemas/GetJobResultV2'
            text/json:
              schema:
                $ref: '#/components/schemas/GetJobResultV2'
    delete:
      tags:
      - TransferControllerV2
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: correlation-id
        in: header
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
  /v2/transfer/jobs/{jobId}/qc:
    get:
      tags:
      - TransferControllerV2
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: correlation-id
        in: header
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GetTokenResult'
            application/json:
              schema:
                $ref: '#/components/schemas/GetTokenResult'
            text/json:
              schema:
                $ref: '#/components/schemas/GetTokenResult'
components:
  schemas:
    GetTokenResult:
      type: object
      properties:
        sasUrl:
          type: string
          format: uri
          nullable: true
      additionalProperties: false
    TimeSpan:
      type: object
      properties:
        ticks:
          type: integer
          format: int64
        days:
          type: integer
          format: int32
          readOnly: true
        hours:
          type: integer
          format: int32
          readOnly: true
        milliseconds:
          type: integer
          format: int32
          readOnly: true
        microseconds:
          type: integer
          format: int32
          readOnly: true
        nanoseconds:
          type: integer
          format: int32
          readOnly: true
        minutes:
          type: integer
          format: int32
          readOnly: true
        seconds:
          type: integer
          format: int32
          readOnly: true
        totalDays:
          type: number
          format: double
          readOnly: true
        totalHours:
          type: number
          format: double
          readOnly: true
        totalMilliseconds:
          type: number
          format: double
          readOnly: true
        totalMicroseconds:
          type: number
          format: double
          readOnly: true
        totalNanoseconds:
          type: number
          format: double
          readOnly: true
        totalMinutes:
          type: number
          format: double
          readOnly: true
        totalSeconds:
          type: number
          format: double
          readOnly: true
      additionalProperties: false
    TransferStatistics:
      type: object
      properties:
        successfulFiles:
          type: integer
          format: int64
        failedFiles:
          type: integer
          format: int64
        skippedFiles:
          type: integer
          format: int64
        successfulBytes:
          type: integer
          format: int64
        failedBytes:
          type: integer
          format: int64
        skippedBytes:
          type: integer
          format: int64
        successfulEmptyDirectories:
          type: integer
          format: int64
        failedEmptyDirectories:
          type: integer
          format: int64
        skippedEmptyDirectories:
          type: integer
          format: int64
      additionalProperties: false
    GetJobResultV2:
      type: object
      properties:
        transferStatus:
          type: string
          nullable: true
        transferJobID:
          type: string
          format: uuid
        destinationFullPath:
          type: string
          nullable: true
        sourceFullPath:
          type: string
          nullable: true
        tags:
          type: object
          additionalProperties:
            type: string
          nullable: true
        eta:
          $ref: '#/components/schemas/TimeSpan'
        transferStatistics:
          $ref: '#/components/schemas/TransferStatistics'
        enumerationStatistics:
          $ref: '#/components/schemas/EnumerationStatistics'
        transferType:
          type: string
          nullable: true
      additionalProperties: false
    CreateTransferRequestV2:
      type: object
      properties:
        destinationPath:
          type: string
          nullable: true
        sourcePath:
          type: string
          nullable: true
        tags:
          type: object
          additionalProperties:
            type: string
          nullable: true
        transferType:
          type: string
          nullable: true
        transferJobID:
          type: string
          format: uuid
      additionalProperties: false
    EnumerationStatistics:
      type: object
      properties:
        totalFiles:
          type: integer
          format: int64
        totalSize:
          type: integer
          format: int64
        totalEmptyDirectories:
          type: integer
          format: int64
        status:
          type: string
          nullable: true
        error:
          type: string
          nullable: true
      additionalProperties: false