Relativity Metadata API

openapi: 3.0.1
info:
  title: Analytics.Conceptual.Service.Interfaces.Public.V1 AnnotationService Metadata API
  description: Analytics.Conceptual.Service.Interfaces.Public
  version: V1
servers:
- url: /Relativity.REST/api
  description: The URL prefix for all Kepler services
tags:
- name: Metadata
paths:
  /v1/Metadata:
    get:
      tags:
      - Metadata
      summary: Gets the metadata
      description: This endpoint retrieves metadata fields required for report creation. The metadata includes fields that are necessary to generate a report or determine the report's content based on the provided ID.
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/MetadataDto'
            application/json:
              schema:
                $ref: '#/components/schemas/MetadataDto'
            text/json:
              schema:
                $ref: '#/components/schemas/MetadataDto'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    MetricDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        valueType:
          enum:
          - Text
          - Int64
          - Double
          - DateTime
          - Boolean
          - Decimal
          type: string
        originId:
          type: string
          format: uuid
        reportType:
          enum:
          - Workspace
          - User
          type: string
        isDefault:
          type: boolean
        isActive:
          type: boolean
      additionalProperties: false
    MetadataDto:
      type: object
      properties:
        origins:
          type: array
          items:
            $ref: '#/components/schemas/MetricOriginDto'
          nullable: true
      additionalProperties: false
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
    MetricOriginDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          nullable: true
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/MetricDto'
          nullable: true
      additionalProperties: false