mammoth-io Jobs API

openapi: 3.2.0
info:
  title: Mammoth Io Jobs API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Jobs across 2 of this provider''s published API definitions: app.mammoth.io-openapi.json, mammoth-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v2
security:
- bearerAuth: []
- apiKey: []
  apiSecret: []
  workspaceId: []
tags:
- name: Jobs
paths:
  /jobs/{job_id}:
    get:
      tags:
      - Jobs
      summary: Get job by id
      description: Job are way to get results of long running tasks. It either returns processing if tasks are still is running or result of task if it is completed
      operationId: GetJob
      parameters:
      - name: job_id
        in: path
        schema:
          type: integer
          minimum: 0.0
          title: Job id to to get status
          description: Job id is unique identifier for Job object. If processing is not completed, it will return processing otherwise it will have information about Job
          examples:
          - 10
        description: Job id is unique identifier for Job object. If processing is not completed, it will return processing otherwise it will have information about Job
        required: true
        deprecated: false
        examples:
          job_id-example-1:
            summary: Returns details of Job id 10
            value: 10
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      deprecated: false
    servers:
    - url: /api/v2
  /jobs:
    get:
      tags:
      - Jobs
      summary: Track multiple job ids
      description: Returns job objects for given list of job ids
      operationId: GetJobs
      parameters:
      - name: job_ids
        in: query
        schema:
          type: string
          title: Comma separated list of job ids to to get status
          description: Track multiple job ids, comma separated
          default: ''
          examples:
          - 10,11,12
        description: Track multiple job ids, comma separated
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          job_ids-example-1:
            summary: Returns details of job ids 10, 11 and 12
            value: 10,11,12
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobsGetResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      deprecated: false
    servers:
    - url: /api/v2
  /jobs/{job_id}/stream:
    get:
      tags:
      - Jobs
      summary: Stream a job until it is done
      description: 'Server-sent events. When the job is done, one `job` event carries the job, as GET /jobs/{job_id} returns it, and the stream ends. Comment lines keep the stream open while the job runs. A stream that ends with no `job` event timed out: read the job with GET /jobs/{job_id}. Only task previews signal at once; other jobs are seen within one heartbeat.'
      operationId: StreamJob
      parameters:
      - name: job_id
        in: path
        schema:
          type: integer
          minimum: 0.0
          title: Job id to to get status
          description: Job id is unique identifier for Job object. If processing is not completed, it will return processing otherwise it will have information about Job
          examples:
          - 10
        description: Job id is unique identifier for Job object. If processing is not completed, it will return processing otherwise it will have information about Job
        required: true
        deprecated: false
        examples:
          job_id-example-1:
            summary: Returns details of Job id 10
            value: 10
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema: {}
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Validation Exception
                examples:
                - status_code: 400
                  detail: Bad Request
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    JobSchema:
      properties:
        id:
          type: integer
          minimum: 0.0
          title: Job id
          examples:
          - value:
              id: 10
        status:
          type: string
          enum:
          - success
          - failure
          - processing
          - error
          title: Job status
          description: Job status can be success, failure or processing
          examples:
          - value:
              status: success
        response:
          oneOf:
          - type: object
          - type: array
          description: Result of async task is stored in response
          examples:
          - value:
              response:
                object: some object
        last_updated_at:
          type: string
          format: date-time
          title: Job last updated at
          description: Job last updated at is the time when Job status was last updated
          examples:
          - value:
              last_updated_at: '2021-08-10T10:00:00'
        created_at:
          type: string
          format: date-time
          title: Job created at
          description: Create at is time when async task was created
          examples:
          - value:
              created_at: '2021-08-10T10:00:00'
        path:
          type: string
          title: Job path
          description: API request path of the Job operation
          examples:
          - value:
              path: /api/v2/dataviews/1
        operation:
          type: string
          title: Job operation
          description: Operation is async task name which Job is tracking
          examples:
          - value:
              operation: post_modification_pipeline_execution
      type: object
      required:
      - created_at
      - id
      - last_updated_at
      - operation
      - path
      - response
      - status
      title: JobSchema
    JobResponse:
      properties:
        job:
          $ref: '#/components/schemas/JobSchema'
      type: object
      required:
      - job
      title: JobResponse
    JobsGetResponse:
      properties:
        jobs:
          items:
            $ref: '#/components/schemas/JobSchema'
          type: array
          examples:
          - - id: 2
              status: success
              response:
                alone: bzdXMsvhsvQnjpsxSmwt
                laugh: http://www.ingram-allen.net/searchpost.asp
                meeting: '-354234653618046708671335867366504813314641740844433590678872.6300749181269592117235667342'
                participant: http://www.castillo.com/tag/mainabout.html
                administration: 3664
                design: CcUmnviVzUMZozziJUhC
                maintain: 8825
                tax: 8026
                million: DfYRTwdshFRPhSOVrnPx
                than: 8514
                fall: '1978-09-24T17:31:00.840898'
                ready: qbkVDGbgpSmpeFCZfQiy
                talk: 9750
              last_updated_at: '2008-11-06T06:52:00.903517'
              created_at: '2020-06-07T17:40:31.926594'
              path: ZjEwZJqYSNRLxMkFgOaw
              operation: vtQkOPQsswkMypzVvHso
      type: object
      required:
      - jobs
      title: JobsGetResponse
      examples:
      - jobs:
        - id: 2
          status: processing
          response:
            tonight: 2760
            me: https://www.yang.com/list/list/apphomepage.php
            people: 31568.5018799828
            media: CQcDdvDZVPEurUjWDORT
            because: johnsonmichael@example.com
            road: 9849
            notice: kendrawilson@example.com
            service: bVAsuEshTKFLZjQQrDxk
            hit: 2499
            suddenly: WjGDYPstccqXcjHsjXcF
            seven: 1273
          last_updated_at: '2007-03-11T00:02:26.153572'
          created_at: '2002-09-04T23:06:54.909999'
          path: ivNyOTjTEvAUueXgfLqp
          operation: HUrVGFBaiJKfHyEulsYj
  securitySchemes:
    bearerAuth:
      type: http
      description: 'Primary credential. Authorization: Bearer mm_<token>. The token is issued server-side and shown once at creation.'
      scheme: bearer
    apiKey:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-KEY
      in: header
    apiSecret:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-SECRET
      in: header
    workspaceId:
      type: apiKey
      description: Required with X-API-KEY and X-API-SECRET. Deprecated with them — use bearerAuth.
      name: X-WORKSPACE-ID
      in: header
x-refined-from:
- app.mammoth.io-openapi.json
- mammoth-io-openapi.json