openapi: 3.0.1
info:
  title: Analytics.Conceptual.Service.Interfaces.Public.V1 AnnotationService JobInformation API
  description: Analytics.Conceptual.Service.Interfaces.Public
  version: V1
servers:
- url: /Relativity.REST/api
  description: The URL prefix for all Kepler services
tags:
- name: JobInformation
paths:
  /v3/jobs/{jobID}/status:
    get:
      tags:
      - JobInformation
      summary: Asynchronously retrieves the current status and progress of a job.
      parameters:
      - name: jobID
        in: path
        description: Job identifier
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Job status retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobProgressResponse'
        '404':
          description: Job not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '500':
          description: Internal server error
components:
  schemas:
    JobProgressStatus:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      type: integer
      description: Job progress status values
      format: int32
    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: {}
    JobProgressResponse:
      type: object
      properties:
        jobId:
          type: string
          description: Unique identifier of the job
          nullable: true
        jobState:
          $ref: '#/components/schemas/JobProgressStatus'
      additionalProperties: false
      description: Response containing job progress information