openapi: 3.0.1
info:
  contact: {}
  title: Infoworks Rest API V3
  version: '1.0'
  description: Infoworks Rest API V3
servers:
  - url: '{protocol}://{host}:{port}/v3'
    variables:
      protocol:
        default: http
        enum:
          - http
          - https
      host:
        default: localhost
      port:
        default: '3001'
tags:
  - name: Security
    description: ''
  - name: Users
    description: ''
  - name: Environment
    description: ''
  - name: Sources
    description: ''
  - name: Connections
    description: ''
  - name: Source Configurations
    description: ''
  - name: Generic Source Types
    description: ''
  - name: Topics
    description: ''
  - name: File Mappings
    description: ''
  - name: Streaming
    description: ''
  - name: Tables
    description: ''
  - name: Table Groups
    description: ''
  - name: Table Group Schedule
    description: Enable/Disable schedule for table groups
  - name: Domains
    description: ''
  - name: Pipelines
    description: ''
  - name: Pipeline Extensions
    description: ''
  - name: Source Extensions
    description: ''
  - name: Workflows
    description: ''
  - name: Workflow Versions
    description: Workflow Versions CRUD Operations
  - name: Workflows Schedules
    description: ''
  - name: Jobs
    description: ''
  - name: Job Hooks
    description: ''
  - name: License
    description: ''
  - name: Pipeline Groups
    description: ''
  - name: Service Authentication
    description: CRUD Operations to manage Service Authentication mechanisms
  - name: Secret Store
    description: CRUD Operations to manage Secret Stores
  - name: Secrets
    description: CRUD Operations to manage Secrets
  - name: Event Notifications
    description: Read Operation for event notifications
  - name: Engagement Metrics
    description: Read Operation for engagement metrics
  - name: Data Catalog
    description: Read Operation for Data Catalog
  - name: Pipeline Version Locks
    description: CRUD operations from pipeline version locks
  - name: Jobflows
    description: Operations to manage Jobflows
  - name: Environment Cluster
    description: Environment Cluster to start/stop/restart cluster
  - name: Billing Metering Data
    description: ''
  - name: Scheduling Information
    description: ''
  - name: Validation
    description: ''
  - name: Configurations
    description: ''
  - name: Getting Server Timezone
    description: ''
  - name: Target Data Connections
    description: Target Data Connections
  - name: Custom Tags
    description: Custom Tags
  - name: Presets
    description: CRUD Operations to manage user specific presets
paths:
  /security/authenticate:
    get:
      tags:
        - Security
      summary: Get `authentication_token` with `username` and `password`.
      description: Get `authentication_token` with `username` and `password`.
      parameters:
        - name: service_id
          in: query
          description: Used to represent the way user has login into infoworks
          schema:
            type: number
            example: 1
      security:
        - BasicAuth: []
      responses:
        '200':
          description: Authentication success response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Authentication Success
                  result:
                    type: object
                    properties:
                      authentication_token:
                        type: string
                        example: >-
                          eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MjUwMzc2MTcsInN1YiI6IntcbiAgXCJlbWFpbFwiIDogXCJhZG1pbkBpbmZvd29ya3MuaW9cIixcbiAgXCJzY29wZVwiIDoge1xuICAgIFwiYWN0aW9uXCIgOiBcInJlZnJlc2hfdG9rZW5cIlxuICB9XG59IiwianRpIjoiOTFlZGZkMWYtN2Y5My00NjM0LTg4MjctZTZlYjViYWJmNDJkIiwiZXhwIjoxNjI1MDM4NTE3fQ.aCTMjNebvC2Rf1CrJp_wA0dsozJd-uKpTcdEvDyigSU
                      is_authenticated:
                        type: boolean
                        example: true
                      user_id:
                        type: string
                        example: 6RkfybTRQQByEey3v
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '406':
          description: Authentication Failed response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Security Client Errors
                  details:
                    type: string
                    example: 'Authentication Failed: Incorrect user credentials'
                  iw_code:
                    type: string
                    example: IW10031
                  help:
                    type: string
                    example: http://api.infoworks.io/help/IW10029
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /security/token/access:
    get:
      tags:
        - Security
      summary: Get `authentication_token` with `refresh_token`.
      description: Get `authentication_token` with `refresh_token`.
      parameters:
        - name: Authorization
          in: header
          description: refresh token auth header put `Basic {refresh_token}`
          required: true
          schema:
            type: string
            example: >-
              zThziQ7MoJJPYAha+U/+PBSTZG944F+SHBDs+m/z2qn8+m/ax8Prpzla1MHzQ5EBLzB2Bw8a+Qs9r6En5BEN2DsmUVJ6sKFb2yI2
      responses:
        '200':
          description: Authentication success response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Authentication Success
                  result:
                    type: object
                    properties:
                      authentication_token:
                        type: string
                        example: >-
                          eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MjUwMzc2MTcsInN1YiI6IntcbiAgXCJlbWFpbFwiIDogXCJhZG1pbkBpbmZvd29ya3MuaW9cIixcbiAgXCJzY29wZVwiIDoge1xuICAgIFwiYWN0aW9uXCIgOiBcInJlZnJlc2hfdG9rZW5cIlxuICB9XG59IiwianRpIjoiOTFlZGZkMWYtN2Y5My00NjM0LTg4MjctZTZlYjViYWJmNDJkIiwiZXhwIjoxNjI1MDM4NTE3fQ.aCTMjNebvC2Rf1CrJp_wA0dsozJd-uKpTcdEvDyigSU
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '406':
          description: Authentication Failed response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Security Client Errors
                  details:
                    type: string
                    example: 'Authentication Failed: Incorrect user credentials'
                  iw_code:
                    type: string
                    example: IW10031
                  help:
                    type: string
                    example: http://api.infoworks.io/help/IW10029
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      operationId: deleteAuthToken
      tags:
        - Security
      summary: Purge authentication token
      description: >-
        Purges authentication token and logs out the user. The user will need to
        generate a new authentication token for subsequent API calls.
      security:
        - BearerAuth: []
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: Token successfully blacklisted
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /security/token/validate:
    get:
      tags:
        - Security
      summary: Validate `authentication_token` if its active or not.
      description: Validate `authentication_token` if its active or not.
      security:
        - BearerAuth: []
      responses:
        '200':
          description: Valid Token Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: ''
                  result:
                    type: object
                    properties:
                      is_valid:
                        type: boolean
                        example: true
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /security/token/refresh:
    delete:
      tags:
        - Security
      summary: Regenerate Refresh Token and blacklist old token.
      description: Regenerate Refresh Token and blacklist old token.
      security:
        - BasicAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Platform Security Response
                  result:
                    type: string
                    example: Successfully Blacklisted Refresh Token.
          description: ''
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /security/authorise/user:
    post:
      tags:
        - Security
      summary: Authorise User.
      description: Authorise User.
      security:
        - BearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                entityType:
                  type: string
                action:
                  type: string
                entityId:
                  type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  result:
                    type: object
                    properties:
                      delegation_token:
                        type: string
                      is_authorised:
                        type: boolean
          description: ''
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /security/sso/initialise:
    get:
      tags:
        - Security
      summary: Get SAML Redirect URL.
      description: Get SAML Redirect URL.
      security:
        - BearerAuth: []
      responses:
        '200':
          description: Valid Token Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  Location:
                    type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /security/get/user/data:
    post:
      tags:
        - Security
      summary: LDAP Authorise User.
      description: LDAP Authorise User.
      security:
        - BearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                userIds:
                  type: array
                  items:
                    type: string
                searchAttribute:
                  type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  users:
                    type: array
                    items:
                      type: string
          description: ''
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /security/bulk-ldap-sync:
    post:
      tags:
        - Security
      summary: bulk sync (add/update) ldap user by providing login attribute
      description: bulk sync (add/update) ldap user by providing login attribute
      security:
        - BasicAuth: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                search_on:
                  type: string
                  example: email
                search_list:
                  type: array
                  items:
                    type: string
                    example: admin@infoworks.io
                should_update:
                  type: boolean
                  example: true
                  default: true
                should_add:
                  type: boolean
                  example: true
                  default: true
      responses:
        '200':
          description: bulk ldap users sync response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Successfully synced ldap users
                  result:
                    type: object
                    properties:
                      new_users_count:
                        type: integer
                        example: 1
                      existing_user_count:
                        type: integer
                        example: 20
                      added:
                        type: array
                        items:
                          type: object
                          properties:
                            email:
                              type: string
                              example: modeller@infoworks.io
                            id:
                              type: string
                              example: 8qvdcWsT5foNuryNF
                      updated:
                        type: array
                        items:
                          type: object
                          properties:
                            email:
                              type: string
                              example: admin@infoworks.io
                            id:
                              type: string
                              example: 6RkfybTRQQByEey3v
                      failed:
                        type: array
                        items:
                          type: object
                          properties:
                            email:
                              type: string
                              example: prodops@infoworks.io
                            id:
                              type: string
                              example: 9DvdcZsH5foNuryVN
                            error:
                              type: string
                              example: No valid role found for the User.
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '406':
          description: Authentication Failed response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Security Client Errors
                  details:
                    type: string
                    example: 'Authentication Failed: Incorrect user credentials'
                  iw_code:
                    type: string
                    example: IW10031
                  help:
                    type: string
                    example: http://api.infoworks.io/help/IW10029
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/configuration/general:
    get:
      security:
        - BearerAuth: []
      operationId: getConfigs
      tags:
        - Admin Configurations
      summary: Get all General Configurations for Infoworks.
      description: Get all General Configurations for Infoworks.
      responses:
        '200':
          description: ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        additionalProperties:
                          properties:
                            value:
                              type: string
                              example: '1000'
                            description:
                              type: string
                              example: dummy description
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    put:
      security:
        - BearerAuth: []
      operationId: putConfigs
      tags:
        - Admin Configurations
      summary: Replace General Configurations for Infoworks.
      description: Replace General Configurations for Infoworks.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                properties:
                  value:
                    type: string
                    example: '1000'
                  description:
                    type: string
                    example: dummy description
      responses:
        '200':
          description: ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/configuration:
    parameters:
      - name: fetch_from_mongo
        in: query
        description: Fetch from Mongo
        required: false
        schema:
          type: string
    post:
      security:
        - BearerAuth: []
      operationId: Get general configuration with key
      tags:
        - General Configs
      summary: Get general configuration with key
      description: Get general configuration with key
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                config_type:
                  type: string
                  example: application
                component:
                  type: string
                  example: admin
                configuration_keys:
                  type: array
                  items:
                    type: string
                    example: cdc_start_time_place_holder
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          key_1:
                            type: string
                          key_2:
                            type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/mongo-backup:
    get:
      security:
        - BearerAuth: []
      operationId: getMongoBackups
      tags:
        - Admin Configurations
      summary: Gets `Mongo Backups` list.
      description: Gets `Mongo Backups` list.
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                properties:
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      target_path:
                        type: string
                        example: /home/ec2-user/mongo-backups
                      file_name:
                        type: string
                        example: mongo-backup-12-03-2019.zip
                      error:
                        type: string
                        example: Not Enough Space
                      status:
                        type: string
                        enum:
                          - success
                          - failed
                          - running
                      created_at:
                        type: object
                        properties:
                          created_at:
                            type: string
                            example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/mongo-backup/{mongo_backup_id}:
    get:
      security:
        - BearerAuth: []
      operationId: getMongoBackup
      tags:
        - Admin Configurations
      summary: Gets Mongo Backup With Specified Id.
      description: Gets Mongo Backup With Specified Id.
      parameters:
        - name: mongo_backup_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                properties:
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      target_path:
                        type: string
                        example: /home/ec2-user/mongo-backups
                      file_name:
                        type: string
                        example: mongo-backup-12-03-2019.zip
                      error:
                        type: string
                        example: Not Enough Space
                      status:
                        type: string
                        enum:
                          - success
                          - failed
                          - running
                      created_at:
                        type: object
                        properties:
                          created_at:
                            type: string
                            example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/mongo-backup/run:
    post:
      security:
        - BearerAuth: []
      operationId: startMongoBackup
      tags:
        - Admin Configurations
      summary: Start Mongo Backup
      description: Start Mongo Backup.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/mongo-backup/schedule:
    get:
      security:
        - BearerAuth: []
      operationId: getBackupSchedule
      summary: Get the Schedule of the Mongo Backup.
      description: Get the Schedule of the Mongo Backup.
      tags:
        - Admin Configurations
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                properties:
                  result:
                    type: object
                    properties:
                      schedule_type:
                        type: string
                        example: mongo-backup
                      schedule_details:
                        oneOf:
                          - type: object
                            title: Generic Schedule
                            description: Generic schedule object
                            required:
                              - schedule_status
                            properties:
                              schedule_status:
                                type: string
                                enum:
                                  - enabled
                                  - disabled
                                example: enabled
                              start_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: Start time should be after current time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              start_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 14
                              start_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 35
                              repeat_interval_unit:
                                type: string
                                enum:
                                  - NEVER
                                  - MINUTE
                                  - HOUR
                                  - DAY
                                  - WEEK
                                  - MONTH
                                default: NEVER
                                example: MONTH
                              repeat_interval_measure:
                                type: integer
                                minimum: 1
                              repeat_on_last_day:
                                type: boolean
                                description: >
                                  `specified_days` must be provided if
                                  `repeat_on_last_day` is false. Applicable for
                                  `repeat_interval_unit=MONTH`
                                default: false
                              specified_days:
                                type: array
                                description: >
                                  Applicable when `repeat_interval_unit` is
                                  `WEEK` or `MONTH`.
                                minLength: 1
                                items:
                                  type: integer
                                  minimum: 0
                                  maximum: 31
                                example:
                                  - 1
                                  - 17
                                  - 31
                              ends:
                                type: boolean
                                description: >
                                  `end_date`, `end_hour`, `end_min` must be
                                  provided if `ends` is `true`.
                                default: false
                                example: true
                              end_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: End time should be after start time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              end_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 15
                              end_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 38
                              is_custom_job:
                                type: boolean
                                description: >
                                  `custom_job_details` must be provided when
                                  `is_custom_job=true`. Applicable when
                                  `repeat_interval_unit` is `DAY`, `WEEK` or
                                  `MONTH`.
                                default: false
                              custom_job_details:
                                type: object
                                required:
                                  - starts_daily_at
                                  - ends_daily_at
                                  - repeat_interval_measure
                                  - repeat_interval_unit
                                properties:
                                  starts_daily_at:
                                    pattern: ^{0-23}:[0-59]$
                                    type: string
                                    example: '12:40'
                                  ends_daily_at:
                                    pattern: ^{0-23}:[0-59]$
                                    type: string
                                    example: '17:45'
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                    example: 10
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - MINUTE
                                      - HOUR
                          - type: object
                            title: By Minute Schedule
                            description: Schedule job by minutes
                            required:
                              - schedule_status
                              - start_date
                              - start_hour
                              - start_min
                              - repeat_interval_unit
                              - repeat_interval_measure
                            properties:
                              schedule_status:
                                type: string
                                enum:
                                  - enabled
                                example: enabled
                              start_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: Start time should be after current time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              start_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 14
                              start_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 35
                              repeat_interval_unit:
                                type: string
                                enum:
                                  - MINUTE
                              repeat_interval_measure:
                                type: integer
                                minimum: 1
                              ends:
                                type: boolean
                                description: >
                                  `end_date`, `end_hour`, `end_min` must be
                                  provided if `ends` is `true`.
                                default: false
                                example: true
                              end_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: End time should be after start time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              end_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 15
                              end_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 55
                          - type: object
                            title: Hourly Schedule
                            description: Schedule job hourly
                            required:
                              - schedule_status
                              - start_date
                              - start_hour
                              - start_min
                              - repeat_interval_unit
                              - repeat_interval_measure
                            properties:
                              schedule_status:
                                type: string
                                enum:
                                  - enabled
                                example: enabled
                              start_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: Start time should be after current time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              start_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 14
                              start_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 35
                              repeat_interval_unit:
                                type: string
                                enum:
                                  - HOUR
                              repeat_interval_measure:
                                type: integer
                                minimum: 1
                              ends:
                                type: boolean
                                description: >
                                  `end_date`, `end_hour`, `end_min` must be
                                  provided if `ends` is `true`.
                                default: false
                                example: true
                              end_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: End time should be after start time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              end_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 15
                              end_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 55
                          - type: object
                            title: Daily Schedule
                            description: Schedule job daily
                            required:
                              - schedule_status
                              - start_date
                              - start_hour
                              - start_min
                              - repeat_interval_unit
                              - repeat_interval_measure
                            properties:
                              schedule_status:
                                type: string
                                enum:
                                  - enabled
                                example: enabled
                              start_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: Start time should be after current time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              start_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 14
                              start_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 35
                              repeat_interval_unit:
                                type: string
                                enum:
                                  - DAY
                              repeat_interval_measure:
                                type: integer
                                minimum: 1
                              ends:
                                type: boolean
                                description: >
                                  `end_date`, `end_hour`, `end_min` must be
                                  provided if `ends` is `true`.
                                default: false
                                example: true
                              end_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: End time should be after start time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              end_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 15
                              end_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 55
                              is_custom_job:
                                type: boolean
                                description: >
                                  `custom_job_details` must be provided when
                                  `is_custom_job=true`
                                default: false
                                example: true
                              custom_job_details:
                                type: object
                                required:
                                  - starts_daily_at
                                  - ends_daily_at
                                  - repeat_interval_measure
                                  - repeat_interval_unit
                                properties:
                                  starts_daily_at:
                                    pattern: ^{0-23}:[0-59]$
                                    type: string
                                    example: '12:40'
                                  ends_daily_at:
                                    pattern: ^{0-23}:[0-59]$
                                    type: string
                                    example: '17:45'
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                    example: 10
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - MINUTE
                                      - HOUR
                          - type: object
                            title: Weekly Schedule
                            description: Schedule job weekly
                            required:
                              - schedule_status
                              - start_date
                              - start_hour
                              - start_min
                              - repeat_interval_unit
                              - repeat_interval_measure
                              - specified_days
                            properties:
                              schedule_status:
                                type: string
                                enum:
                                  - enabled
                                example: enabled
                              start_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: Start time should be after current time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              start_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 14
                              start_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 35
                              repeat_interval_unit:
                                type: string
                                enum:
                                  - WEEK
                              repeat_interval_measure:
                                type: integer
                                minimum: 1
                              specified_days:
                                type: array
                                minLength: 1
                                items:
                                  type: integer
                                  minimum: 0
                                  maximum: 6
                                example:
                                  - 0
                                  - 2
                                  - 5
                              ends:
                                type: boolean
                                description: >
                                  `end_date`, `end_hour`, `end_min` must be
                                  provided if `ends` is `true`.
                                default: false
                                example: true
                              end_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: End time should be after start time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              end_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 15
                              end_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 55
                              is_custom_job:
                                type: boolean
                                description: >
                                  `custom_job_details` must be provided when
                                  `is_custom_job=true`
                                default: false
                                example: true
                              custom_job_details:
                                type: object
                                required:
                                  - starts_daily_at
                                  - ends_daily_at
                                  - repeat_interval_measure
                                  - repeat_interval_unit
                                properties:
                                  starts_daily_at:
                                    pattern: ^{0-23}:[0-59]$
                                    type: string
                                    example: '12:40'
                                  ends_daily_at:
                                    pattern: ^{0-23}:[0-59]$
                                    type: string
                                    example: '17:45'
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                    example: 10
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - MINUTE
                                      - HOUR
                          - type: object
                            title: Monthly Schedule
                            description: Schedule job monthly
                            required:
                              - schedule_status
                              - start_date
                              - start_hour
                              - start_min
                              - repeat_interval_unit
                              - repeat_interval_measure
                            properties:
                              schedule_status:
                                type: string
                                enum:
                                  - enabled
                                example: enabled
                              start_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: Start time should be after current time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              start_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 14
                              start_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 35
                              repeat_interval_unit:
                                type: string
                                enum:
                                  - MONTH
                              repeat_interval_measure:
                                type: integer
                                minimum: 1
                              repeat_on_last_day:
                                type: boolean
                                description: >
                                  `specified_days` must be provided if
                                  `repeat_on_last_day` is false.
                                default: false
                              specified_days:
                                type: array
                                minLength: 1
                                items:
                                  type: integer
                                  minimum: 1
                                  maximum: 31
                                example:
                                  - 1
                                  - 17
                                  - 31
                              ends:
                                type: boolean
                                description: >
                                  `end_date`, `end_hour`, `end_min` must be
                                  provided if `ends` is `true`.
                                default: false
                                example: true
                              end_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: End time should be after start time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              end_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 15
                              end_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 45
                              is_custom_job:
                                type: boolean
                                description: >
                                  `custom_job_details` must be provided when
                                  `is_custom_job=true`
                                default: false
                                example: true
                              custom_job_details:
                                type: object
                                required:
                                  - starts_daily_at
                                  - ends_daily_at
                                  - repeat_interval_measure
                                  - repeat_interval_unit
                                properties:
                                  starts_daily_at:
                                    pattern: ^{0-23}:[0-59]$
                                    type: string
                                    example: '12:40'
                                  ends_daily_at:
                                    pattern: ^{0-23}:[0-59]$
                                    type: string
                                    example: '17:45'
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                    example: 10
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - MINUTE
                                      - HOUR
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/mongo-backup/schedule/enable:
    put:
      security:
        - BearerAuth: []
      operationId: enableBackupSchedule
      summary: Schedule Mongo Backup.
      description: Schedule Mongo Backup.
      tags:
        - Admin Configurations
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  title: Generic Schedule
                  description: Generic schedule object
                  required:
                    - schedule_status
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                        - disabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - NEVER
                        - MINUTE
                        - HOUR
                        - DAY
                        - WEEK
                        - MONTH
                      default: NEVER
                      example: MONTH
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    repeat_on_last_day:
                      type: boolean
                      description: >
                        `specified_days` must be provided if
                        `repeat_on_last_day` is false. Applicable for
                        `repeat_interval_unit=MONTH`
                      default: false
                    specified_days:
                      type: array
                      description: >
                        Applicable when `repeat_interval_unit` is `WEEK` or
                        `MONTH`.
                      minLength: 1
                      items:
                        type: integer
                        minimum: 0
                        maximum: 31
                      example:
                        - 1
                        - 17
                        - 31
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 38
                    is_custom_job:
                      type: boolean
                      description: >
                        `custom_job_details` must be provided when
                        `is_custom_job=true`. Applicable when
                        `repeat_interval_unit` is `DAY`, `WEEK` or `MONTH`.
                      default: false
                    custom_job_details:
                      type: object
                      required:
                        - starts_daily_at
                        - ends_daily_at
                        - repeat_interval_measure
                        - repeat_interval_unit
                      properties:
                        starts_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '12:40'
                        ends_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '17:45'
                        repeat_interval_measure:
                          type: integer
                          minimum: 1
                          example: 10
                        repeat_interval_unit:
                          type: string
                          enum:
                            - MINUTE
                            - HOUR
                - type: object
                  title: By Minute Schedule
                  description: Schedule job by minutes
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - MINUTE
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 55
                - type: object
                  title: Hourly Schedule
                  description: Schedule job hourly
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - HOUR
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 55
                - type: object
                  title: Daily Schedule
                  description: Schedule job daily
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - DAY
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 55
                    is_custom_job:
                      type: boolean
                      description: >
                        `custom_job_details` must be provided when
                        `is_custom_job=true`
                      default: false
                      example: true
                    custom_job_details:
                      type: object
                      required:
                        - starts_daily_at
                        - ends_daily_at
                        - repeat_interval_measure
                        - repeat_interval_unit
                      properties:
                        starts_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '12:40'
                        ends_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '17:45'
                        repeat_interval_measure:
                          type: integer
                          minimum: 1
                          example: 10
                        repeat_interval_unit:
                          type: string
                          enum:
                            - MINUTE
                            - HOUR
                - type: object
                  title: Weekly Schedule
                  description: Schedule job weekly
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                    - specified_days
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - WEEK
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    specified_days:
                      type: array
                      minLength: 1
                      items:
                        type: integer
                        minimum: 0
                        maximum: 6
                      example:
                        - 0
                        - 2
                        - 5
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 55
                    is_custom_job:
                      type: boolean
                      description: >
                        `custom_job_details` must be provided when
                        `is_custom_job=true`
                      default: false
                      example: true
                    custom_job_details:
                      type: object
                      required:
                        - starts_daily_at
                        - ends_daily_at
                        - repeat_interval_measure
                        - repeat_interval_unit
                      properties:
                        starts_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '12:40'
                        ends_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '17:45'
                        repeat_interval_measure:
                          type: integer
                          minimum: 1
                          example: 10
                        repeat_interval_unit:
                          type: string
                          enum:
                            - MINUTE
                            - HOUR
                - type: object
                  title: Monthly Schedule
                  description: Schedule job monthly
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - MONTH
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    repeat_on_last_day:
                      type: boolean
                      description: >
                        `specified_days` must be provided if
                        `repeat_on_last_day` is false.
                      default: false
                    specified_days:
                      type: array
                      minLength: 1
                      items:
                        type: integer
                        minimum: 1
                        maximum: 31
                      example:
                        - 1
                        - 17
                        - 31
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 45
                    is_custom_job:
                      type: boolean
                      description: >
                        `custom_job_details` must be provided when
                        `is_custom_job=true`
                      default: false
                      example: true
                    custom_job_details:
                      type: object
                      required:
                        - starts_daily_at
                        - ends_daily_at
                        - repeat_interval_measure
                        - repeat_interval_unit
                      properties:
                        starts_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '12:40'
                        ends_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '17:45'
                        repeat_interval_measure:
                          type: integer
                          minimum: 1
                          example: 10
                        repeat_interval_unit:
                          type: string
                          enum:
                            - MINUTE
                            - HOUR
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/mongo-backup/schedule/disable:
    put:
      security:
        - BearerAuth: []
      operationId: disableBackupSchedule
      summary: Schedule Mongo Backup.
      description: Schedule Mongo Backup.
      tags:
        - Admin Configurations
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/configuration/authentication:
    get:
      security:
        - BearerAuth: []
      operationId: getAllConfigs
      summary: Get the type of the Authentication and associated properties.
      description: Get the type of the Authentication and associated properties.
      tags:
        - Admin Configurations
      responses:
        '200':
          description: ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              allOf:
                                - type: object
                                  properties:
                                    is_active:
                                      type: boolean
                                      example: true
                                - type: object
                                  properties:
                                    authentication_type:
                                      type: string
                                      enum:
                                        - mongo
                            - type: object
                              allOf:
                                - type: object
                                  properties:
                                    created_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    created_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                                - type: object
                                  properties:
                                    modified_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    modified_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    put:
      security:
        - BearerAuth: []
      operationId: enableAuthConfig
      tags:
        - Admin Configurations
      summary: Change the Authentication Mechanism
      description: Change the Authentication Mechanism
      requestBody:
        content:
          application/json:
            schema:
              type: object
              oneOf:
                - type: object
                  allOf:
                    - type: object
                      properties:
                        is_active:
                          type: boolean
                          example: true
                    - type: object
                      properties:
                        authentication_type:
                          type: string
                          enum:
                            - mongo
                - type: object
                  allOf:
                    - type: object
                      properties:
                        is_active:
                          type: boolean
                          example: true
                    - type: object
                      properties:
                        authentication_type:
                          type: string
                          enum:
                            - ldap
                        ldap_host:
                          type: string
                          example: localhost
                        ldap_port:
                          type: string
                          example: '849'
                        ldap_ssl:
                          type: boolean
                          example: true
                        bind_user_dn:
                          type: string
                          example: admin
                        bind_user_password:
                          type: string
                          example: >-
                            example password (Note - this key will not be
                            available in GET)
                        base_dn:
                          type: string
                          example: OU=ldaptest,DC=infoworks,DC=local
                        login_attribute:
                          type: string
                          example: mail
                        full_name_attribute:
                          type: string
                          example: displayName
                        email_attribute:
                          type: string
                          example: mail
                        role_attribute:
                          type: string
                          example: memberOf
                        role_separator:
                          type: string
                          example: ','
                        login_hint:
                          type: string
                          example: LDAP email
                        system_admin_roles:
                          type: string
                          example: CN=admingroup,OU=ldaptest,DC=infoworks,DC=local
                        database_admin_roles:
                          type: string
                          example: CN=dbadmingroup,OU=ldaptest,DC=infoworks,DC=local
                        data_analyst_roles:
                          type: string
                          example: CN=analystgroup,OU=ldaptest,DC=infoworks,DC=local
                        data_modeller_roles:
                          type: string
                          example: CN=modellergroup,OU=ldaptest,DC=infoworks,DC=local
                        operations_analyst_roles:
                          type: string
                          example: CN=modellergroup,OU=ldaptest,DC=infoworks,DC=local
          multipart/form-data:
            schema:
              type: object
              required:
                - authentication_type
                - full_name_attribute
                - email_attribute
                - role_attribute
                - role_separator
                - system_admin_roles
                - upload_option
                - acs_url
                - sp_entity_id
                - saml_type
                - is_active
                - is_controlled_domain_mapping
              allOf:
                - type: object
                  properties:
                    is_active:
                      type: boolean
                      example: true
                - type: object
                  properties:
                    authentication_type:
                      type: string
                      enum:
                        - saml
                    full_name_attribute:
                      type: string
                      example: displayName
                    email_attribute:
                      type: string
                      example: mail
                    role_attribute:
                      type: string
                      example: memberOf
                    role_separator:
                      type: string
                      example: ','
                    system_admin_roles:
                      type: string
                      example: CN=admingroup,OU=ldaptest,DC=infoworks,DC=local
                    database_admin_roles:
                      type: string
                      example: CN=dbadmingroup,OU=ldaptest,DC=infoworks,DC=local
                    data_analyst_roles:
                      type: string
                      example: CN=analystgroup,OU=ldaptest,DC=infoworks,DC=local
                    data_modeller_roles:
                      type: string
                      example: CN=modellergroup,OU=ldaptest,DC=infoworks,DC=local
                    operational_analyst_roles:
                      type: string
                      example: CN=modellergroup,OU=ldaptest,DC=infoworks,DC=local
                    upload_option:
                      type: string
                      enum:
                        - fileUpload
                        - serverPath
                    acs_url:
                      type: string
                    sp_entity_id:
                      type: string
                    saml_type:
                      type: string
                      enum:
                        - OKTA
                        - AZURE
                    is_controlled_domain_mapping:
                      type: boolean
                      default: false
                    server_path:
                      type: string
                    file:
                      type: string
                      format: binary
                    domain_group_attribute:
                      type: string
                    domain_group_separator:
                      type: string
                    domain_group_mappings:
                      type: array
                      items:
                        type: object
                        properties:
                          domain_group_name_pattern:
                            type: string
                          associated_domain:
                            type: array
                            items:
                              type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      operationId: patchEnableAuthConfig
      tags:
        - Admin Configurations
      summary: Change the Authentication Mechanism
      description: Change the Authentication Mechanism
      requestBody:
        content:
          application/json:
            schema:
              type: object
              oneOf:
                - type: object
                  allOf:
                    - type: object
                      properties:
                        is_active:
                          type: boolean
                          example: true
                    - type: object
                      properties:
                        authentication_type:
                          type: string
                          enum:
                            - mongo
                - type: object
                  allOf:
                    - type: object
                      properties:
                        is_active:
                          type: boolean
                          example: true
                    - type: object
                      properties:
                        authentication_type:
                          type: string
                          enum:
                            - ldap
                        ldap_host:
                          type: string
                          example: localhost
                        ldap_port:
                          type: string
                          example: '849'
                        ldap_ssl:
                          type: boolean
                          example: true
                        bind_user_dn:
                          type: string
                          example: admin
                        bind_user_password:
                          type: string
                          example: >-
                            example password (Note - this key will not be
                            available in GET)
                        base_dn:
                          type: string
                          example: OU=ldaptest,DC=infoworks,DC=local
                        login_attribute:
                          type: string
                          example: mail
                        full_name_attribute:
                          type: string
                          example: displayName
                        email_attribute:
                          type: string
                          example: mail
                        role_attribute:
                          type: string
                          example: memberOf
                        role_separator:
                          type: string
                          example: ','
                        login_hint:
                          type: string
                          example: LDAP email
                        system_admin_roles:
                          type: string
                          example: CN=admingroup,OU=ldaptest,DC=infoworks,DC=local
                        database_admin_roles:
                          type: string
                          example: CN=dbadmingroup,OU=ldaptest,DC=infoworks,DC=local
                        data_analyst_roles:
                          type: string
                          example: CN=analystgroup,OU=ldaptest,DC=infoworks,DC=local
                        data_modeller_roles:
                          type: string
                          example: CN=modellergroup,OU=ldaptest,DC=infoworks,DC=local
                        operations_analyst_roles:
                          type: string
                          example: CN=modellergroup,OU=ldaptest,DC=infoworks,DC=local
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/configuration/authentication/test-connection:
    post:
      security:
        - BearerAuth: []
      operationId: testConnection
      tags:
        - Admin Configurations
      summary: Test the Authentication Mechanism's Connection.
      description: Test the Authentication Mechanism's Connection.
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/configuration/authentication/test-ldap-connection:
    post:
      security:
        - BearerAuth: []
      operationId: testLdapConnection
      tags:
        - Admin Configurations
      summary: Test the Authentication Connection for LDAP user.
      description: Test the Authentication Connection for LDAP user.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - test_bind_dn
              allOf:
                - type: object
                  properties:
                    host:
                      type: string
                      example: ldap.forumsys.com
                    port:
                      type: string
                      example: 389
                    is_ssl:
                      type: boolean
                      example: false
                    test_bind_dn:
                      type: string
                      example: uid=einstein,dc=example,dc=com
                    test_bind_password:
                      type: string
                      example: password
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          status:
                            type: string
                            example: Success
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/metadata-cleanup/policies:
    get:
      security:
        - BearerAuth: []
      operationId: getCleanupPolicies
      tags:
        - Admin Metadata Cleanup
      summary: Get metadata cleanup policies.
      description: Get metadata cleanup policies.
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          oneOf:
                            - allOf:
                                - properties:
                                    action:
                                      type: string
                                      example: delete
                                      enum:
                                        - archive
                                        - delete
                                        - disabled
                                    retention_period_in_days:
                                      type: integer
                                      example: 90
                              properties:
                                collection_group_name:
                                  type: string
                                  example: jobs
                                last_cleanup_at:
                                  type: string
                                  example: '2020-1-13T00:00:00.000Z'
                            - allOf:
                                - properties:
                                    action:
                                      type: string
                                      example: delete
                                      enum:
                                        - archive
                                        - delete
                                        - disabled
                                    retention_period_in_days:
                                      type: integer
                                      example: 90
                              properties:
                                collection_group_name:
                                  type: string
                                  example: audits
                                last_cleanup_at:
                                  type: string
                                  example: '2020-1-13T00:00:00.000Z'
                            - allOf:
                                - properties:
                                    action:
                                      type: string
                                      example: delete
                                      enum:
                                        - archive
                                        - delete
                                        - disabled
                                    retention_period_in_days:
                                      type: integer
                                      example: 90
                              properties:
                                collection_group_name:
                                  type: string
                                  example: metrics
                                last_cleanup_at:
                                  type: string
                                  example: '2020-1-13T00:00:00.000Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/metadata-cleanup/policies/jobs:
    get:
      security:
        - BearerAuth: []
      operationId: getJobsPolicy
      tags:
        - Admin Metadata Cleanup
      summary: Get Jobs cleanup policy.
      description: Get Jobs cleanup policy.
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        allOf:
                          - properties:
                              action:
                                type: string
                                example: delete
                                enum:
                                  - archive
                                  - delete
                                  - disabled
                              retention_period_in_days:
                                type: integer
                                example: 90
                        properties:
                          collection_group_name:
                            type: string
                            example: jobs
                          last_cleanup_at:
                            type: string
                            example: '2020-1-13T00:00:00.000Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    put:
      security:
        - BearerAuth: []
      operationId: setJobsPolicy
      tags:
        - Admin Metadata Cleanup
      summary: Edit the Jobs Cleanup Policy
      description: Edit the Jobs Cleanup Policy
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - properties:
                    action:
                      type: string
                      example: delete
                      enum:
                        - archive
                        - delete
                        - disabled
                    retention_period_in_days:
                      type: integer
                      example: 90
                - properties:
                    collection_group_name:
                      type: string
                      example: jobs
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/metadata-cleanup/policies/audits:
    get:
      security:
        - BearerAuth: []
      operationId: getAuditsPolicy
      tags:
        - Admin Metadata Cleanup
      summary: Get Audits cleanup policy.
      description: Get Audits cleanup policy.
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        allOf:
                          - properties:
                              action:
                                type: string
                                example: delete
                                enum:
                                  - archive
                                  - delete
                                  - disabled
                              retention_period_in_days:
                                type: integer
                                example: 90
                        properties:
                          collection_group_name:
                            type: string
                            example: audits
                          last_cleanup_at:
                            type: string
                            example: '2020-1-13T00:00:00.000Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    put:
      security:
        - BearerAuth: []
      operationId: setAuditsPolicy
      tags:
        - Admin Metadata Cleanup
      summary: Edit the Audits Cleanup Policy
      description: Edit the Audits Cleanup Policy
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - properties:
                    action:
                      type: string
                      example: delete
                      enum:
                        - archive
                        - delete
                        - disabled
                    retention_period_in_days:
                      type: integer
                      example: 90
                - properties:
                    collection_group_name:
                      type: string
                      example: audits
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/metadata-cleanup/policies/metrics:
    get:
      security:
        - BearerAuth: []
      operationId: getMetricsPolicy
      tags:
        - Admin Metadata Cleanup
      summary: Get Metrics cleanup policy.
      description: Get Metrics cleanup policy.
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        allOf:
                          - properties:
                              action:
                                type: string
                                example: delete
                                enum:
                                  - archive
                                  - delete
                                  - disabled
                              retention_period_in_days:
                                type: integer
                                example: 90
                        properties:
                          collection_group_name:
                            type: string
                            example: metrics
                          last_cleanup_at:
                            type: string
                            example: '2020-1-13T00:00:00.000Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    put:
      security:
        - BearerAuth: []
      operationId: setMetricsPolicy
      tags:
        - Admin Metadata Cleanup
      summary: Edit the Metrics Cleanup Policy
      description: Edit the Metrics Cleanup Policy
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - properties:
                    action:
                      type: string
                      example: delete
                      enum:
                        - archive
                        - delete
                        - disabled
                    retention_period_in_days:
                      type: integer
                      example: 90
                - properties:
                    collection_group_name:
                      type: string
                      example: metrics
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/metadata-cleanup/schedule:
    get:
      security:
        - BearerAuth: []
      operationId: getMetadataCleanupSchedule
      tags:
        - Admin Metadata Cleanup
      summary: Get Schedule of cleanup policy.
      description: Get Schedule of cleanup policy.
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                properties:
                  result:
                    properties:
                      schedule_username:
                        type: string
                        example: 6RkfybTRQQByEey3v
                      schedule_type:
                        type: string
                        enum:
                          - metadata_cleanup
                      schedule_details:
                        oneOf:
                          - type: object
                            title: Generic Schedule
                            description: Generic schedule object
                            required:
                              - schedule_status
                            properties:
                              schedule_status:
                                type: string
                                enum:
                                  - enabled
                                  - disabled
                                example: enabled
                              start_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: Start time should be after current time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              start_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 14
                              start_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 35
                              repeat_interval_unit:
                                type: string
                                enum:
                                  - NEVER
                                  - MINUTE
                                  - HOUR
                                  - DAY
                                  - WEEK
                                  - MONTH
                                default: NEVER
                                example: MONTH
                              repeat_interval_measure:
                                type: integer
                                minimum: 1
                              repeat_on_last_day:
                                type: boolean
                                description: >
                                  `specified_days` must be provided if
                                  `repeat_on_last_day` is false. Applicable for
                                  `repeat_interval_unit=MONTH`
                                default: false
                              specified_days:
                                type: array
                                description: >
                                  Applicable when `repeat_interval_unit` is
                                  `WEEK` or `MONTH`.
                                minLength: 1
                                items:
                                  type: integer
                                  minimum: 0
                                  maximum: 31
                                example:
                                  - 1
                                  - 17
                                  - 31
                              ends:
                                type: boolean
                                description: >
                                  `end_date`, `end_hour`, `end_min` must be
                                  provided if `ends` is `true`.
                                default: false
                                example: true
                              end_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: End time should be after start time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              end_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 15
                              end_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 38
                              is_custom_job:
                                type: boolean
                                description: >
                                  `custom_job_details` must be provided when
                                  `is_custom_job=true`. Applicable when
                                  `repeat_interval_unit` is `DAY`, `WEEK` or
                                  `MONTH`.
                                default: false
                              custom_job_details:
                                type: object
                                required:
                                  - starts_daily_at
                                  - ends_daily_at
                                  - repeat_interval_measure
                                  - repeat_interval_unit
                                properties:
                                  starts_daily_at:
                                    pattern: ^{0-23}:[0-59]$
                                    type: string
                                    example: '12:40'
                                  ends_daily_at:
                                    pattern: ^{0-23}:[0-59]$
                                    type: string
                                    example: '17:45'
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                    example: 10
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - MINUTE
                                      - HOUR
                          - type: object
                            title: By Minute Schedule
                            description: Schedule job by minutes
                            required:
                              - schedule_status
                              - start_date
                              - start_hour
                              - start_min
                              - repeat_interval_unit
                              - repeat_interval_measure
                            properties:
                              schedule_status:
                                type: string
                                enum:
                                  - enabled
                                example: enabled
                              start_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: Start time should be after current time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              start_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 14
                              start_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 35
                              repeat_interval_unit:
                                type: string
                                enum:
                                  - MINUTE
                              repeat_interval_measure:
                                type: integer
                                minimum: 1
                              ends:
                                type: boolean
                                description: >
                                  `end_date`, `end_hour`, `end_min` must be
                                  provided if `ends` is `true`.
                                default: false
                                example: true
                              end_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: End time should be after start time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              end_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 15
                              end_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 55
                          - type: object
                            title: Hourly Schedule
                            description: Schedule job hourly
                            required:
                              - schedule_status
                              - start_date
                              - start_hour
                              - start_min
                              - repeat_interval_unit
                              - repeat_interval_measure
                            properties:
                              schedule_status:
                                type: string
                                enum:
                                  - enabled
                                example: enabled
                              start_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: Start time should be after current time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              start_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 14
                              start_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 35
                              repeat_interval_unit:
                                type: string
                                enum:
                                  - HOUR
                              repeat_interval_measure:
                                type: integer
                                minimum: 1
                              ends:
                                type: boolean
                                description: >
                                  `end_date`, `end_hour`, `end_min` must be
                                  provided if `ends` is `true`.
                                default: false
                                example: true
                              end_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: End time should be after start time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              end_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 15
                              end_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 55
                          - type: object
                            title: Daily Schedule
                            description: Schedule job daily
                            required:
                              - schedule_status
                              - start_date
                              - start_hour
                              - start_min
                              - repeat_interval_unit
                              - repeat_interval_measure
                            properties:
                              schedule_status:
                                type: string
                                enum:
                                  - enabled
                                example: enabled
                              start_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: Start time should be after current time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              start_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 14
                              start_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 35
                              repeat_interval_unit:
                                type: string
                                enum:
                                  - DAY
                              repeat_interval_measure:
                                type: integer
                                minimum: 1
                              ends:
                                type: boolean
                                description: >
                                  `end_date`, `end_hour`, `end_min` must be
                                  provided if `ends` is `true`.
                                default: false
                                example: true
                              end_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: End time should be after start time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              end_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 15
                              end_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 55
                              is_custom_job:
                                type: boolean
                                description: >
                                  `custom_job_details` must be provided when
                                  `is_custom_job=true`
                                default: false
                                example: true
                              custom_job_details:
                                type: object
                                required:
                                  - starts_daily_at
                                  - ends_daily_at
                                  - repeat_interval_measure
                                  - repeat_interval_unit
                                properties:
                                  starts_daily_at:
                                    pattern: ^{0-23}:[0-59]$
                                    type: string
                                    example: '12:40'
                                  ends_daily_at:
                                    pattern: ^{0-23}:[0-59]$
                                    type: string
                                    example: '17:45'
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                    example: 10
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - MINUTE
                                      - HOUR
                          - type: object
                            title: Weekly Schedule
                            description: Schedule job weekly
                            required:
                              - schedule_status
                              - start_date
                              - start_hour
                              - start_min
                              - repeat_interval_unit
                              - repeat_interval_measure
                              - specified_days
                            properties:
                              schedule_status:
                                type: string
                                enum:
                                  - enabled
                                example: enabled
                              start_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: Start time should be after current time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              start_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 14
                              start_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 35
                              repeat_interval_unit:
                                type: string
                                enum:
                                  - WEEK
                              repeat_interval_measure:
                                type: integer
                                minimum: 1
                              specified_days:
                                type: array
                                minLength: 1
                                items:
                                  type: integer
                                  minimum: 0
                                  maximum: 6
                                example:
                                  - 0
                                  - 2
                                  - 5
                              ends:
                                type: boolean
                                description: >
                                  `end_date`, `end_hour`, `end_min` must be
                                  provided if `ends` is `true`.
                                default: false
                                example: true
                              end_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: End time should be after start time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              end_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 15
                              end_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 55
                              is_custom_job:
                                type: boolean
                                description: >
                                  `custom_job_details` must be provided when
                                  `is_custom_job=true`
                                default: false
                                example: true
                              custom_job_details:
                                type: object
                                required:
                                  - starts_daily_at
                                  - ends_daily_at
                                  - repeat_interval_measure
                                  - repeat_interval_unit
                                properties:
                                  starts_daily_at:
                                    pattern: ^{0-23}:[0-59]$
                                    type: string
                                    example: '12:40'
                                  ends_daily_at:
                                    pattern: ^{0-23}:[0-59]$
                                    type: string
                                    example: '17:45'
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                    example: 10
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - MINUTE
                                      - HOUR
                          - type: object
                            title: Monthly Schedule
                            description: Schedule job monthly
                            required:
                              - schedule_status
                              - start_date
                              - start_hour
                              - start_min
                              - repeat_interval_unit
                              - repeat_interval_measure
                            properties:
                              schedule_status:
                                type: string
                                enum:
                                  - enabled
                                example: enabled
                              start_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: Start time should be after current time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              start_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 14
                              start_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 35
                              repeat_interval_unit:
                                type: string
                                enum:
                                  - MONTH
                              repeat_interval_measure:
                                type: integer
                                minimum: 1
                              repeat_on_last_day:
                                type: boolean
                                description: >
                                  `specified_days` must be provided if
                                  `repeat_on_last_day` is false.
                                default: false
                              specified_days:
                                type: array
                                minLength: 1
                                items:
                                  type: integer
                                  minimum: 1
                                  maximum: 31
                                example:
                                  - 1
                                  - 17
                                  - 31
                              ends:
                                type: boolean
                                description: >
                                  `end_date`, `end_hour`, `end_min` must be
                                  provided if `ends` is `true`.
                                default: false
                                example: true
                              end_date:
                                pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                type: string
                                description: End time should be after start time.
                                format: date-month'/'date-mday'/'date-fullyear
                                example: 08/28/2023
                              end_hour:
                                type: integer
                                minimum: 0
                                maximum: 23
                                example: 15
                              end_min:
                                type: integer
                                minimum: 0
                                maximum: 59
                                example: 45
                              is_custom_job:
                                type: boolean
                                description: >
                                  `custom_job_details` must be provided when
                                  `is_custom_job=true`
                                default: false
                                example: true
                              custom_job_details:
                                type: object
                                required:
                                  - starts_daily_at
                                  - ends_daily_at
                                  - repeat_interval_measure
                                  - repeat_interval_unit
                                properties:
                                  starts_daily_at:
                                    pattern: ^{0-23}:[0-59]$
                                    type: string
                                    example: '12:40'
                                  ends_daily_at:
                                    pattern: ^{0-23}:[0-59]$
                                    type: string
                                    example: '17:45'
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                    example: 10
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - MINUTE
                                      - HOUR
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/metadata-cleanup/schedule/enable:
    put:
      security:
        - BearerAuth: []
      operationId: setMetadataCleanupSchedule
      tags:
        - Admin Metadata Cleanup
      summary: Edit Schedule of cleanup policy.
      description: Edit Schedule of cleanup policy.
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  title: Generic Schedule
                  description: Generic schedule object
                  required:
                    - schedule_status
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                        - disabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - NEVER
                        - MINUTE
                        - HOUR
                        - DAY
                        - WEEK
                        - MONTH
                      default: NEVER
                      example: MONTH
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    repeat_on_last_day:
                      type: boolean
                      description: >
                        `specified_days` must be provided if
                        `repeat_on_last_day` is false. Applicable for
                        `repeat_interval_unit=MONTH`
                      default: false
                    specified_days:
                      type: array
                      description: >
                        Applicable when `repeat_interval_unit` is `WEEK` or
                        `MONTH`.
                      minLength: 1
                      items:
                        type: integer
                        minimum: 0
                        maximum: 31
                      example:
                        - 1
                        - 17
                        - 31
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 38
                    is_custom_job:
                      type: boolean
                      description: >
                        `custom_job_details` must be provided when
                        `is_custom_job=true`. Applicable when
                        `repeat_interval_unit` is `DAY`, `WEEK` or `MONTH`.
                      default: false
                    custom_job_details:
                      type: object
                      required:
                        - starts_daily_at
                        - ends_daily_at
                        - repeat_interval_measure
                        - repeat_interval_unit
                      properties:
                        starts_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '12:40'
                        ends_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '17:45'
                        repeat_interval_measure:
                          type: integer
                          minimum: 1
                          example: 10
                        repeat_interval_unit:
                          type: string
                          enum:
                            - MINUTE
                            - HOUR
                - type: object
                  title: By Minute Schedule
                  description: Schedule job by minutes
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - MINUTE
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 55
                - type: object
                  title: Hourly Schedule
                  description: Schedule job hourly
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - HOUR
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 55
                - type: object
                  title: Daily Schedule
                  description: Schedule job daily
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - DAY
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 55
                    is_custom_job:
                      type: boolean
                      description: >
                        `custom_job_details` must be provided when
                        `is_custom_job=true`
                      default: false
                      example: true
                    custom_job_details:
                      type: object
                      required:
                        - starts_daily_at
                        - ends_daily_at
                        - repeat_interval_measure
                        - repeat_interval_unit
                      properties:
                        starts_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '12:40'
                        ends_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '17:45'
                        repeat_interval_measure:
                          type: integer
                          minimum: 1
                          example: 10
                        repeat_interval_unit:
                          type: string
                          enum:
                            - MINUTE
                            - HOUR
                - type: object
                  title: Weekly Schedule
                  description: Schedule job weekly
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                    - specified_days
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - WEEK
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    specified_days:
                      type: array
                      minLength: 1
                      items:
                        type: integer
                        minimum: 0
                        maximum: 6
                      example:
                        - 0
                        - 2
                        - 5
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 55
                    is_custom_job:
                      type: boolean
                      description: >
                        `custom_job_details` must be provided when
                        `is_custom_job=true`
                      default: false
                      example: true
                    custom_job_details:
                      type: object
                      required:
                        - starts_daily_at
                        - ends_daily_at
                        - repeat_interval_measure
                        - repeat_interval_unit
                      properties:
                        starts_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '12:40'
                        ends_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '17:45'
                        repeat_interval_measure:
                          type: integer
                          minimum: 1
                          example: 10
                        repeat_interval_unit:
                          type: string
                          enum:
                            - MINUTE
                            - HOUR
                - type: object
                  title: Monthly Schedule
                  description: Schedule job monthly
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - MONTH
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    repeat_on_last_day:
                      type: boolean
                      description: >
                        `specified_days` must be provided if
                        `repeat_on_last_day` is false.
                      default: false
                    specified_days:
                      type: array
                      minLength: 1
                      items:
                        type: integer
                        minimum: 1
                        maximum: 31
                      example:
                        - 1
                        - 17
                        - 31
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 45
                    is_custom_job:
                      type: boolean
                      description: >
                        `custom_job_details` must be provided when
                        `is_custom_job=true`
                      default: false
                      example: true
                    custom_job_details:
                      type: object
                      required:
                        - starts_daily_at
                        - ends_daily_at
                        - repeat_interval_measure
                        - repeat_interval_unit
                      properties:
                        starts_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '12:40'
                        ends_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '17:45'
                        repeat_interval_measure:
                          type: integer
                          minimum: 1
                          example: 10
                        repeat_interval_unit:
                          type: string
                          enum:
                            - MINUTE
                            - HOUR
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/metadata-cleanup/schedule/disable:
    put:
      security:
        - BearerAuth: []
      operationId: disableMetadataCleanupSchedule
      tags:
        - Admin Metadata Cleanup
      summary: Edit Schedule of cleanup policy.
      description: Edit Schedule of cleanup policy.
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/metadata-cleanup/schedule/user:
    put:
      security:
        - BearerAuth: []
      operationId: changeMetadataCleanupScheduleUser
      tags:
        - Admin Metadata Cleanup
      summary: >-
        Edit Scheduling User of cleanup policy. Hit this API with the delegation
        token of the required User.
      description: >-
        Edit Scheduling User of cleanup policy. Hit this API with the delegation
        token of the required User.
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/workflows/pause:
    post:
      security:
        - BearerAuth: []
      operationId: pauseMultipleWorkflows
      tags:
        - Admin Workflows
      summary: Pause Multiple Workflows
      description: Pause Multiple Workflows
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - workflows
              properties:
                workflows:
                  type: array
                  description: List of workflows and their versions to pause or resume.
                  items:
                    type: object
                    required:
                      - workflow_id
                      - workflow_version_id
                    properties:
                      workflow_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      workflow_version_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        type: object
                        properties:
                          message:
                            type: string
                            description: Summary message of the operation.
                            example: Successfully Resumed Workflow
                          result:
                            type: array
                            description: List of resumed workflows with their versions.
                            items:
                              type: object
                              required:
                                - workflow_id
                                - workflow_version_id
                              properties:
                                workflow_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                workflow_version_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/jobs/{job_id}/reports/ingestion-metrics:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Metrics
      summary: Get the Ingestion-metrics of the table with job_id
      description: Get the Ingestion-metrics of the table with job_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            result:
                              type: array
                              items:
                                type: object
                                properties:
                                  number_of_records_written:
                                    type: integer
                                    format: integer
                                  number_of_records_read:
                                    type: integer
                                    format: integer
                                  last_merged_watermark:
                                    type: string
                                    format: string
                                  first_merged_watermark:
                                    type: string
                                    format: string
                                  source_table_name:
                                    type: string
                                    format: string
                                  source_schema_name:
                                    type: string
                                    format: string
                                  source_database_name:
                                    type: string
                                    format: string
                                  workflow_run_id:
                                    type: string
                                    format: string
                                  workflow_id:
                                    type: string
                                    format: string
                                  job_duration:
                                    type: string
                                    format: string
                                  job_end_time:
                                    type: string
                                    format: string
                                  job_id:
                                    type: string
                                    format: string
                                  job_start_time:
                                    type: string
                                    format: string
                                  table_id:
                                    type: string
                                    format: string
                                  job_status:
                                    type: string
                                    format: string
                                  target_records_count:
                                    type: string
                                    format: string
                                  fetch_records_count:
                                    type: string
                                    format: string
                                  job_type:
                                    type: string
                                    format: string
                                  source_id:
                                    type: string
                                    format: string
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/jobs/{job_id}/reports/export-metrics:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Metrics
      summary: Get the Export-metrics of the table with job_id
      description: Get the Export-metrics of the table with job_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            result:
                              type: array
                              items:
                                type: object
                                properties:
                                  number_of_records_written:
                                    type: integer
                                    format: integer
                                  number_of_records_read:
                                    type: integer
                                    format: integer
                                  last_merged_watermark:
                                    type: string
                                    format: string
                                  first_merged_watermark:
                                    type: string
                                    format: string
                                  source_table_name:
                                    type: string
                                    format: string
                                  source_schema_name:
                                    type: string
                                    format: string
                                  source_database_name:
                                    type: string
                                    format: string
                                  workflow_run_id:
                                    type: string
                                    format: string
                                  workflow_id:
                                    type: string
                                    format: string
                                  job_duration:
                                    type: string
                                    format: string
                                  job_end_time:
                                    type: string
                                    format: string
                                  job_id:
                                    type: string
                                    format: string
                                  job_start_time:
                                    type: string
                                    format: string
                                  table_id:
                                    type: string
                                    format: string
                                  job_status:
                                    type: string
                                    format: string
                                  target_records_count:
                                    type: string
                                    format: string
                                  job_type:
                                    type: string
                                    format: string
                                  source_id:
                                    type: string
                                    format: string
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/jobs/{job_id}/reports/pipeline-metrics:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Metrics
      summary: Get the Pipeline-metrics of the table with job_id
      description: Get the Pipeline-metrics of the table with job_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            result:
                              type: array
                              items:
                                type: object
                                properties:
                                  number_of_records_written:
                                    type: integer
                                    format: integer
                                  number_of_records_read:
                                    type: integer
                                    format: integer
                                  last_merged_watermark:
                                    type: string
                                    format: string
                                  first_merged_watermark:
                                    type: string
                                    format: string
                                  source_table_name:
                                    type: string
                                    format: string
                                  source_schema_name:
                                    type: string
                                    format: string
                                  workflow_run_id:
                                    type: string
                                    format: string
                                  workflow_id:
                                    type: string
                                    format: string
                                  job_end_time:
                                    type: string
                                    format: string
                                  job_id:
                                    type: string
                                    format: string
                                  job_start_time:
                                    type: string
                                    format: string
                                  job_status:
                                    type: string
                                    format: string
                                  target_records_count:
                                    type: string
                                    format: string
                                  query_tag:
                                    type: string
                                    format: string
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/workflows/resume:
    post:
      security:
        - BearerAuth: []
      operationId: resumeMultipleWorkflows
      tags:
        - Admin Workflows
      summary: Resume Multiple Workflows
      description: Resume Multiple Workflows
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - workflows
              properties:
                workflows:
                  type: array
                  description: List of workflows and their versions to pause or resume.
                  items:
                    type: object
                    required:
                      - workflow_id
                      - workflow_version_id
                    properties:
                      workflow_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      workflow_version_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        type: object
                        properties:
                          message:
                            type: string
                            description: Summary message of the operation.
                            example: Successfully Resumed Workflow
                          result:
                            type: array
                            description: List of resumed workflows with their versions.
                            items:
                              type: object
                              required:
                                - workflow_id
                                - workflow_version_id
                              properties:
                                workflow_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                workflow_version_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/workflows/restart:
    post:
      security:
        - BearerAuth: []
      operationId: restartMultipleWorkflowRuns
      tags:
        - Admin Workflows
      summary: Restart Multiple Workflows
      description: Restart Multiple Workflows
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: object
                    properties:
                      workflow_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      run_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      skip_nodes:
                        type: array
                        items:
                          type: string
                          example: DM_AA38
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        type: object
                        properties:
                          ids:
                            type: array
                            items:
                              type: object
                              properties:
                                workflow_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                run_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                error:
                                  type: string
                                  example: Example Error Message
                                  nullable: true
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/workflows/cancel:
    post:
      security:
        - BearerAuth: []
      operationId: cancelMultipleWorkflowRuns
      tags:
        - Admin Workflows
      summary: Cancel Multiple Workflows
      description: Cancel Multiple Workflows
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: object
                    properties:
                      workflow_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      run_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      skip_nodes:
                        type: array
                        items:
                          type: string
                          example: DM_AA38
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/workflows:
    get:
      security:
        - BearerAuth: []
      summary: Retrieves the status of workflow
      description: Retrieves the status of workflows for the Admin user.
      operationId: getAdminWorkflows
      tags:
        - Admin Workflows
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        type: object
                        properties:
                          total_count:
                            type: integer
                            minimum: 0
                            description: Total count of workflows
                            example: 10
                          items:
                            type: array
                            items:
                              type: object
                              allOf:
                                - type: object
                                  properties:
                                    created_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                                - properties:
                                    created_by_user_email:
                                      type: string
                                      description: User email
                                      example: admin@infoworks.io
                                    created_by_user_name:
                                      type: string
                                      description: User name
                                      example: Infoworks Admin
                                    domain_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    domain_name:
                                      type: string
                                      description: Domain name
                                    is_paused:
                                      type: boolean
                                      example: false
                                    last_exec_end_time:
                                      type: string
                                      example: '2022-06-14 07:55:57.334000+00:00'
                                    last_exec_start_time:
                                      type: string
                                      example: '2022-06-14 07:55:55.549158+00:00'
                                    last_exec_status:
                                      type: string
                                      example: success
                                    workflow_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    workflow_name:
                                      type: string
                                      example: new_workflow
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/workflow-versions:
    get:
      security:
        - BearerAuth: []
      summary: Gets workflow versions
      description: Retrieves the list of workflow versions for the Admin user.
      operationId: getAdminWorkflowVersions
      tags:
        - Admin Workflows
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        type: array
                        description: List of workflow version objects.
                        items:
                          type: object
                          properties:
                            workflow_id:
                              type: string
                              description: Unique ID of the parent workflow.
                              example: 686e20a16f25c44e155ba21d
                            version:
                              type: integer
                              description: Version number of the workflow.
                              example: 1
                            last_execution_details:
                              type: object
                              properties:
                                run_id:
                                  type: string
                                  description: ID of the last workflow execution run.
                                  example: 686e24e46f25c44e155ba227
                                start_date:
                                  type: string
                                  format: date-time
                                  description: Start time of the last execution.
                                  example: '2025-07-09T08:14:29.498325+00:00'
                                end_date:
                                  type: string
                                  format: date-time
                                  description: End time of the last execution.
                                  example: '2025-07-09T08:14:33.119Z'
                                status:
                                  type: string
                                  description: Status of the last execution.
                                  example: success
                            is_paused:
                              type: boolean
                              description: Indicates if the workflow version is paused.
                              example: true
                            domain_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                            domain_name:
                              type: string
                              description: >-
                                Name of the domain to which the workflow
                                belongs.
                              example: Data_Engineering
                            workflow_name:
                              type: string
                              description: Name of the workflow.
                              example: w1
                            workflow_version_id:
                              type: string
                              description: Unique ID of the workflow version.
                              example: 686e20a16f25c44e155ba220
                            created_by_username:
                              type: string
                              description: >-
                                Name of the user who created the workflow
                                version.
                              example: Infoworks Admin
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/workflows/runs:
    get:
      security:
        - BearerAuth: []
      summary: Get Workflows
      description: Get Workflows runs
      tags:
        - Admin Workflows
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        type: object
                        properties:
                          total_count:
                            type: integer
                            minimum: 0
                            description: Total count of workflows
                            example: 10
                          items:
                            type: array
                            items:
                              type: object
                              allOf:
                                - type: object
                                  properties:
                                    created_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                                - properties:
                                    created_by_user_email:
                                      type: string
                                      description: User email
                                      example: admin@infoworks.io
                                    created_by_user_name:
                                      type: string
                                      description: User name
                                      example: Infoworks Admin
                                    domain_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    domain_name:
                                      type: string
                                      description: Domain name
                                    is_paused:
                                      type: boolean
                                      example: false
                                    last_exec_end_time:
                                      type: string
                                      example: '2022-06-14 07:55:57.334000+00:00'
                                    last_exec_start_time:
                                      type: string
                                      example: '2022-06-14 07:55:55.549158+00:00'
                                    last_exec_status:
                                      type: string
                                      example: success
                                    workflow_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    workflow_name:
                                      type: string
                                      example: new_workflow
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/workflows/tasks:
    get:
      security:
        - BearerAuth: []
      summary: Get Workflows tasks
      description: Get Workflows tasks
      tags:
        - Admin Workflows
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        allOf:
                          - type: object
                            properties:
                              count:
                                type: integer
                                example: 10
                          - type: object
                            properties:
                              items:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    duration:
                                      type: string
                                      example: 1.657273
                                    end_date:
                                      type: string
                                      example: '2010-01-18T10:29:40.667Z'
                                    execution_date:
                                      type: string
                                      example: '2010-01-18T10:29:35.000Z'
                                    hostname:
                                      type: string
                                      example: iw-10.internal.cloudapp.net
                                    run_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    start_date:
                                      type: string
                                      example: '2010-01-18T10:29:39.009Z'
                                    task_id:
                                      type: string
                                      example: DM_GNIA
                                    task_status:
                                      type: string
                                      example: success
                                    task_type:
                                      type: string
                                      example: dummy
                                    workflow_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    workflow_name:
                                      type: string
                                      example: new_workflow
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/workflows/{workflow_id}/runs/{run_id}:
    parameters:
      - name: run_id
        in: path
        required: true
        schema:
          type: string
      - name: workflow_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      summary: Get Workflow run Id details
      description: Get Workflow run Id details
      tags:
        - Admin Workflows
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        allOf:
                          - type: object
                            properties:
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          - properties:
                              workflow_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              build_number:
                                type: integer
                                example: 2
                              workflow_name:
                                type: string
                                example: new_workflow
                              user_auth_token:
                                type: string
                                example: sugsv***
                          - type: object
                            allOf:
                              - type: object
                                properties:
                                  created_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  created_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                              - type: object
                                properties:
                                  modified_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  modified_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                          - properties:
                              triggered_at:
                                type: string
                                example: Wed Nov 18 2020 05:34:11 GMT+0000 (UTC)
                              tasks_status:
                                type: array
                                items:
                                  type: boolean
                                  example: null
                              workflow_status:
                                properties:
                                  state:
                                    type: string
                                    example: failed
                              triggered_by:
                                type: object
                                allOf:
                                  - type: object
                                    properties:
                                      id:
                                        type: string
                                        example: e77850ad5127a2d7dab870ff
                                  - properties:
                                      type:
                                        type: string
                                        example: user
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/locked-entities:
    get:
      security:
        - BearerAuth: []
      operationId: getLockedEntityList
      summary: Get All Currently Locked Entities.
      description: Get All Currently Locked Entities.
      tags:
        - Locked Entities
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                properties:
                  total_count:
                    type: integer
                    minimum: 0
                    example: 10
                  result:
                    items:
                      properties:
                        entity_state:
                          type: string
                          example: crawling
                        entity_type:
                          type: string
                          example: table_group
                        entity_name:
                          type: string
                          example: northwind_group
                        entity_id:
                          type: string
                          example: e77850ad5127a2d7dab870ff
                        job_id:
                          type: string
                          example: e77850ad5127a2d7dab870ff
                        job_type:
                          type: string
                          example: source_ingest
                        job_status:
                          type: string
                          example: blocked
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/unlock-entities:
    post:
      security:
        - BearerAuth: []
      operationId: unlockEntities
      summary: Unlock Currently Locked Entities.
      description: Unlocks all Currently Locked Entities.
      tags:
        - Locked Entities
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        items:
                          properties:
                            id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                            error:
                              type: string
                              example: Example Error
                              nullable: true
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/locked-entities/{entity_id}:
    parameters:
      - name: entity_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getLockedEntity
      summary: Get a specific currently Locked Entity.
      description: Get a specific currently Locked Entity.
      tags:
        - Locked Entities
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        properties:
                          entity_state:
                            type: string
                            example: crawling
                          entity_type:
                            type: string
                            example: table_group
                          entity_name:
                            type: string
                            example: northwind_group
                          entity_id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                          job_id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                          job_type:
                            type: string
                            example: source_ingest
                          job_status:
                            type: string
                            example: blocked
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/unlock-entities/{entity_id}:
    parameters:
      - name: entity_id
        in: path
        required: true
        schema:
          type: string
    post:
      security:
        - BearerAuth: []
      operationId: unlockEntity
      summary: Unlock a Currently Locked Entity.
      description: Unlock a Currently Locked Entity.
      tags:
        - Locked Entities
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/subscribers:
    get:
      security:
        - BearerAuth: []
      operationId: getAdminSubscriberList
      tags:
        - Admin Subscribers
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      summary: Get a list of subscribers.
      description: Get a list of subscribers.
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - type: object
                              allOf:
                                - type: object
                                  properties:
                                    created_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    created_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                                - type: object
                                  properties:
                                    modified_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    modified_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                            - properties:
                                profile:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                      example: John Steinbeck
                                    email:
                                      type: string
                                      example: john@steinbeck.org
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: addSubscriber
      tags:
        - Admin Subscribers
      summary: Create a new subscriber.
      description: Create a new subscriber.
      requestBody:
        content:
          application/json:
            schema:
              properties:
                profile:
                  type: object
                  properties:
                    name:
                      type: string
                      example: John Steinbeck
                    email:
                      type: string
                      example: john@steinbeck.org
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/subscribers/{subscriber_id}:
    parameters:
      - name: subscriber_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getAdminSubscriber
      tags:
        - Admin Subscribers
      summary: Get a subscriber.
      description: Get a subscriber.
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        allOf:
                          - type: object
                            properties:
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          - type: object
                            allOf:
                              - type: object
                                properties:
                                  created_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  created_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                              - type: object
                                properties:
                                  modified_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  modified_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                          - properties:
                              profile:
                                type: object
                                properties:
                                  name:
                                    type: string
                                    example: John Steinbeck
                                  email:
                                    type: string
                                    example: john@steinbeck.org
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    put:
      security:
        - BearerAuth: []
      operationId: updateSubscriber
      tags:
        - Admin Subscribers
      summary: Update a subscriber.
      description: Update a subscriber.
      requestBody:
        content:
          application/json:
            schema:
              properties:
                profile:
                  type: object
                  properties:
                    name:
                      type: string
                      example: John Steinbeck
                    email:
                      type: string
                      example: john@steinbeck.org
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      operationId: deleteSubscriber
      tags:
        - Admin Subscribers
      summary: Delete a subscriber.
      description: Delete a subscriber.
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/subscriptions/{subscriber_id}:
    parameters:
      - name: subscriber_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getSubscriptionList
      tags:
        - Admin Subscribers
      summary: Get a Subscription List for a subscriber.
      description: Get a Subscription List for a subscriber.
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        properties:
                          entity_id:
                            type: string
                            example: 0822b5f5929e892cb8777473
                          entity_name:
                            type: string
                            example: AvroSourceBugTest
                          entity_type:
                            type: string
                            example: source
                          notify_events:
                            type: array
                            items:
                              type: object
                              properties:
                                event_job_type:
                                  type: string
                                notify_on:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - SUCCESS
                                    - FAILED
                          notify_via:
                            type: array
                            items:
                              type: string
                              example:
                                - EMAIL
                          updated_at:
                            type: string
                          updated_by:
                            type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      operationId: deleteSubscription
      tags:
        - Admin Subscribers
      summary: Delete all the subscription for a subscriber.
      description: Delete all the subscription for a subscriber.
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/allUsers:
    get:
      security:
        - BearerAuth: []
      operationId: getUserList
      tags:
        - Admin Subscribers
      summary: Get a list of all external and internal users.
      description: Get a list of all external and internal users.
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        items:
                          properties:
                            id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                            name:
                              type: string
                              example: user1
                            email:
                              type: string
                              example: admin@infoworks.io
                            type:
                              type: string
                              enum:
                                - internal
                                - external
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/jobs:
    get:
      security:
        - BearerAuth: []
      operationId: getJobs
      tags:
        - Jobs
      summary: Get the jobs details
      description: Get the jobs details
      parameters:
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: resolve_ref
          in: query
          description: To get entity details and created by user name
          schema:
            type: boolean
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 8714887c9a8c5bb0b8794811
                            build_id:
                              type: integer
                              example: 2
                            name:
                              type: string
                              example: test_job
                            status:
                              type: string
                              enum:
                                - completed
                                - pending
                                - aborted
                                - blocked
                                - failed
                                - running
                                - canceled
                                - succeeded
                              example: completed
                            percentage:
                              type: integer
                              example: 100
                            type:
                              type: string
                              enum:
                                - source_test_connection
                                - fetch_metadata
                                - source_structured_fetch_metadata
                                - source_crawl
                                - source_crawl_chunk_load
                                - source_cdc
                                - source_unstructured_crawl
                                - source_structured_crawl
                                - source_semistructured_crawl
                                - delete_entity
                                - pipeline_metadata
                                - pipeline_build
                                - pipeline_build_restatement
                                - full_load
                                - cdc
                                - source_merge
                                - source_structured_cdc_merge
                                - source_structured_cdc
                                - source_cdc_merge
                                - source_cdc_restatement
                                - source_semistructured_cdc_merge
                                - source_semistructured_cdc
                                - metadata_cleanup_policy
                            entity_id:
                              type: string
                              example: d2f33c1d424363162692b3bf
                            entity_type:
                              type: string
                              enum:
                                - source
                                - pipeline
                                - workflow
                            sub_entity_id:
                              type: string
                              example: be034607444511f74313be63
                            sub_entity_type:
                              type: string
                              example: table_group
                            duration:
                              type: integer
                              example: 349316
                              description: This is duration of the job.
                            cluster_id:
                              type: string
                              example: j-134jnasdkjaasd
                              description: Extenal clusterId
                            compute_id:
                              type: string
                              example: be034607444511f74313be63
                              description: Infoworks compute cluster id
                            compute_name:
                              type: string
                              example: Default_Persistent_cluster
                              description: Infoworks compute name
                            created_at:
                              type: string
                              format: date-time
                              example: '2020-10-05T04:23:30.339Z'
                            created_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                              description: UserId of user who triggered the job.
                            last_updated:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
                            processed_at:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/jobs/{job_id}:
    parameters:
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getjobs id details
      tags:
        - Jobs
      summary: Get the job details with `job_id`
      description: Get the job details with `job_id`
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 8714887c9a8c5bb0b8794811
                          build_id:
                            type: integer
                            example: 2
                          name:
                            type: string
                            example: test_job
                          status:
                            type: string
                            enum:
                              - completed
                              - pending
                              - aborted
                              - blocked
                              - failed
                              - running
                              - canceled
                              - succeeded
                            example: completed
                          percentage:
                            type: integer
                            example: 100
                          type:
                            type: string
                            enum:
                              - source_test_connection
                              - fetch_metadata
                              - source_structured_fetch_metadata
                              - source_crawl
                              - source_crawl_chunk_load
                              - source_cdc
                              - source_unstructured_crawl
                              - source_structured_crawl
                              - source_semistructured_crawl
                              - delete_entity
                              - pipeline_metadata
                              - pipeline_build
                              - pipeline_build_restatement
                              - full_load
                              - cdc
                              - source_merge
                              - source_structured_cdc_merge
                              - source_structured_cdc
                              - source_cdc_merge
                              - source_cdc_restatement
                              - source_semistructured_cdc_merge
                              - source_semistructured_cdc
                              - metadata_cleanup_policy
                          entity_id:
                            type: string
                            example: d2f33c1d424363162692b3bf
                          entity_type:
                            type: string
                            enum:
                              - source
                              - pipeline
                              - workflow
                          sub_entity_id:
                            type: string
                            example: be034607444511f74313be63
                          sub_entity_type:
                            type: string
                            example: table_group
                          duration:
                            type: integer
                            example: 349316
                            description: This is duration of the job.
                          cluster_id:
                            type: string
                            example: j-134jnasdkjaasd
                            description: Extenal clusterId
                          compute_id:
                            type: string
                            example: be034607444511f74313be63
                            description: Infoworks compute cluster id
                          compute_name:
                            type: string
                            example: Default_Persistent_cluster
                            description: Infoworks compute name
                          created_at:
                            type: string
                            format: date-time
                            example: '2020-10-05T04:23:30.339Z'
                          created_by:
                            type: string
                            example: 6RkfybTRQQByEey3v
                            description: UserId of user who triggered the job.
                          last_updated:
                            type: string
                            example: '2019-11-21T12:54:05.875Z'
                          processed_at:
                            type: string
                            example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/jobs/{job_id}/resubmit:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    post:
      security:
        - BearerAuth: []
      tags:
        - Jobs
      summary: Resubmit Failed tables for ingestion
      description: Resubmit Failed tables for ingestion
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/jobs/{job_id}/logs:
    parameters:
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
      - name: num_lines
        in: query
        description: Number of lines of log required
        schema:
          type: integer
          default: 100
    get:
      security:
        - BearerAuth: []
      operationId: get_job_logs_admin
      tags:
        - Jobs
      summary: Get the job log as text stream with `job_id`
      description: Get the job log as text stream with `job_id`
      responses:
        '200':
          description: Ok.
          content:
            application/octet-stream:
              schema:
                type: string
                example: >
                  [INFO] 2020-12-22 13:44:52,730 [main]
                  io.infoworks.saas.ingestion.commons.utils.HeartBeatJob:24 ::
                  Starting job for 5fe1f854e27e6d67b923f7c4
                   [INFO] 2020-12-22 13:44:52,732 [main] io.infoworks.saas.ingestion.commons.utils.HeartbeatUpdater:30 :: Starting heartbeats thread
                   [INFO] 2020-12-22 13:44:55,876 [main] io.infoworks.saas.ingestion.core.crawl.util.CrawlHelper:523 :: connector path :/opt/infoworks/lib/ingestion/connectors/mysql
                   [INFO] 2020-12-22 13:44:55,876 [main] io.infoworks.saas.ingestion.core.crawl.util.CrawlHelper:526 :: Loading connector specific jars for :mysql
                   [INFO] 2020-12-22 13:44:55,885 [main] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver
                   [INFO] 2020-12-22 13:44:56,330 [main] io.infoworks.saas.ingestion.core.connectors.jdbc.sourcecrawler.AbstractJDBCSourceCrawler:83 :: Granted 1 connections
                   [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.utils.ConnectionPool:24 :: Releasing 1 connections to pool
                   [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.connectors.jdbc.sourcecrawler.AbstractJDBCSourceCrawler:83 :: Granted 1 connections
                   [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.utils.ConnectionPool:24 :: Releasing 1 connections to pool
                   [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.connectors.jdbc.sourcecrawler.AbstractJDBCSourceCrawler:83 :: Granted 1 connections
                   [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.utils.ConnectionPool:24 :: Releasing 1 connections to pool
                   [INFO] 2020-12-22 13:44:56,335 [main] io.infoworks.saas.ingestion.core.connectors.jdbc.sourcecrawler.AbstractJDBCSourceCrawler:83 :: Granted 1 connections
                   [INFO] 2020-12-22 13:44:56,335 [main] io.infoworks.saas.ingestion.core.utils.ConnectionPool:24 :: Releasing 1 connections to pool
                   [INFO] 2020-12-22 13:44:56,542 [pool-1-thread-1] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver
                   [INFO] 2020-12-22 13:44:56,546 [pool-1-thread-4] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver
                   [INFO] 2020-12-22 13:44:56,550 [pool-1-thread-2] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver
                   [INFO] 2020-12-22 13:44:56,553 [pool-1-thread-3] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver
                   [INFO] 2020-12-22 13:44:56,824 [pool-1-thread-4] io.infoworks.platform.metadb.core.sync.store.MongoDBMetaStore:37 :: Initializing mongodb meta store ...
                   [INFO] 2020-12-22 13:44:56,892 [pool-1-thread-4] io.infoworks.platform.common.encryption.AES256:94 :: Attempting to decrypt data using AES-256
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/jobs/{job_id}/logs/download:
    parameters:
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Jobs
      summary: Download iw job logs zip for iw_job with job_id
      description: Download iw job logs zip for iw_job with `job_id`
      responses:
        '200':
          description: Ok.
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
                example: log_file_5fe1f854e27e6d67b923f7c4.zip
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/jobs/{job_id}/runs:
    parameters:
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Jobs
      summary: Get cluster jobs for iw_job with job_id
      description: Get cluster jobs for iw_job with `job_id`
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 8714887c9a8c5bb0b8794811
                          entity_id:
                            type: string
                            example: 8714887c9a8c5bb0b8794811
                          entity_type:
                            type: string
                            example: source
                          entity_name:
                            type: string
                            example: jdbc_source
                          sub_entity_type:
                            type: string
                            example: table
                          sub_entity_id:
                            type: string
                            example: 8714887c9a8c5bb0b8794811
                          iw_job_id:
                            type: string
                            example: 8714887c9a8c5bb0b8794811
                          job_name:
                            type: string
                            example: table ingestion
                          duration:
                            type: integer
                            example: 123414
                          percentage:
                            type: integer
                            format: int32
                            example: 90
                          type:
                            type: string
                            enum:
                              - dataproc
                              - databricks
                              - local
                            example: dataproc
                          state:
                            type: string
                            enum:
                              - PENDING
                              - RUNNING
                              - SKIPPED
                              - TERMINATING
                              - TERMINATED
                              - INTERNAL_ERROR
                              - DONE
                              - NOT_RUNNING
                              - CANCELED
                              - STATE_UNSPECIFIED
                              - SETUP_DONE
                              - UNKNOWN
                              - ERROR
                              - CANCELED
                              - CANCEL_STARTED
                              - CANCEL_PENDING
                              - ATTEMPT_FAILURE
                            example: PENDING
                          stages:
                            type: object
                            properties:
                              stage:
                                type: string
                                example: start_cluster
                              start_time:
                                type: integer
                                example: 1608637355
                              end_time:
                                type: integer
                                example: 1608737355
                              stage_status:
                                type: string
                                enum:
                                  - pending
                                  - running
                                  - completed
                                  - failed
                                  - canceled
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/jobs/{job_id}/runs/{run_id}:
    parameters:
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
      - name: run_id
        in: path
        description: Cluster Job Run Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Jobs
      summary: Get cluster job for iw_job with job_id and run_id
      description: Get cluster job for iw_job with `job_id` and `run_id`
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 8714887c9a8c5bb0b8794811
                          entity_id:
                            type: string
                            example: 8714887c9a8c5bb0b8794811
                          entity_type:
                            type: string
                            example: source
                          entity_name:
                            type: string
                            example: jdbc_source
                          sub_entity_type:
                            type: string
                            example: table
                          sub_entity_id:
                            type: string
                            example: 8714887c9a8c5bb0b8794811
                          iw_job_id:
                            type: string
                            example: 8714887c9a8c5bb0b8794811
                          job_name:
                            type: string
                            example: table ingestion
                          duration:
                            type: integer
                            example: 123414
                          percentage:
                            type: integer
                            format: int32
                            example: 90
                          type:
                            type: string
                            enum:
                              - dataproc
                              - databricks
                              - local
                            example: dataproc
                          state:
                            type: string
                            enum:
                              - PENDING
                              - RUNNING
                              - SKIPPED
                              - TERMINATING
                              - TERMINATED
                              - INTERNAL_ERROR
                              - DONE
                              - NOT_RUNNING
                              - CANCELED
                              - STATE_UNSPECIFIED
                              - SETUP_DONE
                              - UNKNOWN
                              - ERROR
                              - CANCELED
                              - CANCEL_STARTED
                              - CANCEL_PENDING
                              - ATTEMPT_FAILURE
                            example: PENDING
                          stages:
                            type: object
                            properties:
                              stage:
                                type: string
                                example: start_cluster
                              start_time:
                                type: integer
                                example: 1608637355
                              end_time:
                                type: integer
                                example: 1608737355
                              stage_status:
                                type: string
                                enum:
                                  - pending
                                  - running
                                  - completed
                                  - failed
                                  - canceled
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/jobs/{job_id}/runs/{run_id}/logs:
    parameters:
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
      - name: run_id
        in: path
        description: Cluster Job Run Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Jobs
      summary: Download cluster job logs zip for iw_job with job_id and run_id
      description: Download cluster job logs zip for iw_job with `job_id` and `run_id`
      responses:
        '200':
          description: Ok.
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
                example: log_file_5fe1f854e27e6d67b923f7c4.zip
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/admin-jobs:
    get:
      security:
        - BearerAuth: []
      operationId: Get-admin-jobs
      tags:
        - Jobs
      summary: Get the admin-jobs details
      description: Get the admin-jobs details
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - properties:
                                build_id:
                                  type: integer
                                  example: 2
                            - properties:
                                status:
                                  type: string
                                  example: completed
                            - properties:
                                percentage:
                                  type: integer
                                  example: 100
                            - properties:
                                type:
                                  type: string
                                  example: source_semistructured_cdc_merge
                                duration:
                                  type: integer
                                  example: 31424
                            - type: object
                              properties:
                                created_at:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
                            - type: object
                              properties:
                                created_by:
                                  type: string
                                  example: 6RkfybTRQQByEey3v
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/users:
    get:
      security:
        - BearerAuth: []
      operationId: GetUsers
      tags:
        - Users
      summary: Get the User details
      description: Get the User details
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                  - properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - properties:
                                profile:
                                  allOf:
                                    - type: object
                                      properties:
                                        name:
                                          type: string
                                          example: DF_SQLIMPORT
                                    - properties:
                                        email:
                                          type: string
                                          example: xxx@infoworks.io
                                    - properties:
                                        needs_password_reset:
                                          type: boolean
                                          example: false
                                emails:
                                  type: array
                                  items:
                                    properties:
                                      address:
                                        type: string
                                        example: xxx@infoworks.io
                                      verified:
                                        type: boolean
                                        example: true
                                display_name:
                                  type: string
                                  example: Admin
                                roles:
                                  type: array
                                  items:
                                    type: string
                                    example: modeller
                                refresh_token:
                                  type: string
                                  example: zThziQ7MoJJP...
                                status:
                                  type: object
                                  properties:
                                    is_online:
                                      type: boolean
                                      example: false
                                    last_login_details:
                                      properties:
                                        date:
                                          type: string
                                          example: '2019-11-21T12:54:05.875Z'
                                        ip_address:
                                          type: string
                                          example: 10.12.43.23
                                        user_agent:
                                          type: string
                                          example: Mozilla/****
                            - properties:
                                accessible_domains:
                                  type: array
                                  items:
                                    type: string
                                    example: ffb38b0cc595cfcd05c54e49
                            - properties:
                                failed_logins:
                                  type: array
                                  items:
                                    example: null
                                created_at:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
                                modified_at:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
                                is_password_required:
                                  type: boolean
                                  example: false
                                login_disabled:
                                  type: boolean
                                  example: true
                                locked_till:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: createUser
      tags:
        - Users
      summary: Create a new User
      description: Create a new User
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    profile:
                      allOf:
                        - type: object
                          properties:
                            name:
                              type: string
                              example: DF_SQLIMPORT
                        - properties:
                            email:
                              type: string
                              example: xxx@infoworks.io
                    roles:
                      type: array
                      items:
                        type: string
                        example: modeller
                - type: object
                  properties:
                    password:
                      type: string
                      example: kdb***
                - properties:
                    accessible_domains:
                      type: array
                      items:
                        type: string
                        example: ffb38b0cc595cfcd05c54e49
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/users/{user_id}:
    parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: GetUserIdForAdmin
      tags:
        - Users
      summary: Get the details of the user linked with the user_id
      description: Get the details of the user linked with the user_id
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                  - properties:
                      result:
                        type: object
                        allOf:
                          - type: object
                            properties:
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          - properties:
                              profile:
                                allOf:
                                  - type: object
                                    properties:
                                      name:
                                        type: string
                                        example: DF_SQLIMPORT
                                  - properties:
                                      email:
                                        type: string
                                        example: xxx@infoworks.io
                                  - properties:
                                      needs_password_reset:
                                        type: boolean
                                        example: false
                              emails:
                                type: array
                                items:
                                  properties:
                                    address:
                                      type: string
                                      example: xxx@infoworks.io
                                    verified:
                                      type: boolean
                                      example: true
                              roles:
                                type: array
                                items:
                                  type: string
                                  example: modeller
                              auth_token:
                                type: string
                                example: ksvfvb***
                              status:
                                type: object
                                properties:
                                  is_online:
                                    type: boolean
                                    example: false
                                  last_login_details:
                                    properties:
                                      date:
                                        type: string
                                        example: '2019-11-21T12:54:05.875Z'
                                      ip_address:
                                        type: string
                                        example: 10.12.43.23
                                      user_agent:
                                        type: string
                                        example: Mozilla/****
                          - properties:
                              accessible_domains:
                                type: array
                                items:
                                  type: string
                                  example: ffb38b0cc595cfcd05c54e49
                          - properties:
                              failed_logins:
                                type: array
                                items:
                                  example: null
                              created_at:
                                type: string
                                example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      operationId: deleteUserForAdmin
      tags:
        - Users
      summary: Delete a user.
      description: Delete a user.
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      operationId: updateUserForAdmin
      tags:
        - Users
      summary: Update the User
      description: Update the User
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    profile:
                      allOf:
                        - type: object
                          properties:
                            name:
                              type: string
                              example: DF_SQLIMPORT
                        - properties:
                            email:
                              type: string
                              example: xxx@infoworks.io
                    roles:
                      type: array
                      items:
                        type: string
                        example: modeller
                - properties:
                    accessible_domains:
                      type: array
                      items:
                        type: string
                        example: ffb38b0cc595cfcd05c54e49
                - type: object
                  properties:
                    password:
                      type: string
                      example: kdb***
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/users/{user_id}/reset-password:
    parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
    patch:
      security:
        - BearerAuth: []
      operationId: resetUserPassword
      tags:
        - Users
      summary: Reset password for user
      description: Reset password for user
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    old_password:
                      type: string
                      example: kdb***
                - type: object
                  properties:
                    new_password:
                      type: string
                      example: kdb***
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/users/{user_id}/delete-schedules:
    parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
    delete:
      security:
        - BearerAuth: []
      operationId: deleteSchedulesForUser
      tags:
        - Users
      summary: Delete all schedules for a specific user
      description: Delete all schedules for a specific user
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/users/{user_id}/toggle-user-login:
    parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
    patch:
      security:
        - BearerAuth: []
      operationId: toggleUserLoginAbility
      tags:
        - Users
      summary: Toggle user login ability
      description: Toggle user login ability
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        type: object
                        properties:
                          login_disabled:
                            type: boolean
                            example: true
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/users/{user_id}/accessible-domains:
    parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
    post:
      security:
        - BearerAuth: []
      operationId: AddDomainsToUser
      tags:
        - Users
      summary: Add the domain to the user linked with the user_id
      description: Add the domain to the user linked with the user_id
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                entity_ids:
                  type: array
                  items:
                    example: 195ebb5847e08c1eca8368e4
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/generic-source-type:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
    get:
      security:
        - BearerAuth: []
      tags:
        - Generic Source Types
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      summary: Get Generic Source Types List
      description: Get Generic Source Types List
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: List of Generic JDBC Sources.
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 1e4b221a10e1a64e4a429e10
                        name:
                          type: string
                          example: test
                        source_type:
                          type: string
                          example: generic_jdbc
                        upload_option:
                          type: string
                          enum:
                            - fileUpload
                            - serverLocation
                          example: fileUpload
                        folder_path:
                          type: string
                          example: /opt/infoworks/drivers
                        driver_class_name:
                          type: string
                          example: com.jdbc.test
                        file_details:
                          type: array
                          items:
                            type: object
                            properties:
                              file_name:
                                type: string
                                example: terajdbc4.jar
                              file_path:
                                type: string
                                example: >-
                                  /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                              file_size:
                                type: integer
                                example: 963400
                              uploaded_by:
                                type: string
                                example: 6RkfybTRQQByEey3v
                              last_modified:
                                type: string
                                example: '2019-11-21T12:54:05.875Z'
                        created_at:
                          type: string
                          example: '2019-11-21T12:54:05.875Z'
                        created_by:
                          type: string
                          example: 6RkfybTRQQByEey3v
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      tags:
        - Generic Source Types
      summary: Register or Create Generic Source Type
      description: Register or Create Generic Source Type
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - name
                - driver_class_name
                - upload_option
              properties:
                name:
                  type: string
                  example: new-generic-source
                  pattern: ^[a-z0-9A-Z_-]+$
                driver_class_name:
                  type: string
                  example: test.genric.driver
                upload_option:
                  type: string
                  example: fileUpload
                files:
                  description: Required files if upload_option is fileUpload
                  type: string
                  format: binary
                  example: driver.jar
                folder_path:
                  type: string
                  description: Required folder_path if upload_option is serverLocation
                  example: /opt/infoworks/lib/ingestion/drivers/custom_driver
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Successfully created generic source type.
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 5f9708117758f33f8b013824
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/generic-source-type/{generic_source_type_id}:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: generic_source_type_id
        in: path
        description: Generic Source Type Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Generic Source Types
      summary: Get Generic Source Type By Id
      description: Get Generic Source Type By Id
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Found Generic Source Type.
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 1e4b221a10e1a64e4a429e10
                      name:
                        type: string
                        example: test
                      source_type:
                        type: string
                        example: generic_jdbc
                      upload_option:
                        type: string
                        enum:
                          - fileUpload
                          - serverLocation
                        example: fileUpload
                      folder_path:
                        type: string
                        example: /opt/infoworks/drivers
                      driver_class_name:
                        type: string
                        example: com.jdbc.test
                      file_details:
                        type: array
                        items:
                          type: object
                          properties:
                            file_name:
                              type: string
                              example: terajdbc4.jar
                            file_path:
                              type: string
                              example: >-
                                /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                            file_size:
                              type: integer
                              example: 963400
                            uploaded_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                            last_modified:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
                      created_at:
                        type: string
                        example: '2019-11-21T12:54:05.875Z'
                      created_by:
                        type: string
                        example: 6RkfybTRQQByEey3v
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      tags:
        - Generic Source Types
      summary: Update Generic Source Type By Id
      description: Update Generic Source Type By Id
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                upload_option:
                  type: string
                  enum:
                    - fileUpload
                    - serverLocation
                  example: file_upload
                folder_path:
                  description: Required folder_path if upload_option is serverLocation
                  type: string
                  example: /opt/infoworks/lib/ingestion/driver/custom_driver
                files:
                  description: Required files if upload_option is fileUpload
                  type: string
                  format: binary
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Updates generic source type
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 5f9708117758f33f8b013824
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      tags:
        - Generic Source Types
      summary: Delete Generic Source Type By Id
      description: Delete Generic Source Type By Id
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Deleted generic source type
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/generic-source-type/{generic_source_type_id}/dependencies:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: generic_source_type_id
        in: path
        description: Generic Source Type Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Generic Source Types
      operationId: getGenericSourceTypeDependencies
      summary: Get Generic Source Type Dependencies
      description: Retrieves the dependencies for the Generic Source Type
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            entity_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                            name:
                              type: string
                              example: source_name
                            entity_type:
                              type: string
                              example: source
                            ref_name:
                              type: string
                              example: Source
                            additional_details:
                              type: object
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/generic-source-type/{generic_source_type_id}/files:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: generic_source_type_id
        in: path
        description: Generic Source Type Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Generic Source Types
      summary: Get all files in Generic Source Type by id
      description: Get all files in Generic Source Type by `generic_source_type_id`
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            file_name:
                              type: string
                              example: terajdbc4.jar
                            file_path:
                              type: string
                              example: >-
                                /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                            file_size:
                              type: integer
                              example: 963400
                            uploaded_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                            last_modified:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      tags:
        - Generic Source Types
      summary: add file in Generic Source Type by id
      description: add file in Generic Source Type by `generic_source_type_id`
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
              example: test
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/generic-source-type/{generic_source_type_id}/files/{file_name}:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: generic_source_type_id
        in: path
        description: Generic Source Type Id
        required: true
        schema:
          type: string
      - name: file_name
        in: path
        description: File Name
        required: true
        schema:
          type: string
  /admin/mongo-backup/configuration:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
    get:
      security:
        - BearerAuth: []
      tags:
        - Admin Metadata Backup
      summary: Get Backup configs for metadata backup job
      description: Get Backup configs for metadata backup job
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                backup_type:
                                  type: string
                                  enum:
                                    - local
                                  example: local
                                target_path:
                                  type: string
                                  example: /opt/infoworks/mongo-backups/
                            - type: object
                              required:
                                - backup_type
                                - target_path
                                - bucket_name
                                - authentication_mechanism
                                - upload_option
                                - file
                              properties:
                                backup_type:
                                  type: string
                                  enum:
                                    - gcs
                                  example: gcs
                                target_path:
                                  type: string
                                  example: /opt/infoworks/mongo-backups/
                                bucket_name:
                                  type: string
                                  example: temp-bucket
                                authentication_mechanism:
                                  type: string
                                  enum:
                                    - service_credential_file
                                  example: service_credential_file
                                upload_option:
                                  type: string
                                  enum:
                                    - fileUpload
                                    - serverLocation
                                  example: fileUpload
                                server_path:
                                  type: string
                                  example: /opt/infoworks/conf/creds.json
                                files:
                                  description: Required file if upload_option is fileUpload
                                  type: string
                                  format: binary
                            - type: object
                              required:
                                - backup_type
                                - target_path
                                - container_name
                                - storage_account_name
                                - account_key
                              properties:
                                backup_type:
                                  type: string
                                  enum:
                                    - wasb
                                  example: wasb
                                target_path:
                                  type: string
                                  example: /opt/infoworks/mongo-backups/
                                container_name:
                                  type: string
                                  example: temp
                                storage_account_name:
                                  type: string
                                  example: account1
                                account_key:
                                  oneOf:
                                    - type: string
                                    - type: object
                                      required:
                                        - password_type
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - infoworks_managed
                                            - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                        password:
                                          type: string
                            - type: object
                              required:
                                - backup_type
                                - target_path
                                - bucket_name
                                - access_key
                                - secret_key
                              properties:
                                backup_type:
                                  type: string
                                  enum:
                                    - s3
                                  example: s3
                                target_path:
                                  type: string
                                  example: /opt/infoworks/mongo-backups/
                                bucket_name:
                                  type: string
                                  example: temp
                                access_key:
                                  type: string
                                  example: askjbfkajfbajsbI3
                                secret_key:
                                  type: string
                                  example: sfhBsnfaoHi24
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      tags:
        - Admin Metadata Backup
      summary: Add Backup configs for metadata backup job
      description: Add Backup configs for metadata backup job
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    backup_type:
                      type: string
                      enum:
                        - local
                      example: local
                    target_path:
                      type: string
                      example: /opt/infoworks/mongo-backups/
                - type: object
                  required:
                    - backup_type
                    - target_path
                    - bucket_name
                    - authentication_mechanism
                    - upload_option
                    - file
                  properties:
                    backup_type:
                      type: string
                      enum:
                        - gcs
                      example: gcs
                    target_path:
                      type: string
                      example: /opt/infoworks/mongo-backups/
                    bucket_name:
                      type: string
                      example: temp-bucket
                    authentication_mechanism:
                      type: string
                      enum:
                        - service_credential_file
                      example: service_credential_file
                    upload_option:
                      type: string
                      enum:
                        - fileUpload
                        - serverLocation
                      example: fileUpload
                    server_path:
                      type: string
                      example: /opt/infoworks/conf/creds.json
                    files:
                      description: Required file if upload_option is fileUpload
                      type: string
                      format: binary
                - type: object
                  required:
                    - backup_type
                    - target_path
                    - container_name
                    - storage_account_name
                    - account_key
                  properties:
                    backup_type:
                      type: string
                      enum:
                        - wasb
                      example: wasb
                    target_path:
                      type: string
                      example: /opt/infoworks/mongo-backups/
                    container_name:
                      type: string
                      example: temp
                    storage_account_name:
                      type: string
                      example: account1
                    account_key:
                      oneOf:
                        - type: string
                        - type: object
                          required:
                            - password_type
                          properties:
                            password_type:
                              type: string
                              enum:
                                - infoworks_managed
                                - secret_store
                            secret_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                            password:
                              type: string
                - type: object
                  required:
                    - backup_type
                    - target_path
                    - bucket_name
                    - access_key
                    - secret_key
                  properties:
                    backup_type:
                      type: string
                      enum:
                        - s3
                      example: s3
                    target_path:
                      type: string
                      example: /opt/infoworks/mongo-backups/
                    bucket_name:
                      type: string
                      example: temp
                    access_key:
                      type: string
                      example: askjbfkajfbajsbI3
                    secret_key:
                      type: string
                      example: sfhBsnfaoHi24
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/pipeline-extensions:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
    get:
      security:
        - BearerAuth: []
      tags:
        - Pipeline Extensions
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      summary: Get Pipeline Extensions List
      description: Get Pipeline Extensions List
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 1e4b221a10e1a64e4a429e10
                            name:
                              type: string
                              example: test
                            type:
                              type: string
                              example: generic_jdbc
                            execution_type:
                              type: string
                              example: JAVA
                              enum:
                                - JAVA
                                - PYTHON
                            supported_execution_engines:
                              type: array
                              items:
                                type: string
                                enum:
                                  - HIVE
                                  - SPARK
                                  - IMPALA
                            path:
                              type: string
                              example: /opt/infoworks/drivers
                            upload_option:
                              type: string
                              enum:
                                - fileUpload
                                - serverLocation
                              example: fileUpload
                            file_details:
                              type: array
                              items:
                                type: object
                                properties:
                                  file_name:
                                    type: string
                                    example: terajdbc4.jar
                                  file_path:
                                    type: string
                                    example: >-
                                      /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                                  file_size:
                                    type: integer
                                    example: 963400
                                  uploaded_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                                  last_modified:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                            transformations:
                              type: array
                              items:
                                type: object
                                required:
                                  - alias
                                  - class_name
                                properties:
                                  alias:
                                    type: string
                                    example: test
                                  class_name:
                                    type: string
                                    example: transform
                            additional_config_parameters:
                              type: array
                              items:
                                type: object
                                required:
                                  - name
                                  - config_type
                                properties:
                                  name:
                                    type: string
                                    example: RDBMS_PASSWORD
                                  config_type:
                                    type: string
                                    example: KEYVAULT
                                    enum:
                                      - KEYVAULT
                                      - ADMIN
                                  config_name:
                                    type: string
                                    example: iw_admin_conf
                                  secret_id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      tags:
        - Pipeline Extensions
      parameters:
        - name: Content-Type
          in: header
          description: Http content type
          required: true
          schema:
            type: string
            enum:
              - application/json
              - multipart/form-data
              - text/plain
            default: application/json
      summary: Get Pipeline Extensions List
      description: Get Pipeline Extensions List
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - name
                - type
                - execution_type
                - transformations
                - upload_option
              properties:
                name:
                  type: string
                  example: new-pipeline-extension
                  pattern: ^[a-z0-9A-Z_-]+$
                type:
                  type: string
                  example: custom_transformation
                  enum:
                    - custom_transformation
                    - custom_target
                execution_type:
                  type: string
                  example: JAVA
                  enum:
                    - JAVA
                    - PYTHON
                transformations:
                  type: array
                  items:
                    type: object
                    required:
                      - alias
                      - class_name
                    properties:
                      alias:
                        type: string
                        example: test
                      class_name:
                        type: string
                        example: transform
                upload_option:
                  type: string
                  example: fileUpload
                  enum:
                    - fileUpload
                    - serverLocation
                files:
                  description: Required files if upload_option is fileUpload
                  type: string
                  format: binary
                  example: extension.jar
                path:
                  type: string
                  description: Required folder_path if upload_option is serverLocation
                  example: /opt/infoworks/extensions/sfaf
                additional_config_parameters:
                  type: array
                  items:
                    type: object
                    required:
                      - name
                      - config_type
                    properties:
                      name:
                        type: string
                        example: RDBMS_PASSWORD
                      config_type:
                        type: string
                        example: KEYVAULT
                        enum:
                          - KEYVAULT
                          - ADMIN
                      config_name:
                        type: string
                        example: iw_admin_conf
                      secret_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Successfully created Pipeline Extension.
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 5f9708117758f33f8b013824
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/pipeline-extensions/{pipeline_extension_id}:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: pipeline_extension_id
        in: path
        description: Pipeline Extension Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Pipeline Extensions
      summary: Get Pipeline Extension by id
      description: Get Pipeline Extension by `pipeline_extension_id`
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 1e4b221a10e1a64e4a429e10
                          name:
                            type: string
                            example: test
                          type:
                            type: string
                            example: generic_jdbc
                          execution_type:
                            type: string
                            example: JAVA
                            enum:
                              - JAVA
                              - PYTHON
                          supported_execution_engines:
                            type: array
                            items:
                              type: string
                              enum:
                                - HIVE
                                - SPARK
                                - IMPALA
                          path:
                            type: string
                            example: /opt/infoworks/drivers
                          upload_option:
                            type: string
                            enum:
                              - fileUpload
                              - serverLocation
                            example: fileUpload
                          file_details:
                            type: array
                            items:
                              type: object
                              properties:
                                file_name:
                                  type: string
                                  example: terajdbc4.jar
                                file_path:
                                  type: string
                                  example: >-
                                    /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                                file_size:
                                  type: integer
                                  example: 963400
                                uploaded_by:
                                  type: string
                                  example: 6RkfybTRQQByEey3v
                                last_modified:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
                          transformations:
                            type: array
                            items:
                              type: object
                              required:
                                - alias
                                - class_name
                              properties:
                                alias:
                                  type: string
                                  example: test
                                class_name:
                                  type: string
                                  example: transform
                          additional_config_parameters:
                            type: array
                            items:
                              type: object
                              required:
                                - name
                                - config_type
                              properties:
                                name:
                                  type: string
                                  example: RDBMS_PASSWORD
                                config_type:
                                  type: string
                                  example: KEYVAULT
                                  enum:
                                    - KEYVAULT
                                    - ADMIN
                                config_name:
                                  type: string
                                  example: iw_admin_conf
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    put:
      security:
        - BearerAuth: []
      tags:
        - Pipeline Extensions
      summary: Update Pipeline Extension by id
      description: Update Pipeline Extension by `pipeline_extension_id`
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: new-pipeline-extension
                  pattern: ^[a-z0-9A-Z_-]+$
                transformations:
                  description: >-
                    this will replace array wont append new transformations
                    array
                  type: array
                  items:
                    type: object
                    required:
                      - alias
                      - class_name
                    properties:
                      alias:
                        type: string
                        example: test
                      class_name:
                        type: string
                        example: transform
                upload_option:
                  type: string
                  example: fileUpload
                  enum:
                    - fileUpload
                    - serverLocation
                files:
                  description: Required files if upload_option is fileUpload
                  type: string
                  format: binary
                  example:
                    - extension.jar
                path:
                  type: string
                  description: Required folder_path if upload_option is serverLocation
                  example: /opt/infoworks/extensions/sfaf
                additional_config_parameters:
                  type: array
                  items:
                    type: object
                    required:
                      - name
                      - config_type
                    properties:
                      name:
                        type: string
                        example: RDBMS_PASSWORD
                      config_type:
                        type: string
                        example: KEYVAULT
                        enum:
                          - KEYVAULT
                          - ADMIN
                      config_name:
                        type: string
                        example: iw_admin_conf
                      secret_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 1e4b221a10e1a64e4a429e10
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      tags:
        - Pipeline Extensions
      summary: Delete Pipeline Extension by id
      description: Delete Pipeline Extension by `pipeline_extension_id`
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/pipeline-extensions/{pipeline_extension_id}/files:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: pipeline_extension_id
        in: path
        description: Pipeline Extension Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Pipeline Extensions
      summary: Get all files in Pipeline Extension by id
      description: Get all files in Pipeline Extension by `pipeline_extension_id`
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            file_name:
                              type: string
                              example: terajdbc4.jar
                            file_path:
                              type: string
                              example: >-
                                /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                            file_size:
                              type: integer
                              example: 963400
                            uploaded_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                            last_modified:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      tags:
        - Pipeline Extensions
      summary: add file in Pipeline Extension by id
      description: add file in Pipeline Extension by `pipeline_extension_id`
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
              example: test
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/source-extensions:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
    get:
      security:
        - BearerAuth: []
      tags:
        - Source Extensions
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      summary: Get Source Extensions List
      description: Get Source Extensions List
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 1e4b221a10e1a64e4a429e10
                            name:
                              type: string
                              example: test
                            upload_option:
                              type: string
                              enum:
                                - fileUpload
                                - serverLocation
                              example: fileUpload
                            extension_type:
                              type: string
                              example: Custom
                              enum:
                                - Hive_UDF
                                - Custom
                            execution_type:
                              type: string
                              example: JAVA
                              enum:
                                - JAVA
                            server_path:
                              type: string
                              example: /opt/infoworks/drivers
                            file_details:
                              type: array
                              items:
                                type: object
                                properties:
                                  file_name:
                                    type: string
                                    example: terajdbc4.jar
                                  file_path:
                                    type: string
                                    example: >-
                                      /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                                  file_size:
                                    type: integer
                                    example: 963400
                                  uploaded_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                                  last_modified:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                            transformations:
                              type: array
                              items:
                                type: object
                                required:
                                  - alias
                                properties:
                                  alias:
                                    type: string
                                    example: test
                                  class_name:
                                    type: string
                                    example: transform
                                  additional_params_count:
                                    type: number
                                    example: 3
                                  params_details:
                                    type: array
                                    items:
                                      type: object
                            registered_udf:
                              type: boolean
                              example: true
                            ingestion_extension_type:
                              type: string
                              example: source_extension
                              enum:
                                - source_extension
                                - streaming_extension
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      tags:
        - Pipeline Extensions
      parameters:
        - name: Content-Type
          in: header
          description: Http content type
          required: true
          schema:
            type: string
            enum:
              - application/json
              - multipart/form-data
              - text/plain
            default: application/json
      summary: Get Pipeline Extensions List
      description: Get Pipeline Extensions List
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - name
                - extension_type
                - transformations
              properties:
                name:
                  type: string
                  example: new-pipeline-extension
                  pattern: ^[a-z0-9A-Z_-]+$
                extension_type:
                  type: string
                  example: Custom
                  enum:
                    - Hive_UDF
                    - Custom
                execution_type:
                  type: string
                  example: JAVA
                  enum:
                    - JAVA
                upload_option:
                  type: string
                  example: fileUpload
                  enum:
                    - fileUpload
                    - serverLocation
                transformations:
                  type: array
                  items:
                    type: object
                    required:
                      - alias
                    properties:
                      alias:
                        type: string
                        example: test
                      class_name:
                        type: string
                        example: transform
                      additional_params_count:
                        type: number
                        example: 3
                      params_details:
                        type: array
                        items:
                          type: object
                server_path:
                  type: string
                  description: Required folder_path if upload_option is serverLocation
                  example: /opt/infoworks/extensions/sfaf
                registered_udf:
                  type: boolean
                  example: true
                ingestion_extension_type:
                  type: string
                  example: source_extension
                  enum:
                    - source_extension
                    - streaming_extension
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Successfully created Pipeline Extension.
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 5f9708117758f33f8b013824
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/source-extensions/{source_extension_id}:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: source_extension_id
        in: path
        description: Source Extension Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Source Extensions
      summary: Get Source Extension by id
      description: Get Source Extension by `source_extension_id`
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 1e4b221a10e1a64e4a429e10
                          name:
                            type: string
                            example: test
                          upload_option:
                            type: string
                            enum:
                              - fileUpload
                              - serverLocation
                            example: fileUpload
                          extension_type:
                            type: string
                            example: Custom
                            enum:
                              - Hive_UDF
                              - Custom
                          execution_type:
                            type: string
                            example: JAVA
                            enum:
                              - JAVA
                          server_path:
                            type: string
                            example: /opt/infoworks/drivers
                          file_details:
                            type: array
                            items:
                              type: object
                              properties:
                                file_name:
                                  type: string
                                  example: terajdbc4.jar
                                file_path:
                                  type: string
                                  example: >-
                                    /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                                file_size:
                                  type: integer
                                  example: 963400
                                uploaded_by:
                                  type: string
                                  example: 6RkfybTRQQByEey3v
                                last_modified:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
                          transformations:
                            type: array
                            items:
                              type: object
                              required:
                                - alias
                              properties:
                                alias:
                                  type: string
                                  example: test
                                class_name:
                                  type: string
                                  example: transform
                                additional_params_count:
                                  type: number
                                  example: 3
                                params_details:
                                  type: array
                                  items:
                                    type: object
                          registered_udf:
                            type: boolean
                            example: true
                          ingestion_extension_type:
                            type: string
                            example: source_extension
                            enum:
                              - source_extension
                              - streaming_extension
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    put:
      security:
        - BearerAuth: []
      tags:
        - Source Extensions
      summary: Update Source Extension by id
      description: Update Source Extension by `source_extension_id`
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: new-pipeline-extension
                  pattern: ^[a-z0-9A-Z_-]+$
                transformations:
                  description: >-
                    this will replace array wont append new transformations
                    array
                  type: array
                  items:
                    type: object
                    required:
                      - alias
                    properties:
                      alias:
                        type: string
                        example: test
                      class_name:
                        type: string
                        example: transform
                      additional_params_count:
                        type: number
                        example: 3
                      params_details:
                        type: array
                        items:
                          type: object
                upload_option:
                  type: string
                  example: fileUpload
                  enum:
                    - fileUpload
                    - serverLocation
                server_path:
                  type: string
                  description: Required folder_path if upload_option is serverLocation
                  example: /opt/infoworks/extensions/sfaf
                registered_udf:
                  type: boolean
                  example: true
                ingestion_extension_type:
                  type: string
                  example: source_extension
                  enum:
                    - source_extension
                    - streaming_extension
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 1e4b221a10e1a64e4a429e10
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      tags:
        - Source Extensions
      summary: Delete Source Extension by id
      description: Delete Source Extension by `source_extension_id`
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/source-extensions/{source_extension_id}/files:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: source_extension_id
        in: path
        description: Source Extension Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Source Extensions
      summary: Get all files in Source Extension by id
      description: Get all files in Source Extension by `source_extension_id`
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            file_name:
                              type: string
                              example: terajdbc4.jar
                            file_path:
                              type: string
                              example: >-
                                /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                            file_size:
                              type: integer
                              example: 963400
                            uploaded_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                            last_modified:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      tags:
        - Source Extensions
      summary: add file in Source Extension by id
      description: add file in Source Extension by `source_extension_id`
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
              example: test
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/source-extensions/{source_extension_id}/files/{file_name}:
    parameters:
      - name: source_extension_id
        in: path
        description: Source Extension Id
        required: true
        schema:
          type: string
      - name: file_name
        in: path
        description: File Name
        required: true
        schema:
          type: string
    delete:
      security:
        - BearerAuth: []
      tags:
        - Source Extensions
      summary: Delete File from Source Extension by file name
      description: Delete File from Source Extension by `file_name`
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/job-hooks:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
    get:
      security:
        - BearerAuth: []
      tags:
        - Job Hooks
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      summary: Get Job Hooks List
      description: Get Job Hooks List
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: List of Job Hooks.
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 6fb069238f33b86d4262dcdc
                        execution_type:
                          type: string
                          example: PYTHON
                        name:
                          type: string
                          example: test
                        parameters:
                          type: string
                          example: ''
                        fail_job_if_hook_fails:
                          type: boolean
                          example: true
                        executable_file_name:
                          type: string
                          example: test.py
                        file_details:
                          type: array
                          items:
                            type: object
                            properties:
                              file_name:
                                type: string
                                example: terajdbc4.jar
                              file_path:
                                type: string
                                example: >-
                                  /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                              file_size:
                                type: integer
                                example: 963400
                              uploaded_by:
                                type: string
                                example: 6RkfybTRQQByEey3v
                              last_modified:
                                type: string
                                example: '2019-11-21T12:54:05.875Z'
                        environment_variables_conf:
                          type: array
                          items:
                            type: object
                            required:
                              - name
                              - config_type
                            properties:
                              name:
                                type: string
                                example: RDBMS_PASSWORD
                              config_type:
                                type: string
                                example: KEYVAULT
                                enum:
                                  - KEYVAULT
                                  - ADMIN
                              config_name:
                                type: string
                                example: iw_admin_conf
                              secret_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      tags:
        - Job Hooks
      summary: Create a Job Hook
      description: Create a Job Hook
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - name
                - executable_file_name
                - execution_type
                - files
              properties:
                name:
                  type: string
                  example: test
                  pattern: ^[a-z0-9A-Z_-]+$
                execution_type:
                  type: string
                  example: PYTHON
                  enum:
                    - BASH
                    - PYTHON
                executable_file_name:
                  type: string
                  example: test.py
                failJobIfHookFails:
                  type: boolean
                  example: false
                parameters:
                  type: string
                  example: ''
                files:
                  description: Required files if upload_option is fileUpload
                  type: string
                  format: binary
                  example: test.py
                environment_variables_conf:
                  description: Additional environment variables to pass in process
                  type: array
                  items:
                    type: object
                    required:
                      - name
                      - config_type
                    properties:
                      name:
                        type: string
                        example: RDBMS_PASSWORD
                      config_type:
                        type: string
                        example: KEYVAULT
                        enum:
                          - KEYVAULT
                          - ADMIN
                      config_name:
                        type: string
                        example: iw_admin_conf
                      secret_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Successfully created job hook.
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 5f9708117758f33f8b013824
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/job-hooks/{job_hook_id}:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: job_hook_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Job Hooks
      summary: Get Job Hook By Id
      description: Get Job Hook By Id
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Found Generic Source Type.
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 6fb069238f33b86d4262dcdc
                      execution_type:
                        type: string
                        example: PYTHON
                      name:
                        type: string
                        example: test
                      parameters:
                        type: string
                        example: ''
                      fail_job_if_hook_fails:
                        type: boolean
                        example: true
                      executable_file_name:
                        type: string
                        example: test.py
                      file_details:
                        type: array
                        items:
                          type: object
                          properties:
                            file_name:
                              type: string
                              example: terajdbc4.jar
                            file_path:
                              type: string
                              example: >-
                                /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                            file_size:
                              type: integer
                              example: 963400
                            uploaded_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                            last_modified:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
                      environment_variables_conf:
                        type: array
                        items:
                          type: object
                          required:
                            - name
                            - config_type
                          properties:
                            name:
                              type: string
                              example: RDBMS_PASSWORD
                            config_type:
                              type: string
                              example: KEYVAULT
                              enum:
                                - KEYVAULT
                                - ADMIN
                            config_name:
                              type: string
                              example: iw_admin_conf
                            secret_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      tags:
        - Job Hooks
      summary: Update Job Hook Type By Id
      description: Update Job Hook Type By Id
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: test
                  pattern: ^[a-z0-9A-Z_-]+$
                execution_type:
                  type: string
                  example: PYTHON
                  enum:
                    - BASH
                    - PYTHON
                executable_file_name:
                  type: string
                  example: test.py
                failJobIfHookFails:
                  type: boolean
                  example: false
                parameters:
                  type: string
                  example: ''
                files:
                  description: Required files if upload_option is fileUpload
                  type: string
                  format: binary
                  example: test.py
                environment_variables_conf:
                  description: Additional environment variables to pass in process
                  type: array
                  items:
                    type: object
                    required:
                      - name
                      - config_type
                    properties:
                      name:
                        type: string
                        example: RDBMS_PASSWORD
                      config_type:
                        type: string
                        example: KEYVAULT
                        enum:
                          - KEYVAULT
                          - ADMIN
                      config_name:
                        type: string
                        example: iw_admin_conf
                      secret_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Updates Job Hook
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 5f9708117758f33f8b013824
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      tags:
        - Job Hooks
      summary: Delete Job Hook By Id
      description: Delete Job Hook By Id
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Deleted Job Hook
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/job-hooks/{job_hook_id}/files:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: job_hook_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Job Hooks
      summary: Get all files in Job Hook by id
      description: Get all files in Job Hook by `job_hook_id`
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            file_name:
                              type: string
                              example: terajdbc4.jar
                            file_path:
                              type: string
                              example: >-
                                /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                            file_size:
                              type: integer
                              example: 963400
                            uploaded_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                            last_modified:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      tags:
        - Job Hooks
      summary: add file in Job Hook by id
      description: add file in Job Hook by `job_hook_id`
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
              example: test
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/job-hooks/{job_hook_id}/files/{file_name}:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: job_hook_id
        in: path
        required: true
        schema:
          type: string
      - name: file_name
        in: path
        description: File Name
        required: true
        schema:
          type: string
  /admin/data-connections:
    get:
      security:
        - BearerAuth: []
      operationId: getDataConnectionsList
      tags:
        - Target Data Connections
      summary: Get the Target Data Connections
      description: Get the Target Data Connections
      parameters:
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - properties:
                      result:
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - properties:
                                type:
                                  type: string
                                  example: SNOWFLAKE
                                name:
                                  type: string
                                  example: target1
                                connection_url:
                                  type: string
                                  example: jdbc://admin:xxxx@infoworks.io/
                                account_name:
                                  type: string
                                  example: pvt_account_1
                                username:
                                  type: string
                                  example: admin
                                password:
                                  type: string
                                  example: xxxx
                                warehouse:
                                  type: string
                                  example: data_warehouse
                                additional_params:
                                  type: string
                                  example: x=2&&y=4
                            - type: object
                              allOf:
                                - type: object
                                  properties:
                                    created_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    created_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                                - type: object
                                  properties:
                                    modified_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    modified_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: createDataConnection
      tags:
        - Target Data Connections
      summary: Create Target Data Connections
      description: Create Target Data Connections to use in pipeline or sources
      requestBody:
        content:
          application/json:
            schema:
              properties:
                type:
                  type: string
                  example: SNOWFLAKE
                name:
                  type: string
                  example: target1
                connection_url:
                  type: string
                  example: jdbc://admin:xxxx@infoworks.io/
                account_name:
                  type: string
                  example: pvt_account_1
                username:
                  type: string
                  example: admin
                password:
                  type: string
                  example: xxxx
                warehouse:
                  type: string
                  example: data_warehouse
                additional_params:
                  type: string
                  example: x=2&&y=4
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/data-connections/{data_connection_id}:
    parameters:
      - name: data_connection_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getDataConnection
      tags:
        - Domains
      summary: Get the Target Data Connection
      description: Get the Target Data Connection
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        allOf:
                          - type: object
                            properties:
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          - properties:
                              type:
                                type: string
                                example: SNOWFLAKE
                              name:
                                type: string
                                example: target1
                              connection_url:
                                type: string
                                example: jdbc://admin:xxxx@infoworks.io/
                              account_name:
                                type: string
                                example: pvt_account_1
                              username:
                                type: string
                                example: admin
                              password:
                                type: string
                                example: xxxx
                              warehouse:
                                type: string
                                example: data_warehouse
                              additional_params:
                                type: string
                                example: x=2&&y=4
                          - type: object
                            allOf:
                              - type: object
                                properties:
                                  created_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  created_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                              - type: object
                                properties:
                                  modified_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  modified_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    put:
      security:
        - BearerAuth: []
      operationId: updateDataConnection
      tags:
        - Domains
      summary: Edit the Target Data Connections Associated with a Domain
      description: Edit the Target Data Connections Associated with a Domain
      requestBody:
        content:
          application/json:
            schema:
              properties:
                type:
                  type: string
                  example: SNOWFLAKE
                name:
                  type: string
                  example: target1
                connection_url:
                  type: string
                  example: jdbc://admin:xxxx@infoworks.io/
                account_name:
                  type: string
                  example: pvt_account_1
                username:
                  type: string
                  example: admin
                password:
                  type: string
                  example: xxxx
                warehouse:
                  type: string
                  example: data_warehouse
                additional_params:
                  type: string
                  example: x=2&&y=4
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      operationId: patchDataConnection
      tags:
        - Domains
      summary: Patch the Target Data Connection
      description: Patch the Target Data Connection
      requestBody:
        content:
          application/json:
            schema:
              properties:
                type:
                  type: string
                  example: SNOWFLAKE
                name:
                  type: string
                  example: target1
                connection_url:
                  type: string
                  example: jdbc://admin:xxxx@infoworks.io/
                account_name:
                  type: string
                  example: pvt_account_1
                username:
                  type: string
                  example: admin
                password:
                  type: string
                  example: xxxx
                warehouse:
                  type: string
                  example: data_warehouse
                additional_params:
                  type: string
                  example: x=2&&y=4
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      operationId: deleteDataConnection
      tags:
        - Domains
      summary: Delete the Target Data Connections Associated with a Domain
      description: Delete the Target Data Connections Associated with a Domain
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/environment:
    get:
      security:
        - BearerAuth: []
      operationId: EnvironmentsList
      tags:
        - Environment
      summary: Get the list of environments
      description: Retrieves the list of environments that are accessible to the user.
      parameters:
        - name: fetch_all
          in: query
          description: >
            Use this parameter to retrieve the list of all environments. (Only
            for admin user).
          schema:
            type: boolean
            default: null
          required: false
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                  - properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - properties:
                                platform:
                                  type: string
                                  example: azure
                                name:
                                  type: string
                                  example: sample
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - properties:
                                state:
                                  type: string
                                  example: ready
                            - type: object
                              properties:
                                modified_at:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
                            - type: object
                              properties:
                                modified_by:
                                  type: string
                                  example: 6RkfybTRQQByEey3v
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: CreateEnvironment
      tags:
        - Environment
      summary: Create a new environment
      description: >
        Creates or clones a environment.  To clone an existing environment, add
        the `resource_id_to_clone` query parameter. <br> **Note:** Cloning an
        environment will clone all its clusters and storages.
      parameters:
        - name: resource_id_to_clone
          in: query
          description: >
            Id of environment to be cloned.  Request body will be ignored when
            this parameter is passed.
          schema:
            type: string
            example: 5f9708117758f33f8b013824
          required: false
      requestBody:
        content:
          multipart/form-data:
            schema:
              oneOf:
                - type: object
                  properties:
                    name:
                      type: string
                      example: spark_k8s_test_1
                      pattern: ^[a-z0-9A-Z_-]+$
                    platform:
                      type: string
                      example: spark
                    compute_engine:
                      type: string
                      example: kubernetes
                    connection_configuration:
                      type: object
                      required:
                        - cluster_type
                      properties:
                        cluster_type:
                          type: string
                          enum:
                            - external
                            - internal
                          example: external
                        service_account_name:
                          type: string
                          example: kubernetes-service-account
                        authentication_mechanism:
                          type: string
                          enum:
                            - oauth_token
                            - client_key
                          example: oauth_token
                        api_url:
                          type: string
                          example: http://test.com
                        namespace:
                          type: string
                          example: kuberenetes-namespace
                        client_key:
                          type: object
                          description: Required when authentication_mechanism is client_key
                          required:
                            - upload_option
                          properties:
                            upload_option:
                              type: string
                              enum:
                                - fileUpload
                                - serverLocation
                              example: fileUpload
                            context:
                              type: string
                              example: context-value
                        oauth_details:
                          description: Required when authentication_mechanism is client_key
                          required:
                            - oauth_token
                            - https_enabled
                          properties:
                            oauth_token:
                              oneOf:
                                - type: string
                                - type: object
                                  required:
                                    - password_type
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - infoworks_managed
                                        - secret_store
                                    secret_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    password:
                                      type: string
                            https_enabled:
                              type: boolean
                              example: true
                            upload_option:
                              type: string
                              description: Required when https_enabled is true
                              enum:
                                - fileUpload
                                - serverLocation
                              example: fileUpload
                    files:
                      type: string
                      format: binary
                    metastore:
                      type: object
                      properties:
                        type:
                          type: string
                          example: hive
                        configuration:
                          type: object
                          required:
                            - mode
                            - connection_url
                            - metastore_db
                            - password
                            - user_name
                          properties:
                            mode:
                              type: string
                              example: external
                            metastore_db:
                              type: string
                              example: postgres
                            password:
                              oneOf:
                                - type: string
                                - type: object
                                  required:
                                    - password_type
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - infoworks_managed
                                        - secret_store
                                    secret_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    password:
                                      type: string
                            user_name:
                              type: string
                              example: admin
                - type: object
                  properties:
                    name:
                      type: string
                      example: bigquery_gcp_databricks_test_2
                      pattern: ^[a-z0-9A-Z_-]+$
                    platform:
                      type: string
                      example: gcp
                    compute_engine:
                      type: string
                      example: databricks
                    connection_configuration:
                      type: object
                      properties:
                        workspace_url:
                          type: string
                          example: https://adb-3889563399002515.15.azuredatabricks.net
                        token:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - service_authentication
                                    - secret_store
                                service_auth_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                        region:
                          type: string
                          example: us-east-1
                    data_warehouse_type:
                      type: string
                      example: bigQuery
                    data_warehouse_configuration:
                      type: object
                      properties:
                        type:
                          type: string
                          example: bigQuery
                        authentication_mechanism:
                          type: string
                          example: service_credential
                        service_credentials:
                          type: object
                          properties:
                            upload_option:
                              type: string
                              example: fileUpload
                        additional_params:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                example: key
                              value:
                                type: string
                                example: value
                    warehouse_cred_file:
                      type: string
                      format: binary
                - type: object
                  properties:
                    name:
                      type: string
                      example: bigquery_gcp_dataproc_test
                      pattern: ^[a-z0-9A-Z_-]+$
                    platform:
                      type: string
                      example: gcp
                    compute_engine:
                      type: string
                      example: dataproc
                    connection_configuration:
                      type: object
                      properties:
                        authentication_mechanism:
                          type: string
                          example: system
                    data_warehouse_type:
                      type: string
                      example: bigQuery
                    data_warehouse_configuration:
                      type: object
                      properties:
                        type:
                          type: string
                          example: bigQuery
                        authntication_mechanism:
                          type: string
                          example: service_credential
                        service_credentials:
                          type: object
                          properties:
                            upload_option:
                              type: string
                              example: fileUpload
                        additional_params:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                example: key
                              value:
                                type: string
                                example: value
                    warehouse_cred_file:
                      type: string
                      format: binary
                    files:
                      type: string
                      format: binary
                - type: object
                  properties:
                    name:
                      type: string
                      example: bigquery_test
                      pattern: ^[a-z0-9A-Z_-]+$
                    data_warehouse_type:
                      type: string
                      example: bigQuery
                    data_warehouse_configuration:
                      type: object
                      properties:
                        type:
                          type: string
                          example: bigQuery
                        authentication_mechanism:
                          type: string
                          example: service_credential
                        service_credential:
                          type: object
                          properties:
                            upload_option:
                              type: string
                              example: fileUpload
                        additional_params:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                example: key
                              value:
                                type: string
                                example: value
                    warehouse_cred_file:
                      type: string
                      format: binary
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    name:
                      type: string
                      example: rest_api_gcp_test_1
                      pattern: ^[a-z0-9A-Z_-]+$
                    platform:
                      type: string
                      example: gcp
                    compute_engine:
                      type: string
                      example: dataproc
                    metastore:
                      type: object
                      properties:
                        type:
                          type: string
                          example: hive
                        configuration:
                          type: object
                          properties:
                            mode:
                              type: string
                              example: external
                            admin_password_uri:
                              type: string
                              example: gs://regression50/password.encrypted
                            hive_password_uri:
                              type: string
                              example: gs://regression50/password.encrypted
                            kms_key_uri:
                              type: string
                              example: >-
                                projects/iw-gcp-eng-dev/locations/global/keyRings/regression-50-keyring/cryptoKeys/regr50-key
                            warehouse_dir:
                              type: string
                              example: gs://regression50/hive-warehouse
                            use_private_ip:
                              type: boolean
                              example: true
                            machine_tag:
                              type: string
                              example: us-central1:regression50
                            runtime_version:
                              type: string
                              enum:
                                - '1.5'
                                - '2.0'
                    connection_configuration:
                      type: object
                      properties:
                        region:
                          type: string
                          example: us-central1
                        authentication_mechanism:
                          type: string
                          example: system
                - type: object
                  properties:
                    name:
                      type: string
                      example: snowflake_aws_databricks_rest_1
                      pattern: ^[a-z0-9A-Z_-]+$
                    platform:
                      type: string
                      example: aws
                    compute_engine:
                      type: string
                      example: databricks
                    connection_configuration:
                      type: object
                      properties:
                        workspace_url:
                          type: string
                          example: https://adb-3889563399002515.15.azuredatabricks.net
                        token:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - service_authentication
                                    - secret_store
                                service_auth_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                        region:
                          type: string
                          example: us-east-1
                    data_warehouse_type:
                      type: string
                      example: snowflake
                    data_warehouse_configuration:
                      type: object
                      properties:
                        type:
                          type: string
                          example: snowflake
                        connection_url:
                          type: string
                          example: jdbc:mysql://host:port/hive
                        account_name:
                          type: string
                          example: test
                        snowflake_profiles:
                          type: array
                          items:
                            oneOf:
                              - type: object
                                properties:
                                  name:
                                    type: string
                                    example: profile1
                                  is_default_profile:
                                    type: boolean
                                    example: true
                                  warehouse:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        name:
                                          type: string
                                          example: test
                                        description:
                                          type: string
                                          example: sample description
                                        is_default_warehouse:
                                          type: boolean
                                          example: true
                                  authentication_properties:
                                    type: object
                                    properties:
                                      type:
                                        type: string
                                        example: default
                                      username:
                                        type: string
                                        example: test
                                      password:
                                        oneOf:
                                          - type: string
                                          - type: object
                                            required:
                                              - password_type
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - infoworks_managed
                                                  - secret_store
                                              secret_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                              password:
                                                type: string
                                  additional_params:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: key
                                        value:
                                          type: string
                                          example: value
                                  session_params:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: key
                                        value:
                                          type: string
                                          example: value
                              - type: object
                                properties:
                                  name:
                                    type: string
                                    example: profile1
                                  is_default_profile:
                                    type: boolean
                                    example: true
                                  warehouse:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        name:
                                          type: string
                                          example: test
                                        description:
                                          type: string
                                          example: sample description
                                        is_default_warehouse:
                                          type: boolean
                                          example: true
                                  authentication_properties:
                                    type: object
                                    properties:
                                      type:
                                        type: string
                                        example: oauth
                                      oauth_service:
                                        type: string
                                        example: snowflake
                                      oauth_client_id:
                                        type: string
                                        example: test
                                      oauth_client_secret:
                                        oneOf:
                                          - type: string
                                          - type: object
                                            required:
                                              - password_type
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - infoworks_managed
                                                  - secret_store
                                              secret_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                              password:
                                                type: string
                                      refresh_token:
                                        oneOf:
                                          - type: string
                                          - type: object
                                            required:
                                              - password_type
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - infoworks_managed
                                                  - secret_store
                                              secret_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                              password:
                                                oneOf:
                                                  - type: string
                                                  - type: object
                                                    required:
                                                      - password_type
                                                    properties:
                                                      password_type:
                                                        type: string
                                                        enum:
                                                          - infoworks_managed
                                                          - secret_store
                                                      secret_id:
                                                        type: string
                                                        example: e77850ad5127a2d7dab870ff
                                                      password:
                                                        type: string
                                  additional_params:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: key
                                        value:
                                          type: string
                                          example: value
                                  session_params:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: key
                                        value:
                                          type: string
                                          example: value
                              - type: object
                                properties:
                                  name:
                                    type: string
                                    example: profile1
                                  is_default_profile:
                                    type: boolean
                                    example: true
                                  warehouse:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        name:
                                          type: string
                                          example: test
                                        description:
                                          type: string
                                          example: sample description
                                        is_default_warehouse:
                                          type: boolean
                                          example: true
                                  authentication_properties:
                                    type: object
                                    properties:
                                      type:
                                        type: string
                                        example: oauth
                                      oauth_service:
                                        type: string
                                        example: external_ad
                                      oauth_access_type:
                                        type: string
                                        enum:
                                          - user
                                          - client
                                      azure_ad_username:
                                        type: string
                                      azure_ad_password:
                                        oneOf:
                                          - type: string
                                          - type: object
                                            required:
                                              - password_type
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - infoworks_managed
                                                  - secret_store
                                              secret_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                              password:
                                                type: string
                                      oauth_client_id:
                                        type: string
                                        example: test
                                      oauth_client_secret:
                                        oneOf:
                                          - type: string
                                          - type: object
                                            required:
                                              - password_type
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - infoworks_managed
                                                  - secret_store
                                              secret_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                              password:
                                                type: string
                                      username:
                                        type: string
                                        example: test
                                      oauth_scope:
                                        type: string
                                        example: test
                                      oauth_token_url:
                                        type: string
                                        example: http://test.com
                                  additional_params:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: key
                                        value:
                                          type: string
                                          example: value
                                  session_params:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: key
                                        value:
                                          type: string
                                          example: value
                - type: object
                  properties:
                    name:
                      type: string
                      example: aws_emr_rest_1
                      pattern: ^[a-z0-9A-Z_-]+$
                    platform:
                      type: string
                      example: aws
                    compute_engine:
                      type: string
                      example: emr
                    connection_configuration:
                      type: object
                      properties:
                        region:
                          type: string
                          example: us-east-1
                        authentication_mechanism:
                          type: string
                          example: access_key
                        secret_key:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                        access_key:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                    metastore:
                      type: object
                      properties:
                        type:
                          type: string
                          example: hive
                        configuration:
                          type: object
                          properties:
                            mode:
                              type: string
                              example: external
                            connection_url:
                              type: string
                              example: >-
                                jdbc:mysql://emr-regression-500.cjkihlti48zz.us-east-1.rds.amazonaws.com:3306/hive
                            driver_name:
                              type: string
                              example: org.mariadb.jdbc.Driver
                            user_name:
                              type: string
                              example: admin
                            password:
                              oneOf:
                                - type: string
                                - type: object
                                  required:
                                    - password_type
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - infoworks_managed
                                        - secret_store
                                    secret_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    password:
                                      type: string
                            warehouse_location:
                              type: string
                              example: s3://tmp-emr/warehouse13/
                - type: object
                  properties:
                    name:
                      type: string
                      example: aws_emr_rest_2
                      pattern: ^[a-z0-9A-Z_-]+$
                    platform:
                      type: string
                      example: aws
                    compute_engine:
                      type: string
                      example: emr
                    connection_configuration:
                      type: object
                      properties:
                        region:
                          type: string
                          example: us-east-1
                        authentication_mechanism:
                          type: string
                          example: system
                    metastore:
                      type: object
                      properties:
                        type:
                          type: string
                          example: hive
                        configuration:
                          type: object
                          properties:
                            mode:
                              type: string
                              example: external
                            connection_url:
                              type: string
                              example: >-
                                jdbc:mysql://emr-regression-500.cjkihlti48zz.us-east-1.rds.amazonaws.com:3306/hive
                            driver_name:
                              type: string
                              example: org.mariadb.jdbc.Driver
                            user_name:
                              type: string
                              example: admin
                            password:
                              oneOf:
                                - type: string
                                - type: object
                                  required:
                                    - password_type
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - infoworks_managed
                                        - secret_store
                                    secret_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    password:
                                      type: string
                            warehouse_location:
                              type: string
                              example: s3://tmp-emr/warehouse13/
                - type: object
                  properties:
                    name:
                      type: string
                      example: aws_emr_rest_3
                      pattern: ^[a-z0-9A-Z_-]+$
                    platform:
                      type: string
                      example: aws
                    compute_engine:
                      type: string
                      example: emr
                    connection_configuration:
                      type: object
                      properties:
                        region:
                          type: string
                          example: us-east-1
                        authentication_mechanism:
                          type: string
                          example: access_key
                        secret_key:
                          type: string
                          example: tIP+bJUSEzMQv6CvCJfUGGmBLPDduGJj/D0qg9Hm
                        access_key:
                          type: string
                          example: REDACTED_AWS_ACCESS_KEY_ID
                    metastore:
                      type: object
                      properties:
                        type:
                          type: string
                          example: glue
                        configuration:
                          type: object
                          properties:
                            mode:
                              type: string
                              example: external
                            warehouse_location:
                              type: string
                              example: s3://tmp-emr/warehouse13/
                            use_custom_glue_catalog_account:
                              type: boolean
                              default: false
                            glue_catalog_account_id:
                              type: string
                              example: '234142552452'
                - type: object
                  properties:
                    name:
                      type: string
                      example: aws_emr_rest_4
                      pattern: ^[a-z0-9A-Z_-]+$
                    platform:
                      type: string
                      example: aws
                    compute_engine:
                      type: string
                      example: emr
                    connection_configuration:
                      type: object
                      properties:
                        region:
                          type: string
                          example: us-east-1
                        authentication_mechanism:
                          type: string
                          example: system
                    metastore:
                      type: object
                      properties:
                        type:
                          type: string
                          example: glue
                        configuration:
                          type: object
                          properties:
                            mode:
                              type: string
                              example: external
                            warehouse_location:
                              type: string
                              example: s3://tmp-emr/warehouse13/
                            use_custom_glue_catalog_account:
                              type: boolean
                              default: false
                            glue_catalog_account_id:
                              type: string
                              example: '234142552452'
                - type: object
                  properties:
                    name:
                      type: string
                      example: bigquery_gcp_databricks_test_1
                      pattern: ^[a-z0-9A-Z_-]+$
                    platform:
                      type: string
                      example: gcp
                    compute_engine:
                      type: string
                      example: databricks
                    connection_configuration:
                      type: object
                      properties:
                        workspace_url:
                          type: string
                          example: https://adb-3889563399002515.15.azuredatabricks.net
                        token:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - service_authentication
                                    - secret_store
                                service_auth_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                        region:
                          type: string
                          example: us-east1
                    data_warehouse_type:
                      type: string
                      example: bigQuery
                    data_warehouse_configuration:
                      type: object
                      properties:
                        type:
                          type: string
                          example: bigQuery
                        authentication_mechanism:
                          type: string
                          example: system
                        additional_params:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                example: key
                              value:
                                type: string
                                example: value
                - type: object
                  properties:
                    name:
                      type: string
                      example: snowflake_aws_databricks_rest_1
                      pattern: ^[a-z0-9A-Z_-]+$
                    platform:
                      type: string
                      example: aws
                    compute_engine:
                      type: string
                      example: emr
                    connection_configuration:
                      type: object
                      properties:
                        region:
                          type: string
                          example: us-east-1
                        authentication_mechanism:
                          type: string
                          example: access_key
                        secret_key:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                        access_key:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                    data_warehouse_type:
                      type: string
                      example: snowflake
                    data_warehouse_configuration:
                      type: object
                      properties:
                        type:
                          type: string
                          example: snowflake
                        connection_url:
                          type: string
                          example: jdbc:mysql://host:port/hive
                        account_name:
                          type: string
                          example: test
                        snowflake_profiles:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                                example: profile1
                              is_default_profile:
                                type: boolean
                                example: true
                              warehouse:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                      example: test
                                    description:
                                      type: string
                                      example: sample description
                                    is_default_warehouse:
                                      type: boolean
                                      example: true
                              authentication_properties:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    example: default
                                  username:
                                    type: string
                                    example: test
                                  password:
                                    oneOf:
                                      - type: string
                                      - type: object
                                        required:
                                          - password_type
                                        properties:
                                          password_type:
                                            type: string
                                            enum:
                                              - infoworks_managed
                                              - secret_store
                                          secret_id:
                                            type: string
                                            example: e77850ad5127a2d7dab870ff
                                          password:
                                            type: string
                              additional_params:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                      example: key
                                    value:
                                      type: string
                                      example: value
                              session_params:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                      example: key
                                    value:
                                      type: string
                                      example: value
                        additional_params:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                example: key
                              value:
                                type: string
                                example: value
                        session_params:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                example: key
                              value:
                                type: string
                                example: value
                - type: object
                  properties:
                    name:
                      type: string
                      example: azure_databricks_rest_1
                      pattern: ^[a-z0-9A-Z_-]+$
                    platform:
                      type: string
                      enum:
                        - azure
                        - aws
                        - gcp
                      example: azure
                    compute_engine:
                      type: string
                      example: databricks
                    metastore:
                      type: object
                      properties:
                        type:
                          type: string
                          example: hive
                        configuration:
                          type: object
                          properties:
                            mode:
                              type: string
                              example: unity_catalog
                    connection_configuration:
                      type: object
                      properties:
                        workspace_url:
                          type: string
                          example: https://adb-3889563399002515.15.azuredatabricks.net
                        token:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - service_authentication
                                    - secret_store
                                service_auth_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                        region:
                          type: string
                          example: us-east-1
                    staging_area:
                      type: object
                      properties:
                        catalog_name:
                          type: string
                          example: catalog_name
                        schema_name:
                          type: string
                          example: schema_name
                        volume_name:
                          type: string
                          example: volume_name
                    profiles:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - azure_service_principal
                              - databricks_service_principal
                              - username
                          name:
                            type: string
                            example: profile_1
                          username:
                            type: string
                            example: username
                          databricks_service_principal:
                            type: string
                            example: d38bc497-94e8-4836-8bde-784fca187cbf
                          azure_service_principal:
                            type: object
                            required:
                              - password_type
                            properties:
                              password_type:
                                type: string
                                enum:
                                  - service_authentication
                              service_auth_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          is_default:
                            type: boolean
                            example: true
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Successfully created a environment.
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 5f9708117758f33f8b013824
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/environment/{environment_id}:
    parameters:
      - name: environment_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: EnvironmentsId
      tags:
        - Environment
      summary: Get the environment id details
      description: Get the environment id details
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                  - properties:
                      result:
                        allOf:
                          - allOf:
                              - properties:
                                  platform:
                                    type: string
                                    example: azure
                                  name:
                                    type: string
                                    example: sample
                              - type: object
                                properties:
                                  id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                              - properties:
                                  state:
                                    type: string
                                    example: ready
                              - type: object
                                properties:
                                  modified_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  modified_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                          - properties:
                              connection_configuration:
                                properties:
                                  token:
                                    oneOf:
                                      - type: string
                                      - type: object
                                        required:
                                          - password_type
                                        properties:
                                          password_type:
                                            type: string
                                            enum:
                                              - infoworks_managed
                                              - service_authentication
                                              - secret_store
                                          service_auth_id:
                                            type: string
                                            example: e77850ad5127a2d7dab870ff
                                          secret_id:
                                            type: string
                                            example: e77850ad5127a2d7dab870ff
                                          password:
                                            type: string
                                  region:
                                    type: string
                                    example: eastus2
                                  workspace_url:
                                    type: string
                                    example: del
                          - properties:
                              metastore:
                                properties:
                                  type:
                                    type: string
                                    example: hive
                                  configuration:
                                    properties:
                                      mode:
                                        type: string
                                        example: internal
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      operationId: DeleteEnvironment
      tags:
        - Environment
      summary: Delete an Environment
      description: Delete an Environment
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Environment deleted successfully
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 5f9708117758f33f8b013824
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      operationId: UpdateEnvironment
      tags:
        - Environment
      summary: Update an environment
      description: Update an existing environment
      requestBody:
        content:
          multipart/form-data:
            schema:
              oneOf:
                - type: object
                  properties:
                    name:
                      type: string
                      example: spark_k8s_test_1
                      pattern: ^[a-z0-9A-Z_-]+$
                    connection_configuration:
                      type: object
                      properties:
                        service_account_name:
                          type: string
                          example: kubernetes-service-account
                        authentication_mechanism:
                          type: string
                          enum:
                            - oauth_token
                            - client_key
                          example: oauth_token
                        api_url:
                          type: string
                          example: http://test.com
                        namespace:
                          type: string
                          example: kuberenetes-namespace
                        client_key:
                          type: object
                          description: Required when authentication_mechanism is client_key
                          required:
                            - upload_option
                          properties:
                            upload_option:
                              type: string
                              enum:
                                - fileUpload
                                - serverLocation
                              example: fileUpload
                            context:
                              type: string
                              example: context-value
                        oauth_details:
                          description: Required when authentication_mechanism is client_key
                          required:
                            - oauth_token
                            - https_enabled
                          properties:
                            oauth_token:
                              oneOf:
                                - type: string
                                - type: object
                                  required:
                                    - password_type
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - infoworks_managed
                                        - secret_store
                                    secret_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    password:
                                      type: string
                            https_enabled:
                              type: boolean
                              example: true
                            upload_option:
                              type: string
                              description: Required when https_enabled is true
                              enum:
                                - fileUpload
                                - serverLocation
                              example: fileUpload
                    files:
                      type: string
                      format: binary
                    metastore:
                      type: object
                      properties:
                        configuration:
                          type: object
                          properties:
                            metastore_db:
                              type: string
                              example: postgres
                            password:
                              oneOf:
                                - type: string
                                - type: object
                                  required:
                                    - password_type
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - infoworks_managed
                                        - secret_store
                                    secret_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    password:
                                      type: string
                            user_name:
                              type: string
                              example: admin
                - type: object
                  properties:
                    name:
                      type: string
                      example: bigquery_gcp_databricks_test_2
                      pattern: ^[a-z0-9A-Z_-]+$
                    connection_configuration:
                      type: object
                      properties:
                        workspace_url:
                          type: string
                          example: https://adb-3889563399002515.15.azuredatabricks.net
                        token:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - service_authentication
                                    - secret_store
                                service_auth_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                        region:
                          type: string
                          example: us-east-1
                    data_warehouse_configuration:
                      type: object
                      properties:
                        authentication_mechanism:
                          type: string
                          example: service_credential
                        service_credentials:
                          type: object
                          properties:
                            upload_option:
                              type: string
                              example: fileUpload
                        additional_params:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                example: key
                              value:
                                type: string
                                example: value
                    warehouse_cred_file:
                      type: string
                      format: binary
                - type: object
                  properties:
                    name:
                      type: string
                      example: bigquery_gcp_dataproc_test
                      pattern: ^[a-z0-9A-Z_-]+$
                    connection_configuration:
                      type: object
                      properties:
                        authentication_mechanism:
                          type: string
                          example: system
                    data_warehouse_configuration:
                      type: object
                      properties:
                        authntication_mechanism:
                          type: string
                          example: service_credential
                        service_credentials:
                          type: object
                          properties:
                            upload_option:
                              type: string
                              example: fileUpload
                        additional_params:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                example: key
                              value:
                                type: string
                                example: value
                    warehouse_cred_file:
                      type: string
                      format: binary
                    files:
                      type: string
                      format: binary
                - type: object
                  properties:
                    name:
                      type: string
                      example: bigquery_test
                      pattern: ^[a-z0-9A-Z_-]+$
                    data_warehouse_configuration:
                      type: object
                      properties:
                        authentication_mechanism:
                          type: string
                          example: service_credential
                        service_credential:
                          type: object
                          properties:
                            upload_option:
                              type: string
                              example: fileUpload
                        additional_params:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                example: key
                              value:
                                type: string
                                example: value
                    warehouse_cred_file:
                      type: string
                      format: binary
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    name:
                      type: string
                      example: rest_api_gcp_test_1
                      pattern: ^[a-z0-9A-Z_-]+$
                    metastore:
                      type: object
                      properties:
                        configuration:
                          type: object
                          properties:
                            admin_password_uri:
                              type: string
                              example: gs://regression50/password.encrypted
                            hive_password_uri:
                              type: string
                              example: gs://regression50/password.encrypted
                            kms_key_uri:
                              type: string
                              example: >-
                                projects/iw-gcp-eng-dev/locations/global/keyRings/regression-50-keyring/cryptoKeys/regr50-key
                            warehouse_dir:
                              type: string
                              example: gs://regression50/hive-warehouse
                            use_private_ip:
                              type: boolean
                              example: true
                            machine_tag:
                              type: string
                              example: us-central1:regression50
                    connection_configuration:
                      type: object
                      properties:
                        region:
                          type: string
                          example: us-central1
                        authentication_mechanism:
                          type: string
                          example: system
                - type: object
                  properties:
                    name:
                      type: string
                      example: snowflake_aws_databricks_rest_1
                      pattern: ^[a-z0-9A-Z_-]+$
                    connection_configuration:
                      type: object
                      properties:
                        workspace_url:
                          type: string
                          example: https://adb-3889563399002515.15.azuredatabricks.net
                        token:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - service_authentication
                                    - secret_store
                                service_auth_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                        region:
                          type: string
                          example: us-east-1
                    data_warehouse_configuration:
                      type: object
                      properties:
                        connection_url:
                          type: string
                          example: jdbc:mysql://host:port/hive
                        account_name:
                          type: string
                          example: test
                        snowflake_profiles:
                          type: array
                          items:
                            oneOf:
                              - type: object
                                properties:
                                  name:
                                    type: string
                                    example: profile1
                                  is_default_profile:
                                    type: boolean
                                    example: true
                                  warehouse:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        name:
                                          type: string
                                          example: test
                                        description:
                                          type: string
                                          example: sample description
                                        is_default_warehouse:
                                          type: boolean
                                          example: true
                                  authentication_properties:
                                    type: object
                                    properties:
                                      type:
                                        type: string
                                        example: default
                                      username:
                                        type: string
                                        example: test
                                      password:
                                        oneOf:
                                          - type: string
                                          - type: object
                                            required:
                                              - password_type
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - infoworks_managed
                                                  - secret_store
                                              secret_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                              password:
                                                type: string
                                  additional_params:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: key
                                        value:
                                          type: string
                                          example: value
                                  session_params:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: key
                                        value:
                                          type: string
                                          example: value
                              - type: object
                                properties:
                                  name:
                                    type: string
                                    example: profile1
                                  is_default_profile:
                                    type: boolean
                                    example: true
                                  warehouse:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        name:
                                          type: string
                                          example: test
                                        description:
                                          type: string
                                          example: sample description
                                        is_default_warehouse:
                                          type: boolean
                                          example: true
                                  authentication_properties:
                                    type: object
                                    properties:
                                      type:
                                        type: string
                                        example: oauth
                                      oauth_service:
                                        type: string
                                        example: snowflake
                                      oauth_client_id:
                                        type: string
                                        example: test
                                      oauth_client_secret:
                                        oneOf:
                                          - type: string
                                          - type: object
                                            required:
                                              - password_type
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - infoworks_managed
                                                  - secret_store
                                              secret_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                              password:
                                                type: string
                                      refresh_token:
                                        oneOf:
                                          - type: string
                                          - type: object
                                            required:
                                              - password_type
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - infoworks_managed
                                                  - secret_store
                                              secret_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                              password:
                                                oneOf:
                                                  - type: string
                                                  - type: object
                                                    required:
                                                      - password_type
                                                    properties:
                                                      password_type:
                                                        type: string
                                                        enum:
                                                          - infoworks_managed
                                                          - secret_store
                                                      secret_id:
                                                        type: string
                                                        example: e77850ad5127a2d7dab870ff
                                                      password:
                                                        type: string
                                  additional_params:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: key
                                        value:
                                          type: string
                                          example: value
                                  session_params:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: key
                                        value:
                                          type: string
                                          example: value
                              - type: object
                                properties:
                                  name:
                                    type: string
                                    example: profile1
                                  is_default_profile:
                                    type: boolean
                                    example: true
                                  warehouse:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        name:
                                          type: string
                                          example: test
                                        description:
                                          type: string
                                          example: sample description
                                        is_default_warehouse:
                                          type: boolean
                                          example: true
                                  authentication_properties:
                                    type: object
                                    properties:
                                      type:
                                        type: string
                                        example: oauth
                                      oauth_service:
                                        type: string
                                        example: external_ad
                                      oauth_access_type:
                                        type: string
                                        enum:
                                          - user
                                          - client
                                      azure_ad_username:
                                        type: string
                                      azure_ad_password:
                                        oneOf:
                                          - type: string
                                          - type: object
                                            required:
                                              - password_type
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - infoworks_managed
                                                  - secret_store
                                              secret_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                              password:
                                                type: string
                                      oauth_client_id:
                                        type: string
                                        example: test
                                      oauth_client_secret:
                                        oneOf:
                                          - type: string
                                          - type: object
                                            required:
                                              - password_type
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - infoworks_managed
                                                  - secret_store
                                              secret_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                              password:
                                                type: string
                                      username:
                                        type: string
                                        example: test
                                      oauth_scope:
                                        type: string
                                        example: test
                                      oauth_token_url:
                                        type: string
                                        example: http://test.com
                                  additional_params:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: key
                                        value:
                                          type: string
                                          example: value
                                  session_params:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        key:
                                          type: string
                                          example: key
                                        value:
                                          type: string
                                          example: value
                - type: object
                  properties:
                    name:
                      type: string
                      example: aws_emr_rest_1
                      pattern: ^[a-z0-9A-Z_-]+$
                    connection_configuration:
                      type: object
                      properties:
                        region:
                          type: string
                          example: us-east-1
                        authentication_mechanism:
                          type: string
                          example: access_key
                        secret_key:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                        access_key:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                    metastore:
                      type: object
                      properties:
                        configuration:
                          type: object
                          properties:
                            connection_url:
                              type: string
                              example: >-
                                jdbc:mysql://emr-regression-500.cjkihlti48zz.us-east-1.rds.amazonaws.com:3306/hive
                            driver_name:
                              type: string
                              example: org.mariadb.jdbc.Driver
                            user_name:
                              type: string
                              example: admin
                            password:
                              oneOf:
                                - type: string
                                - type: object
                                  required:
                                    - password_type
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - infoworks_managed
                                        - secret_store
                                    secret_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    password:
                                      type: string
                            warehouse_location:
                              type: string
                              example: s3://tmp-emr/warehouse13/
                - type: object
                  properties:
                    name:
                      type: string
                      example: aws_emr_rest_2
                      pattern: ^[a-z0-9A-Z_-]+$
                    connection_configuration:
                      type: object
                      properties:
                        region:
                          type: string
                          example: us-east-1
                        authentication_mechanism:
                          type: string
                          example: system
                    metastore:
                      type: object
                      properties:
                        configuration:
                          type: object
                          properties:
                            connection_url:
                              type: string
                              example: >-
                                jdbc:mysql://emr-regression-500.cjkihlti48zz.us-east-1.rds.amazonaws.com:3306/hive
                            driver_name:
                              type: string
                              example: org.mariadb.jdbc.Driver
                            user_name:
                              type: string
                              example: admin
                            password:
                              oneOf:
                                - type: string
                                - type: object
                                  required:
                                    - password_type
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - infoworks_managed
                                        - secret_store
                                    secret_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    password:
                                      type: string
                            warehouse_location:
                              type: string
                              example: s3://tmp-emr/warehouse13/
                - type: object
                  properties:
                    name:
                      type: string
                      example: aws_emr_rest_3
                      pattern: ^[a-z0-9A-Z_-]+$
                    connection_configuration:
                      type: object
                      properties:
                        region:
                          type: string
                          example: us-east-1
                        authentication_mechanism:
                          type: string
                          example: access_key
                        secret_key:
                          type: string
                          example: tIP+bJUSEzMQv6CvCJfUGGmBLPDduGJj/D0qg9Hm
                        access_key:
                          type: string
                          example: REDACTED_AWS_ACCESS_KEY_ID
                    metastore:
                      type: object
                      properties:
                        configuration:
                          type: object
                          properties:
                            warehouse_location:
                              type: string
                              example: s3://tmp-emr/warehouse13/
                            use_custom_glue_catalog_account:
                              type: boolean
                              default: false
                            glue_catalog_account_id:
                              type: string
                              example: '234142552452'
                - type: object
                  properties:
                    name:
                      type: string
                      example: aws_emr_rest_4
                      pattern: ^[a-z0-9A-Z_-]+$
                    connection_configuration:
                      type: object
                      properties:
                        region:
                          type: string
                          example: us-east-1
                        authentication_mechanism:
                          type: string
                          example: system
                    metastore:
                      type: object
                      properties:
                        configuration:
                          type: object
                          properties:
                            warehouse_location:
                              type: string
                              example: s3://tmp-emr/warehouse13/
                            use_custom_glue_catalog_account:
                              type: boolean
                              default: false
                            glue_catalog_account_id:
                              type: string
                              example: '234142552452'
                - type: object
                  properties:
                    name:
                      type: string
                      example: bigquery_gcp_databricks_test_1
                      pattern: ^[a-z0-9A-Z_-]+$
                    connection_configuration:
                      type: object
                      properties:
                        workspace_url:
                          type: string
                          example: https://adb-3889563399002515.15.azuredatabricks.net
                        token:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - service_authentication
                                    - secret_store
                                service_auth_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                        region:
                          type: string
                          example: us-east1
                    data_warehouse_configuration:
                      type: object
                      properties:
                        authentication_mechanism:
                          type: string
                          example: system
                        additional_params:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                example: key
                              value:
                                type: string
                                example: value
                - type: object
                  properties:
                    name:
                      type: string
                      example: snowflake_aws_databricks_rest_1
                      pattern: ^[a-z0-9A-Z_-]+$
                    connection_configuration:
                      type: object
                      properties:
                        region:
                          type: string
                          example: us-east-1
                        authentication_mechanism:
                          type: string
                          example: access_key
                        secret_key:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                        access_key:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                    data_warehouse_configuration:
                      type: object
                      properties:
                        connection_url:
                          type: string
                          example: jdbc:mysql://host:port/hive
                        account_name:
                          type: string
                          example: test
                        snowflake_profiles:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                                example: profile1
                              is_default_profile:
                                type: boolean
                                example: true
                              warehouse:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                      example: test
                                    description:
                                      type: string
                                      example: sample description
                                    is_default_warehouse:
                                      type: boolean
                                      example: true
                              authentication_properties:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    example: default
                                  username:
                                    type: string
                                    example: test
                                  password:
                                    oneOf:
                                      - type: string
                                      - type: object
                                        required:
                                          - password_type
                                        properties:
                                          password_type:
                                            type: string
                                            enum:
                                              - infoworks_managed
                                              - secret_store
                                          secret_id:
                                            type: string
                                            example: e77850ad5127a2d7dab870ff
                                          password:
                                            type: string
                              additional_params:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                      example: key
                                    value:
                                      type: string
                                      example: value
                              session_params:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                      example: key
                                    value:
                                      type: string
                                      example: value
                        additional_params:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                example: key
                              value:
                                type: string
                                example: value
                        session_params:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                example: key
                              value:
                                type: string
                                example: value
                - type: object
                  properties:
                    name:
                      type: string
                      example: azure_databricks_rest_1
                      pattern: ^[a-z0-9A-Z_-]+$
                    platform:
                      type: string
                      enum:
                        - azure
                        - aws
                        - gcp
                      example: azure
                    compute_engine:
                      type: string
                      example: databricks
                    metastore:
                      type: object
                      properties:
                        type:
                          type: string
                          example: hive
                        configuration:
                          type: object
                          properties:
                            mode:
                              type: string
                              example: unity_catalog
                    connection_configuration:
                      type: object
                      properties:
                        workspace_url:
                          type: string
                          example: https://adb-3889563399002515.15.azuredatabricks.net
                        token:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - service_authentication
                                    - secret_store
                                service_auth_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                        region:
                          type: string
                          example: us-east-1
                    staging_area:
                      type: object
                      properties:
                        catalog_name:
                          type: string
                          example: catalog_name
                        schema_name:
                          type: string
                          example: schema_name
                        volume_name:
                          type: string
                          example: volume_name
                    profiles:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - azure_service_principal
                              - databricks_service_principal
                              - username
                          name:
                            type: string
                            example: profile_1
                          username:
                            type: string
                            example: username
                          databricks_service_principal:
                            type: string
                            example: d38bc497-94e8-4836-8bde-784fca187cbf
                          azure_service_principal:
                            type: object
                            required:
                              - password_type
                            properties:
                              password_type:
                                type: string
                                enum:
                                  - service_authentication
                              service_auth_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          is_default:
                            type: boolean
                            example: true
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Environment updated successfully
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/environment/{environment_id}/environment-storage:
    parameters:
      - name: environment_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: EnvironmentsIdStorage
      tags:
        - Environment
      summary: Get the environment id storage details
      description: Get the environment id storage details
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                  - properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - properties:
                                description:
                                  type: string
                                environment_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                storage_type:
                                  type: string
                                  example: dbfs
                                name:
                                  type: string
                                  example: del
                                storage_authentication:
                                  properties:
                                    db_token:
                                      oneOf:
                                        - type: string
                                        - type: object
                                          required:
                                            - password_type
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - infoworks_managed
                                                - service_authentication
                                                - secret_store
                                            service_auth_id:
                                              type: string
                                              example: e77850ad5127a2d7dab870ff
                                            secret_id:
                                              type: string
                                              example: e77850ad5127a2d7dab870ff
                                            password:
                                              type: string
                                    db_url:
                                      type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: EnvironmentStorage
      tags:
        - Environment
      summary: Create storage for environment id
      description: Create storage for environment id
      requestBody:
        content:
          multipart/form-data:
            schema:
              oneOf:
                - type: object
                  properties:
                    name:
                      type: string
                      example: gcs_test_5
                      pattern: ^[a-z0-9A-Z_-]+$
                    description:
                      type: string
                      example: ''
                    region:
                      type: string
                      example: us-east1
                    storage_type:
                      type: string
                      example: gcs
                    storage_authentication:
                      type: object
                      properties:
                        scheme:
                          type: string
                          example: gs://
                        bucket_name:
                          type: string
                          example: staging-bucket-xxx
                        authentication_mechanism:
                          type: string
                          example: service_credential
                        service_credentials:
                          type: object
                          properties:
                            upload_option:
                              type: string
                              example: fileUpload
                    is_default_storage:
                      type: boolean
                      example: true
                    files:
                      type: string
                      format: binary
                - type: object
                  properties:
                    name:
                      type: string
                      example: gcs_test5
                      pattern: ^[a-z0-9A-Z_-]+$
                    description:
                      type: string
                      example: ''
                    storage_type:
                      type: string
                      example: gcs
                    storage_authentication:
                      type: object
                      properties:
                        scheme:
                          type: string
                          example: gs://
                        bucket_name:
                          type: string
                          example: staging-bucket-xxx
                        authentication_mechanism:
                          type: string
                          example: service_credential
                        service_credentials:
                          type: object
                          properties:
                            upload_option:
                              type: string
                              example: fileUpload
                    is_default_storage:
                      type: boolean
                      example: true
                    files:
                      type: string
                      format: binary
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    name:
                      type: string
                      example: gcs_test3
                      pattern: ^[a-z0-9A-Z_-]+$
                    description:
                      type: string
                      example: ''
                    region:
                      type: string
                      example: us-east1
                    storage_type:
                      type: string
                      example: gcs
                    storage_authentication:
                      type: object
                      properties:
                        scheme:
                          type: string
                          example: gs://
                        bucket_name:
                          type: string
                          example: staging-bucket-xxx
                        authentication_mechanism:
                          type: string
                          example: system
                    is_default_storage:
                      type: boolean
                      example: true
                - type: object
                  properties:
                    name:
                      type: string
                      example: gcs_test6
                      pattern: ^[a-z0-9A-Z_-]+$
                    description:
                      type: string
                      example: ''
                    region:
                      type: string
                      example: us-east1
                    storage_type:
                      type: string
                      example: gcs
                    storage_authentication:
                      type: object
                      properties:
                        scheme:
                          type: string
                          example: gs://
                        bucket_name:
                          type: string
                          example: staging-bucket-xxx
                        authentication_mechanism:
                          type: string
                          example: environment_service_credential
                    is_default_storage:
                      type: boolean
                      example: true
                - type: object
                  properties:
                    name:
                      type: string
                      example: gcs_test4
                      pattern: ^[a-z0-9A-Z_-]+$
                    description:
                      type: string
                      example: ''
                    storage_type:
                      type: string
                      example: gcs
                    storage_authentication:
                      type: object
                      properties:
                        scheme:
                          type: string
                          example: gs://
                        bucket_name:
                          type: string
                          example: staging-bucket-xxx
                        authentication_mechanism:
                          type: string
                          example: system
                    is_default_storage:
                      type: boolean
                      example: true
                - type: object
                  properties:
                    name:
                      type: string
                      example: gcs_test6
                      pattern: ^[a-z0-9A-Z_-]+$
                    description:
                      type: string
                      example: ''
                    storage_type:
                      type: string
                      example: gcs
                    storage_authentication:
                      type: object
                      properties:
                        scheme:
                          type: string
                          example: gs://
                        bucket_name:
                          type: string
                          example: staging-bucket-xxx
                        authentication_mechanism:
                          type: string
                          example: system
                    storage_integration_name:
                      type: string
                      example: test
                    is_default_storage:
                      type: boolean
                      example: true
                - type: object
                  properties:
                    name:
                      type: string
                      example: dbfs3
                      pattern: ^[a-z0-9A-Z_-]+$
                    description:
                      type: string
                      example: ''
                    storage_type:
                      type: string
                      example: dbfs
                    is_default_storage:
                      type: boolean
                      example: true
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: adls_gen1_1
                      pattern: ^[a-z0-9A-Z_-]+$
                    storage_type:
                      type: string
                      example: adls_gen1
                    storage_authentication:
                      type: object
                      properties:
                        scheme:
                          type: string
                          example: adl://
                        authentication_mechanism:
                          type: string
                          example: service_principal
                        storage_account_name:
                          type: string
                          example: ingestionadlsgen1
                        application_id:
                          type: string
                          example: test
                        directory_id:
                          type: string
                          example: test
                        service_credential:
                          oneOf:
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - service_authentication
                                service_auth_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                    is_default_storage:
                      type: boolean
                      example: true
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: adls_gen1_2
                      pattern: ^[a-z0-9A-Z_-]+$
                    storage_type:
                      type: string
                      example: adls_gen1
                    storage_authentication:
                      type: object
                      properties:
                        scheme:
                          type: string
                          example: adl://
                        authentication_mechanism:
                          type: string
                          example: service_principal
                        storage_account_name:
                          type: string
                          example: ingestionadlsgen1
                        application_id:
                          type: string
                          example: test
                        directory_id:
                          type: string
                          example: test
                        service_credential:
                          oneOf:
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - service_authentication
                                service_auth_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                    storage_integration_name:
                      type: string
                      example: ''
                    is_default_storage:
                      type: boolean
                      example: true
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: adls_gen2_1
                      pattern: ^[a-z0-9A-Z_-]+$
                    storage_type:
                      type: string
                      example: adls_gen2
                    storage_authentication:
                      type: object
                      properties:
                        scheme:
                          type: string
                          example: abfss://
                        authentication_mechanism:
                          type: string
                          example: access_key
                        file_system:
                          type: string
                          example: ingestion
                        storage_account_name:
                          type: string
                          example: ingestionadlsgen2
                        access_key_name:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: adls_gen2_2
                      pattern: ^[a-z0-9A-Z_-]+$
                    storage_type:
                      type: string
                      example: adls_gen2
                    storage_authentication:
                      type: object
                      properties:
                        scheme:
                          type: string
                          example: abfs://
                        authentication_mechanism:
                          type: string
                          example: service_principal
                        file_system:
                          type: string
                          example: ingestion
                        storage_account_name:
                          type: string
                          example: ingestionadlsgen2
                        application_id:
                          type: string
                          example: tesst
                        directory_id:
                          type: string
                          example: test
                        service_credential:
                          oneOf:
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - service_authentication
                                service_auth_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: adls_gen2_3
                      pattern: ^[a-z0-9A-Z_-]+$
                    storage_type:
                      type: string
                      example: adls_gen2
                    storage_authentication:
                      type: object
                      properties:
                        scheme:
                          type: string
                          example: abfss://
                        authentication_mechanism:
                          type: string
                          example: access_key
                        file_system:
                          type: string
                          example: ingestion
                        storage_account_name:
                          type: string
                          example: ingestionadlsgen2
                        access_key_name:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                    storage_integration_name:
                      type: string
                      example: ''
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: adls_gen2_4
                      pattern: ^[a-z0-9A-Z_-]+$
                    storage_type:
                      type: string
                      example: adls_gen2
                    storage_authentication:
                      type: object
                      properties:
                        scheme:
                          type: string
                          example: abfs://
                        authentication_mechanism:
                          type: string
                          example: service_principal
                        file_system:
                          type: string
                          example: ingestion
                        storage_account_name:
                          type: string
                          example: ingestionadlsgen2
                        application_id:
                          type: string
                          example: tesst
                        directory_id:
                          type: string
                          example: test
                        service_credential:
                          oneOf:
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - service_authentication
                                service_auth_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                    storage_integration_name:
                      type: string
                      example: ''
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: wasb_1
                      pattern: ^[a-z0-9A-Z_-]+$
                    storage_type:
                      type: string
                      example: wasb
                    storage_authentication:
                      type: object
                      properties:
                        scheme:
                          type: string
                          example: wasb://
                        container_name:
                          type: string
                          example: test
                        storage_account_name:
                          type: string
                          example: test
                        account_key:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: wasb_2
                      pattern: ^[a-z0-9A-Z_-]+$
                    storage_type:
                      type: string
                      example: wasb
                    storage_authentication:
                      type: object
                      properties:
                        scheme:
                          type: string
                          example: wasb://
                        container_name:
                          type: string
                          example: test
                        storage_account_name:
                          type: string
                          example: test
                        account_key:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                    storage_integration_name:
                      type: string
                      example: ''
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    storage_type:
                      type: string
                      example: s3
                    name:
                      type: string
                      example: s3_1
                      pattern: ^[a-z0-9A-Z_-]+$
                    storage_authentication:
                      type: object
                      properties:
                        scheme:
                          type: string
                          example: s3a://
                        bucket_name:
                          type: string
                          example: tmp-databricks
                        secret_key:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                        access_key:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                    is_default_storage:
                      type: boolean
                      example: true
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    storage_type:
                      type: string
                      example: s3
                    name:
                      type: string
                      example: s3_2
                      pattern: ^[a-z0-9A-Z_-]+$
                    region:
                      type: string
                      example: us-east-1
                    storage_authentication:
                      type: object
                      properties:
                        authentication_mechanism:
                          type: string
                          example: environment_access_key
                        scheme:
                          type: string
                          example: s3://
                        bucket_name:
                          type: string
                          example: tmp-emr
                    is_default_storage:
                      type: boolean
                      example: true
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    storage_type:
                      type: string
                      example: s3
                    name:
                      type: string
                      example: s3_3
                      pattern: ^[a-z0-9A-Z_-]+$
                    region:
                      type: string
                      example: us-east-1
                    storage_authentication:
                      type: object
                      properties:
                        authentication_mechanism:
                          type: string
                          example: system
                        scheme:
                          type: string
                          example: s3://
                        bucket_name:
                          type: string
                          example: tmp-emr
                    is_default_storage:
                      type: boolean
                      example: true
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    storage_type:
                      type: string
                      example: s3
                    name:
                      type: string
                      example: s3_4
                      pattern: ^[a-z0-9A-Z_-]+$
                    region:
                      type: string
                      example: us-east-1
                    storage_authentication:
                      type: object
                      properties:
                        authentication_mechanism:
                          type: string
                          example: access_key
                        scheme:
                          type: string
                          example: s3://
                        bucket_name:
                          type: string
                          example: tmp-emr
                        access_key:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                        secret_key:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                    is_default_storage:
                      type: boolean
                      example: true
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    storage_type:
                      type: string
                      example: s3
                    name:
                      type: string
                      example: s3_5
                      pattern: ^[a-z0-9A-Z_-]+$
                    storage_authentication:
                      type: object
                      properties:
                        scheme:
                          type: string
                          example: s3a://
                        bucket_name:
                          type: string
                          example: tmp-databricks
                        secret_key:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                        access_key:
                          oneOf:
                            - type: string
                            - type: object
                              required:
                                - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                    storage_integration_name:
                      type: string
                      example: test
                    is_default_storage:
                      type: boolean
                      example: true
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Successfully created a environment storage.
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 5f9708117758f33f8b013824
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/environment/{environment_id}/environment-storage/{environment_storage_id}:
    parameters:
      - name: environment_id
        in: path
        required: true
        schema:
          type: string
      - name: environment_storage_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: EnvironmentsIdStorageId
      tags:
        - Environment
      summary: Get the environment storage id storage details
      description: Get the environment storage id storage details
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                  - properties:
                      result:
                        type: object
                        allOf:
                          - type: object
                            properties:
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          - properties:
                              description:
                                type: string
                              environment_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              storage_type:
                                type: string
                                example: dbfs
                              name:
                                type: string
                                example: del
                              storage_authentication:
                                properties:
                                  db_token:
                                    oneOf:
                                      - type: string
                                      - type: object
                                        required:
                                          - password_type
                                        properties:
                                          password_type:
                                            type: string
                                            enum:
                                              - infoworks_managed
                                              - service_authentication
                                              - secret_store
                                          service_auth_id:
                                            type: string
                                            example: e77850ad5127a2d7dab870ff
                                          secret_id:
                                            type: string
                                            example: e77850ad5127a2d7dab870ff
                                          password:
                                            type: string
                                  db_url:
                                    type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/environment/{environment_id}/environment-storage/{environment_storage_id}/pipelines:
    parameters:
      - name: environment_id
        in: path
        required: true
        schema:
          type: string
      - name: environment_storage_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: EnvironmentsIdStorageIdPipelines
      tags:
        - Environment
      summary: Get list of pipelines using the storage
      description: Get list of pipelines using the storage
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                  - properties:
                      result:
                        type: array
                        items:
                          properties:
                            id:
                              type: string
                              example: c8ff2b391e24ec60143b2d3c
                            name:
                              type: string
                              example: testPipeline
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/environment/{environment_id}/environment-compute-template:
    parameters:
      - name: environment_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: EnvironmentsComputeTemplate
      tags:
        - Environment
      summary: Get List of ephemeral computes for environment
      description: Get List of ephemeral computes for environment
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                  - properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                description:
                                  type: string
                                environment_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                name:
                                  type: string
                                  example: del
                                compute_engine:
                                  type: string
                                  example: databricks
                                launch_strategy:
                                  type: string
                                  example: ephemeral
                            - properties:
                                compute_configuration:
                                  properties:
                                    runtime_configuration:
                                      allOf:
                                        - properties:
                                            cluster_mode:
                                              type: string
                                              example: standard
                                            engine_type:
                                              type: string
                                              example: spark
                                            max_allowed_workers:
                                              type: integer
                                              example: 2
                                            idle_termination_timeout:
                                              type: integer
                                              example: 120
                                            worker_node_type:
                                              type: string
                                              example: Standard_NC24
                                            driver_node_type:
                                              type: string
                                              example: Standard_NC24
                                            runtime_version_properties:
                                              type: object
                                              properties:
                                                runtime_version:
                                                  type: string
                                                  example: 9.1
                                        - properties:
                                            num_worker_node:
                                              type: integer
                                              example: 2
                                            enable_autoscale:
                                              type: boolean
                                              example: false
                                    connection_configuration:
                                      properties:
                                        region:
                                          type: string
                                          example: eastus2
                                        token:
                                          oneOf:
                                            - type: string
                                            - type: object
                                              required:
                                                - password_type
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - infoworks_managed
                                                    - service_authentication
                                                    - secret_store
                                                service_auth_id:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                                secret_id:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                                password:
                                                  type: string
                                        workspace_url:
                                          type: string
                                          example: standard
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: CreateEnvironmentsComputeTemplate
      tags:
        - Environment
      summary: Create ephemeral cluster
      description: Create ephemeral cluster
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: custom_regression_template_%%templ%%
                      pattern: ^[a-z0-9A-Z_-]+$
                    compute_engine:
                      type: string
                      example: emr
                    launch_strategy:
                      type: string
                      example: ephemeral
                    compute_configuration:
                      type: object
                      properties:
                        runtime_configuration:
                          type: object
                          properties:
                            engine_type:
                              type: string
                              example: spark
                            staging_bucket_name:
                              type: string
                              example: tmp-emr
                            cluster_subnet_id:
                              type: string
                              example: subnet-060f04d20161fdc50
                            cluster_vpc:
                              type: string
                              example: vpc-09c1213e9c26d87bf
                            ssh_key:
                              type: string
                              example: dev
                            driver_node_type:
                              type: string
                              example: m4.large
                            runtime_version:
                              type: string
                              example: 5.32.0
                            allow_zero_workers:
                              type: boolean
                              example: true
                            enable_security_configuration:
                              type: boolean
                              example: true
                            security_configuration:
                              type: object
                              properties:
                                enable_kerberos:
                                  type: boolean
                                  example: true
                                security_configuration_name:
                                  type: string
                                  example: emr-kerberos-dedicated
                                kerberos:
                                  type: object
                                  properties:
                                    realm:
                                      type: string
                                      example: infoworks.io
                                    kdc_admin_password:
                                      type: string
                                      example: IN11**rk
                        connection_configuration:
                          type: object
                          properties:
                            region:
                              type: string
                              example: us-east-1
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: custom_regression_template_%%templ%%
                      pattern: ^[a-z0-9A-Z_-]+$
                    compute_engine:
                      type: string
                      example: emr
                    launch_strategy:
                      type: string
                      example: ephemeral
                    compute_configuration:
                      type: object
                      properties:
                        runtime_configuration:
                          type: object
                          properties:
                            engine_type:
                              type: string
                              example: spark
                            staging_bucket_name:
                              type: string
                              example: tmp-emr
                            cluster_subnet_id:
                              type: string
                              example: subnet-060f04d20161fdc50
                            cluster_vpc:
                              type: string
                              example: vpc-09c1213e9c26d87bf
                            ssh_key:
                              type: string
                              example: dev
                            driver_node_type:
                              type: string
                              example: m4.large
                            runtime_version:
                              type: string
                              example: 5.32.0
                            allow_zero_workers:
                              type: boolean
                              example: true
                            enable_security_configuration:
                              type: boolean
                              example: true
                            security_configuration:
                              type: object
                              properties:
                                enable_kerberos:
                                  type: boolean
                                  example: true
                                security_configuration_name:
                                  type: string
                                  example: emr-kerberos-dedicated
                                kerberos:
                                  type: object
                                  properties:
                                    realm:
                                      type: string
                                      example: infoworks.io
                                    kdc_admin_password:
                                      type: string
                                      example: IN11**rk
                            use_custom_instance_role:
                              type: boolean
                              example: true
                            instance_account:
                              type: string
                              example: EMR_EC2_Default_Role
                        connection_configuration:
                          type: object
                          properties:
                            region:
                              type: string
                              example: us-east-1
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: custom_regression_template_%%templ%%
                      pattern: ^[a-z0-9A-Z_-]+$
                    compute_engine:
                      type: string
                      example: emr
                    launch_strategy:
                      type: string
                      example: ephemeral
                    compute_configuration:
                      type: object
                      properties:
                        runtime_configuration:
                          type: object
                          properties:
                            engine_type:
                              type: string
                              example: spark
                            staging_bucket_name:
                              type: string
                              example: tmp-emr
                            cluster_subnet_id:
                              type: string
                              example: subnet-060f04d20161fdc50
                            cluster_vpc:
                              type: string
                              example: vpc-09c1213e9c26d87bf
                            ssh_key:
                              type: string
                              example: dev
                            max_allowed_workers:
                              type: integer
                              example: 5
                            num_worker_nodes:
                              type: integer
                              example: 4
                            worker_node_type:
                              type: string
                              example: m4.large
                            driver_node_type:
                              type: string
                              example: m4.large
                            runtime_version:
                              type: string
                              example: 5.32.0
                            enable_security_configuration:
                              type: boolean
                              example: true
                            security_configuration:
                              type: object
                              properties:
                                enable_kerberos:
                                  type: boolean
                                  example: true
                                security_configuration_name:
                                  type: string
                                  example: emr-kerberos-dedicated
                                kerberos:
                                  type: object
                                  properties:
                                    realm:
                                      type: string
                                      example: infoworks.io
                                    kdc_admin_password:
                                      type: string
                                      example: IN11**rk
                        connection_configuration:
                          type: object
                          properties:
                            region:
                              type: string
                              example: us-east-1
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: custom_regression_template_%%templ%%
                      pattern: ^[a-z0-9A-Z_-]+$
                    compute_engine:
                      type: string
                      example: dataproc
                    launch_strategy:
                      type: string
                      example: ephemeral
                    compute_configuration:
                      type: object
                      properties:
                        runtime_configuration:
                          type: object
                          properties:
                            engine_type:
                              type: string
                              example: spark
                            staging_bucket:
                              type: string
                              example: gs://staging-bucket-xxx
                            temp_bucket:
                              type: string
                              example: gs://temp-bucket-xxx
                            cluster_subnetwork:
                              type: string
                              example: >-
                                https://www.googleapis.com/compute/v1/projects/iw-gcp-eng-host/regions/us-central1/subnetworks/gcp-eng-host-vpc-1-subnet-2
                            worker_node_type:
                              type: string
                              example: n2-standard-4
                            driver_node_type:
                              type: string
                              example: n2-standard-4
                            num_worker_nodes:
                              type: integer
                              example: 4
                            max_allowed_workers:
                              type: integer
                              example: 6
                            runtime_version:
                              type: string
                              example: '1.5'
                        connection_configuration:
                          type: object
                          properties:
                            region:
                              type: string
                              example: us-central1
                            project_id:
                              type: string
                              example: <project_id>
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: custom_regression_template_%%templ%%
                      pattern: ^[a-z0-9A-Z_-]+$
                    compute_engine:
                      type: string
                      example: dataproc
                    launch_strategy:
                      type: string
                      example: ephemeral
                    compute_configuration:
                      type: object
                      properties:
                        runtime_configuration:
                          type: object
                          properties:
                            engine_type:
                              type: string
                              example: spark
                            runtime_version:
                              type: string
                              example: '1.5'
                            staging_bucket:
                              type: string
                              example: gs://staging-bucket-xxx
                            temp_bucket:
                              type: string
                              example: gs://temp-bucket-xxx
                            cluster_subnetwork:
                              type: string
                              example: >-
                                https://www.googleapis.com/compute/v1/projects/iw-gcp-eng-host/regions/us-central1/subnetworks/gcp-eng-host-vpc-1-subnet-2
                            driver_node_type:
                              type: string
                              example: n2-standard-4
                            allow_zero_workers:
                              type: boolean
                              example: true
                        connection_configuration:
                          type: object
                          properties:
                            region:
                              type: string
                              example: us-central1
                            project_id:
                              type: string
                              example: ''
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: custom_regression_template_%%templ%%
                      pattern: ^[a-z0-9A-Z_-]+$
                    compute_engine:
                      type: string
                      example: dataproc
                    launch_strategy:
                      type: string
                      example: ephemeral
                    compute_configuration:
                      type: object
                      properties:
                        runtime_configuration:
                          type: object
                          properties:
                            engine_type:
                              type: string
                              example: spark
                            runtime_version:
                              type: string
                              example: '1.5'
                            staging_bucket:
                              type: string
                              example: gs://staging-bucket-xxx
                            temp_bucket:
                              type: string
                              example: gs://temp-bucket-xxx
                            cluster_subnetwork:
                              type: string
                              example: >-
                                https://www.googleapis.com/compute/v1/projects/iw-gcp-eng-host/regions/us-central1/subnetworks/gcp-eng-host-vpc-1-subnet-2
                            driver_node_type:
                              type: string
                              example: n2-standard-4
                            allow_zero_workers:
                              type: boolean
                              example: true
                            use_custom_service_account:
                              type: boolean
                              example: true
                            service_account:
                              type: string
                              example: test
                        connection_configuration:
                          type: object
                          properties:
                            region:
                              type: string
                              example: us-central1
                            project_id:
                              type: string
                              example: ''
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: gcp_datapproc_single_node1
                      pattern: ^[a-z0-9A-Z_-]+$
                    compute_engine:
                      type: string
                      example: dataproc
                    launch_strategy:
                      type: string
                      example: ephemeral
                    compute_configuration:
                      type: object
                      properties:
                        runtime_configuration:
                          type: object
                          properties:
                            engine_type:
                              type: string
                              example: spark
                            runtime_version:
                              type: string
                              example: '1.5'
                            staging_bucket:
                              type: string
                              example: gs://staging-bucket-xxx
                            temp_bucket:
                              type: string
                              example: gs://temp-bucket-xxx
                            cluster_subnetwork:
                              type: string
                              example: >-
                                https://www.googleapis.com/compute/v1/projects/iw-gcp-eng-host/regions/us-central1/subnetworks/gcp-eng-host-vpc-1-subnet-2
                            driver_node_type:
                              type: string
                              example: n2-standard-4
                            allow_zero_workers:
                              type: boolean
                              example: true
                            advanced_configurations:
                              type: object
                              properties:
                                is_active:
                                  type: boolean
                                  example: true
                                key:
                                  type: string
                                  example: test
                                value:
                                  type: string
                                  example: test_value
                        connection_configuration:
                          type: object
                          properties:
                            region:
                              type: string
                              example: us-central1
                            project_id:
                              type: string
                              example: test
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: gcp_datapproc_multi_node2
                      pattern: ^[a-z0-9A-Z_-]+$
                    compute_engine:
                      type: string
                      example: dataproc
                    launch_strategy:
                      type: string
                      example: ephemeral
                    compute_configuration:
                      type: object
                      properties:
                        runtime_configuration:
                          type: object
                          properties:
                            engine_type:
                              type: string
                              example: spark
                            staging_bucket:
                              type: string
                              example: gs://staging-bucket-xxx
                            temp_bucket:
                              type: string
                              example: gs://temp-bucket-xxx
                            cluster_subnetwork:
                              type: string
                              example: >-
                                https://www.googleapis.com/compute/v1/projects/iw-gcp-eng-host/regions/us-central1/subnetworks/gcp-eng-host-vpc-1-subnet-2
                            worker_node_type:
                              type: string
                              example: n2-standard-4
                            driver_node_type:
                              type: string
                              example: n2-standard-4
                            max_allowed_workers:
                              type: integer
                              example: 6
                            runtime_version:
                              type: string
                              example: '1.5'
                            allow_zero_workers:
                              type: boolean
                              example: false
                            enable_autoscale:
                              type: boolean
                              example: true
                            autoscale:
                              type: object
                              properties:
                                min_worker_nodes:
                                  type: integer
                                  example: 2
                                max_worker_nodes:
                                  type: integer
                                  example: 5
                            num_master_local_ssds:
                              type: integer
                              minimum: 0
                              example: 1
                              description: >
                                Number of Local SSDs for master node.  Check
                                https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds
                                for allowed values.
                            master_local_ssd_interface:
                              type: integer
                              minimum: 0
                              example: 1
                              description: >
                                Disk interface of Local SSD for master node. 
                                Check
                                https://cloud.google.com/compute/docs/disks/local-ssd#choose_an_interface
                                for more info.
                            num_worker_local_ssds:
                              type: integer
                              minimum: 0
                              example: 1
                              description: >
                                Number of Local SSDs for worker node.  Check
                                https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds
                                for allowed values.
                            worker_local_ssd_interface:
                              type: integer
                              minimum: 0
                              example: 1
                              description: >
                                Disk interface of Local SSD for worker node. 
                                Check
                                https://cloud.google.com/compute/docs/disks/local-ssd#choose_an_interface
                                for more info.
                            enable_secondary_worker:
                              type: boolean
                              example: true
                            secondary_worker_config:
                              type: object
                              properties:
                                secondary_worker_type:
                                  type: integer
                                  example: 2
                                min_secondary_worker_nodes:
                                  type: integer
                                  example: 2
                                max_secondary_worker_nodes:
                                  type: integer
                                  example: 3
                                secondary_node_type:
                                  type: string
                                  example: n1-standard-4
                            advanced_configurations:
                              type: object
                              properties:
                                is_active:
                                  type: boolean
                                  example: true
                                key:
                                  type: string
                                  example: test
                                value:
                                  type: string
                                  example: test_value
                        connection_configuration:
                          type: object
                          properties:
                            region:
                              type: string
                              example: us-central1
                            project_id:
                              type: string
                              example: <project_id>
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: gcp_databricks_multi_node_with_autoscale1
                      pattern: ^[a-z0-9A-Z_-]+$
                    compute_engine:
                      type: string
                      example: databricks
                    launch_strategy:
                      type: string
                      example: ephemeral
                    compute_configuration:
                      type: object
                      properties:
                        runtime_configuration:
                          type: object
                          properties:
                            engine_type:
                              type: string
                              example: spark
                            worker_node_type:
                              type: string
                              example: n2-standard-4
                            driver_node_type:
                              type: string
                              example: n2-standard-4
                            max_allowed_workers:
                              type: integer
                              example: 6
                            runtime_version:
                              type: string
                              example: '7.3'
                            enable_autoscale:
                              type: boolean
                              example: true
                            autoscale:
                              type: object
                              properties:
                                min_worker_nodes:
                                  type: integer
                                  example: 2
                                max_worker_nodes:
                                  type: integer
                                  example: 5
                            enable_secondary_worker:
                              type: boolean
                              example: true
                            secondary_worker_config:
                              type: object
                              properties:
                                secondary_worker_type:
                                  type: integer
                                  example: 2
                                min_secondary_worker_nodes:
                                  type: integer
                                  example: 2
                                max_secondary_worker_nodes:
                                  type: integer
                                  example: 3
                                secondary_node_type:
                                  type: string
                                  example: n1-standard-4
                            advanced_configurations:
                              type: object
                              properties:
                                is_active:
                                  type: boolean
                                  example: true
                                key:
                                  type: string
                                  example: test
                                value:
                                  type: string
                                  example: test_value
                            ml_workflow_supported:
                              type: boolean
                              example: true
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: gcp_databricks_multi_node_with_autoscale1
                      pattern: ^[a-z0-9A-Z_-]+$
                    compute_engine:
                      type: string
                      example: databricks
                    launch_strategy:
                      type: string
                      example: ephemeral
                    compute_configuration:
                      type: object
                      properties:
                        runtime_configuration:
                          type: object
                          properties:
                            engine_type:
                              type: string
                              example: spark
                            driver_node_type:
                              type: string
                              example: n2-standard-4
                            runtime_version:
                              type: string
                              example: '7.3'
                            allow_zero_workers:
                              type: boolean
                              example: true
                            ml_workflow_supported:
                              type: boolean
                              example: true
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: databricks_unity_with_autoscale1
                      pattern: ^[a-z0-9A-Z_-]+$
                    compute_engine:
                      type: string
                      example: databricks
                    launch_strategy:
                      type: string
                      example: ephemeral
                    compute_configuration:
                      type: object
                      properties:
                        runtime_configuration:
                          type: object
                          properties:
                            engine_type:
                              type: string
                              example: spark
                            worker_node_type:
                              type: string
                              example: n2-standard-4
                            driver_node_type:
                              type: string
                              example: n2-standard-4
                            max_allowed_workers:
                              type: integer
                              example: 6
                            runtime_version:
                              type: string
                              example: '14.3'
                            enable_autoscale:
                              type: boolean
                              example: true
                            autoscale:
                              type: object
                              properties:
                                min_worker_nodes:
                                  type: integer
                                  example: 2
                                max_worker_nodes:
                                  type: integer
                                  example: 5
                            enable_secondary_worker:
                              type: boolean
                              example: true
                            secondary_worker_config:
                              type: object
                              properties:
                                secondary_worker_type:
                                  type: integer
                                  example: 2
                                min_secondary_worker_nodes:
                                  type: integer
                                  example: 2
                                max_secondary_worker_nodes:
                                  type: integer
                                  example: 3
                                secondary_node_type:
                                  type: string
                                  example: n1-standard-4
                            advanced_configurations:
                              type: object
                              properties:
                                is_active:
                                  type: boolean
                                  example: true
                                key:
                                  type: string
                                  example: test
                                value:
                                  type: string
                                  example: test_value
                            ml_workflow_supported:
                              type: boolean
                              example: true
                            data_security_mode:
                              type: string
                              enum:
                                - SINGLE_USER
                                - USER_ISOLATION
                              example: USER_ISOLATION
                            policy_id:
                              type: string
                              example: <policy_id>
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Successfully created a environment compute.
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 5f9708117758f33f8b013824
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/environment/{environment_id}/environment-compute-template/{environment_compute_template_id}:
    parameters:
      - name: environment_id
        in: path
        required: true
        schema:
          type: string
      - name: environment_compute_template_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: EnvironmentsComputeTemplateId
      tags:
        - Environment
      summary: Get ephemeral computes for environment by id
      description: Get ephemeral computes for environment by id
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                  - properties:
                      result:
                        type: object
                        allOf:
                          - type: object
                            properties:
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          - properties:
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              description:
                                type: string
                              environment_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              name:
                                type: string
                                example: del
                              compute_engine:
                                type: string
                                example: databricks
                              launch_strategy:
                                type: string
                                example: ephemeral
                          - properties:
                              compute_configuration:
                                properties:
                                  runtime_configuration:
                                    allOf:
                                      - properties:
                                          cluster_mode:
                                            type: string
                                            example: standard
                                          engine_type:
                                            type: string
                                            example: spark
                                          max_allowed_workers:
                                            type: integer
                                            example: 2
                                          idle_termination_timeout:
                                            type: integer
                                            example: 120
                                          worker_node_type:
                                            type: string
                                            example: Standard_NC24
                                          driver_node_type:
                                            type: string
                                            example: Standard_NC24
                                          runtime_version_properties:
                                            type: object
                                            properties:
                                              runtime_version:
                                                type: string
                                                example: 9.1
                                      - properties:
                                          num_worker_node:
                                            type: integer
                                            example: 2
                                          enable_autoscale:
                                            type: boolean
                                            example: false
                                  connection_configuration:
                                    properties:
                                      region:
                                        type: string
                                        example: eastus2
                                      token:
                                        oneOf:
                                          - type: string
                                          - type: object
                                            required:
                                              - password_type
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - infoworks_managed
                                                  - service_authentication
                                                  - secret_store
                                              service_auth_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                              secret_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                              password:
                                                type: string
                                      workspace_url:
                                        type: string
                                        example: standard
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/environment/{environment_id}/environment-interactive-clusters:
    parameters:
      - name: environment_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: EnvironmentInteractiveId
      tags:
        - Environment
      summary: Get the list of environments interactive (persistent) templates
      description: Get the list of environments interactive (persistent) templates
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                  - properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                description:
                                  type: string
                                environment_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                name:
                                  type: string
                                  example: del
                                compute_engine:
                                  type: string
                                  example: databricks
                                launch_strategy:
                                  type: string
                                  example: ephemeral
                            - properties:
                                compute_configuration:
                                  properties:
                                    runtime_configuration:
                                      allOf:
                                        - properties:
                                            cluster_mode:
                                              type: string
                                              example: standard
                                            engine_type:
                                              type: string
                                              example: spark
                                            max_allowed_workers:
                                              type: integer
                                              example: 2
                                            idle_termination_timeout:
                                              type: integer
                                              example: 120
                                            worker_node_type:
                                              type: string
                                              example: Standard_NC24
                                            driver_node_type:
                                              type: string
                                              example: Standard_NC24
                                            runtime_version_properties:
                                              type: object
                                              properties:
                                                runtime_version:
                                                  type: string
                                                  example: 9.1
                                    connection_configuration:
                                      properties:
                                        region:
                                          type: string
                                          example: eastus2
                                        token:
                                          oneOf:
                                            - type: string
                                            - type: object
                                              required:
                                                - password_type
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - infoworks_managed
                                                    - service_authentication
                                                    - secret_store
                                                service_auth_id:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                                secret_id:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                                password:
                                                  type: string
                                        workspace_url:
                                          type: string
                                          example: standard
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: EnvironmentInteractive
      tags:
        - Environment
      summary: Create an interactive compute
      description: Create an interactive compute
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: spark_kubernetes_interactive
                      pattern: ^[a-z0-9A-Z_-]+$
                    compute_engine:
                      type: string
                      example: kubernetesInteractive
                    launch_strategy:
                      type: string
                      example: persistent
                    compute_configuration:
                      type: object
                      properties:
                        runtime_configuration:
                          type: object
                          properties:
                            cluster_type:
                              type: string
                              example: external
                            staging_bucket:
                              type: string
                              example: staging-bucket
                            engine_type:
                              type: string
                              example: spark
                            runtime_version_properties:
                              type: object
                              properties:
                                label:
                                  type: string
                                  example: Beta
                                python:
                                  type: string
                                  example: '3.8'
                                scala:
                                  type: string
                                  example: '2.12'
                                spark:
                                  type: string
                                  example: 3.x
                                runtime_version:
                                  type: string
                                  example: Spark-3.3.2-scala2.12
                            advanced_configurations:
                              type: object
                              properties:
                                is_active:
                                  type: boolean
                                  example: true
                                key:
                                  type: string
                                  example: test
                                value:
                                  type: string
                                  example: test_value
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: custom_regression_template_%%templ%%
                      pattern: ^[a-z0-9A-Z_-]+$
                    compute_engine:
                      type: string
                      example: emr
                    launch_strategy:
                      type: string
                      example: persistent
                    compute_configuration:
                      type: object
                      properties:
                        runtime_configuration:
                          type: object
                          properties:
                            engine_type:
                              type: string
                              example: spark
                            staging_bucket_name:
                              type: string
                              example: tmp-emr
                            cluster_subnet_id:
                              type: string
                              example: subnet-060f04d20161fdc50
                            cluster_vpc:
                              type: string
                              example: vpc-09c1213e9c26d87bf
                            ssh_key:
                              type: string
                              example: dev
                            driver_node_type:
                              type: string
                              example: m4.large
                            runtime_version:
                              type: string
                              example: 5.32.0
                            idle_termination_timeout:
                              type: integer
                              example: 120
                            allow_zero_workers:
                              type: boolean
                              example: true
                            enable_security_configuration:
                              type: boolean
                              example: true
                            security_configuration:
                              type: object
                              properties:
                                enable_kerberos:
                                  type: boolean
                                  example: true
                                security_configuration_name:
                                  type: string
                                  example: emr-kerberos-dedicated
                                kerberos:
                                  type: object
                                  properties:
                                    realm:
                                      type: string
                                      example: infoworks.io
                                    kdc_admin_password:
                                      type: string
                                      example: IN11**rk
                        connection_configuration:
                          type: object
                          properties:
                            region:
                              type: string
                              example: us-east-1
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: custom_regression_template_%%templ%%
                      pattern: ^[a-z0-9A-Z_-]+$
                    compute_engine:
                      type: string
                      example: emr
                    launch_strategy:
                      type: string
                      example: persistent
                    compute_configuration:
                      type: object
                      properties:
                        runtime_configuration:
                          type: object
                          properties:
                            engine_type:
                              type: string
                              example: spark
                            staging_bucket_name:
                              type: string
                              example: tmp-emr
                            cluster_subnet_id:
                              type: string
                              example: subnet-060f04d20161fdc50
                            cluster_vpc:
                              type: string
                              example: vpc-09c1213e9c26d87bf
                            ssh_key:
                              type: string
                              example: dev
                            driver_node_type:
                              type: string
                              example: m4.large
                            runtime_version:
                              type: string
                              example: 5.32.0
                            idle_termination_timeout:
                              type: integer
                              example: 120
                            allow_zero_workers:
                              type: boolean
                              example: true
                            enable_security_configuration:
                              type: boolean
                              example: true
                            security_configuration:
                              type: object
                              properties:
                                enable_kerberos:
                                  type: boolean
                                  example: true
                                security_configuration_name:
                                  type: string
                                  example: emr-kerberos-dedicated
                                kerberos:
                                  type: object
                                  properties:
                                    realm:
                                      type: string
                                      example: infoworks.io
                                    kdc_admin_password:
                                      type: string
                                      example: IN11**rk
                            use_custom_instance_role:
                              type: boolean
                              example: true
                            instance_account:
                              type: string
                              example: EMR_EC2_Default_Role
                        connection_configuration:
                          type: object
                          properties:
                            region:
                              type: string
                              example: us-east-1
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: custom_regression_template_%%templ%%
                      pattern: ^[a-z0-9A-Z_-]+$
                    compute_engine:
                      type: string
                      example: emr
                    launch_strategy:
                      type: string
                      example: persistent
                    compute_configuration:
                      type: object
                      properties:
                        runtime_configuration:
                          type: object
                          properties:
                            engine_type:
                              type: string
                              example: spark
                            staging_bucket_name:
                              type: string
                              example: tmp-emr
                            cluster_subnet_id:
                              type: string
                              example: subnet-060f04d20161fdc50
                            cluster_vpc:
                              type: string
                              example: vpc-09c1213e9c26d87bf
                            ssh_key:
                              type: string
                              example: dev
                            max_allowed_workers:
                              type: integer
                              example: 5
                            num_worker_nodes:
                              type: integer
                              example: 4
                            worker_node_type:
                              type: string
                              example: m4.large
                            driver_node_type:
                              type: string
                              example: m4.large
                            runtime_version:
                              type: string
                              example: 5.32.0
                            idle_termination_timeout:
                              type: integer
                              example: 120
                            enable_security_configuration:
                              type: boolean
                              example: true
                            security_configuration:
                              type: object
                              properties:
                                enable_kerberos:
                                  type: boolean
                                  example: true
                                security_configuration_name:
                                  type: string
                                  example: emr-kerberos-dedicated
                                kerberos:
                                  type: object
                                  properties:
                                    realm:
                                      type: string
                                      example: infoworks.io
                                    kdc_admin_password:
                                      type: string
                                      example: IN11**rk
                        connection_configuration:
                          type: object
                          properties:
                            region:
                              type: string
                              example: us-east-1
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: custom_regression_template_%%templ%%
                      pattern: ^[a-z0-9A-Z_-]+$
                    compute_engine:
                      type: string
                      example: dataproc
                    launch_strategy:
                      type: string
                      example: persistent
                    compute_configuration:
                      type: object
                      properties:
                        runtime_configuration:
                          type: object
                          properties:
                            engine_type:
                              type: string
                              example: spark
                            staging_bucket:
                              type: string
                              example: gs://staging-bucket-xxx
                            temp_bucket:
                              type: string
                              example: gs://temp-bucket-xxx
                            cluster_subnetwork:
                              type: string
                              example: >-
                                https://www.googleapis.com/compute/v1/projects/iw-gcp-eng-host/regions/us-central1/subnetworks/gcp-eng-host-vpc-1-subnet-2
                            worker_node_type:
                              type: string
                              example: n2-standard-4
                            driver_node_type:
                              type: string
                              example: n2-standard-4
                            num_worker_nodes:
                              type: integer
                              example: 4
                            max_allowed_workers:
                              type: integer
                              example: 6
                            runtime_version:
                              type: string
                              example: '1.5'
                            idle_termination_timeout:
                              type: integer
                              example: 120
                        connection_configuration:
                          type: object
                          properties:
                            region:
                              type: string
                              example: us-central1
                            project_id:
                              type: string
                              example: <project_id>
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: custom_regression_template_%%templ%%
                      pattern: ^[a-z0-9A-Z_-]+$
                    compute_engine:
                      type: string
                      example: dataproc
                    launch_strategy:
                      type: string
                      example: persistent
                    compute_configuration:
                      type: object
                      properties:
                        runtime_configuration:
                          type: object
                          properties:
                            engine_type:
                              type: string
                              example: spark
                            runtime_version:
                              type: string
                              example: '1.5'
                            staging_bucket:
                              type: string
                              example: gs://staging-bucket-xxx
                            temp_bucket:
                              type: string
                              example: gs://temp-bucket-xxx
                            cluster_subnetwork:
                              type: string
                              example: >-
                                https://www.googleapis.com/compute/v1/projects/iw-gcp-eng-host/regions/us-central1/subnetworks/gcp-eng-host-vpc-1-subnet-2
                            driver_node_type:
                              type: string
                              example: n2-standard-4
                            allow_zero_workers:
                              type: boolean
                              example: true
                            idle_termination_timeout:
                              type: integer
                              example: 120
                        connection_configuration:
                          type: object
                          properties:
                            region:
                              type: string
                              example: us-central1
                            project_id:
                              type: string
                              example: ''
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: custom_regression_template_restapi_test
                      pattern: ^[a-z0-9A-Z_-]+$
                    compute_engine:
                      type: string
                      example: dataprocInteractive
                    launch_strategy:
                      type: string
                      example: persistent
                    compute_configuration:
                      type: object
                      properties:
                        runtime_configuration:
                          type: object
                          properties:
                            engine_type:
                              type: string
                              example: spark
                            runtime_version:
                              type: string
                              example: '1.5'
                            staging_bucket:
                              type: string
                              example: gs://staging-bucket-xxx
                            temp_bucket:
                              type: string
                              example: gs://temp-bucket-xxx
                            cluster_subnetwork:
                              type: string
                              example: >-
                                https://www.googleapis.com/compute/v1/projects/iw-gcp-eng-host/regions/us-central1/subnetworks/gcp-eng-host-vpc-1-subnet-2
                            driver_node_type:
                              type: string
                              example: n2-standard-4
                            allow_zero_workers:
                              type: boolean
                              example: true
                            idle_termination_timeout:
                              type: integer
                              example: 120
                        connection_configuration:
                          type: object
                          properties:
                            region:
                              type: string
                              example: us-central1
                            project_id:
                              type: string
                              example: test
                - type: object
                  properties:
                    description:
                      type: string
                      example: ''
                    name:
                      type: string
                      example: databricks_unity_with_autoscale1
                      pattern: ^[a-z0-9A-Z_-]+$
                    compute_engine:
                      type: string
                      example: databricks
                    launch_strategy:
                      type: string
                      example: ephemeral
                    compute_configuration:
                      type: object
                      properties:
                        runtime_configuration:
                          type: object
                          properties:
                            engine_type:
                              type: string
                              example: spark
                            worker_node_type:
                              type: string
                              example: n2-standard-4
                            driver_node_type:
                              type: string
                              example: n2-standard-4
                            max_allowed_workers:
                              type: integer
                              example: 6
                            runtime_version:
                              type: string
                              example: '14.3'
                            enable_autoscale:
                              type: boolean
                              example: true
                            autoscale:
                              type: object
                              properties:
                                min_worker_nodes:
                                  type: integer
                                  example: 2
                                max_worker_nodes:
                                  type: integer
                                  example: 5
                            enable_secondary_worker:
                              type: boolean
                              example: true
                            secondary_worker_config:
                              type: object
                              properties:
                                secondary_worker_type:
                                  type: integer
                                  example: 2
                                min_secondary_worker_nodes:
                                  type: integer
                                  example: 2
                                max_secondary_worker_nodes:
                                  type: integer
                                  example: 3
                                secondary_node_type:
                                  type: string
                                  example: n1-standard-4
                            advanced_configurations:
                              type: object
                              properties:
                                is_active:
                                  type: boolean
                                  example: true
                                key:
                                  type: string
                                  example: test
                                value:
                                  type: string
                                  example: test_value
                            ml_workflow_supported:
                              type: boolean
                              example: true
                            data_security_mode:
                              type: string
                              enum:
                                - SINGLE_USER
                                - USER_ISOLATION
                              example: USER_ISOLATION
                            policy_id:
                              type: string
                              example: <policy_id>
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Successfully created a environment compute.
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 5f9708117758f33f8b013824
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/environment/{environment_id}/environment-interactive-clusters/{environment_interactive_clusters_id}:
    parameters:
      - name: environment_id
        in: path
        required: true
        schema:
          type: string
      - name: environment_interactive_clusters_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: EnvironmentInteractiveClusterId
      tags:
        - Environment
      summary: Get persistent computes for environment by id
      description: Get persistent computes for environment by id
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                  - properties:
                      result:
                        type: object
                        allOf:
                          - type: object
                            properties:
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          - properties:
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              description:
                                type: string
                              environment_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              name:
                                type: string
                                example: del
                              compute_engine:
                                type: string
                                example: databricks
                              launch_strategy:
                                type: string
                                example: ephemeral
                          - properties:
                              compute_configuration:
                                properties:
                                  runtime_configuration:
                                    allOf:
                                      - properties:
                                          cluster_mode:
                                            type: string
                                            example: standard
                                          engine_type:
                                            type: string
                                            example: spark
                                          max_allowed_workers:
                                            type: integer
                                            example: 2
                                          idle_termination_timeout:
                                            type: integer
                                            example: 120
                                          worker_node_type:
                                            type: string
                                            example: Standard_NC24
                                          driver_node_type:
                                            type: string
                                            example: Standard_NC24
                                          runtime_version_properties:
                                            type: object
                                            properties:
                                              runtime_version:
                                                type: string
                                                example: 9.1
                                  connection_configuration:
                                    properties:
                                      region:
                                        type: string
                                        example: eastus2
                                      token:
                                        oneOf:
                                          - type: string
                                          - type: object
                                            required:
                                              - password_type
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - infoworks_managed
                                                  - service_authentication
                                                  - secret_store
                                              service_auth_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                              secret_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                              password:
                                                type: string
                                      workspace_url:
                                        type: string
                                        example: standard
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/environment/{environment_id}/accessible-domains:
    parameters:
      - name: environment_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: EnvironmentAccessibleDomains
      tags:
        - Environment
      summary: >-
        Get the accessible domains present within an environment accessible by a
        user
      description: >-
        Get the accessible domains present within an environment accessible by a
        user
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 1774ec9fc0c66e9823c2e58a
                          name:
                            type: string
                            example: Domain Name
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/environment/{environment_id}/environment-clusters:
    parameters:
      - name: environment_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Environment
      summary: Gets all environment clusters.
      description: Gets all environment clusters.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                description:
                                  type: string
                                environment_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                name:
                                  type: string
                                  example: del
                                compute_engine:
                                  type: string
                                  example: databricks
                                launch_strategy:
                                  type: string
                                  example: ephemeral
                            - properties:
                                compute_configuration:
                                  properties:
                                    runtime_configuration:
                                      allOf:
                                        - properties:
                                            cluster_mode:
                                              type: string
                                              example: standard
                                            engine_type:
                                              type: string
                                              example: spark
                                            max_allowed_workers:
                                              type: integer
                                              example: 2
                                            idle_termination_timeout:
                                              type: integer
                                              example: 120
                                            worker_node_type:
                                              type: string
                                              example: Standard_NC24
                                            driver_node_type:
                                              type: string
                                              example: Standard_NC24
                                            runtime_version_properties:
                                              type: object
                                              properties:
                                                runtime_version:
                                                  type: string
                                                  example: 9.1
                                    connection_configuration:
                                      properties:
                                        region:
                                          type: string
                                          example: eastus2
                                        token:
                                          oneOf:
                                            - type: string
                                            - type: object
                                              required:
                                                - password_type
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - infoworks_managed
                                                    - service_authentication
                                                    - secret_store
                                                service_auth_id:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                                secret_id:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                                password:
                                                  type: string
                                        workspace_url:
                                          type: string
                                          example: standard
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/self:
    get:
      operationId: GetSelf
      tags:
        - Self
      summary: Get the self details
      description: Get the self details
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                  - properties:
                      result:
                        type: object
                        allOf:
                          - type: object
                            properties:
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          - properties:
                              profile:
                                allOf:
                                  - type: object
                                    properties:
                                      name:
                                        type: string
                                        example: DF_SQLIMPORT
                                  - properties:
                                      email:
                                        type: string
                                        example: xxx@infoworks.io
                                  - properties:
                                      needs_password_reset:
                                        type: boolean
                                        example: false
                                      is_slack:
                                        type: boolean
                                        example: false
                                      medium:
                                        properties:
                                          slack_details:
                                            type: object
                              emails:
                                type: array
                                items:
                                  properties:
                                    address:
                                      type: string
                                      example: xxx@infoworks.io
                              roles:
                                type: array
                                items:
                                  type: string
                                  example: analyst
                              auth_token:
                                type: string
                                example: ksvfvb***
                              status:
                                type: object
                                properties:
                                  is_idle:
                                    type: boolean
                                    example: false
                                  is_online:
                                    type: boolean
                                    example: true
                                  last_login_details:
                                    properties:
                                      date:
                                        type: string
                                        example: '2019-11-21T12:54:05.875Z'
                                      ip_address:
                                        type: string
                                        example: 10.12.43.23
                                      user_agent:
                                        type: string
                                        example: Mozilla/****
                          - properties:
                              accessible_domains:
                                type: array
                                items:
                                  type: string
                                  example: ffb38b0cc595cfcd05c54e49
                          - properties:
                              heartbeat:
                                type: string
                                example: '2019-11-21T12:54:05.875Z'
                              failed_logins:
                                type: array
                                items:
                                  example: null
                              created_at:
                                type: string
                                example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/audit/job-hooks/global:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
    get:
      security:
        - BearerAuth: []
      tags:
        - Job Hooks
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      summary: Get Global Audit Job Hooks List
      description: Get Global Audit Job Hooks List
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: List of Job Hooks.
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 2ece3a493ee726793b2c3fcd
                        extension_id:
                          type: string
                          example: 2ece3a493ee726793b2c3fcd
                        modifiedAt:
                          type: string
                          example: '2022-09-28T09:10:34.860Z'
                        modifiedBy:
                          type: string
                          example: 6RkfybTRQQByEey3v
                        action:
                          type: string
                          example: create
                        audit_details:
                          type: object
                          properties:
                            sub_action:
                              type: string
                            name:
                              type: string
                            new_name:
                              type: string
                            old_name:
                              type: string
                            new_type:
                              type: string
                            old_type:
                              type: string
                        new_Configurations:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 6fb069238f33b86d4262dcdc
                            execution_type:
                              type: string
                              example: PYTHON
                            name:
                              type: string
                              example: test
                            parameters:
                              type: string
                              example: ''
                            fail_job_if_hook_fails:
                              type: boolean
                              example: true
                            executable_file_name:
                              type: string
                              example: test.py
                            file_details:
                              type: array
                              items:
                                type: object
                                properties:
                                  file_name:
                                    type: string
                                    example: terajdbc4.jar
                                  file_path:
                                    type: string
                                    example: >-
                                      /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                                  file_size:
                                    type: integer
                                    example: 963400
                                  uploaded_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                                  last_modified:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                            environment_variables_conf:
                              type: array
                              items:
                                type: object
                                required:
                                  - name
                                  - config_type
                                properties:
                                  name:
                                    type: string
                                    example: RDBMS_PASSWORD
                                  config_type:
                                    type: string
                                    example: KEYVAULT
                                    enum:
                                      - KEYVAULT
                                      - ADMIN
                                  config_name:
                                    type: string
                                    example: iw_admin_conf
                                  secret_id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                        old_Configurations:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 6fb069238f33b86d4262dcdc
                            execution_type:
                              type: string
                              example: PYTHON
                            name:
                              type: string
                              example: test
                            parameters:
                              type: string
                              example: ''
                            fail_job_if_hook_fails:
                              type: boolean
                              example: true
                            executable_file_name:
                              type: string
                              example: test.py
                            file_details:
                              type: array
                              items:
                                type: object
                                properties:
                                  file_name:
                                    type: string
                                    example: terajdbc4.jar
                                  file_path:
                                    type: string
                                    example: >-
                                      /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                                  file_size:
                                    type: integer
                                    example: 963400
                                  uploaded_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                                  last_modified:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                            environment_variables_conf:
                              type: array
                              items:
                                type: object
                                required:
                                  - name
                                  - config_type
                                properties:
                                  name:
                                    type: string
                                    example: RDBMS_PASSWORD
                                  config_type:
                                    type: string
                                    example: KEYVAULT
                                    enum:
                                      - KEYVAULT
                                      - ADMIN
                                  config_name:
                                    type: string
                                    example: iw_admin_conf
                                  secret_id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                        username:
                          type: string
                          example: Admin
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/audit/job-hooks/{extension_id}:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: extension_id
        in: path
        description: Audit Extension Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Job Hooks
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      summary: Get Audit Job Hooks List
      description: Get Audit Job Hooks List
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: List of Job Hooks.
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 2ece3a493ee726793b2c3fcd
                        extension_id:
                          type: string
                          example: 2ece3a493ee726793b2c3fcd
                        modifiedAt:
                          type: string
                          example: '2022-09-28T09:10:34.860Z'
                        modifiedBy:
                          type: string
                          example: 6RkfybTRQQByEey3v
                        action:
                          type: string
                          example: create
                        audit_details:
                          type: object
                          properties:
                            sub_action:
                              type: string
                            name:
                              type: string
                            new_name:
                              type: string
                            old_name:
                              type: string
                            new_type:
                              type: string
                            old_type:
                              type: string
                        new_Configurations:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 1e4b221a10e1a64e4a429e10
                            name:
                              type: string
                              example: test
                            type:
                              type: string
                              example: generic_jdbc
                            execution_type:
                              type: string
                              example: JAVA
                              enum:
                                - JAVA
                                - PYTHON
                            supported_execution_engines:
                              type: array
                              items:
                                type: string
                                enum:
                                  - HIVE
                                  - SPARK
                                  - IMPALA
                            path:
                              type: string
                              example: /opt/infoworks/drivers
                            upload_option:
                              type: string
                              enum:
                                - fileUpload
                                - serverLocation
                              example: fileUpload
                            file_details:
                              type: array
                              items:
                                type: object
                                properties:
                                  file_name:
                                    type: string
                                    example: terajdbc4.jar
                                  file_path:
                                    type: string
                                    example: >-
                                      /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                                  file_size:
                                    type: integer
                                    example: 963400
                                  uploaded_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                                  last_modified:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                            transformations:
                              type: array
                              items:
                                type: object
                                required:
                                  - alias
                                  - class_name
                                properties:
                                  alias:
                                    type: string
                                    example: test
                                  class_name:
                                    type: string
                                    example: transform
                            additional_config_parameters:
                              type: array
                              items:
                                type: object
                                required:
                                  - name
                                  - config_type
                                properties:
                                  name:
                                    type: string
                                    example: RDBMS_PASSWORD
                                  config_type:
                                    type: string
                                    example: KEYVAULT
                                    enum:
                                      - KEYVAULT
                                      - ADMIN
                                  config_name:
                                    type: string
                                    example: iw_admin_conf
                                  secret_id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                        old_Configurations:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 1e4b221a10e1a64e4a429e10
                            name:
                              type: string
                              example: test
                            type:
                              type: string
                              example: generic_jdbc
                            execution_type:
                              type: string
                              example: JAVA
                              enum:
                                - JAVA
                                - PYTHON
                            supported_execution_engines:
                              type: array
                              items:
                                type: string
                                enum:
                                  - HIVE
                                  - SPARK
                                  - IMPALA
                            path:
                              type: string
                              example: /opt/infoworks/drivers
                            upload_option:
                              type: string
                              enum:
                                - fileUpload
                                - serverLocation
                              example: fileUpload
                            file_details:
                              type: array
                              items:
                                type: object
                                properties:
                                  file_name:
                                    type: string
                                    example: terajdbc4.jar
                                  file_path:
                                    type: string
                                    example: >-
                                      /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                                  file_size:
                                    type: integer
                                    example: 963400
                                  uploaded_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                                  last_modified:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                            transformations:
                              type: array
                              items:
                                type: object
                                required:
                                  - alias
                                  - class_name
                                properties:
                                  alias:
                                    type: string
                                    example: test
                                  class_name:
                                    type: string
                                    example: transform
                            additional_config_parameters:
                              type: array
                              items:
                                type: object
                                required:
                                  - name
                                  - config_type
                                properties:
                                  name:
                                    type: string
                                    example: RDBMS_PASSWORD
                                  config_type:
                                    type: string
                                    example: KEYVAULT
                                    enum:
                                      - KEYVAULT
                                      - ADMIN
                                  config_name:
                                    type: string
                                    example: iw_admin_conf
                                  secret_id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                        username:
                          type: string
                          example: Admin
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/audit/pipeline-extensions/global:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
    get:
      security:
        - BearerAuth: []
      tags:
        - Job Hooks
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      summary: Get Global Audit Pipeline Extension List
      description: Get Global Audit Pipeline Extension List
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: List of Job Hooks.
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 2ece3a493ee726793b2c3fcd
                        extension_id:
                          type: string
                          example: 2ece3a493ee726793b2c3fcd
                        modifiedAt:
                          type: string
                          example: '2022-09-28T09:10:34.860Z'
                        modifiedBy:
                          type: string
                          example: 6RkfybTRQQByEey3v
                        action:
                          type: string
                          example: create
                        audit_details:
                          type: object
                          properties:
                            sub_action:
                              type: string
                            name:
                              type: string
                            new_name:
                              type: string
                            old_name:
                              type: string
                            new_type:
                              type: string
                            old_type:
                              type: string
                        new_Configurations:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 1e4b221a10e1a64e4a429e10
                            name:
                              type: string
                              example: test
                            type:
                              type: string
                              example: generic_jdbc
                            execution_type:
                              type: string
                              example: JAVA
                              enum:
                                - JAVA
                                - PYTHON
                            supported_execution_engines:
                              type: array
                              items:
                                type: string
                                enum:
                                  - HIVE
                                  - SPARK
                                  - IMPALA
                            path:
                              type: string
                              example: /opt/infoworks/drivers
                            upload_option:
                              type: string
                              enum:
                                - fileUpload
                                - serverLocation
                              example: fileUpload
                            file_details:
                              type: array
                              items:
                                type: object
                                properties:
                                  file_name:
                                    type: string
                                    example: terajdbc4.jar
                                  file_path:
                                    type: string
                                    example: >-
                                      /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                                  file_size:
                                    type: integer
                                    example: 963400
                                  uploaded_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                                  last_modified:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                            transformations:
                              type: array
                              items:
                                type: object
                                required:
                                  - alias
                                  - class_name
                                properties:
                                  alias:
                                    type: string
                                    example: test
                                  class_name:
                                    type: string
                                    example: transform
                            additional_config_parameters:
                              type: array
                              items:
                                type: object
                                required:
                                  - name
                                  - config_type
                                properties:
                                  name:
                                    type: string
                                    example: RDBMS_PASSWORD
                                  config_type:
                                    type: string
                                    example: KEYVAULT
                                    enum:
                                      - KEYVAULT
                                      - ADMIN
                                  config_name:
                                    type: string
                                    example: iw_admin_conf
                                  secret_id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                        old_Configurations:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 1e4b221a10e1a64e4a429e10
                            name:
                              type: string
                              example: test
                            type:
                              type: string
                              example: generic_jdbc
                            execution_type:
                              type: string
                              example: JAVA
                              enum:
                                - JAVA
                                - PYTHON
                            supported_execution_engines:
                              type: array
                              items:
                                type: string
                                enum:
                                  - HIVE
                                  - SPARK
                                  - IMPALA
                            path:
                              type: string
                              example: /opt/infoworks/drivers
                            upload_option:
                              type: string
                              enum:
                                - fileUpload
                                - serverLocation
                              example: fileUpload
                            file_details:
                              type: array
                              items:
                                type: object
                                properties:
                                  file_name:
                                    type: string
                                    example: terajdbc4.jar
                                  file_path:
                                    type: string
                                    example: >-
                                      /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                                  file_size:
                                    type: integer
                                    example: 963400
                                  uploaded_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                                  last_modified:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                            transformations:
                              type: array
                              items:
                                type: object
                                required:
                                  - alias
                                  - class_name
                                properties:
                                  alias:
                                    type: string
                                    example: test
                                  class_name:
                                    type: string
                                    example: transform
                            additional_config_parameters:
                              type: array
                              items:
                                type: object
                                required:
                                  - name
                                  - config_type
                                properties:
                                  name:
                                    type: string
                                    example: RDBMS_PASSWORD
                                  config_type:
                                    type: string
                                    example: KEYVAULT
                                    enum:
                                      - KEYVAULT
                                      - ADMIN
                                  config_name:
                                    type: string
                                    example: iw_admin_conf
                                  secret_id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                        username:
                          type: string
                          example: Admin
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/audit/pipeline-extensions/{extension_id}:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: extension_id
        in: path
        description: Audit Extension Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Job Hooks
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      summary: Get Audit Pipeline Extension List
      description: Get Audit Pipeline Extension List
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: List of Job Hooks.
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 2ece3a493ee726793b2c3fcd
                        extension_id:
                          type: string
                          example: 2ece3a493ee726793b2c3fcd
                        modifiedAt:
                          type: string
                          example: '2022-09-28T09:10:34.860Z'
                        modifiedBy:
                          type: string
                          example: 6RkfybTRQQByEey3v
                        action:
                          type: string
                          example: create
                        audit_details:
                          type: object
                          properties:
                            sub_action:
                              type: string
                            name:
                              type: string
                            new_name:
                              type: string
                            old_name:
                              type: string
                            new_type:
                              type: string
                            old_type:
                              type: string
                        new_Configurations:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 6fb069238f33b86d4262dcdc
                            execution_type:
                              type: string
                              example: PYTHON
                            name:
                              type: string
                              example: test
                            parameters:
                              type: string
                              example: ''
                            fail_job_if_hook_fails:
                              type: boolean
                              example: true
                            executable_file_name:
                              type: string
                              example: test.py
                            file_details:
                              type: array
                              items:
                                type: object
                                properties:
                                  file_name:
                                    type: string
                                    example: terajdbc4.jar
                                  file_path:
                                    type: string
                                    example: >-
                                      /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                                  file_size:
                                    type: integer
                                    example: 963400
                                  uploaded_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                                  last_modified:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                            environment_variables_conf:
                              type: array
                              items:
                                type: object
                                required:
                                  - name
                                  - config_type
                                properties:
                                  name:
                                    type: string
                                    example: RDBMS_PASSWORD
                                  config_type:
                                    type: string
                                    example: KEYVAULT
                                    enum:
                                      - KEYVAULT
                                      - ADMIN
                                  config_name:
                                    type: string
                                    example: iw_admin_conf
                                  secret_id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                        old_Configurations:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 6fb069238f33b86d4262dcdc
                            execution_type:
                              type: string
                              example: PYTHON
                            name:
                              type: string
                              example: test
                            parameters:
                              type: string
                              example: ''
                            fail_job_if_hook_fails:
                              type: boolean
                              example: true
                            executable_file_name:
                              type: string
                              example: test.py
                            file_details:
                              type: array
                              items:
                                type: object
                                properties:
                                  file_name:
                                    type: string
                                    example: terajdbc4.jar
                                  file_path:
                                    type: string
                                    example: >-
                                      /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                                  file_size:
                                    type: integer
                                    example: 963400
                                  uploaded_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                                  last_modified:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                            environment_variables_conf:
                              type: array
                              items:
                                type: object
                                required:
                                  - name
                                  - config_type
                                properties:
                                  name:
                                    type: string
                                    example: RDBMS_PASSWORD
                                  config_type:
                                    type: string
                                    example: KEYVAULT
                                    enum:
                                      - KEYVAULT
                                      - ADMIN
                                  config_name:
                                    type: string
                                    example: iw_admin_conf
                                  secret_id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                        username:
                          type: string
                          example: Admin
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/audit/source-extensions/global:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
    get:
      security:
        - BearerAuth: []
      tags:
        - Job Hooks
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      summary: Get Global Audit Source Extension List
      description: Get Global Audit Source Extension List
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: List of Job Hooks.
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 2ece3a493ee726793b2c3fcd
                        extension_id:
                          type: string
                          example: 2ece3a493ee726793b2c3fcd
                        modifiedAt:
                          type: string
                          example: '2022-09-28T09:10:34.860Z'
                        modifiedBy:
                          type: string
                          example: 6RkfybTRQQByEey3v
                        action:
                          type: string
                          example: create
                        audit_details:
                          type: object
                          properties:
                            sub_action:
                              type: string
                            name:
                              type: string
                            new_name:
                              type: string
                            old_name:
                              type: string
                            new_type:
                              type: string
                            old_type:
                              type: string
                        new_Configurations:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 1e4b221a10e1a64e4a429e10
                            name:
                              type: string
                              example: test
                            upload_option:
                              type: string
                              enum:
                                - fileUpload
                                - serverLocation
                              example: fileUpload
                            extension_type:
                              type: string
                              example: Custom
                              enum:
                                - Hive_UDF
                                - Custom
                            execution_type:
                              type: string
                              example: JAVA
                              enum:
                                - JAVA
                            server_path:
                              type: string
                              example: /opt/infoworks/drivers
                            file_details:
                              type: array
                              items:
                                type: object
                                properties:
                                  file_name:
                                    type: string
                                    example: terajdbc4.jar
                                  file_path:
                                    type: string
                                    example: >-
                                      /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                                  file_size:
                                    type: integer
                                    example: 963400
                                  uploaded_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                                  last_modified:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                            transformations:
                              type: array
                              items:
                                type: object
                                required:
                                  - alias
                                properties:
                                  alias:
                                    type: string
                                    example: test
                                  class_name:
                                    type: string
                                    example: transform
                                  additional_params_count:
                                    type: number
                                    example: 3
                                  params_details:
                                    type: array
                                    items:
                                      type: object
                            registered_udf:
                              type: boolean
                              example: true
                            ingestion_extension_type:
                              type: string
                              example: source_extension
                              enum:
                                - source_extension
                                - streaming_extension
                        old_Configurations:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 1e4b221a10e1a64e4a429e10
                            name:
                              type: string
                              example: test
                            upload_option:
                              type: string
                              enum:
                                - fileUpload
                                - serverLocation
                              example: fileUpload
                            extension_type:
                              type: string
                              example: Custom
                              enum:
                                - Hive_UDF
                                - Custom
                            execution_type:
                              type: string
                              example: JAVA
                              enum:
                                - JAVA
                            server_path:
                              type: string
                              example: /opt/infoworks/drivers
                            file_details:
                              type: array
                              items:
                                type: object
                                properties:
                                  file_name:
                                    type: string
                                    example: terajdbc4.jar
                                  file_path:
                                    type: string
                                    example: >-
                                      /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                                  file_size:
                                    type: integer
                                    example: 963400
                                  uploaded_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                                  last_modified:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                            transformations:
                              type: array
                              items:
                                type: object
                                required:
                                  - alias
                                properties:
                                  alias:
                                    type: string
                                    example: test
                                  class_name:
                                    type: string
                                    example: transform
                                  additional_params_count:
                                    type: number
                                    example: 3
                                  params_details:
                                    type: array
                                    items:
                                      type: object
                            registered_udf:
                              type: boolean
                              example: true
                            ingestion_extension_type:
                              type: string
                              example: source_extension
                              enum:
                                - source_extension
                                - streaming_extension
                        username:
                          type: string
                          example: Admin
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/audit/source-extensions/{extension_id}:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: extension_id
        in: path
        description: Audit Extension Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Job Hooks
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      summary: Get Audit Source Extension List
      description: Get Audit Source Extension List
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: List of Job Hooks.
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 2ece3a493ee726793b2c3fcd
                        extension_id:
                          type: string
                          example: 2ece3a493ee726793b2c3fcd
                        modifiedAt:
                          type: string
                          example: '2022-09-28T09:10:34.860Z'
                        modifiedBy:
                          type: string
                          example: 6RkfybTRQQByEey3v
                        action:
                          type: string
                          example: create
                        audit_details:
                          type: object
                          properties:
                            sub_action:
                              type: string
                            name:
                              type: string
                            new_name:
                              type: string
                            old_name:
                              type: string
                            new_type:
                              type: string
                            old_type:
                              type: string
                        new_Configurations:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 1e4b221a10e1a64e4a429e10
                            name:
                              type: string
                              example: test
                            upload_option:
                              type: string
                              enum:
                                - fileUpload
                                - serverLocation
                              example: fileUpload
                            extension_type:
                              type: string
                              example: Custom
                              enum:
                                - Hive_UDF
                                - Custom
                            execution_type:
                              type: string
                              example: JAVA
                              enum:
                                - JAVA
                            server_path:
                              type: string
                              example: /opt/infoworks/drivers
                            file_details:
                              type: array
                              items:
                                type: object
                                properties:
                                  file_name:
                                    type: string
                                    example: terajdbc4.jar
                                  file_path:
                                    type: string
                                    example: >-
                                      /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                                  file_size:
                                    type: integer
                                    example: 963400
                                  uploaded_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                                  last_modified:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                            transformations:
                              type: array
                              items:
                                type: object
                                required:
                                  - alias
                                properties:
                                  alias:
                                    type: string
                                    example: test
                                  class_name:
                                    type: string
                                    example: transform
                                  additional_params_count:
                                    type: number
                                    example: 3
                                  params_details:
                                    type: array
                                    items:
                                      type: object
                            registered_udf:
                              type: boolean
                              example: true
                            ingestion_extension_type:
                              type: string
                              example: source_extension
                              enum:
                                - source_extension
                                - streaming_extension
                        old_Configurations:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 1e4b221a10e1a64e4a429e10
                            name:
                              type: string
                              example: test
                            upload_option:
                              type: string
                              enum:
                                - fileUpload
                                - serverLocation
                              example: fileUpload
                            extension_type:
                              type: string
                              example: Custom
                              enum:
                                - Hive_UDF
                                - Custom
                            execution_type:
                              type: string
                              example: JAVA
                              enum:
                                - JAVA
                            server_path:
                              type: string
                              example: /opt/infoworks/drivers
                            file_details:
                              type: array
                              items:
                                type: object
                                properties:
                                  file_name:
                                    type: string
                                    example: terajdbc4.jar
                                  file_path:
                                    type: string
                                    example: >-
                                      /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                                  file_size:
                                    type: integer
                                    example: 963400
                                  uploaded_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                                  last_modified:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                            transformations:
                              type: array
                              items:
                                type: object
                                required:
                                  - alias
                                properties:
                                  alias:
                                    type: string
                                    example: test
                                  class_name:
                                    type: string
                                    example: transform
                                  additional_params_count:
                                    type: number
                                    example: 3
                                  params_details:
                                    type: array
                                    items:
                                      type: object
                            registered_udf:
                              type: boolean
                              example: true
                            ingestion_extension_type:
                              type: string
                              example: source_extension
                              enum:
                                - source_extension
                                - streaming_extension
                        username:
                          type: string
                          example: Admin
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/domains:
    get:
      security:
        - BearerAuth: []
      operationId: getDomains
      tags:
        - Domains
      summary: Get List of Domains
      description: Get List of Domains
      parameters:
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - allOf:
                                - type: object
                                  properties:
                                    name:
                                      type: string
                                      example: DF_SQLIMPORT
                                - type: object
                                  properties:
                                    description:
                                      type: string
                                      example: Example Domain
                                - type: object
                                  properties:
                                    secrets:
                                      type: array
                                      items:
                                        type: string
                                        example: 8247ad34f124512e
                                - properties:
                                    environment_ids:
                                      type: array
                                      items:
                                        type: string
                                        example: 8247ad34f124512e
                                    users:
                                      type: array
                                      items:
                                        type: string
                                        example: 8247ad34f124512e
                            - type: object
                              allOf:
                                - type: object
                                  properties:
                                    created_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    created_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                                - type: object
                                  properties:
                                    modified_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    modified_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                            - type: object
                              properties:
                                accessibleDomains:
                                  type: array
                                  items:
                                    type: string
                                    example: 3456234456cde12e
                            - type: object
                              properties:
                                accessiblePipelineExtensions:
                                  type: array
                                  items:
                                    type: string
                                    example: 7b606a6c4bc0688a99cc5f07
                            - type: object
                              properties:
                                environment:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: 63cd71df9f1c1e258c6e991b
                                    name:
                                      type: string
                                      example: env_azure
                                    compute_engine:
                                      type: string
                                      example: spark
                                    platform:
                                      type: string
                                      example: databricks
                                ephemeral_compute:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                        example: ephemeral_compute
                                      environment_id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                interactive_compute:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                        example: interactive_compute
                                      environment_id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                storage:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      name:
                                        type: string
                                        example: storage
                                      environment_id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      description:
                                        type: string
                                        example: description for storage
                                      storage_type:
                                        type: string
                                        example: gcs
                                      storage_authentication:
                                        type: object
                                        properties:
                                          authentication_mechanism:
                                            type: string
                                            example: environment_service_credential
                                          scheme:
                                            type: string
                                            example: gs://
                                          bucket_name:
                                            type: string
                                            example: temp-bucket-xxx
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/pipelines:
    get:
      security:
        - BearerAuth: []
      operationId: getPipelinesOfAllDomains
      tags:
        - Pipelines
      summary: Get all pipelines of all domains
      description: Get all pipelines of all domains
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: ffb38b0cc595cfcd05c54e49
                                name:
                                  type: string
                                  example: test_pipeline
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/pipeline-groups:
    get:
      security:
        - BearerAuth: []
      operationId: getPipelineGroupsOfAllDomains
      tags:
        - Pipeline Groups
      summary: Get all pipeline groups
      description: Get all pipeline groups
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: ffb38b0cc595cfcd05c54e49
                                name:
                                  type: string
                                  example: test_pipeline_group
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/schedules:
    get:
      security:
        - BearerAuth: []
      operationId: getSchedules
      tags:
        - Admin Schedules
      summary: Get details of all running schedules.
      description: Get details of all running schedules.
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        items:
                          oneOf:
                            - type: object
                              properties:
                                entity_id:
                                  type: string
                                  example: 6eb9ba185b428ceecff98ac4
                                entity_name:
                                  type: string
                                  example: workflow1
                                schedule_type:
                                  type: string
                                  example: workflow-build
                                schedule_username:
                                  type: string
                                  example: admin@infoworks.io
                                created_by_name:
                                  type: string
                                  example: Admin
                                schedule_details:
                                  type: object
                                  properties:
                                    schedule_status:
                                      type: string
                                      example: enabled
                                    repeat_interval_unit:
                                      type: string
                                      example: DAY
                                    repeat_interval_measure:
                                      type: number
                                      example: 1
                                    start_date:
                                      type: number
                                      example: 03/13/2023
                                    ends:
                                      type: boolean
                                      example: true
                                    start_hour:
                                      type: number
                                      example: 7
                                    start_min:
                                      type: number
                                      example: 21
                                    end_hour:
                                      type: number
                                      example: 23
                                    end_min:
                                      type: number
                                      example: 59
                                    is_custom_job:
                                      type: boolean
                                      example: false
                                    specified_days:
                                      type: array
                                      items:
                                        type: string
                                is_refresh_token_expired:
                                  type: boolean
                                  example: true
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/environment/cluster/compute-template/{compute_template_id}:
    parameters:
      - name: compute_template_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Environment Cluster
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      summary: Get Persistent Cluster Status
      description: Get Persistent Cluster Status
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                      result:
                        type: object
                        properties:
                          message:
                            type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/environment/cluster/{environment_id}:
    parameters:
      - name: environment_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Environment Cluster
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      summary: Get Environment Status
      description: Get Environment Status
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      message:
                        type: string
                      result:
                        type: object
                        properties:
                          message:
                            type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/environment/cluster/service/stop:
    post:
      security:
        - BearerAuth: []
      operationId: persistent cluster stop
      tags:
        - Environment Cluster
      summary: Stop the persistent cluster
      description: Stop  the persistent cluster
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    compute_template_id:
                      type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                      result:
                        type: object
                        properties:
                          message:
                            type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/environment/cluster/terminate-async:
    put:
      security:
        - BearerAuth: []
      operationId: terminate stop
      tags:
        - Environment Cluster
      summary: Terminate the persistent cluster
      description: Terminate  the persistent cluster
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    compute_template_id:
                      type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                      result:
                        type: object
                        properties:
                          message:
                            type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/environment/cluster/restart:
    put:
      security:
        - BearerAuth: []
      operationId: cluster restart
      tags:
        - Environment Cluster
      summary: Restart the cluster
      description: Restart the  cluster
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    compute_template_id:
                      type: string
                    type:
                      type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                      result:
                        type: object
                        properties:
                          message:
                            type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/environment/cluster/stop:
    put:
      security:
        - BearerAuth: []
      operationId: cluster stop
      tags:
        - Environment Cluster
      summary: Stop the cluster
      description: Stop  the cluster
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    compute_template_id:
                      type: string
                    type:
                      type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                      result:
                        type: object
                        properties:
                          message:
                            type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/environment/cluster/:
    post:
      security:
        - BearerAuth: []
      operationId: cluster create
      tags:
        - Environment Cluster
      summary: Create the cluster
      description: Create  the  cluster
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    compute_template_id:
                      type: string
                    type:
                      type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                      result:
                        type: object
                        properties:
                          message:
                            type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/custom-audit-columns/{custom_audit_column_id}:
    parameters:
      - name: custom_audit_column_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getCustomAuditColumn
      tags:
        - Custom Audit Columns
      summary: Get the Custom Audit Column
      description: Get the Custom Audit Column
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        allOf:
                          - type: object
                            properties:
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          - type: object
                            properties:
                              column_name:
                                type: string
                              description:
                                type: string
                              entity_type:
                                type: string
                                example: pipeline
                              function:
                                type: string
                                example: $pipelineId
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      operationId: patchCustomAuditColumn
      tags:
        - Custom Audit Columns
      summary: Patch the Custom Audit Column
      description: Patch the Custom Audit Column
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                column_name:
                  type: string
                description:
                  type: string
                entity_type:
                  type: string
                  example: pipeline
                function:
                  type: string
                  example: $pipelineId
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      operationId: deleteCustomAuditColumn
      tags:
        - Custom Audit Columns
      summary: Delete the Custom Audit Column
      description: Delete the Custom Audit Column
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/custom-audit-columns:
    get:
      security:
        - BearerAuth: []
      tags:
        - Custom Audit Columns
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      summary: Get Custom Audit Columns
      description: Get Custom Audit Columns
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - type: object
                              properties:
                                column_name:
                                  type: string
                                description:
                                  type: string
                                entity_type:
                                  type: string
                                  example: pipeline
                                function:
                                  type: string
                                  example: $pipelineId
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: createCustomAuditColumn
      tags:
        - Custom Audit Columns
      summary: Create Custom Audit Column
      description: Create Custom Audit Column
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                column_name:
                  type: string
                description:
                  type: string
                entity_type:
                  type: string
                  example: pipeline
                function:
                  type: string
                  example: $pipelineId
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/domains/{domain_id}/accessible-sources-to-add:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: Domain Accessible Sources
      tags:
        - Domains
      summary: Get List of Domains
      description: Get List of Domains
      parameters:
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              created_at:
                                type: string
                              created_by:
                                type: string
                              source_name:
                                type: string
                              environment_details:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    environment:
                                      type: object
                                      properties:
                                        id:
                                          type: string
                                        name:
                                          type: string
                                        compute_engine:
                                          type: string
                                        platform:
                                          type: string
                                    ephemeral_computes:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          name:
                                            type: string
                                          environment_id:
                                            type: string
                                          id:
                                            type: string
                                    interactive_computes:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          name:
                                            type: string
                                          environment_id:
                                            type: string
                                          id:
                                            type: string
                                    storage:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          id:
                                            type: string
                                          name:
                                            type: string
                                          environment_id:
                                            type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/custom-audit-column/audits:
    get:
      security:
        - BearerAuth: []
      tags:
        - Custom Audit Columns
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      summary: Get Custom Audit Column Audits
      description: Get Custom Audit Columns Audits
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - properties:
                      result:
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - type: object
                              properties:
                                action:
                                  type: string
                                  example: create
                                old_configurations:
                                  type: object
                                  properties:
                                    column_name:
                                      type: string
                                    description:
                                      type: string
                                    entity_type:
                                      type: string
                                    function:
                                      type: string
                                new_configurations:
                                  type: object
                                  properties:
                                    column_name:
                                      type: string
                                    description:
                                      type: string
                                    entity_type:
                                      type: string
                                    function:
                                      type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/domains/{domain_id}/domain-users:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: Domain Users
      tags:
        - Domains
      summary: Get List of Domains Users
      description: Get List of Domains Users
      parameters:
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - properties:
                      result:
                        items:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: sEKaHnrAAEx9P5YkM
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/domains/{domain_id}/accessible-domains-to-add:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: Domain Accessible
      tags:
        - Domains
      summary: Get List of Accessible Domains
      description: Get List of Accessible Domains
      parameters:
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              created_at:
                                type: string
                              created_by:
                                type: string
                              domain_name:
                                type: string
                              created_by_name:
                                type: string
                              description:
                                type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/domains/{domain_id}/accessible-pipeline-extensions-to-add:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: Domain Pipeline Extensions
      tags:
        - Domains
      summary: Get List of Domains Pipeline Extensions
      description: Get List of Domains Pipeline Extensions
      parameters:
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              pipeline_extension_name:
                                type: string
                              extension_type:
                                type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/clear-cache:
    post:
      security:
        - BearerAuth: []
      tags:
        - Clear Cache
      summary: To clear Admin cache
      description: To clear Admin cache
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  example: adbc@gmail.com
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/custom-tags:
    post:
      security:
        - BearerAuth: []
      operationId: createCustomTag
      tags:
        - Custom Tags
      summary: Add Custom tags
      description: Custom tags
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                key:
                  type: string
                  example: key
                value:
                  type: string
                  example: value
                description:
                  type: string
                  example: description
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 66f1133eebd0454c9d600d67
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    get:
      security:
        - BearerAuth: []
      operationId: getCustomTags
      tags:
        - Custom Tags
      summary: Get List of Custom Tags
      description: Get List of Custom Tags
      parameters:
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            result:
                              type: object
                              properties:
                                key:
                                  type: string
                                  example: key
                                value:
                                  type: string
                                  example: value
                                description:
                                  type: string
                                  example: description
                                created_by:
                                  type: string
                                  example: 6RkfybTRQQByEey3v
                                created_at:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
                                modified_by:
                                  type: string
                                  example: 6RkfybTRQQByEey3v
                                modified_at:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/custom-tags/{custom_tag_id}:
    parameters:
      - name: custom_tag_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getCustomTag
      tags:
        - Custom Tags
      summary: Get custom tags
      description: Get custom tags
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          result:
                            type: object
                            properties:
                              key:
                                type: string
                                example: key
                              value:
                                type: string
                                example: value
                              description:
                                type: string
                                example: description
                              created_by:
                                type: string
                                example: 6RkfybTRQQByEey3v
                              created_at:
                                type: string
                                example: '2019-11-21T12:54:05.875Z'
                              modified_by:
                                type: string
                                example: 6RkfybTRQQByEey3v
                              modified_at:
                                type: string
                                example: '2019-11-21T12:54:05.875Z'
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      operationId: updateCustomTag
      tags:
        - Custom Tags
      summary: Update Custom tags
      description: Custom tags
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                value:
                  type: string
                  example: value
                description:
                  type: string
                  example: description
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 66f1133eebd0454c9d600d67
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      operationId: deleteCustomTag
      tags:
        - Custom Tags
      summary: Update Custom tags
      description: Custom tags
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 66f1133eebd0454c9d600d67
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/job-status-metrics:
    get:
      parameters:
        - name: created_at_window
          in: query
          description: Job run in last some hours.
          required: false
          schema:
            type: integer
            format: int32
            default: 24
        - name: count
          in: query
          description: Number of last jobs to make a query to return.
          required: false
          schema:
            type: integer
            format: int32
            default: 50
        - name: status
          in: query
          description: Comma-separated list of job statuses to filter by.
          required: false
          schema:
            type: string
            enum:
              - running
              - blocked
              - pending
              - completed
              - failed
              - canceled
      security:
        - BearerAuth: []
      operationId: getJobStatusMetrics
      tags:
        - Metrics
      summary: Get Job Status Metrics
      description: Get Job Status Metrics
      responses:
        '200':
          description: Successful response with job status metrics.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      job_status_metrics:
                        type: array
                        items:
                          type: object
                          properties:
                            count:
                              type: integer
                              description: Number of jobs in the given status
                            status:
                              type: string
                              description: Job status (e.g., canceled, completed, failed)
                            average_run_time:
                              type: integer
                              description: Average runtime of jobs in milliseconds
                            longest_run_time:
                              type: integer
                              description: Longest runtime of a job in milliseconds
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /sources/{source_id}/table-groups:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    post:
      security:
        - BearerAuth: []
      tags:
        - Table Groups
      summary: Add a `Table Group`.
      description: Add a `Table Group`.
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    id:
                      type: string
                      example: e77850ad5127a2d7dab870ff
                - type: object
                  properties:
                    source:
                      type: string
                      example: e77850ad5127a2d7dab870ff
                    environment_compute_template:
                      properties:
                        environment_compute_template_id:
                          type: string
                          example: e77850ad5127a2d7dab870ff
                    name:
                      type: string
                    max_connections:
                      type: integer
                      example: 1
                    max_parallel_entities:
                      type: integer
                      example: 1
                    tables:
                      type: array
                      items:
                        properties:
                          table_id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                          connection_quota:
                            type: integer
                            example: 100
                          sync_type:
                            type: string
                            example: Incremental
                          state:
                            type: string
                            example: ready
                          schema_name_at_source:
                            type: string
                            example: APEX_040000
                    compute_cluster_name:
                      type: string
                      example: Persistent Cluster
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Table Group Successfully Created
                      result:
                        properties:
                          id:
                            type: string
                            example: c70822c5a88e5521a8153c7c
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    get:
      security:
        - BearerAuth: []
      tags:
        - Table Groups
      summary: Gets `Table Group` list.
      description: Gets `Table Group` list.
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: resolve_ref
          in: query
          description: To get entity details and created by user name
          schema:
            type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - allOf:
                                - type: object
                                  properties:
                                    id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                - type: object
                                  properties:
                                    source:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    environment_compute_template:
                                      properties:
                                        environment_compute_template_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                    name:
                                      type: string
                                    max_connections:
                                      type: integer
                                      example: 1
                                    max_parallel_entities:
                                      type: integer
                                      example: 1
                                    tables:
                                      type: array
                                      items:
                                        properties:
                                          table_id:
                                            type: string
                                            example: e77850ad5127a2d7dab870ff
                                          connection_quota:
                                            type: integer
                                            example: 100
                                          sync_type:
                                            type: string
                                            example: Incremental
                                          state:
                                            type: string
                                            example: ready
                                          schema_name_at_source:
                                            type: string
                                            example: APEX_040000
                                    compute_cluster_name:
                                      type: string
                                      example: Persistent Cluster
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/table-groups/{table_group_id}:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: table_group_id
        in: path
        description: Table Group Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Table Groups
      summary: Gets `Table Group` object for given id.
      description: Gets `Table Group` object for given id.
      parameters:
        - name: resolve_ref
          in: query
          description: To get entity details and created by user name
          schema:
            type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - allOf:
                      - type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                      - type: object
                        properties:
                          source:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                          environment_compute_template:
                            properties:
                              environment_compute_template_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          name:
                            type: string
                          max_connections:
                            type: integer
                            example: 1
                          max_parallel_entities:
                            type: integer
                            example: 1
                          tables:
                            type: array
                            items:
                              properties:
                                table_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                connection_quota:
                                  type: integer
                                  example: 100
                                sync_type:
                                  type: string
                                  example: Incremental
                                state:
                                  type: string
                                  example: ready
                                schema_name_at_source:
                                  type: string
                                  example: APEX_040000
                          compute_cluster_name:
                            type: string
                            example: Persistent Cluster
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    put:
      security:
        - BearerAuth: []
      tags:
        - Table Groups
      summary: Update `Table Group` object for given id.
      description: Update `Table Group` object for given id.
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    environment_compute_template:
                      properties:
                        environment_compute_template_id:
                          type: string
                          example: e77850ad5127a2d7dab870ff
                    name:
                      type: string
                    max_connections:
                      type: integer
                      example: 1
                    max_parallel_entities:
                      type: integer
                      example: 1
                    query_tag:
                      type: string
                      example: table_group_tag
                    tables:
                      type: array
                      items:
                        properties:
                          table_id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                          connection_quota:
                            type: integer
                            example: 100
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully updated table group
                      result:
                        properties:
                          id:
                            type: string
                            example: c70822c5a88e5521a8153c7c
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    delete:
      security:
        - BearerAuth: []
      tags:
        - Table Groups
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: Table Group Successfully Created
                  result:
                    properties:
                      id:
                        type: string
                        example: c70822c5a88e5521a8153c7c
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/configurations/file-mapping:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
    post:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Creates the file mapping (table) of the csv source.
      description: >-
        Creates the previously configured file mapping (table) of the csv
        source.
      operationId: createFileMappingForTable
      requestBody:
        description: This is the JSON body of request containing configured Table object.
        content:
          application/json:
            schema:
              type: object
              properties:
                header_rows_count:
                  type: integer
                  format: int64
                column_separator:
                  type: string
                column_enclosed_by:
                  type: string
                escape_character:
                  type: string
                encoding:
                  type: string
                enable_pk_chunk:
                  type: boolean
                record_width_type:
                  type: string
                record_separator:
                  type: string
                columns_configuration:
                  type: array
                  items:
                    allOf:
                      - allOf:
                          - type: object
                            properties:
                              column_width:
                                type: integer
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      status:
                        type: string
                        example: success
                      id:
                        type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    put:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Modifies the file mapping (table) of the csv source.
      description: >-
        Modifies the previously configured file mapping (table) of the csv
        source.
      operationId: modifyFileMappingForTable
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                header_rows_count:
                  type: integer
                  format: int64
                column_separator:
                  type: string
                column_enclosed_by:
                  type: string
                escape_character:
                  type: string
                encoding:
                  type: string
                enable_pk_chunk:
                  type: boolean
                record_width_type:
                  type: string
                record_separator:
                  type: string
                columns_configuration:
                  type: array
                  items:
                    allOf:
                      - allOf:
                          - type: object
                            properties:
                              column_width:
                                type: integer
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      status:
                        type: string
                        example: success
                      id:
                        type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    patch:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Updates the file mapping (table) of the csv source.
      description: >-
        Updates the previously configured file mapping (table) of the csv
        source.
      operationId: updateFileMappingForTable
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                header_rows_count:
                  type: integer
                  format: int64
                column_separator:
                  type: string
                column_enclosed_by:
                  type: string
                escape_character:
                  type: string
                encoding:
                  type: string
                enable_pk_chunk:
                  type: boolean
                record_width_type:
                  type: string
                record_separator:
                  type: string
                columns_configuration:
                  type: array
                  items:
                    allOf:
                      - allOf:
                          - type: object
                            properties:
                              column_width:
                                type: integer
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      status:
                        type: string
                        example: success
                      id:
                        type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/table-groups/{table_group_id}/configurations:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: table_group_id
        in: path
        description: Table Group Id
        required: true
        schema:
          type: string
    post:
      security:
        - BearerAuth: []
      tags:
        - Table Groups
      summary: This will Configure particular `Table Group` with `tableGroupId`.
      description: This will Configure particular `Table Group` with `tableGroupId`.
      requestBody:
        description: >-
          This is the JSON body of request containing configured Table group
          object.
        content:
          application/json:
            schema:
              type: object
              properties:
                tables:
                  type: array
                  items:
                    type: object
                    properties:
                      table_id:
                        type: string
                      connection_quota:
                        type: integer
                        example: 15
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      status:
                        type: string
                        example: success
                      id:
                        type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/table-groups/{table_group_id}/audit-logs:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: table_group_id
        in: path
        description: Table Group Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Table Groups
      summary: This will fetch array of audit logs for table group with `tableGroupId`.
      description: This will fetch array of audit logs for table group with `tableGroupId`.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - type: object
                              properties:
                                entity_type:
                                  type: string
                                  example: table_group
                            - type: object
                              properties:
                                entity_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - properties:
                                modification:
                                  type: string
                                  example: Changed connection type to tpt from jdbc
                            - type: object
                              properties:
                                modified_at:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
                            - type: object
                              properties:
                                modified_by:
                                  type: string
                                  example: 6RkfybTRQQByEey3v
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/table-groups/{table_group_id}/schedules:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: table_group_id
        in: path
        description: Table Group Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Table Group Schedule
      operationId: getTableGroupSchedule
      summary: Get Table Group Schedule
      description: Retrieves the table group schedule.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      entity_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      schedule_type:
                        type: string
                        enum:
                          - workflow-build
                          - metadata_cleanup
                          - mongo-backup
                          - table-group-cdc
                          - table
                      schedule_username:
                        type: string
                        example: admin@infoworks.io
                      schedule_details:
                        allOf:
                          - oneOf:
                              - type: object
                                title: Generic Schedule
                                description: Generic schedule object
                                required:
                                  - schedule_status
                                properties:
                                  schedule_status:
                                    type: string
                                    enum:
                                      - enabled
                                      - disabled
                                    example: enabled
                                  start_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: Start time should be after current time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  start_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 14
                                  start_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 35
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - NEVER
                                      - MINUTE
                                      - HOUR
                                      - DAY
                                      - WEEK
                                      - MONTH
                                    default: NEVER
                                    example: MONTH
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                  repeat_on_last_day:
                                    type: boolean
                                    description: >
                                      `specified_days` must be provided if
                                      `repeat_on_last_day` is false. Applicable
                                      for `repeat_interval_unit=MONTH`
                                    default: false
                                  specified_days:
                                    type: array
                                    description: >
                                      Applicable when `repeat_interval_unit` is
                                      `WEEK` or `MONTH`.
                                    minLength: 1
                                    items:
                                      type: integer
                                      minimum: 0
                                      maximum: 31
                                    example:
                                      - 1
                                      - 17
                                      - 31
                                  ends:
                                    type: boolean
                                    description: >
                                      `end_date`, `end_hour`, `end_min` must be
                                      provided if `ends` is `true`.
                                    default: false
                                    example: true
                                  end_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: End time should be after start time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  end_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 15
                                  end_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 38
                                  is_custom_job:
                                    type: boolean
                                    description: >
                                      `custom_job_details` must be provided when
                                      `is_custom_job=true`. Applicable when
                                      `repeat_interval_unit` is `DAY`, `WEEK` or
                                      `MONTH`.
                                    default: false
                                  custom_job_details:
                                    type: object
                                    required:
                                      - starts_daily_at
                                      - ends_daily_at
                                      - repeat_interval_measure
                                      - repeat_interval_unit
                                    properties:
                                      starts_daily_at:
                                        pattern: ^{0-23}:[0-59]$
                                        type: string
                                        example: '12:40'
                                      ends_daily_at:
                                        pattern: ^{0-23}:[0-59]$
                                        type: string
                                        example: '17:45'
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                        example: 10
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                          - MINUTE
                                          - HOUR
                              - type: object
                                title: By Minute Schedule
                                description: Schedule job by minutes
                                required:
                                  - schedule_status
                                  - start_date
                                  - start_hour
                                  - start_min
                                  - repeat_interval_unit
                                  - repeat_interval_measure
                                properties:
                                  schedule_status:
                                    type: string
                                    enum:
                                      - enabled
                                    example: enabled
                                  start_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: Start time should be after current time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  start_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 14
                                  start_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 35
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - MINUTE
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                  ends:
                                    type: boolean
                                    description: >
                                      `end_date`, `end_hour`, `end_min` must be
                                      provided if `ends` is `true`.
                                    default: false
                                    example: true
                                  end_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: End time should be after start time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  end_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 15
                                  end_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 55
                              - type: object
                                title: Hourly Schedule
                                description: Schedule job hourly
                                required:
                                  - schedule_status
                                  - start_date
                                  - start_hour
                                  - start_min
                                  - repeat_interval_unit
                                  - repeat_interval_measure
                                properties:
                                  schedule_status:
                                    type: string
                                    enum:
                                      - enabled
                                    example: enabled
                                  start_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: Start time should be after current time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  start_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 14
                                  start_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 35
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - HOUR
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                  ends:
                                    type: boolean
                                    description: >
                                      `end_date`, `end_hour`, `end_min` must be
                                      provided if `ends` is `true`.
                                    default: false
                                    example: true
                                  end_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: End time should be after start time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  end_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 15
                                  end_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 55
                              - type: object
                                title: Daily Schedule
                                description: Schedule job daily
                                required:
                                  - schedule_status
                                  - start_date
                                  - start_hour
                                  - start_min
                                  - repeat_interval_unit
                                  - repeat_interval_measure
                                properties:
                                  schedule_status:
                                    type: string
                                    enum:
                                      - enabled
                                    example: enabled
                                  start_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: Start time should be after current time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  start_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 14
                                  start_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 35
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - DAY
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                  ends:
                                    type: boolean
                                    description: >
                                      `end_date`, `end_hour`, `end_min` must be
                                      provided if `ends` is `true`.
                                    default: false
                                    example: true
                                  end_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: End time should be after start time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  end_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 15
                                  end_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 55
                                  is_custom_job:
                                    type: boolean
                                    description: >
                                      `custom_job_details` must be provided when
                                      `is_custom_job=true`
                                    default: false
                                    example: true
                                  custom_job_details:
                                    type: object
                                    required:
                                      - starts_daily_at
                                      - ends_daily_at
                                      - repeat_interval_measure
                                      - repeat_interval_unit
                                    properties:
                                      starts_daily_at:
                                        pattern: ^{0-23}:[0-59]$
                                        type: string
                                        example: '12:40'
                                      ends_daily_at:
                                        pattern: ^{0-23}:[0-59]$
                                        type: string
                                        example: '17:45'
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                        example: 10
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                          - MINUTE
                                          - HOUR
                              - type: object
                                title: Weekly Schedule
                                description: Schedule job weekly
                                required:
                                  - schedule_status
                                  - start_date
                                  - start_hour
                                  - start_min
                                  - repeat_interval_unit
                                  - repeat_interval_measure
                                  - specified_days
                                properties:
                                  schedule_status:
                                    type: string
                                    enum:
                                      - enabled
                                    example: enabled
                                  start_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: Start time should be after current time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  start_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 14
                                  start_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 35
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - WEEK
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                  specified_days:
                                    type: array
                                    minLength: 1
                                    items:
                                      type: integer
                                      minimum: 0
                                      maximum: 6
                                    example:
                                      - 0
                                      - 2
                                      - 5
                                  ends:
                                    type: boolean
                                    description: >
                                      `end_date`, `end_hour`, `end_min` must be
                                      provided if `ends` is `true`.
                                    default: false
                                    example: true
                                  end_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: End time should be after start time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  end_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 15
                                  end_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 55
                                  is_custom_job:
                                    type: boolean
                                    description: >
                                      `custom_job_details` must be provided when
                                      `is_custom_job=true`
                                    default: false
                                    example: true
                                  custom_job_details:
                                    type: object
                                    required:
                                      - starts_daily_at
                                      - ends_daily_at
                                      - repeat_interval_measure
                                      - repeat_interval_unit
                                    properties:
                                      starts_daily_at:
                                        pattern: ^{0-23}:[0-59]$
                                        type: string
                                        example: '12:40'
                                      ends_daily_at:
                                        pattern: ^{0-23}:[0-59]$
                                        type: string
                                        example: '17:45'
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                        example: 10
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                          - MINUTE
                                          - HOUR
                              - type: object
                                title: Monthly Schedule
                                description: Schedule job monthly
                                required:
                                  - schedule_status
                                  - start_date
                                  - start_hour
                                  - start_min
                                  - repeat_interval_unit
                                  - repeat_interval_measure
                                properties:
                                  schedule_status:
                                    type: string
                                    enum:
                                      - enabled
                                    example: enabled
                                  start_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: Start time should be after current time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  start_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 14
                                  start_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 35
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - MONTH
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                  repeat_on_last_day:
                                    type: boolean
                                    description: >
                                      `specified_days` must be provided if
                                      `repeat_on_last_day` is false.
                                    default: false
                                  specified_days:
                                    type: array
                                    minLength: 1
                                    items:
                                      type: integer
                                      minimum: 1
                                      maximum: 31
                                    example:
                                      - 1
                                      - 17
                                      - 31
                                  ends:
                                    type: boolean
                                    description: >
                                      `end_date`, `end_hour`, `end_min` must be
                                      provided if `ends` is `true`.
                                    default: false
                                    example: true
                                  end_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: End time should be after start time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  end_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 15
                                  end_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 45
                                  is_custom_job:
                                    type: boolean
                                    description: >
                                      `custom_job_details` must be provided when
                                      `is_custom_job=true`
                                    default: false
                                    example: true
                                  custom_job_details:
                                    type: object
                                    required:
                                      - starts_daily_at
                                      - ends_daily_at
                                      - repeat_interval_measure
                                      - repeat_interval_unit
                                    properties:
                                      starts_daily_at:
                                        pattern: ^{0-23}:[0-59]$
                                        type: string
                                        example: '12:40'
                                      ends_daily_at:
                                        pattern: ^{0-23}:[0-59]$
                                        type: string
                                        example: '17:45'
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                        example: 10
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                          - MINUTE
                                          - HOUR
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/table-groups/{table_group_id}/schedules/enable:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: table_group_id
        in: path
        description: Table Group Id
        required: true
        schema:
          type: string
    put:
      security:
        - BearerAuth: []
      tags:
        - Table Group Schedule
      operationId: enableTableGroupSchedule
      summary: Enable Table Group Schedule
      description: Enables the table group schedule.
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  title: Generic Schedule
                  description: Generic schedule object
                  required:
                    - schedule_status
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                        - disabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - NEVER
                        - MINUTE
                        - HOUR
                        - DAY
                        - WEEK
                        - MONTH
                      default: NEVER
                      example: MONTH
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    repeat_on_last_day:
                      type: boolean
                      description: >
                        `specified_days` must be provided if
                        `repeat_on_last_day` is false. Applicable for
                        `repeat_interval_unit=MONTH`
                      default: false
                    specified_days:
                      type: array
                      description: >
                        Applicable when `repeat_interval_unit` is `WEEK` or
                        `MONTH`.
                      minLength: 1
                      items:
                        type: integer
                        minimum: 0
                        maximum: 31
                      example:
                        - 1
                        - 17
                        - 31
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 38
                    is_custom_job:
                      type: boolean
                      description: >
                        `custom_job_details` must be provided when
                        `is_custom_job=true`. Applicable when
                        `repeat_interval_unit` is `DAY`, `WEEK` or `MONTH`.
                      default: false
                    custom_job_details:
                      type: object
                      required:
                        - starts_daily_at
                        - ends_daily_at
                        - repeat_interval_measure
                        - repeat_interval_unit
                      properties:
                        starts_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '12:40'
                        ends_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '17:45'
                        repeat_interval_measure:
                          type: integer
                          minimum: 1
                          example: 10
                        repeat_interval_unit:
                          type: string
                          enum:
                            - MINUTE
                            - HOUR
                - type: object
                  title: By Minute Schedule
                  description: Schedule job by minutes
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - MINUTE
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 55
                - type: object
                  title: Hourly Schedule
                  description: Schedule job hourly
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - HOUR
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 55
                - type: object
                  title: Daily Schedule
                  description: Schedule job daily
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - DAY
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 55
                    is_custom_job:
                      type: boolean
                      description: >
                        `custom_job_details` must be provided when
                        `is_custom_job=true`
                      default: false
                      example: true
                    custom_job_details:
                      type: object
                      required:
                        - starts_daily_at
                        - ends_daily_at
                        - repeat_interval_measure
                        - repeat_interval_unit
                      properties:
                        starts_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '12:40'
                        ends_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '17:45'
                        repeat_interval_measure:
                          type: integer
                          minimum: 1
                          example: 10
                        repeat_interval_unit:
                          type: string
                          enum:
                            - MINUTE
                            - HOUR
                - type: object
                  title: Weekly Schedule
                  description: Schedule job weekly
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                    - specified_days
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - WEEK
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    specified_days:
                      type: array
                      minLength: 1
                      items:
                        type: integer
                        minimum: 0
                        maximum: 6
                      example:
                        - 0
                        - 2
                        - 5
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 55
                    is_custom_job:
                      type: boolean
                      description: >
                        `custom_job_details` must be provided when
                        `is_custom_job=true`
                      default: false
                      example: true
                    custom_job_details:
                      type: object
                      required:
                        - starts_daily_at
                        - ends_daily_at
                        - repeat_interval_measure
                        - repeat_interval_unit
                      properties:
                        starts_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '12:40'
                        ends_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '17:45'
                        repeat_interval_measure:
                          type: integer
                          minimum: 1
                          example: 10
                        repeat_interval_unit:
                          type: string
                          enum:
                            - MINUTE
                            - HOUR
                - type: object
                  title: Monthly Schedule
                  description: Schedule job monthly
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - MONTH
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    repeat_on_last_day:
                      type: boolean
                      description: >
                        `specified_days` must be provided if
                        `repeat_on_last_day` is false.
                      default: false
                    specified_days:
                      type: array
                      minLength: 1
                      items:
                        type: integer
                        minimum: 1
                        maximum: 31
                      example:
                        - 1
                        - 17
                        - 31
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 45
                    is_custom_job:
                      type: boolean
                      description: >
                        `custom_job_details` must be provided when
                        `is_custom_job=true`
                      default: false
                      example: true
                    custom_job_details:
                      type: object
                      required:
                        - starts_daily_at
                        - ends_daily_at
                        - repeat_interval_measure
                        - repeat_interval_unit
                      properties:
                        starts_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '12:40'
                        ends_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '17:45'
                        repeat_interval_measure:
                          type: integer
                          minimum: 1
                          example: 10
                        repeat_interval_unit:
                          type: string
                          enum:
                            - MINUTE
                            - HOUR
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/table-groups/{table_group_id}/schedules/disable:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: table_group_id
        in: path
        description: Table Group Id
        required: true
        schema:
          type: string
    put:
      security:
        - BearerAuth: []
      tags:
        - Table Group Schedule
      operationId: disableTableGroupSchedule
      summary: Disable Table Group Schedule
      description: Disables the table group schedule.
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/table-groups/{table_group_id}/schedules/user:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: table_group_id
        in: path
        description: Table Group Id
        required: true
        schema:
          type: string
    put:
      security:
        - BearerAuth: []
      tags:
        - Table Group Schedule
      operationId: configureTableGroupScheduleUser
      summary: Configure Table Group Schedule User
      description: Configures the table group schedule user.
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/table/{table_id}/configurations/streaming:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
    put:
      security:
        - BearerAuth: []
      tags:
        - Streaming
      summary: Add/Edit Configuration for streaming options of a table group.
      description: Add/Edit Configuration for streaming options of a table group.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                state:
                  type: string
                  enum:
                    - enabled
                    - disabled
                engine:
                  type: object
                  properties:
                    name:
                      type: string
                      enum:
                        - spark
                    master:
                      type: string
                      enum:
                        - yarn
                        - standalone
                    deploy_mode:
                      type: string
                      enum:
                        - client
                        - cluster
                topic_identifier:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - list
                        - regex
                    value:
                      type: string
                streaming_frequency:
                  type: string
                  enum:
                    - minutes
                    - hours
                    - days
                streaming_value:
                  type: integer
                record_type:
                  type: object
                  properties:
                    name:
                      type: string
                      example: delimited
                    column_separator:
                      type: string
                    column_enclosed_by:
                      type: string
                    escape_character:
                      type: string
                    character_encoding:
                      type: string
                      enum:
                        - utf-8
                        - ascii
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      status:
                        type: string
                        example: success
                      id:
                        type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    get:
      security:
        - BearerAuth: []
      tags:
        - Streaming
      summary: Get streaming configuration of given table.
      description: Get streaming configuration of given table.
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  table_id:
                    type: string
                  status:
                    type: string
                  job_id:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/streaming-tables:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Streaming
      summary: >-
        Get tables for whom streaming configurations are set in a particular
        source.
      description: >-
        Get tables for whom streaming configurations are set in a particular
        source.
      parameters:
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          table_id:
                            type: string
                          status:
                            type: string
                          job_id:
                            type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/streaming-tables/{table_id}:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Streaming
      summary: Get streaming table info.
      description: Get streaming table info.
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  table_id:
                    type: string
                  status:
                    type: string
                  job_id:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/jobs:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Jobs
      summary: Get List of All jobs of this Source and it's artifacts.
      description: Get List of All jobs of this Source and it's artifacts.
      parameters:
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 8714887c9a8c5bb0b8794811
                            build_id:
                              type: integer
                              example: 2
                            name:
                              type: string
                              example: test_job
                            status:
                              type: string
                              enum:
                                - completed
                                - pending
                                - aborted
                                - blocked
                                - failed
                                - running
                                - canceled
                                - succeeded
                              example: completed
                            percentage:
                              type: integer
                              example: 100
                            type:
                              type: string
                              enum:
                                - source_test_connection
                                - fetch_metadata
                                - source_structured_fetch_metadata
                                - source_crawl
                                - source_crawl_chunk_load
                                - source_cdc
                                - source_unstructured_crawl
                                - source_structured_crawl
                                - source_semistructured_crawl
                                - delete_entity
                                - pipeline_metadata
                                - pipeline_build
                                - pipeline_build_restatement
                                - full_load
                                - cdc
                                - source_merge
                                - source_structured_cdc_merge
                                - source_structured_cdc
                                - source_cdc_merge
                                - source_cdc_restatement
                                - source_semistructured_cdc_merge
                                - source_semistructured_cdc
                                - metadata_cleanup_policy
                            entity_id:
                              type: string
                              example: d2f33c1d424363162692b3bf
                            entity_type:
                              type: string
                              enum:
                                - source
                                - pipeline
                                - workflow
                            sub_entity_id:
                              type: string
                              example: be034607444511f74313be63
                            sub_entity_type:
                              type: string
                              example: table_group
                            duration:
                              type: integer
                              example: 349316
                              description: This is duration of the job.
                            cluster_id:
                              type: string
                              example: j-134jnasdkjaasd
                              description: Extenal clusterId
                            compute_id:
                              type: string
                              example: be034607444511f74313be63
                              description: Infoworks compute cluster id
                            compute_name:
                              type: string
                              example: Default_Persistent_cluster
                              description: Infoworks compute name
                            created_at:
                              type: string
                              format: date-time
                              example: '2020-10-05T04:23:30.339Z'
                            created_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                              description: UserId of user who triggered the job.
                            last_updated:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
                            processed_at:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      tags:
        - Jobs
      summary: Initiates jobs for source and its artifacts
      description: >-
        Initiates jobs for source and its artifacts. The job types that can be
        submitted are `export_data`, `streaming_start`, `segmentation_load`,
        `truncate_reload`, `cdc_merge`, `cdc_restatement`, `truncate_table`,
        `source_test_connection`, `source_fetch_metadata`,
        `table_fetch_metadata`.
      operationId: createJobForSource
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              oneOf:
                - title: DeleteEntityJobRequestSchema
                  type: object
                  required:
                    - job_type
                  properties:
                    job_type:
                      type: string
                      enum:
                        - source_delete
                      example: source_delete
                    purge_metadata:
                      type: boolean
                      example: true
                - title: TruncateTableJobRequestSchema
                  type: object
                  required:
                    - job_type
                    - table_ids
                  properties:
                    job_type:
                      type: string
                      enum:
                        - truncate_table
                      example: truncate_table
                    table_ids:
                      type: array
                      items:
                        type: string
                        example: 5f0754885406f51f04a85293
                - title: IngestionJobRequestSchema
                  type: object
                  required:
                    - job_type
                    - job_name
                    - table_ids
                    - compute_template_id
                    - min_worker_nodes
                    - max_worker_nodes
                    - max_parallel_entities
                  properties:
                    job_type:
                      type: string
                      enum:
                        - truncate_reload
                        - cdc_merge
                        - cdc_restatement
                      example: truncate_reload
                    job_name:
                      type: string
                      example: test_job
                      description: required in case job is triggered for tables
                    table_group_id:
                      type: string
                      example: 5f0754885406f51f04a85293
                      description: table_group_id is required if no table_ids are provided
                    table_ids:
                      description: required if no table_group_id is provided
                      type: array
                      items:
                        type: string
                        example: 5f0754885406f51f04a85293
                    max_connections:
                      type: integer
                      example: 7
                    max_parallel_entities:
                      type: integer
                      example: 2
                    cluster_template_id:
                      type: string
                      example: 5f0754885406f51f04a85293
                    interactive_cluster_id:
                      type: string
                      example: 7d3652565406f51e34a85125
                    warehouse:
                      type: string
                      example: DEMO_WH
                    custom_tags:
                      type: string
                      example: tag
                    num_worker_nodes:
                      type: number
                      example: 3
                    min_worker_nodes:
                      type: number
                      example: 2
                    max_worker_nodes:
                      type: number
                      example: 4
                    query_tag:
                      type: string
                      example: querytag
                - title: SourceTestConnectionJobRequestSchema
                  type: object
                  required:
                    - job_type
                  properties:
                    job_type:
                      type: string
                      enum:
                        - source_test_connection
                      example: source_test_connection
                - title: SourceFetchMetadataJobRequestSchema
                  type: object
                  required:
                    - job_type
                    - table_ids
                  properties:
                    job_type:
                      type: string
                      enum:
                        - source_fetch_metadata
                      example: source_fetch_metadata
                    overwrite:
                      type: boolean
                      example: true
                    table_ids:
                      type: array
                      items:
                        type: string
                        example: 5f0754885406f51f04a85293
                - title: TableMetadataCrawlJobForCSVSourceSchema
                  type: object
                  required:
                    - job_type
                    - table_id
                  properties:
                    job_type:
                      type: string
                      enum:
                        - table_fetch_metadata
                      example: table_fetch_metadata
                    table_id:
                      type: string
                      example: 5f0754885406f51f04a85293
                    source_file_properties:
                      type: object
                      properties:
                        header_rows_count:
                          type: integer
                          format: int32
                          example: 1
                        column_separator:
                          type: string
                          example: null
                        column_enclosed_by:
                          type: string
                          example: null
                        escape_character:
                          type: string
                          example: \
                        encoding:
                          type: string
                          example: UTF-8
                        enable_pk_chunk:
                          type: boolean
                          example: true
                        record_width_type:
                          type: string
                          example: UTF-8
                        record_separator:
                          type: string
                          example: ','
                        columns_configurations:
                          type: object
                          properties:
                            column_width:
                              type: number
                              example: 20
                - title: StreamingJobRequestSchema
                  type: object
                  required:
                    - job_type
                    - table_ids
                    - compute_template_id
                    - min_worker_nodes
                    - max_worker_nodes
                  properties:
                    job_type:
                      type: string
                      enum:
                        - streaming_start
                      example: streaming_start
                    table_id:
                      type: string
                      example: 5f0754885406f51f04a85293
                    compute_template_id:
                      type: string
                      example: 5f0754885406f51f04a85293
                    interactive_cluster_id:
                      type: string
                      example: 5f0754885406f51f04a85293
                    warehouse:
                      type: string
                      example: DEMO_WH
                    custom_tags:
                      type: array
                      items:
                        type: string
                        example: tag1
                    num_worker_nodes:
                      type: number
                      example: 3
                    min_worker_nodes:
                      type: number
                      example: 2
                    max_worker_nodes:
                      type: number
                      example: 4
                - title: SegmentationJobRequestSchema
                  type: object
                  required:
                    - job_type
                    - job_name
                    - table_id
                    - compute_template_id
                    - segment_ids
                    - max_connections
                    - max_parallel_entities
                    - min_worker_nodes
                    - max_worker_nodes
                  properties:
                    job_type:
                      type: string
                      enum:
                        - segmentation_load
                      example: segmentation_load
                    job_name:
                      type: string
                      example: test_job
                      description: required in case job is triggered for tables
                    max_connections:
                      type: integer
                      example: 7
                    max_parallel_entities:
                      type: integer
                      example: 2
                    cluster_template_id:
                      type: string
                      example: 5f0754885406f51f04a85293
                    interactive_cluster_id:
                      type: string
                      example: 7d3652565406f51e34a85125
                    warehouse:
                      type: string
                      example: DEMO_WH
                    custom_tags:
                      type: array
                      items:
                        type: string
                        example: tag1
                    num_worker_nodes:
                      type: number
                      example: 3
                    min_worker_nodes:
                      type: number
                      example: 2
                    max_worker_nodes:
                      type: number
                      example: 4
                    table_id:
                      type: string
                      example: 7d3652234406f51f34b42125
                    segment_ids:
                      type: string
                      items:
                        type: string
                        example: 4e3626534412f51f34b42111
                    run_segments_in_single_job:
                      type: boolean
                      example: true
                - title: ExportTableDataJobRequestSchema
                  type: object
                  required:
                    - job_type
                    - job_name
                    - table_ids
                    - num_worker_nodes
                    - compute_template_id
                  properties:
                    job_type:
                      type: string
                      enum:
                        - export_data
                      example: export_data
                    job_name:
                      type: string
                      example: export1
                    compute_template_id:
                      type: string
                      example: 5f0754885406f51f04a85293
                    interactive_cluster_id:
                      type: string
                      example: 5f0754885406f51f04a85293
                    warehouse:
                      type: string
                      example: DEMO_WH
                    custom_tags:
                      type: array
                      items:
                        type: string
                        example: tag1
                    num_worker_nodes:
                      type: number
                      example: 3
                    min_worker_nodes:
                      type: number
                      example: 2
                    max_worker_nodes:
                      type: number
                      example: 4
                - title: SourceCDCRestatementJobRequestSchema
                  type: object
                  required:
                    - job_type
                    - job_name
                    - table_ids
                    - runtime_configurations
                  properties:
                    job_type:
                      type: string
                      enum:
                        - cdc_restatement
                      example: cdc_restatement
                    job_name:
                      type: string
                      example: source_cdc_restatement_job
                    compute_template_id:
                      type: string
                      example: 5f0754885406f51f04a85293
                    interactive_cluster_id:
                      type: string
                      example: 5f0754885406f51f04a85293
                    warehouse:
                      type: string
                      example: DEMO_WH
                    custom_tags:
                      type: array
                      items:
                        type: string
                        example: tag1
                    num_worker_nodes:
                      type: number
                      example: 3
                    min_worker_nodes:
                      type: number
                      example: 2
                    max_worker_nodes:
                      type: number
                      example: 4
                    max_connections:
                      type: integer
                      example: 1
                    max_parallel_entities:
                      type: integer
                      example: 1
                    query_tag:
                      type: string
                      example: table_group_tag
                    runtime_configurations:
                      type: array
                      items:
                        type: object
                        required:
                          - table_id
                          - watermark_lower_limit
                        properties:
                          table_id:
                            type: string
                            example: 5f0754885406f51f04a85293
                          watermark_lower_limit:
                            type: string
                            example: '2024-03-29 06:18:31.79'
                          watermark_upper_limit:
                            type: string
                            default: $(MAX(WATERMARK_COLUMN(S)))
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /sources/{source_id}/stop-streaming:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    post:
      security:
        - BearerAuth: []
      tags:
        - StopStreaming
      summary: Stops the streaming jobs for tables listed in request.
      description: Stops the streaming jobs for tables listed in request.
      operationId: StopStreaming
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              title: StopStreamingJobRequestSchema
              type: object
              required:
                - table_ids
              properties:
                table_ids:
                  description: Table ids for which streaming needs to be stopped
                  type: array
                  items:
                    type: string
                    example: 5f0754885406f51f04a85293
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /sources/{source_id}/jobs/{job_id}:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Jobs
      summary: Get job with job id.
      description: Get job with job id.
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 8714887c9a8c5bb0b8794811
                      build_id:
                        type: integer
                        example: 2
                      name:
                        type: string
                        example: test_job
                      status:
                        type: string
                        enum:
                          - completed
                          - pending
                          - aborted
                          - blocked
                          - failed
                          - running
                          - canceled
                          - succeeded
                        example: completed
                      percentage:
                        type: integer
                        example: 100
                      type:
                        type: string
                        enum:
                          - source_test_connection
                          - fetch_metadata
                          - source_structured_fetch_metadata
                          - source_crawl
                          - source_crawl_chunk_load
                          - source_cdc
                          - source_unstructured_crawl
                          - source_structured_crawl
                          - source_semistructured_crawl
                          - delete_entity
                          - pipeline_metadata
                          - pipeline_build
                          - pipeline_build_restatement
                          - full_load
                          - cdc
                          - source_merge
                          - source_structured_cdc_merge
                          - source_structured_cdc
                          - source_cdc_merge
                          - source_cdc_restatement
                          - source_semistructured_cdc_merge
                          - source_semistructured_cdc
                          - metadata_cleanup_policy
                      entity_id:
                        type: string
                        example: d2f33c1d424363162692b3bf
                      entity_type:
                        type: string
                        enum:
                          - source
                          - pipeline
                          - workflow
                      sub_entity_id:
                        type: string
                        example: be034607444511f74313be63
                      sub_entity_type:
                        type: string
                        example: table_group
                      duration:
                        type: integer
                        example: 349316
                        description: This is duration of the job.
                      cluster_id:
                        type: string
                        example: j-134jnasdkjaasd
                        description: Extenal clusterId
                      compute_id:
                        type: string
                        example: be034607444511f74313be63
                        description: Infoworks compute cluster id
                      compute_name:
                        type: string
                        example: Default_Persistent_cluster
                        description: Infoworks compute name
                      created_at:
                        type: string
                        format: date-time
                        example: '2020-10-05T04:23:30.339Z'
                      created_by:
                        type: string
                        example: 6RkfybTRQQByEey3v
                        description: UserId of user who triggered the job.
                      last_updated:
                        type: string
                        example: '2019-11-21T12:54:05.875Z'
                      processed_at:
                        type: string
                        example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/config-migration:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Configurations
      summary: Exports the source configuration
      description: Exports the source configuration to JSON format.
      operationId: exportSourceConfiguration
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    allOf:
                      - type: object
                        properties:
                          configuration:
                            type: object
                            properties:
                              iw_mappings:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    entity_id:
                                      type: string
                                      example: 8e7b3069f1368c53ed4f08ac
                                    entity_type:
                                      type: string
                                      description: An Infoworks Entity
                                      enum:
                                        - source
                                        - table_group
                                        - table
                                        - workflow
                                        - environment_compute_template
                                    recommendation:
                                      type: object
                                      properties:
                                        source_name:
                                          type: string
                                          example: test_oracle
                              source_configs:
                                type: object
                              entity_configs:
                                type: array
                                items:
                                  type: object
                              table_configs:
                                type: array
                                items:
                                  type: object
                              table_group_configs:
                                type: array
                                items:
                                  type: object
                              entity:
                                type: array
                                items:
                                  type: object
                              file_mappings:
                                type: array
                                items:
                                  type: object
                              topic_mappings:
                                type: array
                                items:
                                  type: object
                              export:
                                type: object
                                properties:
                                  exported_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                                  exported_at:
                                    type: string
                                    example: test_oracle
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    post:
      security:
        - BearerAuth: []
      tags:
        - Configurations
      summary: Imports the source configuration
      description: Imports the source configuration from JSON format.
      operationId: importSourceConfiguration
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    dry_run:
                      type: boolean
                      example: true
                    import_configs:
                      properties:
                        run_pipeline_metadata_build:
                          type: boolean
                          example: false
                        is_pipeline_version_active:
                          type: boolean
                          example: false
                        include_optional_properties:
                          type: boolean
                          example: false
                        import_data_connection:
                          type: boolean
                          example: false
                - type: object
                  properties:
                    configuration:
                      type: object
                      properties:
                        iw_mappings:
                          type: array
                          items:
                            type: object
                            properties:
                              entity_id:
                                type: string
                                example: 8e7b3069f1368c53ed4f08ac
                              entity_type:
                                type: string
                                description: An Infoworks Entity
                                enum:
                                  - source
                                  - table_group
                                  - table
                                  - workflow
                                  - environment_compute_template
                              recommendation:
                                type: object
                                properties:
                                  source_name:
                                    type: string
                                    example: test_oracle
                        source_configs:
                          type: object
                        entity_configs:
                          type: array
                          items:
                            type: object
                        table_configs:
                          type: array
                          items:
                            type: object
                        table_group_configs:
                          type: array
                          items:
                            type: object
                        entity:
                          type: array
                          items:
                            type: object
                        file_mappings:
                          type: array
                          items:
                            type: object
                        topic_mappings:
                          type: array
                          items:
                            type: object
                        export:
                          type: object
                          properties:
                            exported_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                            exported_at:
                              type: string
                              example: test_oracle
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: array
                    items:
                      allOf:
                        - type: object
                          properties:
                            entity_id:
                              type: string
                              example: 8e7b3069f1368c53ed4f08ac
                            entity_type:
                              type: string
                              description: An Infoworks Entity
                              enum:
                                - table
                                - table_group
                                - source
                                - workflow
                                - environment_compute_template
                            recommendation:
                              type: object
                              properties:
                                table_name:
                                  type: string
                                  example: BATCH_BASED
                            to_entity_id:
                              type: string
                              example: 8e7b3069f1368c53ed4f08ac
                            table_upsert_status:
                              type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/jobs/{job_id}/resubmit:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    post:
      security:
        - BearerAuth: []
      tags:
        - Jobs
      summary: Resubmit Failed tables for ingestion
      description: Resubmit Failed tables for ingestion
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      status:
                        type: string
                        example: success
                      id:
                        type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /sources/{source_id}/jobs/{job_id}/summary:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Jobs
      summary: Get crawl job info.
      description: Get crawl job info.
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            message:
                              type: string
                              example: Starting To Execute Job for table abcd
                            timestamp:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/jobs/{job_id}/logs:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Jobs
      summary: Get Summary Logs for the Source Crawl Job.
      description: Get Summary Logs for the Source Crawl Job.
      parameters:
        - in: query
          name: num_lines
          schema:
            type: integer
            example: 50
      responses:
        '200':
          description: Ok.
          content:
            text/plain:
              schema:
                type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/jobs/{job_id}/logs/download:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Jobs
      summary: Get Summary Logs for the Source Crawl Job.
      description: Get Summary Logs for the Source Crawl Job.
      responses:
        '200':
          description: Ok.
          content:
            application/zip:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Sources
      summary: Get list of sources
      description: Get list of sources
      operationId: getSourceList
      parameters:
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: resolve_ref
          in: query
          description: To get entity details and created by user name
          schema:
            type: boolean
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              allOf:
                                - properties:
                                    id:
                                      type: string
                                      example: 354t45656556254564545
                                    name:
                                      type: string
                                      example: sample source
                                    type:
                                      type: string
                                      example: streaming
                                    sub_type:
                                      type: string
                                      example: kafka
                                      enum:
                                        - kafka
                                        - structured
                                        - json
                                        - xml
                                        - unstructured
                                        - teradata
                                        - redshift
                                        - oracle
                                        - mysql
                                        - mariadb
                                        - sqlserver
                                        - db2
                                        - netezza
                                        - saphana
                                        - hive
                                        - sybaseiq
                                        - ignite
                                        - vertica
                                        - maprdb
                                        - mongodb
                                        - rest_generic
                                        - salesforce
                                    data_lake_path:
                                      type: string
                                      example: /iw/kafka-source
                                    use_staging_schema_for_infoworks_managed_tables:
                                      type: boolean
                                      example: true
                                    use_staging_dataset_for_infoworks_managed_tables:
                                      type: boolean
                                      example: true
                                    description:
                                      type: string
                                      example: example description
                                    tags:
                                      type: array
                                      items:
                                        example: c54t456f6d5a2c4564aed
                                    data_lake_schema:
                                      type: string
                                      example: kafka
                                    state:
                                      type: string
                                      example: ready
                                    is_source_ingested:
                                      type: boolean
                                      example: true
                                    is_public:
                                      type: boolean
                                - type: object
                                  allOf:
                                    - type: object
                                      properties:
                                        created_at:
                                          type: string
                                          example: '2019-11-21T12:54:05.875Z'
                                    - type: object
                                      properties:
                                        created_by:
                                          type: string
                                          example: 6RkfybTRQQByEey3v
                                    - type: object
                                      properties:
                                        modified_at:
                                          type: string
                                          example: '2019-11-21T12:54:05.875Z'
                                    - type: object
                                      properties:
                                        modified_by:
                                          type: string
                                          example: 6RkfybTRQQByEey3v
                            - properties:
                                tables:
                                  type: array
                                  items:
                                    type: string
                                    example: c74a5abb4854ac0a70206f00
                            - type: object
                              properties:
                                environment:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: 63cd71df9f1c1e258c6e991b
                                    name:
                                      type: string
                                      example: env_azure
                                    compute_engine:
                                      type: string
                                      example: spark
                                    platform:
                                      type: string
                                      example: databricks
                                ephemeral_compute:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                        example: ephemeral_compute
                                      environment_id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                interactive_compute:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                        example: interactive_compute
                                      environment_id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                storage:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      name:
                                        type: string
                                        example: storage
                                      environment_id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      description:
                                        type: string
                                        example: description for storage
                                      storage_type:
                                        type: string
                                        example: gcs
                                      storage_authentication:
                                        type: object
                                        properties:
                                          authentication_mechanism:
                                            type: string
                                            example: environment_service_credential
                                          scheme:
                                            type: string
                                            example: gs://
                                          bucket_name:
                                            type: string
                                            example: temp-bucket-xxx
                            - type: object
                              properties:
                                environment_id:
                                  type: string
                                  example: 5fda050e7758f32604184d38
                                storage_id:
                                  type: string
                                  example: 5fda050e7758f32604184d38
                                is_generic_jdbc_source_type:
                                  type: boolean
                                  example: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    post:
      security:
        - BearerAuth: []
      tags:
        - Sources
      summary: Create source
      description: Create source
      operationId: createSource
      requestBody:
        description: Source configurations
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    name:
                      type: string
                    environment_id:
                      type: string
                    storage_id:
                      type: string
                    data_lake_schema:
                      type: string
                    data_lake_path:
                      type: string
                    type:
                      type: string
                    is_source_ingested:
                      type: boolean
                    storage:
                      type: string
                    is_public:
                      type: boolean
                    sub_type:
                      type: string
                      enum:
                        - redshift
                        - saphana
                        - sybaseiq
                        - vertica
                        - mongodb
                        - rest_generic
                    is_oem_connector:
                      type: boolean
                    connection:
                      oneOf:
                        - allOf:
                            - type: object
                              required:
                                - source_schema
                                - username
                                - password
                                - database
                              properties:
                                connection_mode:
                                  type: string
                                  example: jdbc
                                  enum:
                                    - jdbc
                                connection_url:
                                  type: string
                                  example: >-
                                    jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                                source_schema:
                                  type: string
                                  example: test_schema
                                username:
                                  type: string
                                  example: Lucifer
                                password:
                                  oneOf:
                                    - type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - infoworks_managed
                                        password:
                                          type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                database:
                                  type: string
                                  example: automation_db
                                snowflake_profile:
                                  type: string
                                  example: profile1
                                warehouse:
                                  type: string
                                  example: DEMO_WH
                            - type: object
                              properties:
                                enable_log_based_cdc:
                                  type: boolean
                                  example: true
                                staging_database:
                                  type: string
                                  example: db_staging
                                enable_dictionary_rebuild_for_each_job:
                                  type: boolean
                                  example: true
                                dictionary_path:
                                  type: string
                                  example: /tmp/dict
                                dictionary_type:
                                  type: string
                                  example: online
                                  enum:
                                    - online
                                    - offline
                                    - redo_log
                        - allOf:
                            - type: object
                              required:
                                - source_schema
                                - username
                                - password
                                - database
                              properties:
                                connection_mode:
                                  type: string
                                  example: jdbc
                                  enum:
                                    - jdbc
                                connection_url:
                                  type: string
                                  example: >-
                                    jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                                source_schema:
                                  type: string
                                  example: test_schema
                                username:
                                  type: string
                                  example: Lucifer
                                password:
                                  oneOf:
                                    - type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - infoworks_managed
                                        password:
                                          type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                database:
                                  type: string
                                  example: automation_db
                                snowflake_profile:
                                  type: string
                                  example: profile1
                                warehouse:
                                  type: string
                                  example: DEMO_WH
                        - allOf:
                            - type: object
                              required:
                                - source_schema
                                - username
                                - password
                                - database
                              properties:
                                connection_mode:
                                  type: string
                                  example: jdbc
                                  enum:
                                    - jdbc
                                connection_url:
                                  type: string
                                  example: >-
                                    jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                                source_schema:
                                  type: string
                                  example: test_schema
                                username:
                                  type: string
                                  example: Lucifer
                                password:
                                  oneOf:
                                    - type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - infoworks_managed
                                        password:
                                          type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                database:
                                  type: string
                                  example: automation_db
                                snowflake_profile:
                                  type: string
                                  example: profile1
                                warehouse:
                                  type: string
                                  example: DEMO_WH
                        - allOf:
                            - type: object
                              required:
                                - source_schema
                                - username
                                - password
                                - database
                              properties:
                                connection_mode:
                                  type: string
                                  example: jdbc
                                  enum:
                                    - jdbc
                                connection_url:
                                  type: string
                                  example: >-
                                    jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                                source_schema:
                                  type: string
                                  example: test_schema
                                username:
                                  type: string
                                  example: Lucifer
                                password:
                                  oneOf:
                                    - type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - infoworks_managed
                                        password:
                                          type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                database:
                                  type: string
                                  example: automation_db
                                snowflake_profile:
                                  type: string
                                  example: profile1
                                warehouse:
                                  type: string
                                  example: DEMO_WH
                            - type: object
                              properties:
                                enable_teradata_wallet:
                                  type: boolean
                                  example: true
                                teradata_wallet_key_used_for_password:
                                  type: string
                                storage:
                                  oneOf:
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                        - type: object
                                          required:
                                            - sftp_host
                                            - sftp_port
                                            - username
                                            - password
                                            - auth_type
                                          properties:
                                            sftp_host:
                                              type: string
                                              example: 192.168.1.1
                                            sftp_port:
                                              type: integer
                                              example: 22
                                            username:
                                              type: string
                                              example: Lucifer
                                            password:
                                              oneOf:
                                                - type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - infoworks_managed
                                                    password:
                                                      type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - secret_store
                                                    secret_id:
                                                      type: string
                                                      example: e77850ad5127a2d7dab870ff
                                            auth_type:
                                              type: string
                                              example: password
                                            credential:
                                              oneOf:
                                                - type: object
                                                  required:
                                                    - type
                                                    - username
                                                    - password
                                                  properties:
                                                    type:
                                                      type: string
                                                      example: basic
                                                    username:
                                                      type: string
                                                      example: sftp-user
                                                    password:
                                                      oneOf:
                                                        - type: string
                                                          minLength: 1
                                                          example:
                                                            - passw@rd_plain
                                                            - >-
                                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                        - type: object
                                                          properties:
                                                            password_type:
                                                              type: string
                                                              enum:
                                                                - infoworks_managed
                                                            password:
                                                              type: string
                                                              minLength: 1
                                                              example:
                                                                - passw@rd_plain
                                                                - >-
                                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                        - type: object
                                                          properties:
                                                            password_type:
                                                              type: string
                                                              enum:
                                                                - secret_store
                                                            secret_id:
                                                              type: string
                                                              example: e77850ad5127a2d7dab870ff
                                                - type: object
                                                  required:
                                                    - type
                                                    - username
                                                    - private_key_path
                                                    - passphrase
                                                  properties:
                                                    type:
                                                      type: string
                                                      example: key
                                                    username:
                                                      type: string
                                                      example: sftp-user
                                                    private_key_path:
                                                      type: string
                                                      example: /opt/infoworks/key
                                                    passphrase:
                                                      type: string
                                                      example: J9moLFp0XjMhsLu
                                    - oneOf:
                                        - allOf:
                                            - type: object
                                              properties:
                                                storage_type:
                                                  type: string
                                                  enum:
                                                    - dbfs
                                                    - remote
                                                    - cloud
                                            - type: object
                                              properties:
                                                cloud_type:
                                                  type: string
                                                  enum:
                                                    - s3
                                                    - wasb
                                                    - gs
                                            - type: object
                                              required:
                                                - type
                                                - base_path
                                                - credential
                                              properties:
                                                account_type:
                                                  type: string
                                                access_id:
                                                  type: string
                                                secret_key:
                                                  oneOf:
                                                    - type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - infoworks_managed
                                                        password:
                                                          type: string
                                                          minLength: 1
                                                          example:
                                                            - passw@rd_plain
                                                            - >-
                                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - secret_store
                                                        secret_id:
                                                          type: string
                                                          example: e77850ad5127a2d7dab870ff
                                                access_type:
                                                  type: string
                                                support_gov_cloud:
                                                  type: boolean
                                                endpoint:
                                                  type: string
                                        - allOf:
                                            - type: object
                                              properties:
                                                storage_type:
                                                  type: string
                                                  enum:
                                                    - dbfs
                                                    - remote
                                                    - cloud
                                            - type: object
                                              properties:
                                                cloud_type:
                                                  type: string
                                                  enum:
                                                    - s3
                                                    - wasb
                                                    - gs
                                            - type: object
                                              properties:
                                                access_type:
                                                  type: string
                                                  example: service_account
                                                  enum:
                                                    - service_account
                                                project_id:
                                                  type: string
                                                  example: csv_store
                                                upload_option:
                                                  type: string
                                                  enum:
                                                    - fileUpload
                                                    - serverLocation
                                                  example: fileUpload
                                                server_path:
                                                  type: string
                                                  description: >-
                                                    required if upload_option is set to
                                                    serverLocation
                                                  example: >-
                                                    /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json
                                        - allOf:
                                            - type: object
                                              properties:
                                                storage_type:
                                                  type: string
                                                  enum:
                                                    - dbfs
                                                    - remote
                                                    - cloud
                                            - type: object
                                              properties:
                                                cloud_type:
                                                  type: string
                                                  enum:
                                                    - s3
                                                    - wasb
                                                    - gs
                                            - type: object
                                              properties:
                                                account_name:
                                                  type: string
                                                account_key:
                                                  oneOf:
                                                    - type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - infoworks_managed
                                                        password:
                                                          type: string
                                                          minLength: 1
                                                          example:
                                                            - passw@rd_plain
                                                            - >-
                                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - secret_store
                                                        secret_id:
                                                          type: string
                                                          example: e77850ad5127a2d7dab870ff
                                                account_endpoint:
                                                  type: string
                                                container_name:
                                                  type: string
                                                support_gov_cloud:
                                                  type: boolean
                                                access_type:
                                                  type: string
                                                  enum:
                                                    - none
                                                    - account_key
                                enable_ingestion_via_tpt:
                                  type: boolean
                                  example: true
                                is_td_wallet_enabled:
                                  type: boolean
                                  example: true
                                enable_tpt_for_source:
                                  type: boolean
                                  example: true
                        - allOf:
                            - type: object
                              required:
                                - source_schema
                                - username
                                - password
                                - database
                              properties:
                                connection_mode:
                                  type: string
                                  example: jdbc
                                  enum:
                                    - jdbc
                                connection_url:
                                  type: string
                                  example: >-
                                    jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                                source_schema:
                                  type: string
                                  example: test_schema
                                username:
                                  type: string
                                  example: Lucifer
                                password:
                                  oneOf:
                                    - type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - infoworks_managed
                                        password:
                                          type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                database:
                                  type: string
                                  example: automation_db
                                snowflake_profile:
                                  type: string
                                  example: profile1
                                warehouse:
                                  type: string
                                  example: DEMO_WH
                        - allOf:
                            - type: object
                              required:
                                - source_schema
                                - username
                                - password
                                - database
                              properties:
                                connection_mode:
                                  type: string
                                  example: jdbc
                                  enum:
                                    - jdbc
                                connection_url:
                                  type: string
                                  example: >-
                                    jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                                source_schema:
                                  type: string
                                  example: test_schema
                                username:
                                  type: string
                                  example: Lucifer
                                password:
                                  oneOf:
                                    - type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - infoworks_managed
                                        password:
                                          type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                database:
                                  type: string
                                  example: automation_db
                                snowflake_profile:
                                  type: string
                                  example: profile1
                                warehouse:
                                  type: string
                                  example: DEMO_WH
                        - type: object
                          required:
                            - source_type
                            - storage
                          properties:
                            source_type:
                              type: string
                              example: structured_files
                              enum:
                                - structured_files
                            storage:
                              oneOf:
                                - allOf:
                                    - type: object
                                      properties:
                                        storage_type:
                                          type: string
                                          enum:
                                            - dbfs
                                            - remote
                                            - cloud
                                - allOf:
                                    - type: object
                                      properties:
                                        storage_type:
                                          type: string
                                          enum:
                                            - dbfs
                                            - remote
                                            - cloud
                                    - type: object
                                      required:
                                        - sftp_host
                                        - sftp_port
                                        - username
                                        - password
                                        - auth_type
                                      properties:
                                        sftp_host:
                                          type: string
                                          example: 192.168.1.1
                                        sftp_port:
                                          type: integer
                                          example: 22
                                        username:
                                          type: string
                                          example: Lucifer
                                        password:
                                          oneOf:
                                            - type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - infoworks_managed
                                                password:
                                                  type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - secret_store
                                                secret_id:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                        auth_type:
                                          type: string
                                          example: password
                                        credential:
                                          oneOf:
                                            - type: object
                                              required:
                                                - type
                                                - username
                                                - password
                                              properties:
                                                type:
                                                  type: string
                                                  example: basic
                                                username:
                                                  type: string
                                                  example: sftp-user
                                                password:
                                                  oneOf:
                                                    - type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - infoworks_managed
                                                        password:
                                                          type: string
                                                          minLength: 1
                                                          example:
                                                            - passw@rd_plain
                                                            - >-
                                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - secret_store
                                                        secret_id:
                                                          type: string
                                                          example: e77850ad5127a2d7dab870ff
                                            - type: object
                                              required:
                                                - type
                                                - username
                                                - private_key_path
                                                - passphrase
                                              properties:
                                                type:
                                                  type: string
                                                  example: key
                                                username:
                                                  type: string
                                                  example: sftp-user
                                                private_key_path:
                                                  type: string
                                                  example: /opt/infoworks/key
                                                passphrase:
                                                  type: string
                                                  example: J9moLFp0XjMhsLu
                                - oneOf:
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                        - type: object
                                          properties:
                                            cloud_type:
                                              type: string
                                              enum:
                                                - s3
                                                - wasb
                                                - gs
                                        - type: object
                                          required:
                                            - type
                                            - base_path
                                            - credential
                                          properties:
                                            account_type:
                                              type: string
                                            access_id:
                                              type: string
                                            secret_key:
                                              oneOf:
                                                - type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - infoworks_managed
                                                    password:
                                                      type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - secret_store
                                                    secret_id:
                                                      type: string
                                                      example: e77850ad5127a2d7dab870ff
                                            access_type:
                                              type: string
                                            support_gov_cloud:
                                              type: boolean
                                            endpoint:
                                              type: string
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                        - type: object
                                          properties:
                                            cloud_type:
                                              type: string
                                              enum:
                                                - s3
                                                - wasb
                                                - gs
                                        - type: object
                                          properties:
                                            access_type:
                                              type: string
                                              example: service_account
                                              enum:
                                                - service_account
                                            project_id:
                                              type: string
                                              example: csv_store
                                            upload_option:
                                              type: string
                                              enum:
                                                - fileUpload
                                                - serverLocation
                                              example: fileUpload
                                            server_path:
                                              type: string
                                              description: >-
                                                required if upload_option is set to
                                                serverLocation
                                              example: >-
                                                /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                        - type: object
                                          properties:
                                            cloud_type:
                                              type: string
                                              enum:
                                                - s3
                                                - wasb
                                                - gs
                                        - type: object
                                          properties:
                                            account_name:
                                              type: string
                                            account_key:
                                              oneOf:
                                                - type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - infoworks_managed
                                                    password:
                                                      type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - secret_store
                                                    secret_id:
                                                      type: string
                                                      example: e77850ad5127a2d7dab870ff
                                            account_endpoint:
                                              type: string
                                            container_name:
                                              type: string
                                            support_gov_cloud:
                                              type: boolean
                                            access_type:
                                              type: string
                                              enum:
                                                - none
                                                - account_key
                        - type: object
                          required:
                            - source_base_path
                            - storage
                          properties:
                            source_base_path:
                              type: string
                              example: /sources/csv_source
                            storage:
                              oneOf:
                                - allOf:
                                    - type: object
                                      properties:
                                        storage_type:
                                          type: string
                                          enum:
                                            - dbfs
                                            - remote
                                            - cloud
                                - allOf:
                                    - type: object
                                      properties:
                                        storage_type:
                                          type: string
                                          enum:
                                            - dbfs
                                            - remote
                                            - cloud
                                    - type: object
                                      required:
                                        - sftp_host
                                        - sftp_port
                                        - username
                                        - password
                                        - auth_type
                                      properties:
                                        sftp_host:
                                          type: string
                                          example: 192.168.1.1
                                        sftp_port:
                                          type: integer
                                          example: 22
                                        username:
                                          type: string
                                          example: Lucifer
                                        password:
                                          oneOf:
                                            - type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - infoworks_managed
                                                password:
                                                  type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - secret_store
                                                secret_id:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                        auth_type:
                                          type: string
                                          example: password
                                        credential:
                                          oneOf:
                                            - type: object
                                              required:
                                                - type
                                                - username
                                                - password
                                              properties:
                                                type:
                                                  type: string
                                                  example: basic
                                                username:
                                                  type: string
                                                  example: sftp-user
                                                password:
                                                  oneOf:
                                                    - type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - infoworks_managed
                                                        password:
                                                          type: string
                                                          minLength: 1
                                                          example:
                                                            - passw@rd_plain
                                                            - >-
                                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - secret_store
                                                        secret_id:
                                                          type: string
                                                          example: e77850ad5127a2d7dab870ff
                                            - type: object
                                              required:
                                                - type
                                                - username
                                                - private_key_path
                                                - passphrase
                                              properties:
                                                type:
                                                  type: string
                                                  example: key
                                                username:
                                                  type: string
                                                  example: sftp-user
                                                private_key_path:
                                                  type: string
                                                  example: /opt/infoworks/key
                                                passphrase:
                                                  type: string
                                                  example: J9moLFp0XjMhsLu
                                - oneOf:
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                        - type: object
                                          properties:
                                            cloud_type:
                                              type: string
                                              enum:
                                                - s3
                                                - wasb
                                                - gs
                                        - type: object
                                          required:
                                            - type
                                            - base_path
                                            - credential
                                          properties:
                                            account_type:
                                              type: string
                                            access_id:
                                              type: string
                                            secret_key:
                                              oneOf:
                                                - type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - infoworks_managed
                                                    password:
                                                      type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - secret_store
                                                    secret_id:
                                                      type: string
                                                      example: e77850ad5127a2d7dab870ff
                                            access_type:
                                              type: string
                                            support_gov_cloud:
                                              type: boolean
                                            endpoint:
                                              type: string
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                        - type: object
                                          properties:
                                            cloud_type:
                                              type: string
                                              enum:
                                                - s3
                                                - wasb
                                                - gs
                                        - type: object
                                          properties:
                                            access_type:
                                              type: string
                                              example: service_account
                                              enum:
                                                - service_account
                                            project_id:
                                              type: string
                                              example: csv_store
                                            upload_option:
                                              type: string
                                              enum:
                                                - fileUpload
                                                - serverLocation
                                              example: fileUpload
                                            server_path:
                                              type: string
                                              description: >-
                                                required if upload_option is set to
                                                serverLocation
                                              example: >-
                                                /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                        - type: object
                                          properties:
                                            cloud_type:
                                              type: string
                                              enum:
                                                - s3
                                                - wasb
                                                - gs
                                        - type: object
                                          properties:
                                            account_name:
                                              type: string
                                            account_key:
                                              oneOf:
                                                - type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - infoworks_managed
                                                    password:
                                                      type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - secret_store
                                                    secret_id:
                                                      type: string
                                                      example: e77850ad5127a2d7dab870ff
                                            account_endpoint:
                                              type: string
                                            container_name:
                                              type: string
                                            support_gov_cloud:
                                              type: boolean
                                            access_type:
                                              type: string
                                              enum:
                                                - none
                                                - account_key
                            key:
                              description: >-
                                required only if gcs cloud storage type is
                                selected with fileUpload Option use content-type
                                as multipart/form-data
                              format: binary
                              example: key.json
                            snowflake_profile:
                              type: string
                              example: profile1
                            warehouse:
                              type: string
                              example: DEMO_WH
                        - allOf:
                            - type: object
                              required:
                                - source_base_path
                                - storage
                              properties:
                                source_base_path:
                                  type: string
                                  example: /sources/csv_source
                                storage:
                                  oneOf:
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                        - type: object
                                          required:
                                            - sftp_host
                                            - sftp_port
                                            - username
                                            - password
                                            - auth_type
                                          properties:
                                            sftp_host:
                                              type: string
                                              example: 192.168.1.1
                                            sftp_port:
                                              type: integer
                                              example: 22
                                            username:
                                              type: string
                                              example: Lucifer
                                            password:
                                              oneOf:
                                                - type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - infoworks_managed
                                                    password:
                                                      type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - secret_store
                                                    secret_id:
                                                      type: string
                                                      example: e77850ad5127a2d7dab870ff
                                            auth_type:
                                              type: string
                                              example: password
                                            credential:
                                              oneOf:
                                                - type: object
                                                  required:
                                                    - type
                                                    - username
                                                    - password
                                                  properties:
                                                    type:
                                                      type: string
                                                      example: basic
                                                    username:
                                                      type: string
                                                      example: sftp-user
                                                    password:
                                                      oneOf:
                                                        - type: string
                                                          minLength: 1
                                                          example:
                                                            - passw@rd_plain
                                                            - >-
                                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                        - type: object
                                                          properties:
                                                            password_type:
                                                              type: string
                                                              enum:
                                                                - infoworks_managed
                                                            password:
                                                              type: string
                                                              minLength: 1
                                                              example:
                                                                - passw@rd_plain
                                                                - >-
                                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                        - type: object
                                                          properties:
                                                            password_type:
                                                              type: string
                                                              enum:
                                                                - secret_store
                                                            secret_id:
                                                              type: string
                                                              example: e77850ad5127a2d7dab870ff
                                                - type: object
                                                  required:
                                                    - type
                                                    - username
                                                    - private_key_path
                                                    - passphrase
                                                  properties:
                                                    type:
                                                      type: string
                                                      example: key
                                                    username:
                                                      type: string
                                                      example: sftp-user
                                                    private_key_path:
                                                      type: string
                                                      example: /opt/infoworks/key
                                                    passphrase:
                                                      type: string
                                                      example: J9moLFp0XjMhsLu
                                    - oneOf:
                                        - allOf:
                                            - type: object
                                              properties:
                                                storage_type:
                                                  type: string
                                                  enum:
                                                    - dbfs
                                                    - remote
                                                    - cloud
                                            - type: object
                                              properties:
                                                cloud_type:
                                                  type: string
                                                  enum:
                                                    - s3
                                                    - wasb
                                                    - gs
                                            - type: object
                                              required:
                                                - type
                                                - base_path
                                                - credential
                                              properties:
                                                account_type:
                                                  type: string
                                                access_id:
                                                  type: string
                                                secret_key:
                                                  oneOf:
                                                    - type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - infoworks_managed
                                                        password:
                                                          type: string
                                                          minLength: 1
                                                          example:
                                                            - passw@rd_plain
                                                            - >-
                                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - secret_store
                                                        secret_id:
                                                          type: string
                                                          example: e77850ad5127a2d7dab870ff
                                                access_type:
                                                  type: string
                                                support_gov_cloud:
                                                  type: boolean
                                                endpoint:
                                                  type: string
                                        - allOf:
                                            - type: object
                                              properties:
                                                storage_type:
                                                  type: string
                                                  enum:
                                                    - dbfs
                                                    - remote
                                                    - cloud
                                            - type: object
                                              properties:
                                                cloud_type:
                                                  type: string
                                                  enum:
                                                    - s3
                                                    - wasb
                                                    - gs
                                            - type: object
                                              properties:
                                                access_type:
                                                  type: string
                                                  example: service_account
                                                  enum:
                                                    - service_account
                                                project_id:
                                                  type: string
                                                  example: csv_store
                                                upload_option:
                                                  type: string
                                                  enum:
                                                    - fileUpload
                                                    - serverLocation
                                                  example: fileUpload
                                                server_path:
                                                  type: string
                                                  description: >-
                                                    required if upload_option is set to
                                                    serverLocation
                                                  example: >-
                                                    /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json
                                        - allOf:
                                            - type: object
                                              properties:
                                                storage_type:
                                                  type: string
                                                  enum:
                                                    - dbfs
                                                    - remote
                                                    - cloud
                                            - type: object
                                              properties:
                                                cloud_type:
                                                  type: string
                                                  enum:
                                                    - s3
                                                    - wasb
                                                    - gs
                                            - type: object
                                              properties:
                                                account_name:
                                                  type: string
                                                account_key:
                                                  oneOf:
                                                    - type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - infoworks_managed
                                                        password:
                                                          type: string
                                                          minLength: 1
                                                          example:
                                                            - passw@rd_plain
                                                            - >-
                                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - secret_store
                                                        secret_id:
                                                          type: string
                                                          example: e77850ad5127a2d7dab870ff
                                                account_endpoint:
                                                  type: string
                                                container_name:
                                                  type: string
                                                support_gov_cloud:
                                                  type: boolean
                                                access_type:
                                                  type: string
                                                  enum:
                                                    - none
                                                    - account_key
                                key:
                                  description: >-
                                    required only if gcs cloud storage type is
                                    selected with fileUpload Option use
                                    content-type as multipart/form-data
                                  format: binary
                                  example: key.json
                                snowflake_profile:
                                  type: string
                                  example: profile1
                                warehouse:
                                  type: string
                                  example: DEMO_WH
                            - type: object
                              properties:
                                source_base_path_relative:
                                  type: string
                        - type: object
                          properties:
                            environment:
                              type: string
                            connection_url:
                              type: string
                            username:
                              type: string
                            password:
                              oneOf:
                                - type: string
                                  minLength: 1
                                  example:
                                    - passw@rd_plain
                                    - >-
                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                - type: object
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - infoworks_managed
                                    password:
                                      type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                - type: object
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - secret_store
                                    secret_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                            application_secret_key:
                              oneOf:
                                - type: string
                                  minLength: 1
                                  example:
                                    - passw@rd_plain
                                    - >-
                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                - type: object
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - infoworks_managed
                                    password:
                                      type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                - type: object
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - secret_store
                                    secret_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                            fetch_mechanism:
                              type: string
                              enum:
                                - bulk
                                - rest
                                - both
                            api_version:
                              type: string
                            snowflake_profile:
                              type: string
                              example: profile1
                            warehouse:
                              type: string
                              example: DEMO_WH
                        - type: object
                          properties:
                            broker_id:
                              type: string
                            message_format:
                              type: string
                              enum:
                                - json
                                - avro
                            snowflake_profile:
                              type: string
                              example: profile1
                            warehouse:
                              type: string
                              example: DEMO_WH
                        - type: object
                          properties:
                            broker_id:
                              type: string
                            message_format:
                              type: string
                              enum:
                                - json
                                - avro
                            enable_cluster_authentication:
                              type: boolean
                            enable_schema_registry:
                              type: boolean
                            cluster_authentication_details:
                              type: object
                              properties:
                                security_protocol:
                                  type: string
                                  enum:
                                    - sasl_ssl
                                sasl_mechanism:
                                  type: string
                                  enum:
                                    - plain
                                username:
                                  type: string
                                password:
                                  oneOf:
                                    - type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - infoworks_managed
                                        password:
                                          type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                            schema_registry_authentication_details:
                              type: object
                              properties:
                                authentication_mechanism:
                                  type: string
                                  enum:
                                    - http_basic
                                    - none
                                username:
                                  type: string
                                password:
                                  oneOf:
                                    - type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - infoworks_managed
                                        password:
                                          type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                            schema_registry_url:
                              type: string
                            snowflake_profile:
                              type: string
                              example: profile1
                            warehouse:
                              type: string
                              example: DEMO_WH
                        - type: object
                          properties:
                            connection_url:
                              type: string
                            source_schema:
                              type: string
                            username:
                              type: string
                            password:
                              oneOf:
                                - type: string
                                  minLength: 1
                                  example:
                                    - passw@rd_plain
                                    - >-
                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                - type: object
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - infoworks_managed
                                    password:
                                      type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                - type: object
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - secret_store
                                    secret_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                            database:
                              type: string
                            parameters:
                              type: object
                              properties:
                                is_active:
                                  type: boolean
                                is_encrypted:
                                  type: boolean
                                key:
                                  type: string
                                value:
                                  type: string
                            snowflake_profile:
                              type: string
                              example: profile1
                            warehouse:
                              type: string
                              example: DEMO_WH
                - type: object
                  properties:
                    name:
                      type: string
                    environment_id:
                      type: string
                    storage_id:
                      type: string
                    data_lake_schema:
                      type: string
                    data_lake_path:
                      type: string
                    type:
                      type: string
                    is_source_ingested:
                      type: boolean
                    storage:
                      type: string
                    is_public:
                      type: boolean
                    sub_type:
                      type: string
                      enum:
                        - structured
                        - json
                        - xml
                        - unstructured
                        - teradata
                        - oracle
                        - mysql
                        - mariadb
                        - sqlserver
                        - db2
                        - netezza
                        - hive
                        - ignite
                        - maprdb
                        - salesforce
                    connection:
                      oneOf:
                        - allOf:
                            - type: object
                              required:
                                - source_schema
                                - username
                                - password
                                - database
                              properties:
                                connection_mode:
                                  type: string
                                  example: jdbc
                                  enum:
                                    - jdbc
                                connection_url:
                                  type: string
                                  example: >-
                                    jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                                source_schema:
                                  type: string
                                  example: test_schema
                                username:
                                  type: string
                                  example: Lucifer
                                password:
                                  oneOf:
                                    - type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - infoworks_managed
                                        password:
                                          type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                database:
                                  type: string
                                  example: automation_db
                                snowflake_profile:
                                  type: string
                                  example: profile1
                                warehouse:
                                  type: string
                                  example: DEMO_WH
                            - type: object
                              properties:
                                enable_log_based_cdc:
                                  type: boolean
                                  example: true
                                staging_database:
                                  type: string
                                  example: db_staging
                                enable_dictionary_rebuild_for_each_job:
                                  type: boolean
                                  example: true
                                dictionary_path:
                                  type: string
                                  example: /tmp/dict
                                dictionary_type:
                                  type: string
                                  example: online
                                  enum:
                                    - online
                                    - offline
                                    - redo_log
                        - allOf:
                            - type: object
                              required:
                                - source_schema
                                - username
                                - password
                                - database
                              properties:
                                connection_mode:
                                  type: string
                                  example: jdbc
                                  enum:
                                    - jdbc
                                connection_url:
                                  type: string
                                  example: >-
                                    jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                                source_schema:
                                  type: string
                                  example: test_schema
                                username:
                                  type: string
                                  example: Lucifer
                                password:
                                  oneOf:
                                    - type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - infoworks_managed
                                        password:
                                          type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                database:
                                  type: string
                                  example: automation_db
                                snowflake_profile:
                                  type: string
                                  example: profile1
                                warehouse:
                                  type: string
                                  example: DEMO_WH
                        - allOf:
                            - type: object
                              required:
                                - source_schema
                                - username
                                - password
                                - database
                              properties:
                                connection_mode:
                                  type: string
                                  example: jdbc
                                  enum:
                                    - jdbc
                                connection_url:
                                  type: string
                                  example: >-
                                    jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                                source_schema:
                                  type: string
                                  example: test_schema
                                username:
                                  type: string
                                  example: Lucifer
                                password:
                                  oneOf:
                                    - type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - infoworks_managed
                                        password:
                                          type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                database:
                                  type: string
                                  example: automation_db
                                snowflake_profile:
                                  type: string
                                  example: profile1
                                warehouse:
                                  type: string
                                  example: DEMO_WH
                        - allOf:
                            - type: object
                              required:
                                - source_schema
                                - username
                                - password
                                - database
                              properties:
                                connection_mode:
                                  type: string
                                  example: jdbc
                                  enum:
                                    - jdbc
                                connection_url:
                                  type: string
                                  example: >-
                                    jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                                source_schema:
                                  type: string
                                  example: test_schema
                                username:
                                  type: string
                                  example: Lucifer
                                password:
                                  oneOf:
                                    - type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - infoworks_managed
                                        password:
                                          type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                database:
                                  type: string
                                  example: automation_db
                                snowflake_profile:
                                  type: string
                                  example: profile1
                                warehouse:
                                  type: string
                                  example: DEMO_WH
                            - type: object
                              properties:
                                enable_teradata_wallet:
                                  type: boolean
                                  example: true
                                teradata_wallet_key_used_for_password:
                                  type: string
                                storage:
                                  oneOf:
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                        - type: object
                                          required:
                                            - sftp_host
                                            - sftp_port
                                            - username
                                            - password
                                            - auth_type
                                          properties:
                                            sftp_host:
                                              type: string
                                              example: 192.168.1.1
                                            sftp_port:
                                              type: integer
                                              example: 22
                                            username:
                                              type: string
                                              example: Lucifer
                                            password:
                                              oneOf:
                                                - type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - infoworks_managed
                                                    password:
                                                      type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - secret_store
                                                    secret_id:
                                                      type: string
                                                      example: e77850ad5127a2d7dab870ff
                                            auth_type:
                                              type: string
                                              example: password
                                            credential:
                                              oneOf:
                                                - type: object
                                                  required:
                                                    - type
                                                    - username
                                                    - password
                                                  properties:
                                                    type:
                                                      type: string
                                                      example: basic
                                                    username:
                                                      type: string
                                                      example: sftp-user
                                                    password:
                                                      oneOf:
                                                        - type: string
                                                          minLength: 1
                                                          example:
                                                            - passw@rd_plain
                                                            - >-
                                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                        - type: object
                                                          properties:
                                                            password_type:
                                                              type: string
                                                              enum:
                                                                - infoworks_managed
                                                            password:
                                                              type: string
                                                              minLength: 1
                                                              example:
                                                                - passw@rd_plain
                                                                - >-
                                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                        - type: object
                                                          properties:
                                                            password_type:
                                                              type: string
                                                              enum:
                                                                - secret_store
                                                            secret_id:
                                                              type: string
                                                              example: e77850ad5127a2d7dab870ff
                                                - type: object
                                                  required:
                                                    - type
                                                    - username
                                                    - private_key_path
                                                    - passphrase
                                                  properties:
                                                    type:
                                                      type: string
                                                      example: key
                                                    username:
                                                      type: string
                                                      example: sftp-user
                                                    private_key_path:
                                                      type: string
                                                      example: /opt/infoworks/key
                                                    passphrase:
                                                      type: string
                                                      example: J9moLFp0XjMhsLu
                                    - oneOf:
                                        - allOf:
                                            - type: object
                                              properties:
                                                storage_type:
                                                  type: string
                                                  enum:
                                                    - dbfs
                                                    - remote
                                                    - cloud
                                            - type: object
                                              properties:
                                                cloud_type:
                                                  type: string
                                                  enum:
                                                    - s3
                                                    - wasb
                                                    - gs
                                            - type: object
                                              required:
                                                - type
                                                - base_path
                                                - credential
                                              properties:
                                                account_type:
                                                  type: string
                                                access_id:
                                                  type: string
                                                secret_key:
                                                  oneOf:
                                                    - type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - infoworks_managed
                                                        password:
                                                          type: string
                                                          minLength: 1
                                                          example:
                                                            - passw@rd_plain
                                                            - >-
                                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - secret_store
                                                        secret_id:
                                                          type: string
                                                          example: e77850ad5127a2d7dab870ff
                                                access_type:
                                                  type: string
                                                support_gov_cloud:
                                                  type: boolean
                                                endpoint:
                                                  type: string
                                        - allOf:
                                            - type: object
                                              properties:
                                                storage_type:
                                                  type: string
                                                  enum:
                                                    - dbfs
                                                    - remote
                                                    - cloud
                                            - type: object
                                              properties:
                                                cloud_type:
                                                  type: string
                                                  enum:
                                                    - s3
                                                    - wasb
                                                    - gs
                                            - type: object
                                              properties:
                                                access_type:
                                                  type: string
                                                  example: service_account
                                                  enum:
                                                    - service_account
                                                project_id:
                                                  type: string
                                                  example: csv_store
                                                upload_option:
                                                  type: string
                                                  enum:
                                                    - fileUpload
                                                    - serverLocation
                                                  example: fileUpload
                                                server_path:
                                                  type: string
                                                  description: >-
                                                    required if upload_option is set to
                                                    serverLocation
                                                  example: >-
                                                    /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json
                                        - allOf:
                                            - type: object
                                              properties:
                                                storage_type:
                                                  type: string
                                                  enum:
                                                    - dbfs
                                                    - remote
                                                    - cloud
                                            - type: object
                                              properties:
                                                cloud_type:
                                                  type: string
                                                  enum:
                                                    - s3
                                                    - wasb
                                                    - gs
                                            - type: object
                                              properties:
                                                account_name:
                                                  type: string
                                                account_key:
                                                  oneOf:
                                                    - type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - infoworks_managed
                                                        password:
                                                          type: string
                                                          minLength: 1
                                                          example:
                                                            - passw@rd_plain
                                                            - >-
                                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - secret_store
                                                        secret_id:
                                                          type: string
                                                          example: e77850ad5127a2d7dab870ff
                                                account_endpoint:
                                                  type: string
                                                container_name:
                                                  type: string
                                                support_gov_cloud:
                                                  type: boolean
                                                access_type:
                                                  type: string
                                                  enum:
                                                    - none
                                                    - account_key
                                enable_ingestion_via_tpt:
                                  type: boolean
                                  example: true
                                is_td_wallet_enabled:
                                  type: boolean
                                  example: true
                                enable_tpt_for_source:
                                  type: boolean
                                  example: true
                        - allOf:
                            - type: object
                              required:
                                - source_schema
                                - username
                                - password
                                - database
                              properties:
                                connection_mode:
                                  type: string
                                  example: jdbc
                                  enum:
                                    - jdbc
                                connection_url:
                                  type: string
                                  example: >-
                                    jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                                source_schema:
                                  type: string
                                  example: test_schema
                                username:
                                  type: string
                                  example: Lucifer
                                password:
                                  oneOf:
                                    - type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - infoworks_managed
                                        password:
                                          type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                database:
                                  type: string
                                  example: automation_db
                                snowflake_profile:
                                  type: string
                                  example: profile1
                                warehouse:
                                  type: string
                                  example: DEMO_WH
                        - allOf:
                            - type: object
                              required:
                                - source_schema
                                - username
                                - password
                                - database
                              properties:
                                connection_mode:
                                  type: string
                                  example: jdbc
                                  enum:
                                    - jdbc
                                connection_url:
                                  type: string
                                  example: >-
                                    jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                                source_schema:
                                  type: string
                                  example: test_schema
                                username:
                                  type: string
                                  example: Lucifer
                                password:
                                  oneOf:
                                    - type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - infoworks_managed
                                        password:
                                          type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                database:
                                  type: string
                                  example: automation_db
                                snowflake_profile:
                                  type: string
                                  example: profile1
                                warehouse:
                                  type: string
                                  example: DEMO_WH
                        - type: object
                          required:
                            - source_type
                            - storage
                          properties:
                            source_type:
                              type: string
                              example: structured_files
                              enum:
                                - structured_files
                            storage:
                              oneOf:
                                - allOf:
                                    - type: object
                                      properties:
                                        storage_type:
                                          type: string
                                          enum:
                                            - dbfs
                                            - remote
                                            - cloud
                                - allOf:
                                    - type: object
                                      properties:
                                        storage_type:
                                          type: string
                                          enum:
                                            - dbfs
                                            - remote
                                            - cloud
                                    - type: object
                                      required:
                                        - sftp_host
                                        - sftp_port
                                        - username
                                        - password
                                        - auth_type
                                      properties:
                                        sftp_host:
                                          type: string
                                          example: 192.168.1.1
                                        sftp_port:
                                          type: integer
                                          example: 22
                                        username:
                                          type: string
                                          example: Lucifer
                                        password:
                                          oneOf:
                                            - type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - infoworks_managed
                                                password:
                                                  type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - secret_store
                                                secret_id:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                        auth_type:
                                          type: string
                                          example: password
                                        credential:
                                          oneOf:
                                            - type: object
                                              required:
                                                - type
                                                - username
                                                - password
                                              properties:
                                                type:
                                                  type: string
                                                  example: basic
                                                username:
                                                  type: string
                                                  example: sftp-user
                                                password:
                                                  oneOf:
                                                    - type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - infoworks_managed
                                                        password:
                                                          type: string
                                                          minLength: 1
                                                          example:
                                                            - passw@rd_plain
                                                            - >-
                                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - secret_store
                                                        secret_id:
                                                          type: string
                                                          example: e77850ad5127a2d7dab870ff
                                            - type: object
                                              required:
                                                - type
                                                - username
                                                - private_key_path
                                                - passphrase
                                              properties:
                                                type:
                                                  type: string
                                                  example: key
                                                username:
                                                  type: string
                                                  example: sftp-user
                                                private_key_path:
                                                  type: string
                                                  example: /opt/infoworks/key
                                                passphrase:
                                                  type: string
                                                  example: J9moLFp0XjMhsLu
                                - oneOf:
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                        - type: object
                                          properties:
                                            cloud_type:
                                              type: string
                                              enum:
                                                - s3
                                                - wasb
                                                - gs
                                        - type: object
                                          required:
                                            - type
                                            - base_path
                                            - credential
                                          properties:
                                            account_type:
                                              type: string
                                            access_id:
                                              type: string
                                            secret_key:
                                              oneOf:
                                                - type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - infoworks_managed
                                                    password:
                                                      type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - secret_store
                                                    secret_id:
                                                      type: string
                                                      example: e77850ad5127a2d7dab870ff
                                            access_type:
                                              type: string
                                            support_gov_cloud:
                                              type: boolean
                                            endpoint:
                                              type: string
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                        - type: object
                                          properties:
                                            cloud_type:
                                              type: string
                                              enum:
                                                - s3
                                                - wasb
                                                - gs
                                        - type: object
                                          properties:
                                            access_type:
                                              type: string
                                              example: service_account
                                              enum:
                                                - service_account
                                            project_id:
                                              type: string
                                              example: csv_store
                                            upload_option:
                                              type: string
                                              enum:
                                                - fileUpload
                                                - serverLocation
                                              example: fileUpload
                                            server_path:
                                              type: string
                                              description: >-
                                                required if upload_option is set to
                                                serverLocation
                                              example: >-
                                                /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                        - type: object
                                          properties:
                                            cloud_type:
                                              type: string
                                              enum:
                                                - s3
                                                - wasb
                                                - gs
                                        - type: object
                                          properties:
                                            account_name:
                                              type: string
                                            account_key:
                                              oneOf:
                                                - type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - infoworks_managed
                                                    password:
                                                      type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - secret_store
                                                    secret_id:
                                                      type: string
                                                      example: e77850ad5127a2d7dab870ff
                                            account_endpoint:
                                              type: string
                                            container_name:
                                              type: string
                                            support_gov_cloud:
                                              type: boolean
                                            access_type:
                                              type: string
                                              enum:
                                                - none
                                                - account_key
                        - type: object
                          required:
                            - source_base_path
                            - storage
                          properties:
                            source_base_path:
                              type: string
                              example: /sources/csv_source
                            storage:
                              oneOf:
                                - allOf:
                                    - type: object
                                      properties:
                                        storage_type:
                                          type: string
                                          enum:
                                            - dbfs
                                            - remote
                                            - cloud
                                - allOf:
                                    - type: object
                                      properties:
                                        storage_type:
                                          type: string
                                          enum:
                                            - dbfs
                                            - remote
                                            - cloud
                                    - type: object
                                      required:
                                        - sftp_host
                                        - sftp_port
                                        - username
                                        - password
                                        - auth_type
                                      properties:
                                        sftp_host:
                                          type: string
                                          example: 192.168.1.1
                                        sftp_port:
                                          type: integer
                                          example: 22
                                        username:
                                          type: string
                                          example: Lucifer
                                        password:
                                          oneOf:
                                            - type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - infoworks_managed
                                                password:
                                                  type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - secret_store
                                                secret_id:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                        auth_type:
                                          type: string
                                          example: password
                                        credential:
                                          oneOf:
                                            - type: object
                                              required:
                                                - type
                                                - username
                                                - password
                                              properties:
                                                type:
                                                  type: string
                                                  example: basic
                                                username:
                                                  type: string
                                                  example: sftp-user
                                                password:
                                                  oneOf:
                                                    - type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - infoworks_managed
                                                        password:
                                                          type: string
                                                          minLength: 1
                                                          example:
                                                            - passw@rd_plain
                                                            - >-
                                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - secret_store
                                                        secret_id:
                                                          type: string
                                                          example: e77850ad5127a2d7dab870ff
                                            - type: object
                                              required:
                                                - type
                                                - username
                                                - private_key_path
                                                - passphrase
                                              properties:
                                                type:
                                                  type: string
                                                  example: key
                                                username:
                                                  type: string
                                                  example: sftp-user
                                                private_key_path:
                                                  type: string
                                                  example: /opt/infoworks/key
                                                passphrase:
                                                  type: string
                                                  example: J9moLFp0XjMhsLu
                                - oneOf:
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                        - type: object
                                          properties:
                                            cloud_type:
                                              type: string
                                              enum:
                                                - s3
                                                - wasb
                                                - gs
                                        - type: object
                                          required:
                                            - type
                                            - base_path
                                            - credential
                                          properties:
                                            account_type:
                                              type: string
                                            access_id:
                                              type: string
                                            secret_key:
                                              oneOf:
                                                - type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - infoworks_managed
                                                    password:
                                                      type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - secret_store
                                                    secret_id:
                                                      type: string
                                                      example: e77850ad5127a2d7dab870ff
                                            access_type:
                                              type: string
                                            support_gov_cloud:
                                              type: boolean
                                            endpoint:
                                              type: string
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                        - type: object
                                          properties:
                                            cloud_type:
                                              type: string
                                              enum:
                                                - s3
                                                - wasb
                                                - gs
                                        - type: object
                                          properties:
                                            access_type:
                                              type: string
                                              example: service_account
                                              enum:
                                                - service_account
                                            project_id:
                                              type: string
                                              example: csv_store
                                            upload_option:
                                              type: string
                                              enum:
                                                - fileUpload
                                                - serverLocation
                                              example: fileUpload
                                            server_path:
                                              type: string
                                              description: >-
                                                required if upload_option is set to
                                                serverLocation
                                              example: >-
                                                /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                        - type: object
                                          properties:
                                            cloud_type:
                                              type: string
                                              enum:
                                                - s3
                                                - wasb
                                                - gs
                                        - type: object
                                          properties:
                                            account_name:
                                              type: string
                                            account_key:
                                              oneOf:
                                                - type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - infoworks_managed
                                                    password:
                                                      type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - secret_store
                                                    secret_id:
                                                      type: string
                                                      example: e77850ad5127a2d7dab870ff
                                            account_endpoint:
                                              type: string
                                            container_name:
                                              type: string
                                            support_gov_cloud:
                                              type: boolean
                                            access_type:
                                              type: string
                                              enum:
                                                - none
                                                - account_key
                            key:
                              description: >-
                                required only if gcs cloud storage type is
                                selected with fileUpload Option use content-type
                                as multipart/form-data
                              format: binary
                              example: key.json
                            snowflake_profile:
                              type: string
                              example: profile1
                            warehouse:
                              type: string
                              example: DEMO_WH
                        - allOf:
                            - type: object
                              required:
                                - source_base_path
                                - storage
                              properties:
                                source_base_path:
                                  type: string
                                  example: /sources/csv_source
                                storage:
                                  oneOf:
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                    - allOf:
                                        - type: object
                                          properties:
                                            storage_type:
                                              type: string
                                              enum:
                                                - dbfs
                                                - remote
                                                - cloud
                                        - type: object
                                          required:
                                            - sftp_host
                                            - sftp_port
                                            - username
                                            - password
                                            - auth_type
                                          properties:
                                            sftp_host:
                                              type: string
                                              example: 192.168.1.1
                                            sftp_port:
                                              type: integer
                                              example: 22
                                            username:
                                              type: string
                                              example: Lucifer
                                            password:
                                              oneOf:
                                                - type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - infoworks_managed
                                                    password:
                                                      type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - secret_store
                                                    secret_id:
                                                      type: string
                                                      example: e77850ad5127a2d7dab870ff
                                            auth_type:
                                              type: string
                                              example: password
                                            credential:
                                              oneOf:
                                                - type: object
                                                  required:
                                                    - type
                                                    - username
                                                    - password
                                                  properties:
                                                    type:
                                                      type: string
                                                      example: basic
                                                    username:
                                                      type: string
                                                      example: sftp-user
                                                    password:
                                                      oneOf:
                                                        - type: string
                                                          minLength: 1
                                                          example:
                                                            - passw@rd_plain
                                                            - >-
                                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                        - type: object
                                                          properties:
                                                            password_type:
                                                              type: string
                                                              enum:
                                                                - infoworks_managed
                                                            password:
                                                              type: string
                                                              minLength: 1
                                                              example:
                                                                - passw@rd_plain
                                                                - >-
                                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                        - type: object
                                                          properties:
                                                            password_type:
                                                              type: string
                                                              enum:
                                                                - secret_store
                                                            secret_id:
                                                              type: string
                                                              example: e77850ad5127a2d7dab870ff
                                                - type: object
                                                  required:
                                                    - type
                                                    - username
                                                    - private_key_path
                                                    - passphrase
                                                  properties:
                                                    type:
                                                      type: string
                                                      example: key
                                                    username:
                                                      type: string
                                                      example: sftp-user
                                                    private_key_path:
                                                      type: string
                                                      example: /opt/infoworks/key
                                                    passphrase:
                                                      type: string
                                                      example: J9moLFp0XjMhsLu
                                    - oneOf:
                                        - allOf:
                                            - type: object
                                              properties:
                                                storage_type:
                                                  type: string
                                                  enum:
                                                    - dbfs
                                                    - remote
                                                    - cloud
                                            - type: object
                                              properties:
                                                cloud_type:
                                                  type: string
                                                  enum:
                                                    - s3
                                                    - wasb
                                                    - gs
                                            - type: object
                                              required:
                                                - type
                                                - base_path
                                                - credential
                                              properties:
                                                account_type:
                                                  type: string
                                                access_id:
                                                  type: string
                                                secret_key:
                                                  oneOf:
                                                    - type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - infoworks_managed
                                                        password:
                                                          type: string
                                                          minLength: 1
                                                          example:
                                                            - passw@rd_plain
                                                            - >-
                                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - secret_store
                                                        secret_id:
                                                          type: string
                                                          example: e77850ad5127a2d7dab870ff
                                                access_type:
                                                  type: string
                                                support_gov_cloud:
                                                  type: boolean
                                                endpoint:
                                                  type: string
                                        - allOf:
                                            - type: object
                                              properties:
                                                storage_type:
                                                  type: string
                                                  enum:
                                                    - dbfs
                                                    - remote
                                                    - cloud
                                            - type: object
                                              properties:
                                                cloud_type:
                                                  type: string
                                                  enum:
                                                    - s3
                                                    - wasb
                                                    - gs
                                            - type: object
                                              properties:
                                                access_type:
                                                  type: string
                                                  example: service_account
                                                  enum:
                                                    - service_account
                                                project_id:
                                                  type: string
                                                  example: csv_store
                                                upload_option:
                                                  type: string
                                                  enum:
                                                    - fileUpload
                                                    - serverLocation
                                                  example: fileUpload
                                                server_path:
                                                  type: string
                                                  description: >-
                                                    required if upload_option is set to
                                                    serverLocation
                                                  example: >-
                                                    /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json
                                        - allOf:
                                            - type: object
                                              properties:
                                                storage_type:
                                                  type: string
                                                  enum:
                                                    - dbfs
                                                    - remote
                                                    - cloud
                                            - type: object
                                              properties:
                                                cloud_type:
                                                  type: string
                                                  enum:
                                                    - s3
                                                    - wasb
                                                    - gs
                                            - type: object
                                              properties:
                                                account_name:
                                                  type: string
                                                account_key:
                                                  oneOf:
                                                    - type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - infoworks_managed
                                                        password:
                                                          type: string
                                                          minLength: 1
                                                          example:
                                                            - passw@rd_plain
                                                            - >-
                                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                    - type: object
                                                      properties:
                                                        password_type:
                                                          type: string
                                                          enum:
                                                            - secret_store
                                                        secret_id:
                                                          type: string
                                                          example: e77850ad5127a2d7dab870ff
                                                account_endpoint:
                                                  type: string
                                                container_name:
                                                  type: string
                                                support_gov_cloud:
                                                  type: boolean
                                                access_type:
                                                  type: string
                                                  enum:
                                                    - none
                                                    - account_key
                                key:
                                  description: >-
                                    required only if gcs cloud storage type is
                                    selected with fileUpload Option use
                                    content-type as multipart/form-data
                                  format: binary
                                  example: key.json
                                snowflake_profile:
                                  type: string
                                  example: profile1
                                warehouse:
                                  type: string
                                  example: DEMO_WH
                            - type: object
                              properties:
                                source_base_path_relative:
                                  type: string
                        - type: object
                          properties:
                            environment:
                              type: string
                            connection_url:
                              type: string
                            username:
                              type: string
                            password:
                              oneOf:
                                - type: string
                                  minLength: 1
                                  example:
                                    - passw@rd_plain
                                    - >-
                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                - type: object
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - infoworks_managed
                                    password:
                                      type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                - type: object
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - secret_store
                                    secret_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                            application_secret_key:
                              oneOf:
                                - type: string
                                  minLength: 1
                                  example:
                                    - passw@rd_plain
                                    - >-
                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                - type: object
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - infoworks_managed
                                    password:
                                      type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                - type: object
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - secret_store
                                    secret_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                            fetch_mechanism:
                              type: string
                              enum:
                                - bulk
                                - rest
                                - both
                            api_version:
                              type: string
                            snowflake_profile:
                              type: string
                              example: profile1
                            warehouse:
                              type: string
                              example: DEMO_WH
                        - type: object
                          properties:
                            broker_id:
                              type: string
                            message_format:
                              type: string
                              enum:
                                - json
                                - avro
                            snowflake_profile:
                              type: string
                              example: profile1
                            warehouse:
                              type: string
                              example: DEMO_WH
                        - type: object
                          properties:
                            broker_id:
                              type: string
                            message_format:
                              type: string
                              enum:
                                - json
                                - avro
                            enable_cluster_authentication:
                              type: boolean
                            enable_schema_registry:
                              type: boolean
                            cluster_authentication_details:
                              type: object
                              properties:
                                security_protocol:
                                  type: string
                                  enum:
                                    - sasl_ssl
                                sasl_mechanism:
                                  type: string
                                  enum:
                                    - plain
                                username:
                                  type: string
                                password:
                                  oneOf:
                                    - type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - infoworks_managed
                                        password:
                                          type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                            schema_registry_authentication_details:
                              type: object
                              properties:
                                authentication_mechanism:
                                  type: string
                                  enum:
                                    - http_basic
                                    - none
                                username:
                                  type: string
                                password:
                                  oneOf:
                                    - type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - infoworks_managed
                                        password:
                                          type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                            schema_registry_url:
                              type: string
                            snowflake_profile:
                              type: string
                              example: profile1
                            warehouse:
                              type: string
                              example: DEMO_WH
                        - type: object
                          properties:
                            connection_url:
                              type: string
                            source_schema:
                              type: string
                            username:
                              type: string
                            password:
                              oneOf:
                                - type: string
                                  minLength: 1
                                  example:
                                    - passw@rd_plain
                                    - >-
                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                - type: object
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - infoworks_managed
                                    password:
                                      type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                - type: object
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                        - secret_store
                                    secret_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                            database:
                              type: string
                            parameters:
                              type: object
                              properties:
                                is_active:
                                  type: boolean
                                is_encrypted:
                                  type: boolean
                                key:
                                  type: string
                                value:
                                  type: string
                            snowflake_profile:
                              type: string
                              example: profile1
                            warehouse:
                              type: string
                              example: DEMO_WH
            examples:
              Infoworks Connectors:
                value:
                  name: sample source
                  environment_id: 5fda050e7758f32604184d38
                  storage_id: 5fda050e7758f32604184d38
                  data_lake_schema: kafka
                  data_lake_path: /iw/kafka-source
                  type: rdbms
                  is_source_ingested": true
                  storage: old_test
                  is_public: true
                  sub_type: mongodb
                  is_oem_connector: true
              OEM Connectors:
                value:
                  name: sample source
                  environment_id: 5fda050e7758f32604184d38
                  storage_id: 5fda050e7758f32604184d38
                  data_lake_schema: kafka
                  data_lake_path: /iw/kafka-source
                  type: rdbms
                  is_source_ingested": true
                  storage: old_test
                  is_public: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: fdf5c3fb3afaf1c3d286ef95
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
      x-codegen-request-body-name: configurations
  /sources/{source_id}:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Sources
      summary: Get Source Info
      description: Get Source Info
      operationId: getSourceInfo
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    allOf:
                      - type: object
                        allOf:
                          - properties:
                              id:
                                type: string
                                example: 354t45656556254564545
                              name:
                                type: string
                                example: sample source
                              type:
                                type: string
                                example: streaming
                              sub_type:
                                type: string
                                example: kafka
                                enum:
                                  - kafka
                                  - structured
                                  - json
                                  - xml
                                  - unstructured
                                  - teradata
                                  - redshift
                                  - oracle
                                  - mysql
                                  - mariadb
                                  - sqlserver
                                  - db2
                                  - netezza
                                  - saphana
                                  - hive
                                  - sybaseiq
                                  - ignite
                                  - vertica
                                  - maprdb
                                  - mongodb
                                  - rest_generic
                                  - salesforce
                              data_lake_path:
                                type: string
                                example: /iw/kafka-source
                              use_staging_schema_for_infoworks_managed_tables:
                                type: boolean
                                example: true
                              use_staging_dataset_for_infoworks_managed_tables:
                                type: boolean
                                example: true
                              description:
                                type: string
                                example: example description
                              tags:
                                type: array
                                items:
                                  example: c54t456f6d5a2c4564aed
                              data_lake_schema:
                                type: string
                                example: kafka
                              state:
                                type: string
                                example: ready
                              is_source_ingested:
                                type: boolean
                                example: true
                              is_public:
                                type: boolean
                          - type: object
                            allOf:
                              - type: object
                                properties:
                                  created_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  created_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                              - type: object
                                properties:
                                  modified_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  modified_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                      - properties:
                          tables:
                            type: array
                            items:
                              type: string
                              example: c74a5abb4854ac0a70206f00
                      - type: object
                        properties:
                          environment_details:
                            type: array
                            items:
                              type: object
                              properties:
                                environment:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: 63cd71df9f1c1e258c6e991b
                                    name:
                                      type: string
                                      example: env_azure
                                    compute_engine:
                                      type: string
                                      example: spark
                                    platform:
                                      type: string
                                      example: databricks
                                ephemeral_compute:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                        example: ephemeral_compute
                                      environment_id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                interactive_compute:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                        example: interactive_compute
                                      environment_id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                storage:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      name:
                                        type: string
                                        example: storage
                                      environment_id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      description:
                                        type: string
                                        example: description for storage
                                      storage_type:
                                        type: string
                                        example: gcs
                                      storage_authentication:
                                        type: object
                                        properties:
                                          authentication_mechanism:
                                            type: string
                                            example: environment_service_credential
                                          scheme:
                                            type: string
                                            example: gs://
                                          bucket_name:
                                            type: string
                                            example: temp-bucket-xxx
                          connection:
                            type: object
                            properties:
                              environment_details:
                                type: object
                                properties:
                                  environment:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      name:
                                        type: string
                                        example: env_azure
                                      compute_engine:
                                        type: string
                                        example: spark
                                      platform:
                                        type: string
                                        example: databricks
                                      description:
                                        type: string
                                        example: Test Description
                                  ephemeral_compute:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        name:
                                          type: string
                                          example: ephemeral_compute
                                        environment_id:
                                          type: string
                                          example: 63cd71df9f1c1e258c6e991b
                                        id:
                                          type: string
                                          example: 63cd71df9f1c1e258c6e991b
                                  interactive_compute:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        name:
                                          type: string
                                          example: interactive_compute
                                        environment_id:
                                          type: string
                                          example: 63cd71df9f1c1e258c6e991b
                                        id:
                                          type: string
                                          example: 63cd71df9f1c1e258c6e991b
                                  storage:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        id:
                                          type: string
                                          example: 63cd71df9f1c1e258c6e991b
                                        name:
                                          type: string
                                          example: storage
                                        environment_id:
                                          type: string
                                          example: 63cd71df9f1c1e258c6e991b
                          configuration:
                            type: object
                            properties:
                              oracle_staging_database:
                                type: string
                                example: AUTOMATION_DB_LOG_DEFAULTST19
                              oracle_logminer_dictionary_type:
                                type: string
                                example: online
                              oracle_logbased_cdc_enabled:
                                type: boolean
                                example: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    delete:
      security:
        - BearerAuth: []
      tags:
        - Sources
      summary: Delete source
      description: Delete source
      operationId: deleteSource
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: fdf5c3fb3afaf1c3d286ef95
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    patch:
      security:
        - BearerAuth: []
      tags:
        - Sources
      summary: Update source
      description: Update source
      operationId: updateSource
      requestBody:
        description: Source configurations
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: Sales_data
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: fdf5c3fb3afaf1c3d286ef95
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
      x-codegen-request-body-name: configurations
  /sources/{source_id}/metadata:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    put:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: update source metadata
      description: update source metadata
      requestBody:
        description: Source Metadata
        content:
          application/json:
            schema:
              type: object
              properties:
                tags_to_add:
                  type: array
                  items:
                    type: string
                    example: sales
                tags_to_remove:
                  type: array
                  items:
                    type: string
                    example: engg
                is_favorite:
                  type: boolean
                  example: true
                description:
                  type: string
                  example: description
            examples:
              EntityMetadata:
                value:
                  tags_to_add:
                    - sales
                  tags_to_remove:
                    - engg
                  is_favorite: true
                  description: description
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully updated metadata
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: get source metadata
      description: get source metadata
      responses:
        '200':
          description: get source metadata
          content:
            application/json:
              schema:
                type: object
                properties:
                  tags:
                    type: array
                    items:
                      type: string
                      example: sales
                  is_favorite:
                    type: boolean
                    example: true
                  description:
                    type: string
                    example: description
              examples:
                EntityMetadata:
                  value:
                    tags:
                      - sales
                    is_favorite: true
                    description: description
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/edit-staging-fields:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: get whether staging fields can be edited
      description: get whether staging fields can be edited
      responses:
        '200':
          description: get whether staging fields can be edited
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: 'Fetched result. '
                  result:
                    type: boolean
                    example: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/source_tables:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: is_filter_enabled
        in: query
        description: True if filter is passed
        required: true
        schema:
          type: boolean
          example: true
      - name: schemas_filter
        in: query
        description: schema filter
        schema:
          type: string
          example: ingestion
      - name: catalogs_filter
        in: query
        description: catalogs filter
        schema:
          type: string
          example: catalog_name
      - name: tables_filter
        in: query
        description: tables filter
        schema:
          type: string
          example: table1
    get:
      security:
        - BearerAuth: []
      tags:
        - Sources
      summary: Browse source
      description: Browse source
      operationId: browseSource
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Source Browsed Successfully.
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: fdf5c3fb3afaf1c3d286ef95
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/jobs/{job_id}/reports/ingestion-metrics:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Metrics
      summary: Get Ingestion Metrics with job id.
      description: Get Ingestion Metrics with job id.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            number_of_records_written:
                              type: integer
                              format: integer
                            number_of_records_read:
                              type: integer
                              format: integer
                            last_merged_watermark:
                              type: string
                              format: string
                            first_merged_watermark:
                              type: string
                              format: string
                            source_table_name:
                              type: string
                              format: string
                            source_schema_name:
                              type: string
                              format: string
                            source_database_name:
                              type: string
                              format: string
                            workflow_run_id:
                              type: string
                              format: string
                            workflow_id:
                              type: string
                              format: string
                            job_duration:
                              type: string
                              format: string
                            job_end_time:
                              type: string
                              format: string
                            job_id:
                              type: string
                              format: string
                            job_start_time:
                              type: string
                              format: string
                            table_id:
                              type: string
                              format: string
                            job_status:
                              type: string
                              format: string
                            target_records_count:
                              type: string
                              format: string
                            fetch_records_count:
                              type: string
                              format: string
                            job_type:
                              type: string
                              format: string
                            source_id:
                              type: string
                              format: string
                            query_tag:
                              type: string
                              format: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/jobs/{job_id}/reports/job-metrics:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Metrics
      summary: Get job metrics with job id.
      description: Get job metrics with job id.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            job_duration:
                              type: string
                              format: string
                            job_end_time:
                              type: string
                              format: string
                            job_id:
                              type: string
                              format: string
                            job_start_time:
                              type: string
                              format: string
                            table_id:
                              type: string
                              format: string
                            job_status:
                              type: string
                              format: string
                            target_record_count:
                              type: string
                              format: string
                            fetch_record_count:
                              type: string
                              format: string
                            job_type:
                              type: string
                              format: string
                            source_id:
                              type: string
                              format: string
                            query_tag:
                              type: string
                              format: string
  /sources/{source_id}/jobs/{job_id}/reports/export-metrics:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Metrics
      summary: Get Export Metrics with job id.
      description: Get Export Metrics with job id.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            number_of_records_written:
                              type: integer
                              format: integer
                            number_of_records_read:
                              type: integer
                              format: integer
                            last_merged_watermark:
                              type: string
                              format: string
                            first_merged_watermark:
                              type: string
                              format: string
                            source_table_name:
                              type: string
                              format: string
                            target_table_name:
                              type: string
                              format: string
                            source_database_name:
                              type: string
                              format: string
                            workflow_run_id:
                              type: string
                              format: string
                            workflow_id:
                              type: string
                              format: string
                            job_duration:
                              type: string
                              format: string
                            job_end_time:
                              type: string
                              format: string
                            job_id:
                              type: string
                              format: string
                            job_start_time:
                              type: string
                              format: string
                            table_id:
                              type: string
                              format: string
                            job_status:
                              type: string
                              format: string
                            target_records_count:
                              type: string
                              format: string
                            job_type:
                              type: string
                              format: string
                            source_id:
                              type: string
                              format: string
                            query_tag:
                              type: string
                              format: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/reports/table-metrics:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: table_group_id
        in: path
        description: Table Group Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Metrics
      summary: Get Metrics for all tables in the source.
      description: Get Metrics for all tables in the source.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Ingestion table metrics
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            job_duration:
                              type: integer
                              example: 46470
                            job_id:
                              type: string
                              example: 600a79ed7758f33ee14b755a
                            job_start_time:
                              type: string
                              format: date-time
                            job_end_time:
                              type: string
                              format: date-time
                            job_status:
                              type: string
                              example: SUCCEEDED
                            job_type:
                              type: string
                              example: Infoworks Job type
                            fetch_records_count:
                              type: integer
                              minimum: 0
                            target_records_count:
                              type: integer
                              minimum: 0
                            table_id:
                              type: string
                              example: 600a79ed7758f33ee14b755a
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/jobs/{job_id}/reports/export-metrics:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Metrics
      summary: Get the Export-metrics of the table with job id
      description: Get the Export-metrics of the table with job id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            result:
                              type: array
                              items:
                                type: object
                                properties:
                                  number_of_records_written:
                                    type: integer
                                    format: integer
                                  number_of_records_read:
                                    type: integer
                                    format: integer
                                  last_merged_watermark:
                                    type: string
                                    format: string
                                  first_merged_watermark:
                                    type: string
                                    format: string
                                  source_table_name:
                                    type: string
                                    format: string
                                  target_table_name:
                                    type: string
                                    format: string
                                  source_database_name:
                                    type: string
                                    format: string
                                  workflow_run_id:
                                    type: string
                                    format: string
                                  workflow_id:
                                    type: string
                                    format: string
                                  job_duration:
                                    type: string
                                    format: string
                                  job_end_time:
                                    type: string
                                    format: string
                                  job_id:
                                    type: string
                                    format: string
                                  job_start_time:
                                    type: string
                                    format: string
                                  table_id:
                                    type: string
                                    format: string
                                  job_status:
                                    type: string
                                    format: string
                                  target_records_count:
                                    type: string
                                    format: string
                                  job_type:
                                    type: string
                                    format: string
                                  source_id:
                                    type: string
                                    format: string
                                  query_tag:
                                    type: string
                                    format: string
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/jobs/{job_id}/reports/ingestion-metrics:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Metrics
      summary: Get the ingestion-metrics of the table with job id
      description: Get the ingestion-metrics of the table with job id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            result:
                              type: array
                              items:
                                type: object
                                properties:
                                  number_of_records_written:
                                    type: integer
                                    format: integer
                                  number_of_records_read:
                                    type: integer
                                    format: integer
                                  last_merged_watermark:
                                    type: string
                                    format: string
                                  first_merged_watermark:
                                    type: string
                                    format: string
                                  source_table_name:
                                    type: string
                                    format: string
                                  source_schema_name:
                                    type: string
                                    format: string
                                  source_database_name:
                                    type: string
                                    format: string
                                  workflow_run_id:
                                    type: string
                                    format: string
                                  workflow_id:
                                    type: string
                                    format: string
                                  job_duration:
                                    type: string
                                    format: string
                                  job_end_time:
                                    type: string
                                    format: string
                                  job_id:
                                    type: string
                                    format: string
                                  job_start_time:
                                    type: string
                                    format: string
                                  table_id:
                                    type: string
                                    format: string
                                  job_status:
                                    type: string
                                    format: string
                                  target_records_count:
                                    type: string
                                    format: string
                                  fetch_records_count:
                                    type: string
                                    format: string
                                  job_type:
                                    type: string
                                    format: string
                                  source_id:
                                    type: string
                                    format: string
                                  query_tag:
                                    type: string
                                    format: string
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/jobs/{job_id}/reports/sourceFilesPath:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Get the list of Source Files paths of the table
      description: Get the list of Source Files paths of the table
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            result:
                              type: array
                              items:
                                type: string
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/reports/ingestion-metrics:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Metrics
      summary: Get the ingestion-metrics for the table
      description: Get the ingestion-metrics for the table
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            result:
                              type: array
                              items:
                                type: object
                                properties:
                                  number_of_records_written:
                                    type: integer
                                    format: integer
                                  number_of_records_read:
                                    type: integer
                                    format: integer
                                  last_merged_watermark:
                                    type: string
                                    format: string
                                  first_merged_watermark:
                                    type: string
                                    format: string
                                  source_table_name:
                                    type: string
                                    format: string
                                  source_schema_name:
                                    type: string
                                    format: string
                                  source_database_name:
                                    type: string
                                    format: string
                                  workflow_run_id:
                                    type: string
                                    format: string
                                  workflow_id:
                                    type: string
                                    format: string
                                  job_duration:
                                    type: string
                                    format: string
                                  job_end_time:
                                    type: string
                                    format: string
                                  job_id:
                                    type: string
                                    format: string
                                  job_start_time:
                                    type: string
                                    format: string
                                  table_id:
                                    type: string
                                    format: string
                                  job_status:
                                    type: string
                                    format: string
                                  target_records_count:
                                    type: string
                                    format: string
                                  fetch_records_count:
                                    type: string
                                    format: string
                                  job_type:
                                    type: string
                                    format: string
                                  source_id:
                                    type: string
                                    format: string
                                  query_tag:
                                    type: string
                                    format: string
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/reports/ingestion-metrics/download:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Metrics
      summary: Download ingestion metrics for the table
      description: Download ingestion metrics for the table
      responses:
        '200':
          description: Ok.
          content:
            application/csv:
              schema:
                type: string
                format: binary
            application/octet-stream:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/:source_id/reports/jobs/ingestion-metrics:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Jobs
      summary: Get List of All jobs of this Source and it's artifacts.
      description: Get List of All jobs of this Source and it's artifacts.
      parameters:
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 8714887c9a8c5bb0b8794811
                            build_id:
                              type: integer
                              example: 2
                            name:
                              type: string
                              example: test_job
                            status:
                              type: string
                              enum:
                                - completed
                                - pending
                                - aborted
                                - blocked
                                - failed
                                - running
                                - canceled
                                - succeeded
                              example: completed
                            percentage:
                              type: integer
                              example: 100
                            type:
                              type: string
                              enum:
                                - source_test_connection
                                - fetch_metadata
                                - source_structured_fetch_metadata
                                - source_crawl
                                - source_crawl_chunk_load
                                - source_cdc
                                - source_unstructured_crawl
                                - source_structured_crawl
                                - source_semistructured_crawl
                                - delete_entity
                                - pipeline_metadata
                                - pipeline_build
                                - pipeline_build_restatement
                                - full_load
                                - cdc
                                - source_merge
                                - source_structured_cdc_merge
                                - source_structured_cdc
                                - source_cdc_merge
                                - source_cdc_restatement
                                - source_semistructured_cdc_merge
                                - source_semistructured_cdc
                                - metadata_cleanup_policy
                            entity_id:
                              type: string
                              example: d2f33c1d424363162692b3bf
                            entity_type:
                              type: string
                              enum:
                                - source
                                - pipeline
                                - workflow
                            sub_entity_id:
                              type: string
                              example: be034607444511f74313be63
                            sub_entity_type:
                              type: string
                              example: table_group
                            duration:
                              type: integer
                              example: 349316
                              description: This is duration of the job.
                            cluster_id:
                              type: string
                              example: j-134jnasdkjaasd
                              description: Extenal clusterId
                            compute_id:
                              type: string
                              example: be034607444511f74313be63
                              description: Infoworks compute cluster id
                            compute_name:
                              type: string
                              example: Default_Persistent_cluster
                              description: Infoworks compute name
                            created_at:
                              type: string
                              format: date-time
                              example: '2020-10-05T04:23:30.339Z'
                            created_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                              description: UserId of user who triggered the job.
                            last_updated:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
                            processed_at:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /sources/:source_id/reports/jobs/ingestion-metrics/download:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Metrics
      summary: Download List of All jobs of this Source and it's artifacts.
      description: Download List of All jobs of this Source and it's artifacts.
      responses:
        '200':
          description: Ok.
          content:
            application/csv:
              schema:
                type: string
                format: binary
            application/octet-stream:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/reports/export-metrics:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Metrics
      summary: Get the export-metrics for the table
      description: Get the export-metrics for the table
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            result:
                              type: array
                              items:
                                type: object
                                properties:
                                  number_of_records_written:
                                    type: integer
                                    format: integer
                                  number_of_records_read:
                                    type: integer
                                    format: integer
                                  last_merged_watermark:
                                    type: string
                                    format: string
                                  first_merged_watermark:
                                    type: string
                                    format: string
                                  source_table_name:
                                    type: string
                                    format: string
                                  target_table_name:
                                    type: string
                                    format: string
                                  source_database_name:
                                    type: string
                                    format: string
                                  workflow_run_id:
                                    type: string
                                    format: string
                                  workflow_id:
                                    type: string
                                    format: string
                                  job_duration:
                                    type: string
                                    format: string
                                  job_end_time:
                                    type: string
                                    format: string
                                  job_id:
                                    type: string
                                    format: string
                                  job_start_time:
                                    type: string
                                    format: string
                                  table_id:
                                    type: string
                                    format: string
                                  job_status:
                                    type: string
                                    format: string
                                  target_records_count:
                                    type: string
                                    format: string
                                  job_type:
                                    type: string
                                    format: string
                                  source_id:
                                    type: string
                                    format: string
                                  query_tag:
                                    type: string
                                    format: string
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/query_tables:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    post:
      security:
        - BearerAuth: []
      tags:
        - Sources
      summary: Add query tables
      description: Add query tables
      operationId: addQueryTables
      requestBody:
        description: Query table configurations
        content:
          application/json:
            schema:
              type: object
              properties:
                tables_to_add:
                  type: object
                  example:
                    - table_type: TABLE
                      query: select * from "company"."sales"."order"
                      target_table_name: order
                      target_schema_name: sales
                      target_database_name: testdb
                      target_dataset_name: test_dataset
                      project_id: test-id
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Query table added Successfully.
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: fdf5c3fb3afaf1c3d286ef95
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/meta-crawled-table-count:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: table_ids
        in: query
        description: Required for getting the metacrawled table list
        required: true
        schema:
          type: array
          items:
            type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Get meta crawled table count
      description: Get meta crawled table count
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        properties:
                          count:
                            type: number
                            example: 546
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/source_tables/excluded-tables:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Get List of excluded tables
      description: Get List of source table which are not yet ingested
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 63c7c6703eed7852977aa219
                            tableName:
                              type: string
                              example: Table2
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/source_tables/schema-for-source:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Get Source schema
      description: Get all distinct schema for a given source table
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            schemaName:
                              type: string
                              example: Table2
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /schema/exists:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
    post:
      security:
        - BearerAuth: []
      tags:
        - Misc
      summary: Check if schema is unique
      description: Check if schema is unique
      operationId: checkUniqueSchema
      requestBody:
        description: Source configurations
        content:
          application/json:
            schema:
              type: object
              properties:
                schema:
                  type: string
                  example: Ebola
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      exists:
                        type: boolean
                        example: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
      x-codegen-request-body-name: schema
  /path/exists:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
    post:
      security:
        - BearerAuth: []
      tags:
        - Misc
      summary: Check if path is unique
      description: Check if path is unique
      operationId: checkUniquePath
      requestBody:
        description: Source configurations
        content:
          application/json:
            schema:
              type: object
              properties:
                path:
                  type: string
                  example: Ebola
                storage_type:
                  type: string
                  example: Ebola
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      exists:
                        type: boolean
                        example: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
      x-codegen-request-body-name: path
  /sources/{source_id}/configurations/connection:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Connections
      summary: Get source connection details
      description: Get source connection details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        properties:
                          enable_log_based_cdc:
                            type: boolean
                            example: false
                          driver_name:
                            type: string
                            example: oracle.jdbc.driver.OracleDriver
                          connection_url:
                            type: string
                            example: bc:oracle:thin:@0.0.0.0
                          username:
                            example: automation_db
                          password:
                            oneOf:
                              - type: string
                                minLength: 1
                                example:
                                  - passw@rd_plain
                                  - >-
                                    gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                              - type: object
                                properties:
                                  password_type:
                                    type: string
                                    enum:
                                      - infoworks_managed
                                  password:
                                    type: string
                                    minLength: 1
                                    example:
                                      - passw@rd_plain
                                      - >-
                                        gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                              - type: object
                                properties:
                                  password_type:
                                    type: string
                                    enum:
                                      - secret_store
                                  secret_id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                          source_schema:
                            type: string
                            example: AUTOMATION_DB
                          connection_mode:
                            type: string
                            example: JDBC
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    put:
      security:
        - BearerAuth: []
      tags:
        - Connections
      summary: Update an existing source connection
      description: Update an existing source connection
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - allOf:
                    - type: object
                      required:
                        - source_schema
                        - username
                        - password
                        - database
                      properties:
                        connection_mode:
                          type: string
                          example: jdbc
                          enum:
                            - jdbc
                        connection_url:
                          type: string
                          example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                        source_schema:
                          type: string
                          example: test_schema
                        username:
                          type: string
                          example: Lucifer
                        password:
                          oneOf:
                            - type: string
                              minLength: 1
                              example:
                                - passw@rd_plain
                                - >-
                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                password:
                                  type: string
                                  minLength: 1
                                  example:
                                    - passw@rd_plain
                                    - >-
                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                        database:
                          type: string
                          example: automation_db
                        snowflake_profile:
                          type: string
                          example: profile1
                        warehouse:
                          type: string
                          example: DEMO_WH
                    - type: object
                      properties:
                        enable_log_based_cdc:
                          type: boolean
                          example: true
                        staging_database:
                          type: string
                          example: db_staging
                        enable_dictionary_rebuild_for_each_job:
                          type: boolean
                          example: true
                        dictionary_path:
                          type: string
                          example: /tmp/dict
                        dictionary_type:
                          type: string
                          example: online
                          enum:
                            - online
                            - offline
                            - redo_log
                - allOf:
                    - type: object
                      required:
                        - source_schema
                        - username
                        - password
                        - database
                      properties:
                        connection_mode:
                          type: string
                          example: jdbc
                          enum:
                            - jdbc
                        connection_url:
                          type: string
                          example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                        source_schema:
                          type: string
                          example: test_schema
                        username:
                          type: string
                          example: Lucifer
                        password:
                          oneOf:
                            - type: string
                              minLength: 1
                              example:
                                - passw@rd_plain
                                - >-
                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                password:
                                  type: string
                                  minLength: 1
                                  example:
                                    - passw@rd_plain
                                    - >-
                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                        database:
                          type: string
                          example: automation_db
                        snowflake_profile:
                          type: string
                          example: profile1
                        warehouse:
                          type: string
                          example: DEMO_WH
                - allOf:
                    - type: object
                      required:
                        - source_schema
                        - username
                        - password
                        - database
                      properties:
                        connection_mode:
                          type: string
                          example: jdbc
                          enum:
                            - jdbc
                        connection_url:
                          type: string
                          example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                        source_schema:
                          type: string
                          example: test_schema
                        username:
                          type: string
                          example: Lucifer
                        password:
                          oneOf:
                            - type: string
                              minLength: 1
                              example:
                                - passw@rd_plain
                                - >-
                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                password:
                                  type: string
                                  minLength: 1
                                  example:
                                    - passw@rd_plain
                                    - >-
                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                        database:
                          type: string
                          example: automation_db
                        snowflake_profile:
                          type: string
                          example: profile1
                        warehouse:
                          type: string
                          example: DEMO_WH
                - allOf:
                    - type: object
                      required:
                        - source_schema
                        - username
                        - password
                        - database
                      properties:
                        connection_mode:
                          type: string
                          example: jdbc
                          enum:
                            - jdbc
                        connection_url:
                          type: string
                          example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                        source_schema:
                          type: string
                          example: test_schema
                        username:
                          type: string
                          example: Lucifer
                        password:
                          oneOf:
                            - type: string
                              minLength: 1
                              example:
                                - passw@rd_plain
                                - >-
                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                password:
                                  type: string
                                  minLength: 1
                                  example:
                                    - passw@rd_plain
                                    - >-
                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                        database:
                          type: string
                          example: automation_db
                        snowflake_profile:
                          type: string
                          example: profile1
                        warehouse:
                          type: string
                          example: DEMO_WH
                    - type: object
                      properties:
                        enable_teradata_wallet:
                          type: boolean
                          example: true
                        teradata_wallet_key_used_for_password:
                          type: string
                        storage:
                          oneOf:
                            - allOf:
                                - type: object
                                  properties:
                                    storage_type:
                                      type: string
                                      enum:
                                        - dbfs
                                        - remote
                                        - cloud
                            - allOf:
                                - type: object
                                  properties:
                                    storage_type:
                                      type: string
                                      enum:
                                        - dbfs
                                        - remote
                                        - cloud
                                - type: object
                                  required:
                                    - sftp_host
                                    - sftp_port
                                    - username
                                    - password
                                    - auth_type
                                  properties:
                                    sftp_host:
                                      type: string
                                      example: 192.168.1.1
                                    sftp_port:
                                      type: integer
                                      example: 22
                                    username:
                                      type: string
                                      example: Lucifer
                                    password:
                                      oneOf:
                                        - type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - infoworks_managed
                                            password:
                                              type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - secret_store
                                            secret_id:
                                              type: string
                                              example: e77850ad5127a2d7dab870ff
                                    auth_type:
                                      type: string
                                      example: password
                                    credential:
                                      oneOf:
                                        - type: object
                                          required:
                                            - type
                                            - username
                                            - password
                                          properties:
                                            type:
                                              type: string
                                              example: basic
                                            username:
                                              type: string
                                              example: sftp-user
                                            password:
                                              oneOf:
                                                - type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - infoworks_managed
                                                    password:
                                                      type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - secret_store
                                                    secret_id:
                                                      type: string
                                                      example: e77850ad5127a2d7dab870ff
                                        - type: object
                                          required:
                                            - type
                                            - username
                                            - private_key_path
                                            - passphrase
                                          properties:
                                            type:
                                              type: string
                                              example: key
                                            username:
                                              type: string
                                              example: sftp-user
                                            private_key_path:
                                              type: string
                                              example: /opt/infoworks/key
                                            passphrase:
                                              type: string
                                              example: J9moLFp0XjMhsLu
                            - oneOf:
                                - allOf:
                                    - type: object
                                      properties:
                                        storage_type:
                                          type: string
                                          enum:
                                            - dbfs
                                            - remote
                                            - cloud
                                    - type: object
                                      properties:
                                        cloud_type:
                                          type: string
                                          enum:
                                            - s3
                                            - wasb
                                            - gs
                                    - type: object
                                      required:
                                        - type
                                        - base_path
                                        - credential
                                      properties:
                                        account_type:
                                          type: string
                                        access_id:
                                          type: string
                                        secret_key:
                                          oneOf:
                                            - type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - infoworks_managed
                                                password:
                                                  type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - secret_store
                                                secret_id:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                        access_type:
                                          type: string
                                        support_gov_cloud:
                                          type: boolean
                                        endpoint:
                                          type: string
                                - allOf:
                                    - type: object
                                      properties:
                                        storage_type:
                                          type: string
                                          enum:
                                            - dbfs
                                            - remote
                                            - cloud
                                    - type: object
                                      properties:
                                        cloud_type:
                                          type: string
                                          enum:
                                            - s3
                                            - wasb
                                            - gs
                                    - type: object
                                      properties:
                                        access_type:
                                          type: string
                                          example: service_account
                                          enum:
                                            - service_account
                                        project_id:
                                          type: string
                                          example: csv_store
                                        upload_option:
                                          type: string
                                          enum:
                                            - fileUpload
                                            - serverLocation
                                          example: fileUpload
                                        server_path:
                                          type: string
                                          description: >-
                                            required if upload_option is set to
                                            serverLocation
                                          example: >-
                                            /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json
                                - allOf:
                                    - type: object
                                      properties:
                                        storage_type:
                                          type: string
                                          enum:
                                            - dbfs
                                            - remote
                                            - cloud
                                    - type: object
                                      properties:
                                        cloud_type:
                                          type: string
                                          enum:
                                            - s3
                                            - wasb
                                            - gs
                                    - type: object
                                      properties:
                                        account_name:
                                          type: string
                                        account_key:
                                          oneOf:
                                            - type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - infoworks_managed
                                                password:
                                                  type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - secret_store
                                                secret_id:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                        account_endpoint:
                                          type: string
                                        container_name:
                                          type: string
                                        support_gov_cloud:
                                          type: boolean
                                        access_type:
                                          type: string
                                          enum:
                                            - none
                                            - account_key
                        enable_ingestion_via_tpt:
                          type: boolean
                          example: true
                        is_td_wallet_enabled:
                          type: boolean
                          example: true
                        enable_tpt_for_source:
                          type: boolean
                          example: true
                - allOf:
                    - type: object
                      required:
                        - source_schema
                        - username
                        - password
                        - database
                      properties:
                        connection_mode:
                          type: string
                          example: jdbc
                          enum:
                            - jdbc
                        connection_url:
                          type: string
                          example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                        source_schema:
                          type: string
                          example: test_schema
                        username:
                          type: string
                          example: Lucifer
                        password:
                          oneOf:
                            - type: string
                              minLength: 1
                              example:
                                - passw@rd_plain
                                - >-
                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                password:
                                  type: string
                                  minLength: 1
                                  example:
                                    - passw@rd_plain
                                    - >-
                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                        database:
                          type: string
                          example: automation_db
                        snowflake_profile:
                          type: string
                          example: profile1
                        warehouse:
                          type: string
                          example: DEMO_WH
                - allOf:
                    - type: object
                      required:
                        - source_schema
                        - username
                        - password
                        - database
                      properties:
                        connection_mode:
                          type: string
                          example: jdbc
                          enum:
                            - jdbc
                        connection_url:
                          type: string
                          example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                        source_schema:
                          type: string
                          example: test_schema
                        username:
                          type: string
                          example: Lucifer
                        password:
                          oneOf:
                            - type: string
                              minLength: 1
                              example:
                                - passw@rd_plain
                                - >-
                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                password:
                                  type: string
                                  minLength: 1
                                  example:
                                    - passw@rd_plain
                                    - >-
                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                        database:
                          type: string
                          example: automation_db
                        snowflake_profile:
                          type: string
                          example: profile1
                        warehouse:
                          type: string
                          example: DEMO_WH
                - type: object
                  required:
                    - source_type
                    - storage
                  properties:
                    source_type:
                      type: string
                      example: structured_files
                      enum:
                        - structured_files
                    storage:
                      oneOf:
                        - allOf:
                            - type: object
                              properties:
                                storage_type:
                                  type: string
                                  enum:
                                    - dbfs
                                    - remote
                                    - cloud
                        - allOf:
                            - type: object
                              properties:
                                storage_type:
                                  type: string
                                  enum:
                                    - dbfs
                                    - remote
                                    - cloud
                            - type: object
                              required:
                                - sftp_host
                                - sftp_port
                                - username
                                - password
                                - auth_type
                              properties:
                                sftp_host:
                                  type: string
                                  example: 192.168.1.1
                                sftp_port:
                                  type: integer
                                  example: 22
                                username:
                                  type: string
                                  example: Lucifer
                                password:
                                  oneOf:
                                    - type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - infoworks_managed
                                        password:
                                          type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                auth_type:
                                  type: string
                                  example: password
                                credential:
                                  oneOf:
                                    - type: object
                                      required:
                                        - type
                                        - username
                                        - password
                                      properties:
                                        type:
                                          type: string
                                          example: basic
                                        username:
                                          type: string
                                          example: sftp-user
                                        password:
                                          oneOf:
                                            - type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - infoworks_managed
                                                password:
                                                  type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - secret_store
                                                secret_id:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                    - type: object
                                      required:
                                        - type
                                        - username
                                        - private_key_path
                                        - passphrase
                                      properties:
                                        type:
                                          type: string
                                          example: key
                                        username:
                                          type: string
                                          example: sftp-user
                                        private_key_path:
                                          type: string
                                          example: /opt/infoworks/key
                                        passphrase:
                                          type: string
                                          example: J9moLFp0XjMhsLu
                        - oneOf:
                            - allOf:
                                - type: object
                                  properties:
                                    storage_type:
                                      type: string
                                      enum:
                                        - dbfs
                                        - remote
                                        - cloud
                                - type: object
                                  properties:
                                    cloud_type:
                                      type: string
                                      enum:
                                        - s3
                                        - wasb
                                        - gs
                                - type: object
                                  required:
                                    - type
                                    - base_path
                                    - credential
                                  properties:
                                    account_type:
                                      type: string
                                    access_id:
                                      type: string
                                    secret_key:
                                      oneOf:
                                        - type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - infoworks_managed
                                            password:
                                              type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - secret_store
                                            secret_id:
                                              type: string
                                              example: e77850ad5127a2d7dab870ff
                                    access_type:
                                      type: string
                                    support_gov_cloud:
                                      type: boolean
                                    endpoint:
                                      type: string
                            - allOf:
                                - type: object
                                  properties:
                                    storage_type:
                                      type: string
                                      enum:
                                        - dbfs
                                        - remote
                                        - cloud
                                - type: object
                                  properties:
                                    cloud_type:
                                      type: string
                                      enum:
                                        - s3
                                        - wasb
                                        - gs
                                - type: object
                                  properties:
                                    access_type:
                                      type: string
                                      example: service_account
                                      enum:
                                        - service_account
                                    project_id:
                                      type: string
                                      example: csv_store
                                    upload_option:
                                      type: string
                                      enum:
                                        - fileUpload
                                        - serverLocation
                                      example: fileUpload
                                    server_path:
                                      type: string
                                      description: >-
                                        required if upload_option is set to
                                        serverLocation
                                      example: >-
                                        /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json
                            - allOf:
                                - type: object
                                  properties:
                                    storage_type:
                                      type: string
                                      enum:
                                        - dbfs
                                        - remote
                                        - cloud
                                - type: object
                                  properties:
                                    cloud_type:
                                      type: string
                                      enum:
                                        - s3
                                        - wasb
                                        - gs
                                - type: object
                                  properties:
                                    account_name:
                                      type: string
                                    account_key:
                                      oneOf:
                                        - type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - infoworks_managed
                                            password:
                                              type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - secret_store
                                            secret_id:
                                              type: string
                                              example: e77850ad5127a2d7dab870ff
                                    account_endpoint:
                                      type: string
                                    container_name:
                                      type: string
                                    support_gov_cloud:
                                      type: boolean
                                    access_type:
                                      type: string
                                      enum:
                                        - none
                                        - account_key
                - type: object
                  required:
                    - source_base_path
                    - storage
                  properties:
                    source_base_path:
                      type: string
                      example: /sources/csv_source
                    storage:
                      oneOf:
                        - allOf:
                            - type: object
                              properties:
                                storage_type:
                                  type: string
                                  enum:
                                    - dbfs
                                    - remote
                                    - cloud
                        - allOf:
                            - type: object
                              properties:
                                storage_type:
                                  type: string
                                  enum:
                                    - dbfs
                                    - remote
                                    - cloud
                            - type: object
                              required:
                                - sftp_host
                                - sftp_port
                                - username
                                - password
                                - auth_type
                              properties:
                                sftp_host:
                                  type: string
                                  example: 192.168.1.1
                                sftp_port:
                                  type: integer
                                  example: 22
                                username:
                                  type: string
                                  example: Lucifer
                                password:
                                  oneOf:
                                    - type: string
                                      minLength: 1
                                      example:
                                        - passw@rd_plain
                                        - >-
                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - infoworks_managed
                                        password:
                                          type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                            - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                auth_type:
                                  type: string
                                  example: password
                                credential:
                                  oneOf:
                                    - type: object
                                      required:
                                        - type
                                        - username
                                        - password
                                      properties:
                                        type:
                                          type: string
                                          example: basic
                                        username:
                                          type: string
                                          example: sftp-user
                                        password:
                                          oneOf:
                                            - type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - infoworks_managed
                                                password:
                                                  type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - secret_store
                                                secret_id:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                    - type: object
                                      required:
                                        - type
                                        - username
                                        - private_key_path
                                        - passphrase
                                      properties:
                                        type:
                                          type: string
                                          example: key
                                        username:
                                          type: string
                                          example: sftp-user
                                        private_key_path:
                                          type: string
                                          example: /opt/infoworks/key
                                        passphrase:
                                          type: string
                                          example: J9moLFp0XjMhsLu
                        - oneOf:
                            - allOf:
                                - type: object
                                  properties:
                                    storage_type:
                                      type: string
                                      enum:
                                        - dbfs
                                        - remote
                                        - cloud
                                - type: object
                                  properties:
                                    cloud_type:
                                      type: string
                                      enum:
                                        - s3
                                        - wasb
                                        - gs
                                - type: object
                                  required:
                                    - type
                                    - base_path
                                    - credential
                                  properties:
                                    account_type:
                                      type: string
                                    access_id:
                                      type: string
                                    secret_key:
                                      oneOf:
                                        - type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - infoworks_managed
                                            password:
                                              type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - secret_store
                                            secret_id:
                                              type: string
                                              example: e77850ad5127a2d7dab870ff
                                    access_type:
                                      type: string
                                    support_gov_cloud:
                                      type: boolean
                                    endpoint:
                                      type: string
                            - allOf:
                                - type: object
                                  properties:
                                    storage_type:
                                      type: string
                                      enum:
                                        - dbfs
                                        - remote
                                        - cloud
                                - type: object
                                  properties:
                                    cloud_type:
                                      type: string
                                      enum:
                                        - s3
                                        - wasb
                                        - gs
                                - type: object
                                  properties:
                                    access_type:
                                      type: string
                                      example: service_account
                                      enum:
                                        - service_account
                                    project_id:
                                      type: string
                                      example: csv_store
                                    upload_option:
                                      type: string
                                      enum:
                                        - fileUpload
                                        - serverLocation
                                      example: fileUpload
                                    server_path:
                                      type: string
                                      description: >-
                                        required if upload_option is set to
                                        serverLocation
                                      example: >-
                                        /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json
                            - allOf:
                                - type: object
                                  properties:
                                    storage_type:
                                      type: string
                                      enum:
                                        - dbfs
                                        - remote
                                        - cloud
                                - type: object
                                  properties:
                                    cloud_type:
                                      type: string
                                      enum:
                                        - s3
                                        - wasb
                                        - gs
                                - type: object
                                  properties:
                                    account_name:
                                      type: string
                                    account_key:
                                      oneOf:
                                        - type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - infoworks_managed
                                            password:
                                              type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - secret_store
                                            secret_id:
                                              type: string
                                              example: e77850ad5127a2d7dab870ff
                                    account_endpoint:
                                      type: string
                                    container_name:
                                      type: string
                                    support_gov_cloud:
                                      type: boolean
                                    access_type:
                                      type: string
                                      enum:
                                        - none
                                        - account_key
                    key:
                      description: >-
                        required only if gcs cloud storage type is selected with
                        fileUpload Option use content-type as
                        multipart/form-data
                      format: binary
                      example: key.json
                    snowflake_profile:
                      type: string
                      example: profile1
                    warehouse:
                      type: string
                      example: DEMO_WH
                - allOf:
                    - type: object
                      required:
                        - source_base_path
                        - storage
                      properties:
                        source_base_path:
                          type: string
                          example: /sources/csv_source
                        storage:
                          oneOf:
                            - allOf:
                                - type: object
                                  properties:
                                    storage_type:
                                      type: string
                                      enum:
                                        - dbfs
                                        - remote
                                        - cloud
                            - allOf:
                                - type: object
                                  properties:
                                    storage_type:
                                      type: string
                                      enum:
                                        - dbfs
                                        - remote
                                        - cloud
                                - type: object
                                  required:
                                    - sftp_host
                                    - sftp_port
                                    - username
                                    - password
                                    - auth_type
                                  properties:
                                    sftp_host:
                                      type: string
                                      example: 192.168.1.1
                                    sftp_port:
                                      type: integer
                                      example: 22
                                    username:
                                      type: string
                                      example: Lucifer
                                    password:
                                      oneOf:
                                        - type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - infoworks_managed
                                            password:
                                              type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - secret_store
                                            secret_id:
                                              type: string
                                              example: e77850ad5127a2d7dab870ff
                                    auth_type:
                                      type: string
                                      example: password
                                    credential:
                                      oneOf:
                                        - type: object
                                          required:
                                            - type
                                            - username
                                            - password
                                          properties:
                                            type:
                                              type: string
                                              example: basic
                                            username:
                                              type: string
                                              example: sftp-user
                                            password:
                                              oneOf:
                                                - type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - infoworks_managed
                                                    password:
                                                      type: string
                                                      minLength: 1
                                                      example:
                                                        - passw@rd_plain
                                                        - >-
                                                          gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                                - type: object
                                                  properties:
                                                    password_type:
                                                      type: string
                                                      enum:
                                                        - secret_store
                                                    secret_id:
                                                      type: string
                                                      example: e77850ad5127a2d7dab870ff
                                        - type: object
                                          required:
                                            - type
                                            - username
                                            - private_key_path
                                            - passphrase
                                          properties:
                                            type:
                                              type: string
                                              example: key
                                            username:
                                              type: string
                                              example: sftp-user
                                            private_key_path:
                                              type: string
                                              example: /opt/infoworks/key
                                            passphrase:
                                              type: string
                                              example: J9moLFp0XjMhsLu
                            - oneOf:
                                - allOf:
                                    - type: object
                                      properties:
                                        storage_type:
                                          type: string
                                          enum:
                                            - dbfs
                                            - remote
                                            - cloud
                                    - type: object
                                      properties:
                                        cloud_type:
                                          type: string
                                          enum:
                                            - s3
                                            - wasb
                                            - gs
                                    - type: object
                                      required:
                                        - type
                                        - base_path
                                        - credential
                                      properties:
                                        account_type:
                                          type: string
                                        access_id:
                                          type: string
                                        secret_key:
                                          oneOf:
                                            - type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - infoworks_managed
                                                password:
                                                  type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - secret_store
                                                secret_id:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                        access_type:
                                          type: string
                                        support_gov_cloud:
                                          type: boolean
                                        endpoint:
                                          type: string
                                - allOf:
                                    - type: object
                                      properties:
                                        storage_type:
                                          type: string
                                          enum:
                                            - dbfs
                                            - remote
                                            - cloud
                                    - type: object
                                      properties:
                                        cloud_type:
                                          type: string
                                          enum:
                                            - s3
                                            - wasb
                                            - gs
                                    - type: object
                                      properties:
                                        access_type:
                                          type: string
                                          example: service_account
                                          enum:
                                            - service_account
                                        project_id:
                                          type: string
                                          example: csv_store
                                        upload_option:
                                          type: string
                                          enum:
                                            - fileUpload
                                            - serverLocation
                                          example: fileUpload
                                        server_path:
                                          type: string
                                          description: >-
                                            required if upload_option is set to
                                            serverLocation
                                          example: >-
                                            /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json
                                - allOf:
                                    - type: object
                                      properties:
                                        storage_type:
                                          type: string
                                          enum:
                                            - dbfs
                                            - remote
                                            - cloud
                                    - type: object
                                      properties:
                                        cloud_type:
                                          type: string
                                          enum:
                                            - s3
                                            - wasb
                                            - gs
                                    - type: object
                                      properties:
                                        account_name:
                                          type: string
                                        account_key:
                                          oneOf:
                                            - type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - infoworks_managed
                                                password:
                                                  type: string
                                                  minLength: 1
                                                  example:
                                                    - passw@rd_plain
                                                    - >-
                                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                            - type: object
                                              properties:
                                                password_type:
                                                  type: string
                                                  enum:
                                                    - secret_store
                                                secret_id:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                        account_endpoint:
                                          type: string
                                        container_name:
                                          type: string
                                        support_gov_cloud:
                                          type: boolean
                                        access_type:
                                          type: string
                                          enum:
                                            - none
                                            - account_key
                        key:
                          description: >-
                            required only if gcs cloud storage type is selected
                            with fileUpload Option use content-type as
                            multipart/form-data
                          format: binary
                          example: key.json
                        snowflake_profile:
                          type: string
                          example: profile1
                        warehouse:
                          type: string
                          example: DEMO_WH
                    - type: object
                      properties:
                        source_base_path_relative:
                          type: string
                - type: object
                  properties:
                    environment:
                      type: string
                    connection_url:
                      type: string
                    username:
                      type: string
                    password:
                      oneOf:
                        - type: string
                          minLength: 1
                          example:
                            - passw@rd_plain
                            - >-
                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                        - type: object
                          properties:
                            password_type:
                              type: string
                              enum:
                                - infoworks_managed
                            password:
                              type: string
                              minLength: 1
                              example:
                                - passw@rd_plain
                                - >-
                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                        - type: object
                          properties:
                            password_type:
                              type: string
                              enum:
                                - secret_store
                            secret_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                    application_secret_key:
                      oneOf:
                        - type: string
                          minLength: 1
                          example:
                            - passw@rd_plain
                            - >-
                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                        - type: object
                          properties:
                            password_type:
                              type: string
                              enum:
                                - infoworks_managed
                            password:
                              type: string
                              minLength: 1
                              example:
                                - passw@rd_plain
                                - >-
                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                        - type: object
                          properties:
                            password_type:
                              type: string
                              enum:
                                - secret_store
                            secret_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                    fetch_mechanism:
                      type: string
                      enum:
                        - bulk
                        - rest
                        - both
                    api_version:
                      type: string
                    snowflake_profile:
                      type: string
                      example: profile1
                    warehouse:
                      type: string
                      example: DEMO_WH
                - type: object
                  properties:
                    broker_id:
                      type: string
                    message_format:
                      type: string
                      enum:
                        - json
                        - avro
                    snowflake_profile:
                      type: string
                      example: profile1
                    warehouse:
                      type: string
                      example: DEMO_WH
                - type: object
                  properties:
                    broker_id:
                      type: string
                    message_format:
                      type: string
                      enum:
                        - json
                        - avro
                    enable_cluster_authentication:
                      type: boolean
                    enable_schema_registry:
                      type: boolean
                    cluster_authentication_details:
                      type: object
                      properties:
                        security_protocol:
                          type: string
                          enum:
                            - sasl_ssl
                        sasl_mechanism:
                          type: string
                          enum:
                            - plain
                        username:
                          type: string
                        password:
                          oneOf:
                            - type: string
                              minLength: 1
                              example:
                                - passw@rd_plain
                                - >-
                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                password:
                                  type: string
                                  minLength: 1
                                  example:
                                    - passw@rd_plain
                                    - >-
                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                    schema_registry_authentication_details:
                      type: object
                      properties:
                        authentication_mechanism:
                          type: string
                          enum:
                            - http_basic
                            - none
                        username:
                          type: string
                        password:
                          oneOf:
                            - type: string
                              minLength: 1
                              example:
                                - passw@rd_plain
                                - >-
                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                password:
                                  type: string
                                  minLength: 1
                                  example:
                                    - passw@rd_plain
                                    - >-
                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                    schema_registry_url:
                      type: string
                    snowflake_profile:
                      type: string
                      example: profile1
                    warehouse:
                      type: string
                      example: DEMO_WH
                - type: object
                  properties:
                    connection_url:
                      type: string
                    source_schema:
                      type: string
                    username:
                      type: string
                    password:
                      oneOf:
                        - type: string
                          minLength: 1
                          example:
                            - passw@rd_plain
                            - >-
                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                        - type: object
                          properties:
                            password_type:
                              type: string
                              enum:
                                - infoworks_managed
                            password:
                              type: string
                              minLength: 1
                              example:
                                - passw@rd_plain
                                - >-
                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                        - type: object
                          properties:
                            password_type:
                              type: string
                              enum:
                                - secret_store
                            secret_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                    database:
                      type: string
                    parameters:
                      type: object
                      properties:
                        is_active:
                          type: boolean
                        is_encrypted:
                          type: boolean
                        key:
                          type: string
                        value:
                          type: string
                    snowflake_profile:
                      type: string
                      example: profile1
                    warehouse:
                      type: string
                      example: DEMO_WH
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully updated source connection
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/configurations/advance:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    post:
      security:
        - BearerAuth: []
      tags:
        - Source Configurations
      summary: Add advanced configuration to the source
      description: Add advanced configuration to the source
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - key
                - value
              properties:
                key:
                  type: string
                  example: keyName
                value:
                  type: string
                  example: keyValue
                description:
                  type: string
                  example: description about this configuration
                is_active:
                  type: boolean
                  example: false
                entity_id:
                  type: string
                  example: e77850ad5127a2d7dab870ff
                entity_type:
                  type: string
                  example: source
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully added advanced configuration
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    get:
      security:
        - BearerAuth: []
      tags:
        - Source Configurations
      summary: Get all advanced configuration of the source
      description: Get all advanced configuration of the source
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: array
                    items:
                      allOf:
                        - type: object
                          required:
                            - key
                            - value
                          properties:
                            key:
                              type: string
                              example: keyName
                            value:
                              type: string
                              example: keyValue
                            description:
                              type: string
                              example: description about this configuration
                            is_active:
                              type: boolean
                              example: false
                            entity_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                            entity_type:
                              type: string
                              example: source
                        - properties:
                            parent_entity_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                            parent_entity_type:
                              type: string
                              example: table
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/configurations/advance/{key}:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: key
        in: path
        description: A unique advanced configuration key in the source
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Source Configurations
      summary: Get a source advanced configuration
      description: Get a source advanced configuration
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        allOf:
                          - type: object
                            required:
                              - key
                              - value
                            properties:
                              key:
                                type: string
                                example: keyName
                              value:
                                type: string
                                example: keyValue
                              description:
                                type: string
                                example: description about this configuration
                              is_active:
                                type: boolean
                                example: false
                              entity_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              entity_type:
                                type: string
                                example: source
                          - properties:
                              parent_entity_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              parent_entity_type:
                                type: string
                                example: table
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    put:
      security:
        - BearerAuth: []
      tags:
        - Source Configurations
      summary: Update a source advanced configuration
      description: Update a source advanced configuration
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - key
                - value
              properties:
                key:
                  type: string
                  example: keyName
                value:
                  type: string
                  example: keyValue
                description:
                  type: string
                  example: description about this configuration
                is_active:
                  type: boolean
                  example: false
                entity_id:
                  type: string
                  example: e77850ad5127a2d7dab870ff
                entity_type:
                  type: string
                  example: source
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully updated advanced configuration
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    delete:
      security:
        - BearerAuth: []
      tags:
        - Source Configurations
      summary: Delete a source advanced configuration
      description: Delete a source advanced configuration
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully deleted advanced configuration
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/audit-logs:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Audits
      summary: Get the audit logs of the source
      description: Get the audit logs of the source
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - type: object
                              properties:
                                entity_type:
                                  type: string
                                  example: table_group
                            - type: object
                              properties:
                                entity_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - properties:
                                modification:
                                  type: string
                                  example: Changed connection type to tpt from jdbc
                            - type: object
                              properties:
                                modified_at:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
                            - type: object
                              properties:
                                modified_by:
                                  type: string
                                  example: 6RkfybTRQQByEey3v
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: resource_id_to_clone
        in: query
        description: Required in case of cloning Mainframe sources
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: list all the tables in the source
      description: list all the tables in the source
      operationId: getTablesList
      parameters:
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: resolve_ref
          in: query
          description: To get entity details and created by user name
          schema:
            type: boolean
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              format: hexadecimal
                            name:
                              type: string
                            original_table_name:
                              type: string
                            topic_mapping_name:
                              type: string
                            file_mapping_name:
                              type: string
                            data_lake_schema:
                              type: string
                              example: kafka
                            data_lake_path:
                              type: string
                              example: /iw/kafka-source
                            meta_crawl_performed:
                              type: boolean
                            columns:
                              type: array
                              items:
                                type: object
                                properties:
                                  sql_type:
                                    type: integer
                                    example: 4
                                  name:
                                    type: string
                                    example: id
                                  original_name:
                                    type: string
                                    example: id
                                  target_sql_type:
                                    type: integer
                                    example: 4
                                  json_schema_node_key:
                                    type: integer
                                    example: 4
                                  is_mixed_element_text_content:
                                    type: boolean
                                    example: false
                                  is_recursive_data_text_content:
                                    type: boolean
                                    example: false
                                  is_excluded_column:
                                    type: boolean
                                    example: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    post:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Add tables to a File Source
      description: Add tables to a File Source
      requestBody:
        content:
          multipart/form-data:
            schema:
              oneOf:
                - type: object
                  required:
                    - name
                    - source
                    - main_copybook
                  properties:
                    name:
                      type: string
                      example: MainframeSourceName
                    source:
                      type: string
                      example: ddedbb84b4ed5aed5ce07da6
                      description: >-
                        It refers to the source id to which tables needs to be
                        added
                    configuration:
                      type: object
                      required:
                        - should_flatten_fields
                        - comment_policy_up_to_char
                        - comment_policy_after_char
                        - record_type
                        - file_encoding
                        - charset
                        - sync_type
                        - target_table_name
                        - include_subdirectories
                        - file_header_bytes
                        - file_footer_bytes
                        - include_filename_regex
                        - source_relative_path
                      properties:
                        should_flatten_fields:
                          type: boolean
                          example: true
                        comment_policy_up_to_char:
                          type: integer
                          example: 6
                        comment_policy_after_char:
                          type: integer
                          example: 72
                        record_type:
                          type: string
                          example: VB
                        records_per_block:
                          type: integer
                          example: 3
                        file_header_bytes:
                          type: integer
                          example: 0
                        file_footer_bytes:
                          type: integer
                          example: 0
                        target_table_name:
                          type: string
                          example: Upgrade_C30
                        sync_type:
                          type: string
                          example: full-load
                        file_encoding:
                          type: string
                          example: ebcdic
                        charset:
                          type: string
                          example: UTF-8
                        source_relative_path:
                          type: string
                          example: /opt/infoworks/temp_file_sources/
                        include_filename_regex:
                          type: string
                          example: .*
                        exclude_filename_regex:
                          type: string
                          example: .*4.*
                        include_subdirectories:
                          type: boolean
                          example: true
                        record_header_type_encoding:
                          type: string
                          example: big_endian
                        block_header_type_encoding:
                          type: string
                          example: big_endian
                        filter_record_value:
                          type: string
                          example: C20
                        filter_record_column:
                          type: string
                          example: ''
                        target_dataset_name:
                          type: string
                          example: MainFrameDataset
                    record_header_name:
                      type: array
                      items:
                        type: string
                        example: 5f0754885406f51f04a85293
                      description: >-
                        This is required in case the recordType field is 
                        Variable Length Custom Header(VCH) or Variable Block
                        Custom Header(VBCH)
                    main_copybook:
                      type: object
                      description: Upload the main copy file
                    custom_copybook:
                      type: object
                      description: >-
                        This is required in case the recordType field is 
                        Variable Length Custom Header(VCH) or Variable Block
                        Custom Header(VBCH)
                    comment_up_to_char_array:
                      type: array
                      items:
                        type: integer
                        example: 6
                      description: >-
                        This is required in case the recordType field is 
                        Variable Length Custom Header(VCH) or Variable Block
                        Custom Header(VBCH)
                    comment_after_char_array:
                      type: array
                      items:
                        type: integer
                        example: 72
                      description: >-
                        This is required in case the recordType field is  
                        Variable Length Custom Header(VCH) or Variable Block
                        Custom Header(VBCH)
                    update_object:
                      type: object
                      description: Required only in case of patch request
                      properties:
                        record_header_name:
                          type: string
                          example: cpb1
                          description: Record Header Name which needs to be updated
                        file_name:
                          type: string
                          example: cbp.txt
                        comment_policy_after_char:
                          type: integer
                        comment_policy_up_to_char:
                          type: integer
                        type:
                          type: string
                          example: update
                          description: Operation which needs to be performed
                        original_record_header_name:
                          type: string
                          description: Needed incase the record header name is updated
            examples:
              FixedLengthRecordType:
                value:
                  name: FixedLengthMainframeSourceName
                  source: ddedbb84b4ed5aed5ce07da6
                  main_copybook:
                    description: Upload the main copybook
                  configuration:
                    should_flatten_fields: true
                    comment_policy_up_to_char: 6
                    comment_policy_after_char: 72
                    record_type: F
                    file_header_bytes: 0
                    file_footer_bytes: 0
                    sync_type: full-load
                    file_encoding: ebcdic
                    charset: cp037
                    source_relative_path: /F/
                    include_filename_regex: .*
                    target_table_name: MainFrameFixed
                    ingest_subdirectories: true
                    filter_record_value: D
                    filter_record_column: MNTH_LIS_REC_TYPE
              VariableLengthCustomHeaderRecordType:
                value:
                  name: VariableCustomHeaderSourceName
                  source: ddedbb84b4ed5aed5ce07da6
                  main_copybook:
                    description: Upload the main copybook
                  custom_copybook:
                    description: Upload the custom copybooks
                  record_header_name:
                    - C10
                    - C20
                    - C30
                  comment_up_to_char_array:
                    - 6
                    - 6
                    - 6
                  comment_after_char_array:
                    - 72
                    - 72
                    - 72
                  configuration:
                    should_flatten_fields: true
                    comment_policy_up_to_char: 6
                    comment_policy_after_char: 72
                    record_type: VCH
                    file_header_bytes: 0
                    file_footer_bytes: 0
                    sync_type: full-load
                    file_encoding: ebcdic
                    charset: cp037
                    source_relative_path: /VCH/
                    include_filename_regex: .*
                    target_table_name: MainFrameVariable
                    ingest_subdirectories: true
                    filter_record_value: C30
                    filter_record_column: ''
              VariableLengthRecordType:
                value:
                  name: VariableLengthMainframeSourceName
                  source: ddedbb84b4ed5aed5ce07da6
                  main_copybook:
                    description: Upload the main copybook
                  configuration:
                    should_flatten_fields: true
                    comment_policy_up_to_char: 6
                    comment_policy_after_char: 72
                    record_type: V
                    record_header_type_encoding: big_endian
                    file_header_bytes: 0
                    file_footer_bytes: 0
                    sync_type: full-load
                    file_encoding: ebcdic
                    charset: cp037
                    source_relative_path: /V/
                    include_filename_regex: .*
                    target_table_name: MainFrameVariable
                    ingest_subdirectories: true
                    filter_record_value: D::31
                    filter_record_column: RECORD_TYPE::RECORD_TYPE_SEQ
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Table added Successfully.
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: fdf5c3fb3afaf1c3d286ef95
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/fetch-tables:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: resource_id_to_clone
        in: query
        description: Required in case of cloning Mainframe sources
        schema:
          type: string
    post:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: list all the tables in the source
      description: list all the tables in the source
      operationId: fetchTablesList
      parameters:
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: resolve_ref
          in: query
          description: To get entity details and created by user name
          schema:
            type: boolean
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              format: hexadecimal
                            name:
                              type: string
                            original_table_name:
                              type: string
                            topic_mapping_name:
                              type: string
                            file_mapping_name:
                              type: string
                            data_lake_schema:
                              type: string
                              example: kafka
                            data_lake_path:
                              type: string
                              example: /iw/kafka-source
                            meta_crawl_performed:
                              type: boolean
                            columns:
                              type: array
                              items:
                                type: object
                                properties:
                                  sql_type:
                                    type: integer
                                    example: 4
                                  name:
                                    type: string
                                    example: id
                                  original_name:
                                    type: string
                                    example: id
                                  target_sql_type:
                                    type: integer
                                    example: 4
                                  json_schema_node_key:
                                    type: integer
                                    example: 4
                                  is_mixed_element_text_content:
                                    type: boolean
                                    example: false
                                  is_recursive_data_text_content:
                                    type: boolean
                                    example: false
                                  is_excluded_column:
                                    type: boolean
                                    example: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Get Table Info
      description: Get Table Info
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        allOf:
                          - type: object
                            properties:
                              source:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              last_ingested_cdc_value:
                                type: string
                                example: null
                              full_load_performed:
                                type: boolean
                                example: false
                              description:
                                type: string
                                example: example description
                              tags:
                                type: array
                                items:
                                  example: c54t456f6d5a2c4564aed
                              schema_name_at_source:
                                type: string
                                example: dummy
                              topic_mapping_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              configuration:
                                type: object
                                allOf:
                                  - properties:
                                      json_schema:
                                        type: array
                                        items:
                                          type: object
                                          properties:
                                            key:
                                              type: integer
                                              example: 1
                                            name:
                                              type: string
                                              example: del
                                            properties:
                                              type: object
                                              properties:
                                                sql_type:
                                                  type: integer
                                                  example: 1
                                                target_sql_type:
                                                  type: integer
                                                  example: 1
                                                type:
                                                  type: string
                                                  example: struct
                                      json_schema_breadcrumb:
                                        type: array
                                        items:
                                          properties:
                                            selected:
                                              type: boolean
                                              example: true
                                            name:
                                              type: string
                                            json_schema_node_key:
                                              type: integer
                                              example: 0
                                      crawl_data_filter_enabled:
                                        type: boolean
                                        example: false
                                      crawl_filter_conditions:
                                        type: array
                                        items:
                                          example: ''
                                      max_num_of_records:
                                        type: integer
                                        example: 20000
                                      streaming_mode:
                                        type: string
                                        example: micro_batch
                                      streaming_frequency_type:
                                        type: string
                                        example: secs
                                      streaming_frequency_number:
                                        type: integer
                                        example: 10
                                      error_threshold:
                                        type: integer
                                        example: 5
                                      source_file_type:
                                        type: string
                                        example: kafka
                                      natural_keys:
                                        type: array
                                        items:
                                          type: string
                                      partition_keys:
                                        type: array
                                        items:
                                          type: string
                                      target_relative_path:
                                        type: string
                                        example: abch
                                      update_strategy:
                                        type: string
                                        example: append
                                      write_supported_engines:
                                        type: array
                                        items:
                                          type: string
                                          example: SPARK
                                      read_supported_engines:
                                        type: array
                                        items:
                                          type: string
                                          example: SPARK
                                      target_table_name:
                                        type: string
                                      storage_format:
                                        type: string
                                      target_schema_name:
                                        type: string
                                      sync_type:
                                        type: string
                                        example: incremental
                          - type: object
                            properties:
                              id:
                                type: string
                                format: hexadecimal
                              name:
                                type: string
                              original_table_name:
                                type: string
                              topic_mapping_name:
                                type: string
                              file_mapping_name:
                                type: string
                              data_lake_schema:
                                type: string
                                example: kafka
                              data_lake_path:
                                type: string
                                example: /iw/kafka-source
                              meta_crawl_performed:
                                type: boolean
                              columns:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    sql_type:
                                      type: integer
                                      example: 4
                                    name:
                                      type: string
                                      example: id
                                    original_name:
                                      type: string
                                      example: id
                                    target_sql_type:
                                      type: integer
                                      example: 4
                                    json_schema_node_key:
                                      type: integer
                                      example: 4
                                    is_mixed_element_text_content:
                                      type: boolean
                                      example: false
                                    is_recursive_data_text_content:
                                      type: boolean
                                      example: false
                                    is_excluded_column:
                                      type: boolean
                                      example: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    patch:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: 'Update the Table '
      description: Update the table Metadata
      requestBody:
        description: Update the table Metadata
        content:
          multipart/form-data:
            schema:
              oneOf:
                - type: object
                  required:
                    - name
                    - source
                    - main_copybook
                  properties:
                    name:
                      type: string
                      example: MainframeSourceName
                    source:
                      type: string
                      example: ddedbb84b4ed5aed5ce07da6
                      description: >-
                        It refers to the source id to which tables needs to be
                        added
                    configuration:
                      type: object
                      required:
                        - should_flatten_fields
                        - comment_policy_up_to_char
                        - comment_policy_after_char
                        - record_type
                        - file_encoding
                        - charset
                        - sync_type
                        - target_table_name
                        - include_subdirectories
                        - file_header_bytes
                        - file_footer_bytes
                        - include_filename_regex
                        - source_relative_path
                      properties:
                        should_flatten_fields:
                          type: boolean
                          example: true
                        comment_policy_up_to_char:
                          type: integer
                          example: 6
                        comment_policy_after_char:
                          type: integer
                          example: 72
                        record_type:
                          type: string
                          example: VB
                        records_per_block:
                          type: integer
                          example: 3
                        file_header_bytes:
                          type: integer
                          example: 0
                        file_footer_bytes:
                          type: integer
                          example: 0
                        target_table_name:
                          type: string
                          example: Upgrade_C30
                        sync_type:
                          type: string
                          example: full-load
                        file_encoding:
                          type: string
                          example: ebcdic
                        charset:
                          type: string
                          example: UTF-8
                        source_relative_path:
                          type: string
                          example: /opt/infoworks/temp_file_sources/
                        include_filename_regex:
                          type: string
                          example: .*
                        exclude_filename_regex:
                          type: string
                          example: .*4.*
                        include_subdirectories:
                          type: boolean
                          example: true
                        record_header_type_encoding:
                          type: string
                          example: big_endian
                        block_header_type_encoding:
                          type: string
                          example: big_endian
                        filter_record_value:
                          type: string
                          example: C20
                        filter_record_column:
                          type: string
                          example: ''
                        target_dataset_name:
                          type: string
                          example: MainFrameDataset
                    record_header_name:
                      type: array
                      items:
                        type: string
                        example: 5f0754885406f51f04a85293
                      description: >-
                        This is required in case the recordType field is 
                        Variable Length Custom Header(VCH) or Variable Block
                        Custom Header(VBCH)
                    main_copybook:
                      type: object
                      description: Upload the main copy file
                    custom_copybook:
                      type: object
                      description: >-
                        This is required in case the recordType field is 
                        Variable Length Custom Header(VCH) or Variable Block
                        Custom Header(VBCH)
                    comment_up_to_char_array:
                      type: array
                      items:
                        type: integer
                        example: 6
                      description: >-
                        This is required in case the recordType field is 
                        Variable Length Custom Header(VCH) or Variable Block
                        Custom Header(VBCH)
                    comment_after_char_array:
                      type: array
                      items:
                        type: integer
                        example: 72
                      description: >-
                        This is required in case the recordType field is  
                        Variable Length Custom Header(VCH) or Variable Block
                        Custom Header(VBCH)
                    update_object:
                      type: object
                      description: Required only in case of patch request
                      properties:
                        record_header_name:
                          type: string
                          example: cpb1
                          description: Record Header Name which needs to be updated
                        file_name:
                          type: string
                          example: cbp.txt
                        comment_policy_after_char:
                          type: integer
                        comment_policy_up_to_char:
                          type: integer
                        type:
                          type: string
                          example: update
                          description: Operation which needs to be performed
                        original_record_header_name:
                          type: string
                          description: Needed incase the record header name is updated
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully updated metadata
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    delete:
      security:
        - BearerAuth: []
      operationId: deleteTable
      tags:
        - Tables
      summary: Delete Table for a source
      description: Delete Table for a source
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/crawl-schema:
    parameters:
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: source_sub_type
        in: query
        description: Specifying source sub type
        required: true
        schema:
          type: string
          example: mainframe
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Crawl Table Schema
      description: Crawl Table Schema
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Example Success Message
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/source_tables:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    post:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: 'add the tables to a source and crawl metadata of those added tables '
      description: add the tables to a source and crawl metadata of those added tables
      operationId: getSourceTablesList
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - allOf:
                    - type: object
                      properties:
                        tables_to_add:
                          type: array
                          items:
                            type: object
                            properties:
                              table_name:
                                type: string
                                format: string
                                example: full_ingestion_tpt
                              schema_name:
                                type: string
                                format: string
                                example: AUTODB_PARQUET
                              table_type:
                                type: string
                                format: string
                                example: TABLE
                              target_table_name:
                                type: string
                                format: string
                                example: full_ingestion_tpt
                              target_schema_name:
                                type: string
                                format: string
                                example: AUTODB_PARQUET
                - allOf:
                    - type: object
                      properties:
                        tables_to_add:
                          type: array
                          items:
                            type: object
                            properties:
                              table_name:
                                type: string
                                format: string
                                example: full_ingestion_tpt
                              schema_name:
                                type: string
                                format: string
                                example: AUTODB_PARQUET
                              catalog_name:
                                type: string
                                format: string
                                example: AUTODB_CATALOG
                              table_type:
                                type: string
                                format: string
                                example: TABLE
                              target_table_name:
                                type: string
                                format: string
                                example: full_ingestion_tpt
                              target_schema_name:
                                type: string
                                format: string
                                example: AUTODB_PARQUET
                - allOf:
                    - type: object
                      properties:
                        tables_to_add:
                          type: array
                          items:
                            type: object
                            properties:
                              table_name:
                                type: string
                                format: string
                                example: full_ingestion_tpt
                              schema_name:
                                type: string
                                format: string
                                example: AUTODB_PARQUET
                              catalog_name:
                                type: string
                                format: string
                                example: AUTODB_CATALOG
                              table_type:
                                type: string
                                format: string
                                example: TABLE
                              target_table_name:
                                type: string
                                format: string
                                example: full_ingestion_tpt
                              target_schema_name:
                                type: string
                                format: string
                                example: AUTODB_PARQUET
                - allOf:
                    - type: object
                      properties:
                        tables_to_add:
                          type: array
                          items:
                            type: object
                            properties:
                              table_name:
                                type: string
                                format: string
                                example: full_ingestion_tpt
                              schema_name:
                                type: string
                                format: string
                                example: AUTODB_PARQUET
                              table_type:
                                type: string
                                format: string
                                example: TABLE
                              target_table_name:
                                type: string
                                format: string
                                example: full_ingestion_tpt
                              target_schema_name:
                                type: string
                                format: string
                                example: AUTODB_PARQUET
                - allOf:
                    - type: object
                      properties:
                        tables_to_add:
                          type: array
                          items:
                            type: object
                            properties:
                              table_name:
                                type: string
                                format: string
                                example: full_ingestion_tpt
                              schema_name:
                                type: string
                                format: string
                                example: AUTODB_PARQUET
                              catalog_name:
                                type: string
                                format: string
                                example: AUTODB_CATALOG
                              table_type:
                                type: string
                                format: string
                                example: TABLE
                              target_table_name:
                                type: string
                                format: string
                                example: full_ingestion_tpt
                              target_schema_name:
                                type: string
                                format: string
                                example: AUTODB_PARQUET
                - allOf:
                    - type: object
                      properties:
                        tables_to_add:
                          type: array
                          items:
                            type: object
                            properties:
                              table_name:
                                type: string
                                format: string
                                example: full_ingestion_tpt
                              catalog_name:
                                type: string
                                format: string
                                example: AUTODB_CATALOG
                              table_type:
                                type: string
                                format: string
                                example: TABLE
                              target_table_name:
                                type: string
                                format: string
                                example: full_ingestion_tpt
                              target_schema_name:
                                type: string
                                format: string
                                example: AUTODB_PARQUET
                - allOf:
                    - type: object
                      properties:
                        tables_to_add:
                          type: array
                          items:
                            type: object
                            properties:
                              table_name:
                                type: string
                                format: string
                                example: full_ingestion_tpt
                              schema_name:
                                type: string
                                format: string
                                example: AUTODB_PARQUET
                              table_type:
                                type: string
                                format: string
                                example: TABLE
                              target_table_name:
                                type: string
                                format: string
                                example: full_ingestion_tpt
                              target_schema_name:
                                type: string
                                format: string
                                example: AUTODB_PARQUET
                - allOf:
                    - type: object
                      properties:
                        tables_to_add:
                          type: array
                          items:
                            type: object
                            properties:
                              table_name:
                                type: string
                                format: string
                                example: full_ingestion_tpt
                              schema_name:
                                type: string
                                format: string
                                example: AUTODB_PARQUET
                              table_type:
                                type: string
                                format: string
                                example: TABLE
                              target_table_name:
                                type: string
                                format: string
                                example: full_ingestion_tpt
                              target_schema_name:
                                type: string
                                format: string
                                example: AUTODB_PARQUET
                - allOf:
                    - type: object
                      properties:
                        tables_to_add:
                          type: array
                          items:
                            type: object
                            properties:
                              table_name:
                                type: string
                                format: string
                                example: full_ingestion_tpt
                              catalog_name:
                                type: string
                                format: string
                                example: AUTODB_CATALOG
                              schema_name:
                                type: string
                                format: string
                                example: AUTODB_SCHEMA
                              table_type:
                                type: string
                                format: string
                                example: TABLE
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Tables added and job created successfully
                  result:
                    type: object
                    properties:
                      added_tables:
                        type: array
                        items:
                          type: string
                          example: 60b52e3127aa3e338e5a2f97
                  job_created:
                    type: string
                    example: 60b52e3927aa3e338e5a2f98
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/configurations/ingestion:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    put:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Updates and configures the table for Ingestion
      description: Sets ingestion configuration for a table.
      requestBody:
        description: Table ingestion Configuration
        content:
          application/json:
            schema:
              oneOf:
                - title: TeradataOnSnowflakeConfigurationSchema
                  allOf:
                    - allOf:
                        - type: object
                          required:
                            - sync_type
                            - target_table_name
                            - target_schema_name
                          properties:
                            sync_type:
                              type: string
                              enum:
                                - full-load
                                - cdc-ogg
                                - cdc-timestamp-column
                                - cdc-query
                                - cdc-batch-id
                                - cdc-log
                            read_supported_engines:
                              type: array
                              items:
                                type: string
                                enum:
                                  - delta
                                  - avro
                                  - parquet
                                  - orc
                            type:
                              type: string
                            subType:
                              type: string
                            sourceSubType:
                              type: string
                            target_table_name:
                              type: string
                            target_schema_name:
                              type: string
                            cdc_type:
                              type: string
                            query:
                              type: string
                            schema_name:
                              type: string
                            table_name:
                              type: string
                            exclude_legacy_audit_columns:
                              type: string
                            is_table_case_sensitive:
                              type: string
                            is_schema_case_sensitive:
                              type: string
                            is_database_case_sensitive:
                              type: string
                            watermark_column:
                              type: string
                            capture_table_name:
                              type: string
                            update_strategy:
                              type: string
                            fetch_mechanism:
                              type: string
                            use_jdbc:
                              type: boolean
                            use_capture_table:
                              type: boolean
                            is_scd2_table:
                              type: boolean
                            ingest_subdirectories:
                              type: boolean
                            is_archive_enabled:
                              type: boolean
                            generate_history_view:
                              type: boolean
                            enable_lower_bound_watermark_offset:
                              type: boolean
                            does_table_contain_data:
                              type: boolean
                            lower_bound_watermark_offset:
                              type: object
                              properties:
                                sql_type:
                                  type: number
                                days:
                                  type: number
                                minutes:
                                  type: number
                                hours:
                                  type: number
                                offset_operation:
                                  type: string
                            partition_keys:
                              type: array
                              items:
                                type: object
                                properties:
                                  partitionKeyColumn:
                                    type: string
                                  partition_column:
                                    type: boolean
                                  is_derived_partition:
                                    type: boolean
                                  parent_column:
                                    type: string
                                  derive_format:
                                    type: string
                        - type: object
                        - required:
                            - is_table_user_managed
                            - target_database_name
                          properties:
                            is_table_user_managed:
                              type: boolean
                            target_database_name:
                              type: string
                    - type: object
                    - required:
                        - data_fetch_type
                      properties:
                        data_fetch_type:
                          type: string
                        crawl_data_filter_enabled:
                          type: boolean
                        crawl_filter_conditions:
                          type: array
                          items:
                            type: object
                        split_by_key:
                          type: object
                          properties:
                            parent_column:
                              type: string
                            is_derived_split:
                              type: string
                            derive_function:
                              type: string
                            derive_format:
                              type: string
                            split_column:
                              type: string
                        segmented_load_columns:
                          type: array
                          items:
                            type: object
                            properties:
                              derive_format:
                                type: string
                              derive_function:
                                type: string
                              extract_from_column:
                                type: boolean
                              column:
                                type: object
                                properties:
                                  sql_type:
                                    type: number
                                  name:
                                    type: string
                                  original_name:
                                    type: string
                                  is_deleted:
                                    type: boolean
                                  target_sql_type:
                                    type: number
                                  is_audit_column:
                                    type: boolean
                                  is_custom_audit_column:
                                    type: boolean
                                  is_excluded_column:
                                    type: boolean
                                  target_scale:
                                    type: string
                                  col_size:
                                    type: number
                                  precision:
                                    type: number
                                  target_precision:
                                    type: number
                                  scale:
                                    type: number
                                  format:
                                    type: string
                                  is_derived_partition:
                                    type: boolean
                                  is_db_specific_column:
                                    type: boolean
                              value:
                                type: string
                - title: TeradataOnAzureConfigurationSchema
                  allOf:
                    - type: object
                      required:
                        - sync_type
                        - target_table_name
                        - target_schema_name
                      properties:
                        sync_type:
                          type: string
                          enum:
                            - full-load
                            - cdc-ogg
                            - cdc-timestamp-column
                            - cdc-query
                            - cdc-batch-id
                            - cdc-log
                        read_supported_engines:
                          type: array
                          items:
                            type: string
                            enum:
                              - delta
                              - avro
                              - parquet
                              - orc
                        type:
                          type: string
                        subType:
                          type: string
                        sourceSubType:
                          type: string
                        target_table_name:
                          type: string
                        target_schema_name:
                          type: string
                        cdc_type:
                          type: string
                        query:
                          type: string
                        schema_name:
                          type: string
                        table_name:
                          type: string
                        exclude_legacy_audit_columns:
                          type: string
                        is_table_case_sensitive:
                          type: string
                        is_schema_case_sensitive:
                          type: string
                        is_database_case_sensitive:
                          type: string
                        watermark_column:
                          type: string
                        capture_table_name:
                          type: string
                        update_strategy:
                          type: string
                        fetch_mechanism:
                          type: string
                        use_jdbc:
                          type: boolean
                        use_capture_table:
                          type: boolean
                        is_scd2_table:
                          type: boolean
                        ingest_subdirectories:
                          type: boolean
                        is_archive_enabled:
                          type: boolean
                        generate_history_view:
                          type: boolean
                        enable_lower_bound_watermark_offset:
                          type: boolean
                        does_table_contain_data:
                          type: boolean
                        lower_bound_watermark_offset:
                          type: object
                          properties:
                            sql_type:
                              type: number
                            days:
                              type: number
                            minutes:
                              type: number
                            hours:
                              type: number
                            offset_operation:
                              type: string
                        partition_keys:
                          type: array
                          items:
                            type: object
                            properties:
                              partitionKeyColumn:
                                type: string
                              partition_column:
                                type: boolean
                              is_derived_partition:
                                type: boolean
                              parent_column:
                                type: string
                              derive_format:
                                type: string
                    - type: object
                      required:
                        - data_fetch_type
                        - write_supported_engines
                      properties:
                        write_supported_engines:
                          type: array
                          items:
                            type: string
                            enum:
                              - delta
                              - avro
                              - parquet
                              - orc
                        crawl_data_filter_enabled:
                          type: boolean
                        crawl_filter_conditions:
                          type: array
                          items:
                            type: object
                        data_fetch_type:
                          type: string
                        split_by_key:
                          type: object
                          properties:
                            parent_column:
                              type: string
                            is_derived_split:
                              type: string
                            derive_function:
                              type: string
                            derive_format:
                              type: string
                        segmented_load_columns:
                          type: array
                          items:
                            type: object
                            properties:
                              derive_format:
                                type: string
                              derive_function:
                                type: string
                              extract_from_column:
                                type: boolean
                              column:
                                type: object
                                properties:
                                  sql_type:
                                    type: number
                                  name:
                                    type: string
                                  original_name:
                                    type: string
                                  is_deleted:
                                    type: boolean
                                  target_sql_type:
                                    type: number
                                  is_audit_column:
                                    type: boolean
                                  is_custom_audit_column:
                                    type: boolean
                                  is_excluded_column:
                                    type: boolean
                                  target_scale:
                                    type: string
                                  col_size:
                                    type: number
                                  precision:
                                    type: number
                                  target_precision:
                                    type: number
                                  scale:
                                    type: number
                                  format:
                                    type: string
                                  is_derived_partition:
                                    type: boolean
                                  is_db_specific_column:
                                    type: boolean
                                  java_type:
                                    type: string
                              value:
                                type: string
                        storage_format:
                          type: string
                          enum:
                            - parquet
                            - avro
                            - orc
                - title: TeradataOnAzureConfigurationSchemaForDelimited
                  allOf:
                    - title: TeradataOnAzureConfigurationSchema
                      allOf:
                        - type: object
                          required:
                            - sync_type
                            - target_table_name
                            - target_schema_name
                          properties:
                            sync_type:
                              type: string
                              enum:
                                - full-load
                                - cdc-ogg
                                - cdc-timestamp-column
                                - cdc-query
                                - cdc-batch-id
                                - cdc-log
                            read_supported_engines:
                              type: array
                              items:
                                type: string
                                enum:
                                  - delta
                                  - avro
                                  - parquet
                                  - orc
                            type:
                              type: string
                            subType:
                              type: string
                            sourceSubType:
                              type: string
                            target_table_name:
                              type: string
                            target_schema_name:
                              type: string
                            cdc_type:
                              type: string
                            query:
                              type: string
                            schema_name:
                              type: string
                            table_name:
                              type: string
                            exclude_legacy_audit_columns:
                              type: string
                            is_table_case_sensitive:
                              type: string
                            is_schema_case_sensitive:
                              type: string
                            is_database_case_sensitive:
                              type: string
                            watermark_column:
                              type: string
                            capture_table_name:
                              type: string
                            update_strategy:
                              type: string
                            fetch_mechanism:
                              type: string
                            use_jdbc:
                              type: boolean
                            use_capture_table:
                              type: boolean
                            is_scd2_table:
                              type: boolean
                            ingest_subdirectories:
                              type: boolean
                            is_archive_enabled:
                              type: boolean
                            generate_history_view:
                              type: boolean
                            enable_lower_bound_watermark_offset:
                              type: boolean
                            does_table_contain_data:
                              type: boolean
                            lower_bound_watermark_offset:
                              type: object
                              properties:
                                sql_type:
                                  type: number
                                days:
                                  type: number
                                minutes:
                                  type: number
                                hours:
                                  type: number
                                offset_operation:
                                  type: string
                            partition_keys:
                              type: array
                              items:
                                type: object
                                properties:
                                  partitionKeyColumn:
                                    type: string
                                  partition_column:
                                    type: boolean
                                  is_derived_partition:
                                    type: boolean
                                  parent_column:
                                    type: string
                                  derive_format:
                                    type: string
                        - type: object
                          required:
                            - data_fetch_type
                            - write_supported_engines
                          properties:
                            write_supported_engines:
                              type: array
                              items:
                                type: string
                                enum:
                                  - delta
                                  - avro
                                  - parquet
                                  - orc
                            crawl_data_filter_enabled:
                              type: boolean
                            crawl_filter_conditions:
                              type: array
                              items:
                                type: object
                            data_fetch_type:
                              type: string
                            split_by_key:
                              type: object
                              properties:
                                parent_column:
                                  type: string
                                is_derived_split:
                                  type: string
                                derive_function:
                                  type: string
                                derive_format:
                                  type: string
                            segmented_load_columns:
                              type: array
                              items:
                                type: object
                                properties:
                                  derive_format:
                                    type: string
                                  derive_function:
                                    type: string
                                  extract_from_column:
                                    type: boolean
                                  column:
                                    type: object
                                    properties:
                                      sql_type:
                                        type: number
                                      name:
                                        type: string
                                      original_name:
                                        type: string
                                      is_deleted:
                                        type: boolean
                                      target_sql_type:
                                        type: number
                                      is_audit_column:
                                        type: boolean
                                      is_custom_audit_column:
                                        type: boolean
                                      is_excluded_column:
                                        type: boolean
                                      target_scale:
                                        type: string
                                      col_size:
                                        type: number
                                      precision:
                                        type: number
                                      target_precision:
                                        type: number
                                      scale:
                                        type: number
                                      format:
                                        type: string
                                      is_derived_partition:
                                        type: boolean
                                      is_db_specific_column:
                                        type: boolean
                                      java_type:
                                        type: string
                                  value:
                                    type: string
                            storage_format:
                              type: string
                              enum:
                                - parquet
                                - avro
                                - orc
                    - type: object
                      properties:
                        storage_format:
                          type: string
                          enum:
                            - delimited_text_files
                        quote_character:
                          type: string
                        record_separator:
                          type: string
                        escape_character:
                          type: string
                        delimiter_character:
                          type: string
                        compression:
                          type: string
                        add_header_row:
                          type: boolean
                        character_encoding:
                          type: string
                - title: DfiOnAzureConfigurationSchema
                  allOf:
                    - type: object
                      required:
                        - sync_type
                        - target_table_name
                        - target_schema_name
                      properties:
                        sync_type:
                          type: string
                          enum:
                            - full-load
                            - cdc-ogg
                            - cdc-timestamp-column
                            - cdc-query
                            - cdc-batch-id
                            - cdc-log
                        read_supported_engines:
                          type: array
                          items:
                            type: string
                            enum:
                              - delta
                              - avro
                              - parquet
                              - orc
                        type:
                          type: string
                        subType:
                          type: string
                        sourceSubType:
                          type: string
                        target_table_name:
                          type: string
                        target_schema_name:
                          type: string
                        cdc_type:
                          type: string
                        query:
                          type: string
                        schema_name:
                          type: string
                        table_name:
                          type: string
                        exclude_legacy_audit_columns:
                          type: string
                        is_table_case_sensitive:
                          type: string
                        is_schema_case_sensitive:
                          type: string
                        is_database_case_sensitive:
                          type: string
                        watermark_column:
                          type: string
                        capture_table_name:
                          type: string
                        update_strategy:
                          type: string
                        fetch_mechanism:
                          type: string
                        use_jdbc:
                          type: boolean
                        use_capture_table:
                          type: boolean
                        is_scd2_table:
                          type: boolean
                        ingest_subdirectories:
                          type: boolean
                        is_archive_enabled:
                          type: boolean
                        generate_history_view:
                          type: boolean
                        enable_lower_bound_watermark_offset:
                          type: boolean
                        does_table_contain_data:
                          type: boolean
                        lower_bound_watermark_offset:
                          type: object
                          properties:
                            sql_type:
                              type: number
                            days:
                              type: number
                            minutes:
                              type: number
                            hours:
                              type: number
                            offset_operation:
                              type: string
                        partition_keys:
                          type: array
                          items:
                            type: object
                            properties:
                              partitionKeyColumn:
                                type: string
                              partition_column:
                                type: boolean
                              is_derived_partition:
                                type: boolean
                              parent_column:
                                type: string
                              derive_format:
                                type: string
                    - type: object
                      required:
                        - write_supported_engines
                      properties:
                        write_supported_engines:
                          type: array
                          items:
                            type: string
                            enum:
                              - delta
                              - avro
                              - parquet
                              - orc
                        crawl_data_filter_enabled:
                          type: boolean
                          example: false
                        crawl_filter_conditions:
                          type: array
                          items:
                            type: object
                        source_file_properties:
                          type: object
                          properties:
                            header_rows_count:
                              type: number
                            column_separator:
                              type: string
                            column_enclosed_by:
                              type: string
                            escape_character:
                              type: string
                            encoding:
                              type: string
                            enable_pk_chunk:
                              type: boolean
                            record_width_type:
                              type: string
                            record_separator:
                              type: string
                            columns_configurations:
                              type: array
                              items:
                                type: object
                                properties:
                                  column_width:
                                    type: number
                - title: DfiOnSnowflakeConfigurationSchema
                  allOf:
                    - allOf:
                        - type: object
                          required:
                            - sync_type
                            - target_table_name
                            - target_schema_name
                          properties:
                            sync_type:
                              type: string
                              enum:
                                - full-load
                                - cdc-ogg
                                - cdc-timestamp-column
                                - cdc-query
                                - cdc-batch-id
                                - cdc-log
                            read_supported_engines:
                              type: array
                              items:
                                type: string
                                enum:
                                  - delta
                                  - avro
                                  - parquet
                                  - orc
                            type:
                              type: string
                            subType:
                              type: string
                            sourceSubType:
                              type: string
                            target_table_name:
                              type: string
                            target_schema_name:
                              type: string
                            cdc_type:
                              type: string
                            query:
                              type: string
                            schema_name:
                              type: string
                            table_name:
                              type: string
                            exclude_legacy_audit_columns:
                              type: string
                            is_table_case_sensitive:
                              type: string
                            is_schema_case_sensitive:
                              type: string
                            is_database_case_sensitive:
                              type: string
                            watermark_column:
                              type: string
                            capture_table_name:
                              type: string
                            update_strategy:
                              type: string
                            fetch_mechanism:
                              type: string
                            use_jdbc:
                              type: boolean
                            use_capture_table:
                              type: boolean
                            is_scd2_table:
                              type: boolean
                            ingest_subdirectories:
                              type: boolean
                            is_archive_enabled:
                              type: boolean
                            generate_history_view:
                              type: boolean
                            enable_lower_bound_watermark_offset:
                              type: boolean
                            does_table_contain_data:
                              type: boolean
                            lower_bound_watermark_offset:
                              type: object
                              properties:
                                sql_type:
                                  type: number
                                days:
                                  type: number
                                minutes:
                                  type: number
                                hours:
                                  type: number
                                offset_operation:
                                  type: string
                            partition_keys:
                              type: array
                              items:
                                type: object
                                properties:
                                  partitionKeyColumn:
                                    type: string
                                  partition_column:
                                    type: boolean
                                  is_derived_partition:
                                    type: boolean
                                  parent_column:
                                    type: string
                                  derive_format:
                                    type: string
                        - type: object
                        - required:
                            - is_table_user_managed
                            - target_database_name
                          properties:
                            is_table_user_managed:
                              type: boolean
                            target_database_name:
                              type: string
                    - type: object
                      properties:
                        crawl_data_filter_enabled:
                          type: boolean
                          example: false
                        crawl_filter_conditions:
                          type: array
                          items:
                            type: object
                        source_file_properties:
                          type: object
                          properties:
                            header_rows_count:
                              type: number
                            column_separator:
                              type: string
                            column_enclosed_by:
                              type: string
                            escape_character:
                              type: string
                            encoding:
                              type: string
                            enable_pk_chunk:
                              type: boolean
                            record_width_type:
                              type: string
                            record_separator:
                              type: string
                            columns_configurations:
                              type: array
                              items:
                                type: object
                                properties:
                                  column_width:
                                    type: number
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully updated ingestion configuration
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Get ingestion configuration of table
      description: Get ingestion configuration of table
      responses:
        '200':
          description: get the ingestion configuration of table
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        allOf:
                          - type: object
                            allOf:
                              - properties:
                                  json_schema:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        key:
                                          type: integer
                                          example: 1
                                        name:
                                          type: string
                                          example: del
                                        properties:
                                          type: object
                                          properties:
                                            sql_type:
                                              type: integer
                                              example: 1
                                            target_sql_type:
                                              type: integer
                                              example: 1
                                            type:
                                              type: string
                                              example: struct
                                  json_schema_breadcrumb:
                                    type: array
                                    items:
                                      properties:
                                        selected:
                                          type: boolean
                                          example: true
                                        name:
                                          type: string
                                        json_schema_node_key:
                                          type: integer
                                          example: 0
                                  crawl_data_filter_enabled:
                                    type: boolean
                                    example: false
                                  crawl_filter_conditions:
                                    type: array
                                    items:
                                      example: ''
                                  max_num_of_records:
                                    type: integer
                                    example: 20000
                                  streaming_mode:
                                    type: string
                                    example: micro_batch
                                  streaming_frequency_type:
                                    type: string
                                    example: secs
                                  streaming_frequency_number:
                                    type: integer
                                    example: 10
                                  error_threshold:
                                    type: integer
                                    example: 5
                                  source_file_type:
                                    type: string
                                    example: kafka
                                  natural_keys:
                                    type: array
                                    items:
                                      type: string
                                  partition_keys:
                                    type: array
                                    items:
                                      type: string
                                  target_relative_path:
                                    type: string
                                    example: abch
                                  update_strategy:
                                    type: string
                                    example: append
                                  write_supported_engines:
                                    type: array
                                    items:
                                      type: string
                                      example: SPARK
                                  read_supported_engines:
                                    type: array
                                    items:
                                      type: string
                                      example: SPARK
                                  target_table_name:
                                    type: string
                                  storage_format:
                                    type: string
                                  target_schema_name:
                                    type: string
                                  sync_type:
                                    type: string
                                    example: incremental
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/configurations/advance:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Get list of Entity advance configuration
      description: Get list of Entity advance configuration
      responses:
        '200':
          description: >-
            Limitby list of all the entity advance configuration sorted on the
            format user provided
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      results:
                        type: array
                        items:
                          allOf:
                            - type: object
                              required:
                                - key
                                - value
                              properties:
                                key:
                                  type: string
                                  example: keyName
                                value:
                                  type: string
                                  example: keyValue
                                description:
                                  type: string
                                  example: description about this configuration
                                is_active:
                                  type: boolean
                                  example: false
                                entity_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                entity_type:
                                  type: string
                                  example: source
                            - properties:
                                parent_entity_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                parent_entity_type:
                                  type: string
                                  example: table
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    post:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Add advance configuration for a table
      description: Add advance configuration for a table
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - key
                - value
              properties:
                key:
                  type: string
                  example: keyName
                value:
                  type: string
                  example: keyValue
                description:
                  type: string
                  example: description about this configuration
                is_active:
                  type: boolean
                  example: false
                entity_id:
                  type: string
                  example: e77850ad5127a2d7dab870ff
                entity_type:
                  type: string
                  example: source
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully added advance configuration
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/configurations/advance/{key}:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: key
        in: path
        description: A unique advanced configuration key
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Get table advance configuration
      description: Get table advance configuration
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        allOf:
                          - properties:
                              key:
                                type: string
                                example: keyName
                              value:
                                type: string
                                example: keyValue
                              description:
                                type: string
                                example: description about this configuration
                              isActive:
                                type: boolean
                                example: true
                              entityId:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              entityType:
                                type: string
                                example: table
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    put:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: update advance configuration for a table
      description: update advance configuration for a table
      requestBody:
        description: Table ingestion Configuration
        content:
          application/json:
            schema:
              type: array
              required:
                - key
                - value
                - entityId
                - entityType
              items:
                type: object
                properties:
                  key:
                    type: string
                  value:
                    type: string
                  entityId:
                    type: string
                  entityType:
                    type: string
                    enum:
                      - table
                      - pipeline
            examples:
              Advance Config:
                value:
                  value: a
                  description: aa
                  isActive: true
                  entityId: 5a6ea49ce4b00234296e37d5
                  entityType: table
                  key: a
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully updated advance configuration
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    delete:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Delete advance configuration for a table
      description: Delete advance configuration for a table
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully deleted advance configuration
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/configurations/export:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    put:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: update table export configuration
      description: update table export configuration
      requestBody:
        description: Table export Configuration
        content:
          application/json:
            schema:
              oneOf:
                - allOf:
                    - type: object
                      required:
                        - sync_type
                        - target_type
                        - connection
                        - target_configuration
                        - columns
                      properties:
                        sync_type:
                          type: string
                          example: OVERWRITE
                          enum:
                            - DISABLED
                            - OVERWRITE
                            - APPEND
                            - MERGE
                        target_type:
                          type: string
                          example: TERADATA
                          enum:
                            - BIG_QUERY
                            - AZURE_SQL_DW
                            - SNOWFLAKE
                            - COSMOS_DB
                            - DELIMITED
                            - POSTGRES
                            - TERADATA
                            - ORACLE
                            - SQLSERVER
                        columns:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                                example: FNAME
                              precision:
                                type: number
                                example: 20
                              scale:
                                type: number
                                example: 0
                              sql_type:
                                type: number
                                example: 12
                        target_configuration:
                          type: object
                          properties:
                            schema_name:
                              type: string
                              example: schema_one
                            table_name:
                              type: string
                              example: table_one
                            natural_key:
                              type: array
                              items:
                                type: string
                            sync_table_schema:
                              type: boolean
                              example: true
                            is_existing_schema:
                              type: boolean
                              example: false
                            distribution_details:
                              type: object
                              properties:
                                distribution_details:
                                  type: string
                                  example: round_robin
                            indexing_details:
                              type: object
                              properties:
                                indexing_type:
                                  type: string
                                  example: heap
                                index_column_names:
                                  type: array
                                  items:
                                    type: string
                            partition_details:
                              type: object
                              properties:
                                partition_column_name:
                                  type: string
                                  example: FNAME
                                partition_values:
                                  type: string
                                  example: '0'
                                range:
                                  type: string
                                  example: left
                        connection:
                          oneOf:
                            - allOf:
                                - type: object
                                  required:
                                    - auth_type
                                    - connection_string
                                    - database
                                    - driver_name
                                    - password
                                    - table
                                    - username
                                    - schema
                                  properties:
                                    auth_type:
                                      type: string
                                      example: SQL_SERVER_DEFAULT
                                    connection_string:
                                      type: string
                                      example: connectionString
                                    database:
                                      type: string
                                      example: database
                                    driver_name:
                                      type: string
                                      example: driverName
                                    password:
                                      oneOf:
                                        - type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - infoworks_managed
                                            password:
                                              type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - secret_store
                                            secret_id:
                                              type: string
                                              example: e77850ad5127a2d7dab870ff
                                    table:
                                      type: string
                                      example: tableName
                                    username:
                                      type: string
                                      example: username
                                    schema:
                                      type: string
                                      example: schema
                                    query_tag:
                                      type: string
                                      example: test_querytag
                            - allOf:
                                - type: object
                                  required:
                                    - auth_type
                                    - connection_string
                                    - database
                                    - driver_name
                                    - password
                                    - table
                                    - username
                                    - schema
                                  properties:
                                    auth_type:
                                      type: string
                                      example: SQL_SERVER_DEFAULT
                                    connection_string:
                                      type: string
                                      example: connectionString
                                    database:
                                      type: string
                                      example: database
                                    driver_name:
                                      type: string
                                      example: driverName
                                    password:
                                      oneOf:
                                        - type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - infoworks_managed
                                            password:
                                              type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - secret_store
                                            secret_id:
                                              type: string
                                              example: e77850ad5127a2d7dab870ff
                                    table:
                                      type: string
                                      example: tableName
                                    username:
                                      type: string
                                      example: username
                                    schema:
                                      type: string
                                      example: schema
                                    query_tag:
                                      type: string
                                      example: test_querytag
                                - type: object
                                  properties:
                                    staging_schema:
                                      type: string
                          discriminator:
                            propertyName: export_type
                            mapping:
                              full_load: '#/components/schemas/connectionFullExport'
                              cdc: '#/components/schemas/connectionCDCExport'
                - allOf:
                    - type: object
                      required:
                        - sync_type
                        - target_type
                        - connection
                        - target_configuration
                        - columns
                      properties:
                        sync_type:
                          type: string
                          example: OVERWRITE
                          enum:
                            - DISABLED
                            - OVERWRITE
                            - APPEND
                            - MERGE
                        target_type:
                          type: string
                          example: TERADATA
                          enum:
                            - BIG_QUERY
                            - AZURE_SQL_DW
                            - SNOWFLAKE
                            - COSMOS_DB
                            - DELIMITED
                            - POSTGRES
                            - TERADATA
                            - ORACLE
                            - SQLSERVER
                        columns:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                                example: FNAME
                              precision:
                                type: number
                                example: 20
                              scale:
                                type: number
                                example: 0
                              sql_type:
                                type: number
                                example: 12
                        target_configuration:
                          type: object
                          properties:
                            schema_name:
                              type: string
                              example: schema_one
                            table_name:
                              type: string
                              example: table_one
                            natural_key:
                              type: array
                              items:
                                type: string
                            sync_table_schema:
                              type: boolean
                              example: true
                            is_existing_schema:
                              type: boolean
                              example: false
                            distribution_details:
                              type: object
                              properties:
                                distribution_details:
                                  type: string
                                  example: round_robin
                            indexing_details:
                              type: object
                              properties:
                                indexing_type:
                                  type: string
                                  example: heap
                                index_column_names:
                                  type: array
                                  items:
                                    type: string
                            partition_details:
                              type: object
                              properties:
                                partition_column_name:
                                  type: string
                                  example: FNAME
                                partition_values:
                                  type: string
                                  example: '0'
                                range:
                                  type: string
                                  example: left
                        connection:
                          oneOf:
                            - allOf:
                                - type: object
                                  required:
                                    - auth_type
                                    - connection_string
                                    - database
                                    - driver_name
                                    - password
                                    - table
                                    - username
                                    - schema
                                  properties:
                                    auth_type:
                                      type: string
                                      example: SQL_SERVER_DEFAULT
                                    connection_string:
                                      type: string
                                      example: connectionString
                                    database:
                                      type: string
                                      example: database
                                    driver_name:
                                      type: string
                                      example: driverName
                                    password:
                                      oneOf:
                                        - type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - infoworks_managed
                                            password:
                                              type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - secret_store
                                            secret_id:
                                              type: string
                                              example: e77850ad5127a2d7dab870ff
                                    table:
                                      type: string
                                      example: tableName
                                    username:
                                      type: string
                                      example: username
                                    schema:
                                      type: string
                                      example: schema
                                    query_tag:
                                      type: string
                                      example: test_querytag
                            - allOf:
                                - type: object
                                  required:
                                    - auth_type
                                    - connection_string
                                    - database
                                    - driver_name
                                    - password
                                    - table
                                    - username
                                    - schema
                                  properties:
                                    auth_type:
                                      type: string
                                      example: SQL_SERVER_DEFAULT
                                    connection_string:
                                      type: string
                                      example: connectionString
                                    database:
                                      type: string
                                      example: database
                                    driver_name:
                                      type: string
                                      example: driverName
                                    password:
                                      oneOf:
                                        - type: string
                                          minLength: 1
                                          example:
                                            - passw@rd_plain
                                            - >-
                                              gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - infoworks_managed
                                            password:
                                              type: string
                                              minLength: 1
                                              example:
                                                - passw@rd_plain
                                                - >-
                                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                        - type: object
                                          properties:
                                            password_type:
                                              type: string
                                              enum:
                                                - secret_store
                                            secret_id:
                                              type: string
                                              example: e77850ad5127a2d7dab870ff
                                    table:
                                      type: string
                                      example: tableName
                                    username:
                                      type: string
                                      example: username
                                    schema:
                                      type: string
                                      example: schema
                                    query_tag:
                                      type: string
                                      example: test_querytag
                                - type: object
                                  properties:
                                    staging_schema:
                                      type: string
                          discriminator:
                            propertyName: export_type
                            mapping:
                              full_load: '#/components/schemas/connectionFullExport'
                              cdc: '#/components/schemas/connectionCDCExport'
            examples:
              Export:
                value:
                  columns:
                    - name: BATCH_ID_DOUBLE
                      original_name: BATCH_ID_DOUBLE
                      precision: 20
                      scale: 0
                      sql_type: 12
                    - original_name: CITY
                      name: CITY
                      precision: 20
                      scale: 0
                      sql_type: 12
                  connection:
                    auth_type: SQL_SERVER_DEFAULT
                    connection_string: sefsf
                    database: SQL Server
                    driver_name: com.microsoft.sqlserver.jdbc.SQLServerDriver
                    password:
                      password_type: infoworks_managed
                      password: pass@123
                    schema: sdfs
                    table: sdfsd
                    username: sdfsd
                    warehouse: w1
                    additional_params: a1
                    server_name: s1
                  sync_type: OVERWRITE
                  target_type: TERADATA
                  target_configuration:
                    database_name: d2
                    table_name: t1
                    natural_key: []
                    is_existing_table: false
                    target_table_type: MULTISET
                    partition_type: NONE
                    indexing_column: []
                    is_unique_index: false
                    sync_table_schema: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully updated export configuration
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: get table export configuration
      description: get table export configuration
      responses:
        '200':
          description: get table export configuration
          content:
            application/json:
              schema:
                oneOf:
                  - allOf:
                      - type: object
                        required:
                          - sync_type
                          - target_type
                          - connection
                          - target_configuration
                          - columns
                        properties:
                          sync_type:
                            type: string
                            example: OVERWRITE
                            enum:
                              - DISABLED
                              - OVERWRITE
                              - APPEND
                              - MERGE
                          target_type:
                            type: string
                            example: TERADATA
                            enum:
                              - BIG_QUERY
                              - AZURE_SQL_DW
                              - SNOWFLAKE
                              - COSMOS_DB
                              - DELIMITED
                              - POSTGRES
                              - TERADATA
                              - ORACLE
                              - SQLSERVER
                          columns:
                            type: array
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  example: FNAME
                                precision:
                                  type: number
                                  example: 20
                                scale:
                                  type: number
                                  example: 0
                                sql_type:
                                  type: number
                                  example: 12
                          target_configuration:
                            type: object
                            properties:
                              schema_name:
                                type: string
                                example: schema_one
                              table_name:
                                type: string
                                example: table_one
                              natural_key:
                                type: array
                                items:
                                  type: string
                              sync_table_schema:
                                type: boolean
                                example: true
                              is_existing_schema:
                                type: boolean
                                example: false
                              distribution_details:
                                type: object
                                properties:
                                  distribution_details:
                                    type: string
                                    example: round_robin
                              indexing_details:
                                type: object
                                properties:
                                  indexing_type:
                                    type: string
                                    example: heap
                                  index_column_names:
                                    type: array
                                    items:
                                      type: string
                              partition_details:
                                type: object
                                properties:
                                  partition_column_name:
                                    type: string
                                    example: FNAME
                                  partition_values:
                                    type: string
                                    example: '0'
                                  range:
                                    type: string
                                    example: left
                          connection:
                            oneOf:
                              - allOf:
                                  - type: object
                                    required:
                                      - auth_type
                                      - connection_string
                                      - database
                                      - driver_name
                                      - password
                                      - table
                                      - username
                                      - schema
                                    properties:
                                      auth_type:
                                        type: string
                                        example: SQL_SERVER_DEFAULT
                                      connection_string:
                                        type: string
                                        example: connectionString
                                      database:
                                        type: string
                                        example: database
                                      driver_name:
                                        type: string
                                        example: driverName
                                      password:
                                        oneOf:
                                          - type: string
                                            minLength: 1
                                            example:
                                              - passw@rd_plain
                                              - >-
                                                gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                          - type: object
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - infoworks_managed
                                              password:
                                                type: string
                                                minLength: 1
                                                example:
                                                  - passw@rd_plain
                                                  - >-
                                                    gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                          - type: object
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - secret_store
                                              secret_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                      table:
                                        type: string
                                        example: tableName
                                      username:
                                        type: string
                                        example: username
                                      schema:
                                        type: string
                                        example: schema
                                      query_tag:
                                        type: string
                                        example: test_querytag
                              - allOf:
                                  - type: object
                                    required:
                                      - auth_type
                                      - connection_string
                                      - database
                                      - driver_name
                                      - password
                                      - table
                                      - username
                                      - schema
                                    properties:
                                      auth_type:
                                        type: string
                                        example: SQL_SERVER_DEFAULT
                                      connection_string:
                                        type: string
                                        example: connectionString
                                      database:
                                        type: string
                                        example: database
                                      driver_name:
                                        type: string
                                        example: driverName
                                      password:
                                        oneOf:
                                          - type: string
                                            minLength: 1
                                            example:
                                              - passw@rd_plain
                                              - >-
                                                gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                          - type: object
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - infoworks_managed
                                              password:
                                                type: string
                                                minLength: 1
                                                example:
                                                  - passw@rd_plain
                                                  - >-
                                                    gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                          - type: object
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - secret_store
                                              secret_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                      table:
                                        type: string
                                        example: tableName
                                      username:
                                        type: string
                                        example: username
                                      schema:
                                        type: string
                                        example: schema
                                      query_tag:
                                        type: string
                                        example: test_querytag
                                  - type: object
                                    properties:
                                      staging_schema:
                                        type: string
                            discriminator:
                              propertyName: export_type
                              mapping:
                                full_load: '#/components/schemas/connectionFullExport'
                                cdc: '#/components/schemas/connectionCDCExport'
                  - allOf:
                      - type: object
                        required:
                          - sync_type
                          - target_type
                          - connection
                          - target_configuration
                          - columns
                        properties:
                          sync_type:
                            type: string
                            example: OVERWRITE
                            enum:
                              - DISABLED
                              - OVERWRITE
                              - APPEND
                              - MERGE
                          target_type:
                            type: string
                            example: TERADATA
                            enum:
                              - BIG_QUERY
                              - AZURE_SQL_DW
                              - SNOWFLAKE
                              - COSMOS_DB
                              - DELIMITED
                              - POSTGRES
                              - TERADATA
                              - ORACLE
                              - SQLSERVER
                          columns:
                            type: array
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  example: FNAME
                                precision:
                                  type: number
                                  example: 20
                                scale:
                                  type: number
                                  example: 0
                                sql_type:
                                  type: number
                                  example: 12
                          target_configuration:
                            type: object
                            properties:
                              schema_name:
                                type: string
                                example: schema_one
                              table_name:
                                type: string
                                example: table_one
                              natural_key:
                                type: array
                                items:
                                  type: string
                              sync_table_schema:
                                type: boolean
                                example: true
                              is_existing_schema:
                                type: boolean
                                example: false
                              distribution_details:
                                type: object
                                properties:
                                  distribution_details:
                                    type: string
                                    example: round_robin
                              indexing_details:
                                type: object
                                properties:
                                  indexing_type:
                                    type: string
                                    example: heap
                                  index_column_names:
                                    type: array
                                    items:
                                      type: string
                              partition_details:
                                type: object
                                properties:
                                  partition_column_name:
                                    type: string
                                    example: FNAME
                                  partition_values:
                                    type: string
                                    example: '0'
                                  range:
                                    type: string
                                    example: left
                          connection:
                            oneOf:
                              - allOf:
                                  - type: object
                                    required:
                                      - auth_type
                                      - connection_string
                                      - database
                                      - driver_name
                                      - password
                                      - table
                                      - username
                                      - schema
                                    properties:
                                      auth_type:
                                        type: string
                                        example: SQL_SERVER_DEFAULT
                                      connection_string:
                                        type: string
                                        example: connectionString
                                      database:
                                        type: string
                                        example: database
                                      driver_name:
                                        type: string
                                        example: driverName
                                      password:
                                        oneOf:
                                          - type: string
                                            minLength: 1
                                            example:
                                              - passw@rd_plain
                                              - >-
                                                gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                          - type: object
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - infoworks_managed
                                              password:
                                                type: string
                                                minLength: 1
                                                example:
                                                  - passw@rd_plain
                                                  - >-
                                                    gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                          - type: object
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - secret_store
                                              secret_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                      table:
                                        type: string
                                        example: tableName
                                      username:
                                        type: string
                                        example: username
                                      schema:
                                        type: string
                                        example: schema
                                      query_tag:
                                        type: string
                                        example: test_querytag
                              - allOf:
                                  - type: object
                                    required:
                                      - auth_type
                                      - connection_string
                                      - database
                                      - driver_name
                                      - password
                                      - table
                                      - username
                                      - schema
                                    properties:
                                      auth_type:
                                        type: string
                                        example: SQL_SERVER_DEFAULT
                                      connection_string:
                                        type: string
                                        example: connectionString
                                      database:
                                        type: string
                                        example: database
                                      driver_name:
                                        type: string
                                        example: driverName
                                      password:
                                        oneOf:
                                          - type: string
                                            minLength: 1
                                            example:
                                              - passw@rd_plain
                                              - >-
                                                gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                          - type: object
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - infoworks_managed
                                              password:
                                                type: string
                                                minLength: 1
                                                example:
                                                  - passw@rd_plain
                                                  - >-
                                                    gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                          - type: object
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                  - secret_store
                                              secret_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                      table:
                                        type: string
                                        example: tableName
                                      username:
                                        type: string
                                        example: username
                                      schema:
                                        type: string
                                        example: schema
                                      query_tag:
                                        type: string
                                        example: test_querytag
                                  - type: object
                                    properties:
                                      staging_schema:
                                        type: string
                            discriminator:
                              propertyName: export_type
                              mapping:
                                full_load: '#/components/schemas/connectionFullExport'
                                cdc: '#/components/schemas/connectionCDCExport'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/column-order:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    patch:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: update table column order
      description: update table column order
      requestBody:
        description: Table Column Order
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: fname
                target_column_position:
                  type: number
                  example: 4
            examples:
              EntityMetadata:
                value:
                  name: fname
                  target_column_position: 5
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully updated metadata
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/metadata:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    put:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: update table metadata
      description: update table metadata
      requestBody:
        description: Table Metadata
        content:
          application/json:
            schema:
              type: object
              properties:
                tags_to_add:
                  type: array
                  items:
                    type: string
                    example: sales
                tags_to_remove:
                  type: array
                  items:
                    type: string
                    example: engg
                is_favorite:
                  type: boolean
                  example: true
                description:
                  type: string
                  example: description
            examples:
              EntityMetadata:
                value:
                  tags_to_add:
                    - sales
                  tags_to_remove:
                    - engg
                  is_favorite: true
                  description: description
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully updated metadata
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: get table metadata
      description: get table metadata
      responses:
        '200':
          description: get table metadata
          content:
            application/json:
              schema:
                type: object
                properties:
                  tags:
                    type: array
                    items:
                      type: string
                      example: sales
                  is_favorite:
                    type: boolean
                    example: true
                  description:
                    type: string
                    example: description
              examples:
                EntityMetadata:
                  value:
                    tags:
                      - sales
                    is_favorite: true
                    description: description
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/configurations/export/connection:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Get table export configuration connection properties
      description: Get table export configuration connection properties
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      schema:
                        oneOf:
                          - allOf:
                              - type: object
                                required:
                                  - auth_type
                                  - connection_string
                                  - database
                                  - driver_name
                                  - password
                                  - table
                                  - username
                                  - schema
                                properties:
                                  auth_type:
                                    type: string
                                    example: SQL_SERVER_DEFAULT
                                  connection_string:
                                    type: string
                                    example: connectionString
                                  database:
                                    type: string
                                    example: database
                                  driver_name:
                                    type: string
                                    example: driverName
                                  password:
                                    oneOf:
                                      - type: string
                                        minLength: 1
                                        example:
                                          - passw@rd_plain
                                          - >-
                                            gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                      - type: object
                                        properties:
                                          password_type:
                                            type: string
                                            enum:
                                              - infoworks_managed
                                          password:
                                            type: string
                                            minLength: 1
                                            example:
                                              - passw@rd_plain
                                              - >-
                                                gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                      - type: object
                                        properties:
                                          password_type:
                                            type: string
                                            enum:
                                              - secret_store
                                          secret_id:
                                            type: string
                                            example: e77850ad5127a2d7dab870ff
                                  table:
                                    type: string
                                    example: tableName
                                  username:
                                    type: string
                                    example: username
                                  schema:
                                    type: string
                                    example: schema
                                  query_tag:
                                    type: string
                                    example: test_querytag
                          - allOf:
                              - type: object
                                required:
                                  - auth_type
                                  - connection_string
                                  - database
                                  - driver_name
                                  - password
                                  - table
                                  - username
                                  - schema
                                properties:
                                  auth_type:
                                    type: string
                                    example: SQL_SERVER_DEFAULT
                                  connection_string:
                                    type: string
                                    example: connectionString
                                  database:
                                    type: string
                                    example: database
                                  driver_name:
                                    type: string
                                    example: driverName
                                  password:
                                    oneOf:
                                      - type: string
                                        minLength: 1
                                        example:
                                          - passw@rd_plain
                                          - >-
                                            gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                      - type: object
                                        properties:
                                          password_type:
                                            type: string
                                            enum:
                                              - infoworks_managed
                                          password:
                                            type: string
                                            minLength: 1
                                            example:
                                              - passw@rd_plain
                                              - >-
                                                gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                      - type: object
                                        properties:
                                          password_type:
                                            type: string
                                            enum:
                                              - secret_store
                                          secret_id:
                                            type: string
                                            example: e77850ad5127a2d7dab870ff
                                  table:
                                    type: string
                                    example: tableName
                                  username:
                                    type: string
                                    example: username
                                  schema:
                                    type: string
                                    example: schema
                                  query_tag:
                                    type: string
                                    example: test_querytag
                              - type: object
                                properties:
                                  staging_schema:
                                    type: string
                        discriminator:
                          propertyName: export_type
                          mapping:
                            full_load: '#/components/schemas/ConnectionFullExport'
                            cdc: '#/components/schemas/ConnectionCDCExport'
              examples:
                connection:
                  value:
                    auth_type: SQL_SERVER_DEFAULT
                    connection_string: sefsf
                    database: SQL Server
                    driver_name: com.microsoft.sqlserver.jdbc.SQLServerDriver
                    password: 0LUKoIi5BneprevHKr1+7ruXmq1NMSyr6yzlcXczTJA=
                    schema: sdfs
                    table: sdfsd
                    username: sdfsd
                    staging_schema: sfdsf
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    put:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: update table export configuration Connection properties
      description: update table export configuration Connection properties
      requestBody:
        description: Table export Configuration connection properties
        content:
          application/json:
            schema:
              oneOf:
                - allOf:
                    - type: object
                      required:
                        - auth_type
                        - connection_string
                        - database
                        - driver_name
                        - password
                        - table
                        - username
                        - schema
                      properties:
                        auth_type:
                          type: string
                          example: SQL_SERVER_DEFAULT
                        connection_string:
                          type: string
                          example: connectionString
                        database:
                          type: string
                          example: database
                        driver_name:
                          type: string
                          example: driverName
                        password:
                          oneOf:
                            - type: string
                              minLength: 1
                              example:
                                - passw@rd_plain
                                - >-
                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                password:
                                  type: string
                                  minLength: 1
                                  example:
                                    - passw@rd_plain
                                    - >-
                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                        table:
                          type: string
                          example: tableName
                        username:
                          type: string
                          example: username
                        schema:
                          type: string
                          example: schema
                        query_tag:
                          type: string
                          example: test_querytag
                - allOf:
                    - type: object
                      required:
                        - auth_type
                        - connection_string
                        - database
                        - driver_name
                        - password
                        - table
                        - username
                        - schema
                      properties:
                        auth_type:
                          type: string
                          example: SQL_SERVER_DEFAULT
                        connection_string:
                          type: string
                          example: connectionString
                        database:
                          type: string
                          example: database
                        driver_name:
                          type: string
                          example: driverName
                        password:
                          oneOf:
                            - type: string
                              minLength: 1
                              example:
                                - passw@rd_plain
                                - >-
                                  gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                password:
                                  type: string
                                  minLength: 1
                                  example:
                                    - passw@rd_plain
                                    - >-
                                      gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                            - type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                        table:
                          type: string
                          example: tableName
                        username:
                          type: string
                          example: username
                        schema:
                          type: string
                          example: schema
                        query_tag:
                          type: string
                          example: test_querytag
                    - type: object
                      properties:
                        staging_schema:
                          type: string
              discriminator:
                propertyName: export_type
                mapping:
                  full_load: '#/components/schemas/ConnectionFullExport'
                  cdc: '#/components/schemas/ConnectionCDCExport'
            examples:
              connection:
                value:
                  auth_type: SQL_SERVER_DEFAULT
                  connection_string: sefsf
                  database: SQL Server
                  driver_name: com.microsoft.sqlserver.jdbc.SQLServerDriver
                  password: 0LUKoIi5BneprevHKr1+7ruXmq1NMSyr6yzlcXczTJA=
                  schema: sdfs
                  table: sdfsd
                  username: sdfsd
                  staging_schema: sfdsf
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully updated export configuration connection
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/segmentation/start:
    post:
      security:
        - BearerAuth: []
      operationId: startSegmentation
      parameters:
        - name: source_id
          in: path
          description: Source Id.
          required: true
          schema:
            type: string
        - name: table_id
          in: path
          description: Table Id.
          required: true
          schema:
            type: string
      tags:
        - Tables
      summary: Start Segmentation on a Table
      description: Start Segmentation on a Table
      requestBody:
        content:
          application/json:
            schema:
              properties:
                derive_format:
                  type: string
                  enum:
                    - yyyy
                    - MM
                    - dd
                    - yyyyMM
                    - MMdd
                    - yyyyMMdd
                derive_function:
                  type: string
                  enum:
                    - year
                    - month
                    - day num in month
                    - year month
                    - month day
                    - year month day
                extract_from_column:
                  type: boolean
                column:
                  properties:
                    name:
                      type: string
                    sql_type:
                      type: integer
            examples:
              Segmented Load Column Without Derived Value:
                value:
                  extract_from_column: false
                  column:
                    name: CITY
                    sql_type: 12
              Segmented Load Column With Derived Value:
                value:
                  derive_format: MM
                  derive_function: month
                  extract_from_column: true
                  column:
                    name: RECADDTS5
                    sql_type: 93
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/segmentation/crawl:
    post:
      security:
        - BearerAuth: []
      operationId: crawlSegments
      parameters:
        - name: source_id
          in: path
          description: Source Id.
          required: true
          schema:
            type: string
        - name: table_id
          in: path
          description: Table Id.
          required: true
          schema:
            type: string
      tags:
        - Tables
      summary: Crawl Segments Metadata on a Table
      description: Crawl Segments Metadata on a Table
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/segmentation:
    get:
      security:
        - BearerAuth: []
      operationId: getTableSegments
      parameters:
        - name: source_id
          in: path
          description: Source Id.
          required: true
          schema:
            type: string
        - name: table_id
          in: path
          description: Table Id.
          required: true
          schema:
            type: string
        - in: query
          name: crawl_segments
          schema:
            type: string
            example: 'false'
          description: >-
            if true, crawls Segments Metadata if they haven't been already
            crawled, default is `false`
      tags:
        - Tables
      summary: Get Table Segments of a Table
      description: Get Table Segments of a Table
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                          segmented_ingested_count:
                            type: integer
                          total_segments_count:
                            type: integer
                          total_count:
                            type: integer
                          table_id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                          segments:
                            items:
                              properties:
                                count:
                                  type: integer
                                ingested_records_count:
                                  type: integer
                                segment_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                status:
                                  type: string
                                  example: ingested
                                segments:
                                  items:
                                    allOf:
                                      - properties:
                                          derive_format:
                                            type: string
                                            enum:
                                              - yyyy
                                              - MM
                                              - dd
                                              - yyyyMM
                                              - MMdd
                                              - yyyyMMdd
                                          derive_function:
                                            type: string
                                            enum:
                                              - year
                                              - month
                                              - day num in month
                                              - year month
                                              - month day
                                              - year month day
                                          extract_from_column:
                                            type: boolean
                                          column:
                                            properties:
                                              name:
                                                type: string
                                              sql_type:
                                                type: integer
                                      - properties:
                                          value:
                                            type: string
                                            description: Any Column Value
                                            example: NEWYORK/ Engineer
                                last_successful_job_time:
                                  type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/segmentation/end:
    post:
      security:
        - BearerAuth: []
      operationId: endSegmentation
      parameters:
        - name: source_id
          in: path
          description: Source Id.
          required: true
          schema:
            type: string
        - name: table_id
          in: path
          description: Table Id.
          required: true
          schema:
            type: string
      tags:
        - Tables
      summary: End Segmentation on a Table
      description: End Segmentation on a Table
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/segmentation/cancel:
    post:
      security:
        - BearerAuth: []
      operationId: cancelSegmentation
      parameters:
        - name: source_id
          in: path
          description: Source Id.
          required: true
          schema:
            type: string
        - name: table_id
          in: path
          description: Table Id.
          required: true
          schema:
            type: string
      tags:
        - Tables
      summary: Cancel Segmentation on a Table
      description: Cancel Segmentation on a Table
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/audit-logs:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Audits
      summary: Get the audit logs of the table
      description: Get the audit logs of the table
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - type: object
                              properties:
                                entity_type:
                                  type: string
                                  example: table_group
                            - type: object
                              properties:
                                entity_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - properties:
                                modification:
                                  type: string
                                  example: Changed connection type to tpt from jdbc
                            - type: object
                              properties:
                                modified_at:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
                            - type: object
                              properties:
                                modified_by:
                                  type: string
                                  example: 6RkfybTRQQByEey3v
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/configurations/schema:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Get the schema of the table
      description: Get the schema of the table
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          properties:
                            is_audit_column:
                              type: boolean
                            name:
                              type: string
                            original_name:
                              type: string
                            sql_type:
                              type: integer
                            target_sql_type:
                              type: integer
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    put:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Update the schema of the table
      description: Update the schema of the table
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    type:
                      type: string
                      example: column
                      enum:
                        - column
                    columns:
                      type: array
                      items:
                        type: object
                        required:
                          - precision
                          - scale
                          - hiveType
                          - name
                          - origName
                        properties:
                          precision:
                            type: number
                            example: 3
                          scale:
                            type: number
                            example: 2
                          hiveType:
                            type: string
                            example: decimal
                          name:
                            type: string
                            example: FNAME
                          origName:
                            type: string
                            example: FNAME
                - type: object
                  required:
                    - type
                    - precision
                    - scale
                  properties:
                    type:
                      type: string
                      example: bulk
                      enum:
                        - bulk
                    precision:
                      type: number
                      example: 3
                    scale:
                      type: number
                      example: 2
            examples:
              Bulk Update:
                value:
                  type: bulk
                  precision: 3
                  scale: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully updated schema of the table
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/configurations:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    properties:
                      ingestion_configuraiton:
                        allOf:
                          - properties:
                              json_schema:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: integer
                                      example: 1
                                    name:
                                      type: string
                                      example: del
                                    properties:
                                      type: object
                                      properties:
                                        sql_type:
                                          type: integer
                                          example: 1
                                        target_sql_type:
                                          type: integer
                                          example: 1
                                        type:
                                          type: string
                                          example: struct
                              json_schema_breadcrumb:
                                type: array
                                items:
                                  properties:
                                    selected:
                                      type: boolean
                                      example: true
                                    name:
                                      type: string
                                    json_schema_node_key:
                                      type: integer
                                      example: 0
                          - properties:
                              crawl_data_filter_enabled:
                                type: boolean
                                example: false
                              crawl_filter_conditions:
                                type: array
                                items:
                                  example: ''
                              topic_identifier:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    example: list
                                  list:
                                    type: array
                                    items:
                                      example: person
                              max_num_of_records:
                                type: integer
                                example: 20000
                              streaming_mode:
                                type: string
                                example: micro_batch
                              streaming_frequency_type:
                                type: string
                                example: secs
                              streaming_frequency_number:
                                type: integer
                                example: 10
                              error_threshold:
                                type: integer
                                example: 5
                              source_file_type:
                                type: string
                                example: kafka
                              target_relative_path:
                                type: string
                                example: abch
                              update_strategy:
                                type: string
                                example: append
                              write_supported_engines:
                                type: array
                                items:
                                  type: string
                                  example: SPARK
                              read_supported_engines:
                                type: array
                                items:
                                  type: string
                                  example: SPARK
                              target_table_name:
                                type: string
                              storage_format:
                                type: string
                              target_schema_name:
                                type: string
                              sync_type:
                                type: string
                                example: incremental
                      advance_configuration:
                        type: array
                        items:
                          allOf:
                            - type: object
                              required:
                                - key
                                - value
                              properties:
                                key:
                                  type: string
                                  example: keyName
                                value:
                                  type: string
                                  example: keyValue
                                description:
                                  type: string
                                  example: description about this configuration
                                is_active:
                                  type: boolean
                                  example: false
                                entity_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                entity_type:
                                  type: string
                                  example: source
                            - properties:
                                parent_entity_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                parent_entity_type:
                                  type: string
                                  example: table
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/configurations:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Source Configurations
      summary: Get source Configuration
      description: Get source Configuration
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    allOf:
                      - type: object
                        allOf:
                          - properties:
                              id:
                                type: string
                                example: 354t45656556254564545
                              name:
                                type: string
                                example: sample source
                              type:
                                type: string
                                example: streaming
                              sub_type:
                                type: string
                                example: kafka
                                enum:
                                  - kafka
                                  - structured
                                  - json
                                  - xml
                                  - unstructured
                                  - teradata
                                  - redshift
                                  - oracle
                                  - mysql
                                  - mariadb
                                  - sqlserver
                                  - db2
                                  - netezza
                                  - saphana
                                  - hive
                                  - sybaseiq
                                  - ignite
                                  - vertica
                                  - maprdb
                                  - mongodb
                                  - rest_generic
                                  - salesforce
                              data_lake_path:
                                type: string
                                example: /iw/kafka-source
                              use_staging_schema_for_infoworks_managed_tables:
                                type: boolean
                                example: true
                              use_staging_dataset_for_infoworks_managed_tables:
                                type: boolean
                                example: true
                              description:
                                type: string
                                example: example description
                              tags:
                                type: array
                                items:
                                  example: c54t456f6d5a2c4564aed
                              data_lake_schema:
                                type: string
                                example: kafka
                              state:
                                type: string
                                example: ready
                              is_source_ingested:
                                type: boolean
                                example: true
                              is_public:
                                type: boolean
                          - type: object
                            allOf:
                              - type: object
                                properties:
                                  created_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  created_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                              - type: object
                                properties:
                                  modified_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  modified_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                      - properties:
                          connection:
                            type: object
                            properties:
                              broker_id:
                                type: string
                              message_format:
                                type: string
                                example: json
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/segments:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Get a list of all table segments.
      description: Get a list of all table segments.
      responses:
        '200':
          description: >-
            Limitby list of all the tables segments sorted on the format user
            provided
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      results:
                        type: array
                        items:
                          type: object
                          properties:
                            value:
                              type: string
                            connection_quota:
                              type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/topic-mappings:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getTopicMappingsForSource
      tags:
        - Topics
      summary: Get a list of all topics mapping.
      description: Get a list of all topics mapping.
      responses:
        '200':
          description: Topics Mapping
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      total_count:
                        type: integer
                        minimum: 0
                        description: Total count of topic mappings
                        example: 10
                      result:
                        items:
                          allOf:
                            - properties:
                                name:
                                  type: string
                                  example: topic_mapping_1
                                configuration:
                                  properties:
                                    topic_identifier:
                                      type: object
                                      properties:
                                        type:
                                          type: string
                                          example: list
                                        list:
                                          type: array
                                          items:
                                            example: person
                                        regex:
                                          type: string
                                          example: ^person
                                        crawl_schema_mechanism:
                                          type: string
                                        subject_name:
                                          type: string
                            - type: object
                              allOf:
                                - type: object
                                  properties:
                                    created_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    created_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                                - type: object
                                  properties:
                                    modified_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    modified_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                          properties:
                            id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                            json_schema:
                              type: array
                              items:
                                type: object
                                properties:
                                  key:
                                    type: integer
                                    example: 1
                                  name:
                                    type: string
                                    example: del
                                  properties:
                                    type: object
                                    properties:
                                      sql_type:
                                        type: integer
                                        example: 1
                                      target_sql_type:
                                        type: integer
                                        example: 1
                                      type:
                                        type: string
                                        example: struct
                            table_details:
                              type: array
                              items:
                                properties:
                                  id:
                                    type: string
                                    example: d04a89ca9d4e9af1b86fdc3e
                                  name:
                                    type: string
                                    example: tableName
                                  state:
                                    type: string
                                    example: ready
                            deserializer_extension_name:
                              type: string
                              example: Kafka
                            deserializer_function_alias:
                              type: string
                              example: Kafka_function
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    post:
      security:
        - BearerAuth: []
      operationId: createTopicMappingForSource
      tags:
        - Topics
      summary: Create Topic Mapping For Source
      description: Create Topic Mapping For Source
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  type: string
                  example: topic_mapping_1
                configuration:
                  properties:
                    topic_identifier:
                      type: object
                      properties:
                        type:
                          type: string
                          example: list
                        list:
                          type: array
                          items:
                            example: person
                        regex:
                          type: string
                          example: ^person
                        crawl_schema_mechanism:
                          type: string
                        subject_name:
                          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/topic-mappings/{topic_mapping_id}:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: topic_mapping_id
        in: path
        description: Topic Mapping Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getTopicMappingForSource
      tags:
        - Topics
      summary: Get topic mapping id.
      description: Get topic mapping id.
      responses:
        '200':
          description: Topics Mapping Id
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        allOf:
                          - properties:
                              name:
                                type: string
                                example: topic_mapping_1
                              configuration:
                                properties:
                                  topic_identifier:
                                    type: object
                                    properties:
                                      type:
                                        type: string
                                        example: list
                                      list:
                                        type: array
                                        items:
                                          example: person
                                      regex:
                                        type: string
                                        example: ^person
                                      crawl_schema_mechanism:
                                        type: string
                                      subject_name:
                                        type: string
                          - type: object
                            allOf:
                              - type: object
                                properties:
                                  created_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  created_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                              - type: object
                                properties:
                                  modified_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  modified_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                          json_schema:
                            type: array
                            items:
                              type: object
                              properties:
                                key:
                                  type: integer
                                  example: 1
                                name:
                                  type: string
                                  example: del
                                properties:
                                  type: object
                                  properties:
                                    sql_type:
                                      type: integer
                                      example: 1
                                    target_sql_type:
                                      type: integer
                                      example: 1
                                    type:
                                      type: string
                                      example: struct
                          table_details:
                            type: array
                            items:
                              properties:
                                id:
                                  type: string
                                  example: d04a89ca9d4e9af1b86fdc3e
                                name:
                                  type: string
                                  example: tableName
                                state:
                                  type: string
                                  example: ready
                          deserializer_extension_name:
                            type: string
                            example: Kafka
                          deserializer_function_alias:
                            type: string
                            example: Kafka_function
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    patch:
      security:
        - BearerAuth: []
      operationId: updateTopicMappingForSource
      tags:
        - Topics
      summary: Update Topic Mapping For Source
      description: Update Topic Mapping For Source
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  type: string
                  example: topic_mapping_1
                configuration:
                  properties:
                    topic_identifier:
                      type: object
                      properties:
                        type:
                          type: string
                          example: list
                        list:
                          type: array
                          items:
                            example: person
                        regex:
                          type: string
                          example: ^person
                        crawl_schema_mechanism:
                          type: string
                        subject_name:
                          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    delete:
      security:
        - BearerAuth: []
      operationId: deleteTopicMapping
      tags:
        - Topics
      summary: Delete Topic Mapping For Source
      description: Delete Topic Mapping For Source
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/topics:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getTopics
      tags:
        - Topics
      summary: Get topics From Source
      description: Get topics From Source
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/topic-mappings/{topic_mapping_id}/preview:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: topic_mapping_id
        in: path
        description: Topic Mapping Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getTopicMappingPreview
      tags:
        - Topics
      summary: Get topic Preview
      description: Get topics Preview
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/topic-mappings/{topic_mapping_id}/crawl-schema:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: topic_mapping_id
        in: path
        description: Topic Mapping Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: crawlSchemaForTopicMapping
      tags:
        - Topics
      summary: Crawl Schema For Topic Mapping
      description: Crawl Schema For Topic Mapping
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/topic-mappings/{topic_mapping_id}/table-schema:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: topic_mapping_id
        in: path
        description: Topic Mapping Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getTableSchemaFromMapping
      tags:
        - Topics
      parameters:
        - name: selected_keys
          in: query
          schema:
            type: string
          example: '[1, 2]'
      summary: Get Table Schema From Mapping
      description: Get Table Schema From Mapping
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/topic-mappings/{topic_mapping_id}/tables:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: topic_mapping_id
        in: path
        description: Topic Mapping Id.
        required: true
        schema:
          type: string
    post:
      security:
        - BearerAuth: []
      operationId: createSourceTable
      tags:
        - Topics
      summary: Create Streaming Table
      description: Create Streaming Table
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/topic-mappings/{topic_mapping_id}/tables/{table_id}:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: topic_mapping_id
        in: path
        description: Topic Mapping Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getTableInfo
      tags:
        - Topics
      summary: Get Streaming Table
      description: Get Streaming Table
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                properties:
                  result:
                    type: object
                    properties:
                      source:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      last_ingested_cdc_value:
                        type: string
                        example: null
                      full_load_performed:
                        type: boolean
                        example: false
                      description:
                        type: string
                        example: example description
                      tags:
                        type: array
                        items:
                          example: c54t456f6d5a2c4564aed
                      schema_name_at_source:
                        type: string
                        example: dummy
                      topic_mapping_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      configuration:
                        type: object
                        allOf:
                          - properties:
                              json_schema:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: integer
                                      example: 1
                                    name:
                                      type: string
                                      example: del
                                    properties:
                                      type: object
                                      properties:
                                        sql_type:
                                          type: integer
                                          example: 1
                                        target_sql_type:
                                          type: integer
                                          example: 1
                                        type:
                                          type: string
                                          example: struct
                              json_schema_breadcrumb:
                                type: array
                                items:
                                  properties:
                                    selected:
                                      type: boolean
                                      example: true
                                    name:
                                      type: string
                                    json_schema_node_key:
                                      type: integer
                                      example: 0
                              crawl_data_filter_enabled:
                                type: boolean
                                example: false
                              crawl_filter_conditions:
                                type: array
                                items:
                                  example: ''
                              max_num_of_records:
                                type: integer
                                example: 20000
                              streaming_mode:
                                type: string
                                example: micro_batch
                              streaming_frequency_type:
                                type: string
                                example: secs
                              streaming_frequency_number:
                                type: integer
                                example: 10
                              error_threshold:
                                type: integer
                                example: 5
                              source_file_type:
                                type: string
                                example: kafka
                              natural_keys:
                                type: array
                                items:
                                  type: string
                              partition_keys:
                                type: array
                                items:
                                  type: string
                              target_relative_path:
                                type: string
                                example: abch
                              update_strategy:
                                type: string
                                example: append
                              write_supported_engines:
                                type: array
                                items:
                                  type: string
                                  example: SPARK
                              read_supported_engines:
                                type: array
                                items:
                                  type: string
                                  example: SPARK
                              target_table_name:
                                type: string
                              storage_format:
                                type: string
                              target_schema_name:
                                type: string
                              sync_type:
                                type: string
                                example: incremental
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    delete:
      security:
        - BearerAuth: []
      operationId: deleteTableFromKafkaSource
      tags:
        - Topics
      summary: Delete Streaming Table
      description: Delete Streaming Table
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/file-mappings:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getFileMappingsForJSONSource
      tags:
        - File Mappings
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: resolve_ref
          in: query
          description: To get entity details and created by user name
          schema:
            type: boolean
      summary: Get File Mappings for JSON source
      description: Get File Mappings for JSON source
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                properties:
                  total_count:
                    type: integer
                    minimum: 0
                    description: Total count of file mappings
                    example: 10
                  result:
                    type: array
                    items:
                      allOf:
                        - type: object
                          allOf:
                            - type: object
                              properties:
                                created_at:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
                            - type: object
                              properties:
                                created_by:
                                  type: string
                                  example: 6RkfybTRQQByEey3v
                            - type: object
                              properties:
                                modified_at:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
                            - type: object
                              properties:
                                modified_by:
                                  type: string
                                  example: 6RkfybTRQQByEey3v
                        - properties:
                            name:
                              type: string
                              example: file_mapping_1
                            configuration:
                              properties:
                                source_relative_path:
                                  type: string
                                  example: >-
                                    /opt/infoworks/temp_file_sources/json_automation_saas/datatypes
                                record_scope:
                                  type: string
                                  example: file
                                  enum:
                                    - file
                                    - line
                                include_subdirectories:
                                  type: boolean
                                  example: true
                                character_encoding:
                                  type: string
                                  example: UTF-8
                                include_filename_regex:
                                  type: string
                                  example: .*
                                exclude_filename_regex:
                                  type: string
                                  example: .*4.*
                      properties:
                        id:
                          type: string
                          example: e77850ad5127a2d7dab870ff
                        json_schema:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: integer
                                example: 1
                              name:
                                type: string
                                example: del
                              properties:
                                type: object
                                properties:
                                  sql_type:
                                    type: integer
                                    example: 1
                                  target_sql_type:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: struct
                        table_details:
                          type: array
                          items:
                            properties:
                              id:
                                type: string
                                example: d04a89ca9d4e9af1b86fdc3e
                              name:
                                type: string
                                example: tableName
                              state:
                                type: string
                                example: ready
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    post:
      security:
        - BearerAuth: []
      operationId: createFileMappingForSource
      tags:
        - File Mappings
      summary: Create File Mapping For JSON Source
      description: Create File Mapping For JSON Source
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  type: string
                  example: file_mapping_1
                configuration:
                  properties:
                    source_relative_path:
                      type: string
                      example: >-
                        /opt/infoworks/temp_file_sources/json_automation_saas/datatypes
                    record_scope:
                      type: string
                      example: file
                      enum:
                        - file
                        - line
                    include_subdirectories:
                      type: boolean
                      example: true
                    character_encoding:
                      type: string
                      example: UTF-8
                    include_filename_regex:
                      type: string
                      example: .*
                    exclude_filename_regex:
                      type: string
                      example: .*4.*
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/file-mappings/{file_mapping_id}:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: file_mapping_id
        in: path
        description: File Mapping Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getFileMappingsForJSONSourceById
      tags:
        - File Mappings
      summary: Get File Mappings for JSON source by id
      description: Get File Mappings for JSON source by id
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                properties:
                  result:
                    allOf:
                      - type: object
                        allOf:
                          - type: object
                            properties:
                              created_at:
                                type: string
                                example: '2019-11-21T12:54:05.875Z'
                          - type: object
                            properties:
                              created_by:
                                type: string
                                example: 6RkfybTRQQByEey3v
                          - type: object
                            properties:
                              modified_at:
                                type: string
                                example: '2019-11-21T12:54:05.875Z'
                          - type: object
                            properties:
                              modified_by:
                                type: string
                                example: 6RkfybTRQQByEey3v
                      - properties:
                          name:
                            type: string
                            example: file_mapping_1
                          configuration:
                            properties:
                              source_relative_path:
                                type: string
                                example: >-
                                  /opt/infoworks/temp_file_sources/json_automation_saas/datatypes
                              record_scope:
                                type: string
                                example: file
                                enum:
                                  - file
                                  - line
                              include_subdirectories:
                                type: boolean
                                example: true
                              character_encoding:
                                type: string
                                example: UTF-8
                              include_filename_regex:
                                type: string
                                example: .*
                              exclude_filename_regex:
                                type: string
                                example: .*4.*
                    properties:
                      id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      json_schema:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: integer
                              example: 1
                            name:
                              type: string
                              example: del
                            properties:
                              type: object
                              properties:
                                sql_type:
                                  type: integer
                                  example: 1
                                target_sql_type:
                                  type: integer
                                  example: 1
                                type:
                                  type: string
                                  example: struct
                      table_details:
                        type: array
                        items:
                          properties:
                            id:
                              type: string
                              example: d04a89ca9d4e9af1b86fdc3e
                            name:
                              type: string
                              example: tableName
                            state:
                              type: string
                              example: ready
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    delete:
      security:
        - BearerAuth: []
      operationId: deleteFileMapping
      tags:
        - File Mappings
      summary: Delete File Mapping For JSON Source
      description: Delete File Mapping For JSON Source
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    patch:
      security:
        - BearerAuth: []
      operationId: updateFileMappingForSource
      tags:
        - File Mappings
      summary: Update File Mapping For JSON Source
      description: Update File Mapping For JSON Source
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  type: string
                  example: file_mapping_1
                configuration:
                  properties:
                    source_relative_path:
                      type: string
                      example: >-
                        /opt/infoworks/temp_file_sources/json_automation_saas/datatypes
                    record_scope:
                      type: string
                      example: file
                      enum:
                        - file
                        - line
                    include_subdirectories:
                      type: boolean
                      example: true
                    character_encoding:
                      type: string
                      example: UTF-8
                    include_filename_regex:
                      type: string
                      example: .*
                    exclude_filename_regex:
                      type: string
                      example: .*4.*
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/file-mappings/{file_mapping_id}/preview:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: file_mapping_id
        in: path
        description: File Mapping Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getFileMappingPreview
      tags:
        - File Mappings
      summary: Get File Mapping Data Preview
      description: Get File Mapping Data Preview
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/file-mappings/{file_mapping_id}/crawl-schema:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: file_mapping_id
        in: path
        description: File Mapping Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: crawlSchemaForFileMapping
      tags:
        - File Mappings
      summary: Crawl Schema For File Mapping
      description: Crawl Schema For File Mapping
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/file-mappings/{file_mapping_id}/table-schema:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: file_mapping_id
        in: path
        description: File Mapping Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getTableSchemaForSelectedNodesForFileMappings
      tags:
        - File Mappings
      parameters:
        - name: selected_keys
          in: query
          schema:
            type: string
          example: '[1, 2]'
      summary: Get Table Schema From Mapping
      description: Get Table Schema From Mapping
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/file-mappings/{file_mapping_id}/tables:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: file_mapping_id
        in: path
        description: File Mapping Id.
        required: true
        schema:
          type: string
    post:
      security:
        - BearerAuth: []
      operationId: createJsonSourceTable
      tags:
        - File Mappings
      summary: Create JSON Source Table
      description: Create JSON Source Table
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/file-mappings/{file_mapping_id}/tables/{table_id}:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: file_mapping_id
        in: path
        description: File Mapping Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getTableInfoForJSONSource
      tags:
        - File Mappings
      summary: Get JSON Source Table
      description: Get JSON Source Table
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                properties:
                  result:
                    type: object
                    properties:
                      source:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      last_ingested_cdc_value:
                        type: string
                        example: null
                      full_load_performed:
                        type: boolean
                        example: false
                      description:
                        type: string
                        example: example description
                      tags:
                        type: array
                        items:
                          example: c54t456f6d5a2c4564aed
                      schema_name_at_source:
                        type: string
                        example: dummy
                      topic_mapping_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      configuration:
                        type: object
                        allOf:
                          - properties:
                              json_schema:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: integer
                                      example: 1
                                    name:
                                      type: string
                                      example: del
                                    properties:
                                      type: object
                                      properties:
                                        sql_type:
                                          type: integer
                                          example: 1
                                        target_sql_type:
                                          type: integer
                                          example: 1
                                        type:
                                          type: string
                                          example: struct
                              json_schema_breadcrumb:
                                type: array
                                items:
                                  properties:
                                    selected:
                                      type: boolean
                                      example: true
                                    name:
                                      type: string
                                    json_schema_node_key:
                                      type: integer
                                      example: 0
                              crawl_data_filter_enabled:
                                type: boolean
                                example: false
                              crawl_filter_conditions:
                                type: array
                                items:
                                  example: ''
                              max_num_of_records:
                                type: integer
                                example: 20000
                              streaming_mode:
                                type: string
                                example: micro_batch
                              streaming_frequency_type:
                                type: string
                                example: secs
                              streaming_frequency_number:
                                type: integer
                                example: 10
                              error_threshold:
                                type: integer
                                example: 5
                              source_file_type:
                                type: string
                                example: kafka
                              natural_keys:
                                type: array
                                items:
                                  type: string
                              partition_keys:
                                type: array
                                items:
                                  type: string
                              target_relative_path:
                                type: string
                                example: abch
                              update_strategy:
                                type: string
                                example: append
                              write_supported_engines:
                                type: array
                                items:
                                  type: string
                                  example: SPARK
                              read_supported_engines:
                                type: array
                                items:
                                  type: string
                                  example: SPARK
                              target_table_name:
                                type: string
                              storage_format:
                                type: string
                              target_schema_name:
                                type: string
                              sync_type:
                                type: string
                                example: incremental
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    delete:
      security:
        - BearerAuth: []
      operationId: deleteTableFromFileMappingsForJSONSource
      tags:
        - Topics
      summary: Delete JSON Source Table
      description: Delete JSON Source Table
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/interactive-jobs:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: The numbers of items to return
        schema:
          type: integer
          default: 10
      - name: sort_by
        in: query
        description: Sort result on field
        schema:
          type: string
      - name: order_by
        in: query
        description: order  ascending | descending
        schema:
          type: string
          default: asc
          enum:
            - asc
            - desc
      - name: filter
        in: query
        description: Filter results query
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getInteractiveJobs
      tags:
        - Jobs
      summary: Get Interactive Jobs List
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: d57850ad5127a2d7dab870ff
                            type:
                              type: string
                              enum:
                                - sampledata
                                - table_preview
                                - query_table_preview
                                - segment_load
                                - file_preview
                                - metacrawl
                                - fetch_topics
                                - browse_source
                              example: file_preview
                            status:
                              type: string
                              enum:
                                - created
                                - submitted
                                - running
                                - failed
                                - completed
                              example: completed
                            source_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                            message:
                              type: string
                              example: job success
                            created_at:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
                            duration:
                              type: number
                              example: 134234
                            entity_name:
                              type: string
                              example: My Source
                            entity_type:
                              type: string
                              enum:
                                - source
                                - table
                                - file_mapping
                                - topic_mapping
                            entity_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /sources/{source_id}/interactive-jobs/{interactive_job_id}:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: interactive_job_id
        in: path
        description: Interactive job id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getInteractiveJob
      tags:
        - Jobs
      summary: Get Interactive Job by id
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: d57850ad5127a2d7dab870ff
                          type:
                            type: string
                            enum:
                              - sampledata
                              - table_preview
                              - query_table_preview
                              - segment_load
                              - file_preview
                              - metacrawl
                              - fetch_topics
                              - browse_source
                            example: file_preview
                          status:
                            type: string
                            enum:
                              - created
                              - submitted
                              - running
                              - failed
                              - completed
                            example: completed
                          source_id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                          message:
                            type: string
                            example: job success
                          created_at:
                            type: string
                            example: '2019-11-21T12:54:05.875Z'
                          duration:
                            type: number
                            example: 134234
                          entity_name:
                            type: string
                            example: My Source
                          entity_type:
                            type: string
                            enum:
                              - source
                              - table
                              - file_mapping
                              - topic_mapping
                          entity_id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      tags:
        - Jobs
      summary: Update the job status for Interactive Job
      description: Update the job status to failed for Interactive jobs
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /sources/{source_id}/interactive-jobs/{interactive_job_id}/logs/download:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: interactive_job_id
        in: path
        description: Interactive job id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: downloadInteractiveJobLogsForSource
      tags:
        - Jobs
      summary: Download Logs for Interactive Job
      description: Downloads the dataplane logs for the source interactive job.
      responses:
        '200':
          description: Ok.
          content:
            application/zip:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/favorites/check-favorite:
    get:
      security:
        - BearerAuth: []
      tags:
        - Favorites
      summary: Check entity favorite tag
      description: Check entity favorite tag
      parameters:
        - name: entity_id
          in: query
          description: Entity ID
          required: true
          schema:
            type: string
        - name: entity_type
          in: query
          description: Entity Type
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      is_favorite:
                        type: boolean
                        example: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/validation-specs:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Gets Validation Specs for a Table.
      description: Gets Validation Specs for a given TableId.
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                name:
                                  type: string
                                  example: validation_regex_1
                                column_name:
                                  type: string
                                  example: CITY_COL
                                table_id:
                                  type: string
                                  example: 848dc34275383cd2acdc8cec
                                type:
                                  type: string
                                  example: regex
                                regex_expression:
                                  type: string
                                  example: '[a-zA-Z]'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    post:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Add Validation Specs to a Table.
      description: Add Validation Specs to a Table.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: validation_regex_1
                column_name:
                  type: string
                  example: CITY_COL
                table_id:
                  type: string
                  example: 848dc34275383cd2acdc8cec
                type:
                  type: string
                  example: regex
                regex_expression:
                  type: string
                  example: '[a-zA-Z]'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Validation Specs added Successfully
                      result:
                        properties:
                          id:
                            type: string
                            example: c70822c5a88e5521a8153c7c
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/favorites/toggle-favorite:
    patch:
      security:
        - BearerAuth: []
      tags:
        - Favorites
      summary: Toggle entity favorite tag
      description: Toggle entity favorite tag
      parameters:
        - name: entity_id
          in: query
          description: Entity ID
          required: true
          schema:
            type: string
        - name: entity_type
          in: query
          description: Entity Type
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/validation-specs/{validation_spec_id}:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
      - name: validation_spec_id
        in: path
        description: Validation Specs Id.
        required: true
        schema:
          type: string
    patch:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Updates the Validation Specs for a table.
      description: Updates the Validation Specs for a table.
      operationId: updateValidationSpecs
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: validation_regex_1
                column_name:
                  type: string
                  example: CITY_COL
                table_id:
                  type: string
                  example: 848dc34275383cd2acdc8cec
                type:
                  type: string
                  example: regex
                regex_expression:
                  type: string
                  example: '[a-zA-Z]'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      status:
                        type: string
                        example: success
                      id:
                        type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    delete:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Delete Validation Specs for a Table
      description: Delete Validation Specs
      operationId: deleteValidationSpecs
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: fdf5c3fb3afaf1c3d286ef95
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables-to-table-groups-mapping:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Table Groups
      summary: Gets `Table to Table Group` Mapping.
      description: Gets `Table to Table Group` Mapping list.
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        allOf:
                          - type: object
                            properties:
                              tableId:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: 62963b9a3009222c5d12f48e
                                    name:
                                      type: string
                                      example: demo
                              connection_mode:
                                type: string
                                example: JDBC
                              connection_url:
                                type: string
                                example: jdbc:oracle:thin:@10.17.3.199:1521:xe
                              username:
                                type: string
                                example: automation_db
                              password:
                                type: string
                                example: '********'
                              driver_name:
                                type: string
                                example: oracle.jdbc.driver.OracleDriver
                              driver_version:
                                type: string
                                example: v2
                              database:
                                type: string
                                example: ORACLE
                              enable_log_based_cdc:
                                type: boolean
                                example: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/table/{source_table_id}/get-preview:
    parameters:
      - name: source_table_id
        in: path
        description: Source Table Id
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Get table preview.
      description: Get table preview.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        allOf:
                          - type: object
                            properties:
                              source:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              last_ingested_cdc_value:
                                type: string
                                example: null
                              full_load_performed:
                                type: boolean
                                example: false
                              description:
                                type: string
                                example: example description
                              tags:
                                type: array
                                items:
                                  example: c54t456f6d5a2c4564aed
                              schema_name_at_source:
                                type: string
                                example: dummy
                              topic_mapping_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              configuration:
                                type: object
                                allOf:
                                  - properties:
                                      json_schema:
                                        type: array
                                        items:
                                          type: object
                                          properties:
                                            key:
                                              type: integer
                                              example: 1
                                            name:
                                              type: string
                                              example: del
                                            properties:
                                              type: object
                                              properties:
                                                sql_type:
                                                  type: integer
                                                  example: 1
                                                target_sql_type:
                                                  type: integer
                                                  example: 1
                                                type:
                                                  type: string
                                                  example: struct
                                      json_schema_breadcrumb:
                                        type: array
                                        items:
                                          properties:
                                            selected:
                                              type: boolean
                                              example: true
                                            name:
                                              type: string
                                            json_schema_node_key:
                                              type: integer
                                              example: 0
                                      crawl_data_filter_enabled:
                                        type: boolean
                                        example: false
                                      crawl_filter_conditions:
                                        type: array
                                        items:
                                          example: ''
                                      max_num_of_records:
                                        type: integer
                                        example: 20000
                                      streaming_mode:
                                        type: string
                                        example: micro_batch
                                      streaming_frequency_type:
                                        type: string
                                        example: secs
                                      streaming_frequency_number:
                                        type: integer
                                        example: 10
                                      error_threshold:
                                        type: integer
                                        example: 5
                                      source_file_type:
                                        type: string
                                        example: kafka
                                      natural_keys:
                                        type: array
                                        items:
                                          type: string
                                      partition_keys:
                                        type: array
                                        items:
                                          type: string
                                      target_relative_path:
                                        type: string
                                        example: abch
                                      update_strategy:
                                        type: string
                                        example: append
                                      write_supported_engines:
                                        type: array
                                        items:
                                          type: string
                                          example: SPARK
                                      read_supported_engines:
                                        type: array
                                        items:
                                          type: string
                                          example: SPARK
                                      target_table_name:
                                        type: string
                                      storage_format:
                                        type: string
                                      target_schema_name:
                                        type: string
                                      sync_type:
                                        type: string
                                        example: incremental
                          - type: object
                            properties:
                              id:
                                type: string
                                format: hexadecimal
                              name:
                                type: string
                              original_table_name:
                                type: string
                              topic_mapping_name:
                                type: string
                              file_mapping_name:
                                type: string
                              data_lake_schema:
                                type: string
                                example: kafka
                              data_lake_path:
                                type: string
                                example: /iw/kafka-source
                              meta_crawl_performed:
                                type: boolean
                              columns:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    sql_type:
                                      type: integer
                                      example: 4
                                    name:
                                      type: string
                                      example: id
                                    original_name:
                                      type: string
                                      example: id
                                    target_sql_type:
                                      type: integer
                                      example: 4
                                    json_schema_node_key:
                                      type: integer
                                      example: 4
                                    is_mixed_element_text_content:
                                      type: boolean
                                      example: false
                                    is_recursive_data_text_content:
                                      type: boolean
                                      example: false
                                    is_excluded_column:
                                      type: boolean
                                      example: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/table/{source_table_id}/generate-preview:
    parameters:
      - name: source_table_id
        in: path
        description: Source Table Id
        required: true
        schema:
          type: string
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Generate table preview.
      description: Generate table preview.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          status:
                            type: string
                            example: success
                          id:
                            type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/jobs_for_source_job_type:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Jobs
      summary: Gets Jobs Model for a Source.
      description: Gets Jobs Model for a Source.
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        allOf:
                          - type: object
                            properties:
                              source:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              last_ingested_cdc_value:
                                type: string
                                example: null
                              full_load_performed:
                                type: boolean
                                example: false
                              description:
                                type: string
                                example: example description
                              tags:
                                type: array
                                items:
                                  example: c54t456f6d5a2c4564aed
                              schema_name_at_source:
                                type: string
                                example: dummy
                              topic_mapping_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              configuration:
                                type: object
                                allOf:
                                  - properties:
                                      json_schema:
                                        type: array
                                        items:
                                          type: object
                                          properties:
                                            key:
                                              type: integer
                                              example: 1
                                            name:
                                              type: string
                                              example: del
                                            properties:
                                              type: object
                                              properties:
                                                sql_type:
                                                  type: integer
                                                  example: 1
                                                target_sql_type:
                                                  type: integer
                                                  example: 1
                                                type:
                                                  type: string
                                                  example: struct
                                      json_schema_breadcrumb:
                                        type: array
                                        items:
                                          properties:
                                            selected:
                                              type: boolean
                                              example: true
                                            name:
                                              type: string
                                            json_schema_node_key:
                                              type: integer
                                              example: 0
                                      crawl_data_filter_enabled:
                                        type: boolean
                                        example: false
                                      crawl_filter_conditions:
                                        type: array
                                        items:
                                          example: ''
                                      max_num_of_records:
                                        type: integer
                                        example: 20000
                                      streaming_mode:
                                        type: string
                                        example: micro_batch
                                      streaming_frequency_type:
                                        type: string
                                        example: secs
                                      streaming_frequency_number:
                                        type: integer
                                        example: 10
                                      error_threshold:
                                        type: integer
                                        example: 5
                                      source_file_type:
                                        type: string
                                        example: kafka
                                      natural_keys:
                                        type: array
                                        items:
                                          type: string
                                      partition_keys:
                                        type: array
                                        items:
                                          type: string
                                      target_relative_path:
                                        type: string
                                        example: abch
                                      update_strategy:
                                        type: string
                                        example: append
                                      write_supported_engines:
                                        type: array
                                        items:
                                          type: string
                                          example: SPARK
                                      read_supported_engines:
                                        type: array
                                        items:
                                          type: string
                                          example: SPARK
                                      target_table_name:
                                        type: string
                                      storage_format:
                                        type: string
                                      target_schema_name:
                                        type: string
                                      sync_type:
                                        type: string
                                        example: incremental
                          - type: object
                            properties:
                              id:
                                type: string
                                format: hexadecimal
                              name:
                                type: string
                              original_table_name:
                                type: string
                              topic_mapping_name:
                                type: string
                              file_mapping_name:
                                type: string
                              data_lake_schema:
                                type: string
                                example: kafka
                              data_lake_path:
                                type: string
                                example: /iw/kafka-source
                              meta_crawl_performed:
                                type: boolean
                              columns:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    sql_type:
                                      type: integer
                                      example: 4
                                    name:
                                      type: string
                                      example: id
                                    original_name:
                                      type: string
                                      example: id
                                    target_sql_type:
                                      type: integer
                                      example: 4
                                    json_schema_node_key:
                                      type: integer
                                      example: 4
                                    is_mixed_element_text_content:
                                      type: boolean
                                      example: false
                                    is_recursive_data_text_content:
                                      type: boolean
                                      example: false
                                    is_excluded_column:
                                      type: boolean
                                      example: true
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                status:
                                  type: string
                                queue_info:
                                  type: string
                                params:
                                  type: object
                                  properties:
                                    connection:
                                      type: object
                                      properties:
                                        driver_name:
                                          type: string
                                        driver_version:
                                          type: string
                                        database:
                                          type: string
                                        connection_method:
                                          type: string
                                        connection_string:
                                          type: string
                                        password:
                                          type: object
                                          properties:
                                            password_type:
                                              type: string
                                            secret_id:
                                              type: string
                                        username:
                                          type: string
                                    entityId:
                                      type: string
                                error:
                                  type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/query_table/generate-preview:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: query
        in: query
        description: Query for table preview
        required: true
        schema:
          type: string
      - name: number_of_rows
        in: query
        description: Number of rows
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Generate query table preview.
      description: Generate query table preview.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          status:
                            type: string
                            example: success
                          id:
                            type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/query_table/get-preview:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: query
        in: query
        description: Query for table preview
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Get query table preview.
      description: Get query table preview.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        allOf:
                          - type: object
                            properties:
                              source:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              last_ingested_cdc_value:
                                type: string
                                example: null
                              full_load_performed:
                                type: boolean
                                example: false
                              description:
                                type: string
                                example: example description
                              tags:
                                type: array
                                items:
                                  example: c54t456f6d5a2c4564aed
                              schema_name_at_source:
                                type: string
                                example: dummy
                              topic_mapping_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              configuration:
                                type: object
                                allOf:
                                  - properties:
                                      json_schema:
                                        type: array
                                        items:
                                          type: object
                                          properties:
                                            key:
                                              type: integer
                                              example: 1
                                            name:
                                              type: string
                                              example: del
                                            properties:
                                              type: object
                                              properties:
                                                sql_type:
                                                  type: integer
                                                  example: 1
                                                target_sql_type:
                                                  type: integer
                                                  example: 1
                                                type:
                                                  type: string
                                                  example: struct
                                      json_schema_breadcrumb:
                                        type: array
                                        items:
                                          properties:
                                            selected:
                                              type: boolean
                                              example: true
                                            name:
                                              type: string
                                            json_schema_node_key:
                                              type: integer
                                              example: 0
                                      crawl_data_filter_enabled:
                                        type: boolean
                                        example: false
                                      crawl_filter_conditions:
                                        type: array
                                        items:
                                          example: ''
                                      max_num_of_records:
                                        type: integer
                                        example: 20000
                                      streaming_mode:
                                        type: string
                                        example: micro_batch
                                      streaming_frequency_type:
                                        type: string
                                        example: secs
                                      streaming_frequency_number:
                                        type: integer
                                        example: 10
                                      error_threshold:
                                        type: integer
                                        example: 5
                                      source_file_type:
                                        type: string
                                        example: kafka
                                      natural_keys:
                                        type: array
                                        items:
                                          type: string
                                      partition_keys:
                                        type: array
                                        items:
                                          type: string
                                      target_relative_path:
                                        type: string
                                        example: abch
                                      update_strategy:
                                        type: string
                                        example: append
                                      write_supported_engines:
                                        type: array
                                        items:
                                          type: string
                                          example: SPARK
                                      read_supported_engines:
                                        type: array
                                        items:
                                          type: string
                                          example: SPARK
                                      target_table_name:
                                        type: string
                                      storage_format:
                                        type: string
                                      target_schema_name:
                                        type: string
                                      sync_type:
                                        type: string
                                        example: incremental
                          - type: object
                            properties:
                              id:
                                type: string
                                format: hexadecimal
                              name:
                                type: string
                              original_table_name:
                                type: string
                              topic_mapping_name:
                                type: string
                              file_mapping_name:
                                type: string
                              data_lake_schema:
                                type: string
                                example: kafka
                              data_lake_path:
                                type: string
                                example: /iw/kafka-source
                              meta_crawl_performed:
                                type: boolean
                              columns:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    sql_type:
                                      type: integer
                                      example: 4
                                    name:
                                      type: string
                                      example: id
                                    original_name:
                                      type: string
                                      example: id
                                    target_sql_type:
                                      type: integer
                                      example: 4
                                    json_schema_node_key:
                                      type: integer
                                      example: 4
                                    is_mixed_element_text_content:
                                      type: boolean
                                      example: false
                                    is_recursive_data_text_content:
                                      type: boolean
                                      example: false
                                    is_excluded_column:
                                      type: boolean
                                      example: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/tables/{table_id}/generateQueries:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Get Preview Queries.
      description: Gets Preview Queries.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        allOf:
                          - type: object
                            properties:
                              sampleDataQuery:
                                type: string
                                example: >-
                                  select  from xyz.` ( select * from xyz.test
                                  limit 101 ) QAAT ` limit 100dfb
                              success:
                                type: boolean
                                example: true
                              cdcQuery:
                                type: string
                                example: >-
                                  select  from  ( select * from test.test limit
                                  101 ) QAAT
                              schemaCrawlQuery:
                                type: string
                                example: >-
                                  select * from  ( select * from test.test limit
                                  101 ) QAAT  where 1=0
                              rowCountQuery:
                                type: string
                                example: >-
                                  select count(*) as tableRowCount from ( select
                                  * from test.test limit 101 ) QAAT
                              message:
                                type: string
                                example: Got Queries successfully
                              fullLoadQuery:
                                type: string
                                example: >-
                                  select  from  ( select * from test.test limit
                                  101 ) QAAT
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/crawl-schema:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: source_sub_type
        in: query
        description: Specifying source sub type
        required: true
        schema:
          type: string
          example: mainframe
      - name: entity_id
        in: query
        description: Entity ID
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Sources
      summary: Crawl Entity Schema
      description: Crawl Entity Schema
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Example Success Message
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/bulk-crawl-schema:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: source_sub_type
        in: query
        description: Specifying source sub type
        required: true
        schema:
          type: string
          example: mainframe
      - name: entity_ids
        in: query
        description: A list of Entity IDs
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Sources
      summary: Bulk Crawl Entity Schema
      description: Bulk Crawl Entity Schema
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Example Success Message
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/crawl-status:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: source_sub_type
        in: query
        description: Specifying source sub type
        required: true
        schema:
          type: string
          example: mainframe
      - name: entity_id
        in: query
        description: Entity ID
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Sources
      summary: Check status for crawling
      description: Check status for crawling
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Example Success Message
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/bulk-crawl-status:
    parameters:
      - name: source_id
        in: path
        description: Source Id.
        required: true
        schema:
          type: string
      - name: source_sub_type
        in: query
        description: Specifying source sub type
        required: true
        schema:
          type: string
          example: mainframe
      - name: entity_ids
        in: query
        description: A list of Entity IDs
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Sources
      summary: Check status for bulk crawling
      description: Check status for bulk crawling
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Example Success Message
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /domains:
    get:
      security:
        - BearerAuth: []
      operationId: getDomains
      tags:
        - Domains
      summary: Get List of Domains
      description: Get List of Domains
      parameters:
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - allOf:
                                - type: object
                                  properties:
                                    name:
                                      type: string
                                      example: DF_SQLIMPORT
                                - type: object
                                  properties:
                                    description:
                                      type: string
                                      example: Example Domain
                                - type: object
                                  properties:
                                    secrets:
                                      type: array
                                      items:
                                        type: string
                                        example: 8247ad34f124512e
                                - properties:
                                    environment_ids:
                                      type: array
                                      items:
                                        type: string
                                        example: 8247ad34f124512e
                                    users:
                                      type: array
                                      items:
                                        type: string
                                        example: 8247ad34f124512e
                            - type: object
                              allOf:
                                - type: object
                                  properties:
                                    created_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    created_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                                - type: object
                                  properties:
                                    modified_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    modified_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                            - type: object
                              properties:
                                accessibleDomains:
                                  type: array
                                  items:
                                    type: string
                                    example: 3456234456cde12e
                            - type: object
                              properties:
                                accessiblePipelineExtensions:
                                  type: array
                                  items:
                                    type: string
                                    example: 7b606a6c4bc0688a99cc5f07
                            - type: object
                              properties:
                                environment:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: 63cd71df9f1c1e258c6e991b
                                    name:
                                      type: string
                                      example: env_azure
                                    compute_engine:
                                      type: string
                                      example: spark
                                    platform:
                                      type: string
                                      example: databricks
                                ephemeral_compute:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                        example: ephemeral_compute
                                      environment_id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                interactive_compute:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                        example: interactive_compute
                                      environment_id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                storage:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      name:
                                        type: string
                                        example: storage
                                      environment_id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      description:
                                        type: string
                                        example: description for storage
                                      storage_type:
                                        type: string
                                        example: gcs
                                      storage_authentication:
                                        type: object
                                        properties:
                                          authentication_mechanism:
                                            type: string
                                            example: environment_service_credential
                                          scheme:
                                            type: string
                                            example: gs://
                                          bucket_name:
                                            type: string
                                            example: temp-bucket-xxx
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: createDomain
      tags:
        - Domains
      summary: Add a domain. (Requires Admin Access)
      description: Add a domain. (Requires Admin Access)
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    name:
                      type: string
                      example: DF_SQLIMPORT
                - type: object
                  properties:
                    description:
                      type: string
                      example: Example Domain
                - type: object
                  properties:
                    secrets:
                      type: array
                      items:
                        type: string
                        example: 8247ad34f124512e
                - properties:
                    environment_ids:
                      type: array
                      items:
                        type: string
                        example: 8247ad34f124512e
                    users:
                      type: array
                      items:
                        type: string
                        example: 8247ad34f124512e
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Successfully created a Domain
                  result:
                    allOf:
                      - type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}:
    get:
      security:
        - BearerAuth: []
      operationId: getDomain
      tags:
        - Domains
      summary: Get description of a domain_id. (Requires Admin Access)
      description: Get description of a domain_id. (Requires Admin Access)
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        allOf:
                          - type: object
                            properties:
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          - allOf:
                              - type: object
                                properties:
                                  name:
                                    type: string
                                    example: DF_SQLIMPORT
                              - type: object
                                properties:
                                  description:
                                    type: string
                                    example: Example Domain
                              - type: object
                                properties:
                                  secrets:
                                    type: array
                                    items:
                                      type: string
                                      example: 8247ad34f124512e
                              - properties:
                                  environment_ids:
                                    type: array
                                    items:
                                      type: string
                                      example: 8247ad34f124512e
                                  users:
                                    type: array
                                    items:
                                      type: string
                                      example: 8247ad34f124512e
                          - type: object
                            allOf:
                              - type: object
                                properties:
                                  created_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  created_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                              - type: object
                                properties:
                                  modified_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  modified_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                          - type: object
                            properties:
                              accessibleDomains:
                                type: array
                                items:
                                  type: string
                                  example: 3456234456cde12e
                          - type: object
                            properties:
                              accessiblePipelineExtensions:
                                type: array
                                items:
                                  type: string
                                  example: 7b606a6c4bc0688a99cc5f07
                          - type: object
                            properties:
                              environment:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: 63cd71df9f1c1e258c6e991b
                                  name:
                                    type: string
                                    example: env_azure
                                  compute_engine:
                                    type: string
                                    example: spark
                                  platform:
                                    type: string
                                    example: databricks
                              ephemeral_compute:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                      example: ephemeral_compute
                                    environment_id:
                                      type: string
                                      example: 63cd71df9f1c1e258c6e991b
                                    id:
                                      type: string
                                      example: 63cd71df9f1c1e258c6e991b
                              interactive_compute:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                      example: interactive_compute
                                    environment_id:
                                      type: string
                                      example: 63cd71df9f1c1e258c6e991b
                                    id:
                                      type: string
                                      example: 63cd71df9f1c1e258c6e991b
                              storage:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: 63cd71df9f1c1e258c6e991b
                                    name:
                                      type: string
                                      example: storage
                                    environment_id:
                                      type: string
                                      example: 63cd71df9f1c1e258c6e991b
                                    description:
                                      type: string
                                      example: description for storage
                                    storage_type:
                                      type: string
                                      example: gcs
                                    storage_authentication:
                                      type: object
                                      properties:
                                        authentication_mechanism:
                                          type: string
                                          example: environment_service_credential
                                        scheme:
                                          type: string
                                          example: gs://
                                        bucket_name:
                                          type: string
                                          example: temp-bucket-xxx
                          - type: object
                            properties:
                              accessible_domains_details:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                    name:
                                      type: string
                                    created_at:
                                      type: string
                                    created_by:
                                      type: string
                                    environment_ids:
                                      type: array
                                      items:
                                        type: object
                          - type: object
                            properties:
                              accessible_pipeline_extensions_details:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                    name:
                                      type: string
                                    type:
                                      type: string
                          - type: object
                            properties:
                              recently_used:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    entity_type:
                                      type: string
                                      example: pipeline
                                    entity_id:
                                      type: string
                                      example: 8f94b2d08e48b07f1a50ac1e
                                    access_at:
                                      type: string
                                      example: '2023-03-09T04:46:27.297Z'
                                    access_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                                    entity_name:
                                      type: string
                                      example: pipeline123
                                    modified_at:
                                      type: string
                                      example: '2023-02-21T05:19:09.803Z'
                                    modified_by_name:
                                      type: string
                                      example: Admin
                                    created_at:
                                      type: string
                                      example: '2022-12-14T10:40:29.536Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      operationId: patchDomain
      tags:
        - Domains
      summary: Edit name and description of a domain. (Requires Admin Access)
      description: Edit name and description of a domain. (Requires Admin Access)
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - type: object
                  properties:
                    name:
                      type: string
                      example: DF_SQLIMPORT
                - type: object
                  properties:
                    description:
                      type: string
                      example: Example Domain
                - type: object
                  properties:
                    secrets:
                      type: array
                      items:
                        type: string
                        example: 8247ad34f124512e
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Successfully Edited a Domain
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      operationId: deleteDomain
      tags:
        - Domains
      summary: Delete a Domain (Requires Admin Access).
      description: Delete a Domain (Requires Admin Access).
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    example: success
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/accessible-sources:
    get:
      security:
        - BearerAuth: []
      operationId: getAccessibleSources
      tags:
        - Domains
      summary: Get all the Sources associated with this Domain
      description: Get all the Sources associated with this Domain
      parameters:
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - allOf:
                                - type: object
                                  properties:
                                    id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                - type: object
                                  properties:
                                    sourceName:
                                      type: string
                                      example: kafka-source
                                    sourceType:
                                      type: string
                                      example: streaming
                                - type: object
                                  properties:
                                    created_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    created_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                            - type: object
                              properties:
                                environment:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: 63cd71df9f1c1e258c6e991b
                                    name:
                                      type: string
                                      example: env_azure
                                    compute_engine:
                                      type: string
                                      example: spark
                                    platform:
                                      type: string
                                      example: databricks
                                ephemeral_compute:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                        example: ephemeral_compute
                                      environment_id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                interactive_compute:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                        example: interactive_compute
                                      environment_id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                storage:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      name:
                                        type: string
                                        example: storage
                                      environment_id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      description:
                                        type: string
                                        example: description for storage
                                      storage_type:
                                        type: string
                                        example: gcs
                                      storage_authentication:
                                        type: object
                                        properties:
                                          authentication_mechanism:
                                            type: string
                                            example: environment_service_credential
                                          scheme:
                                            type: string
                                            example: gs://
                                          bucket_name:
                                            type: string
                                            example: temp-bucket-xxx
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: addAccessibleSources
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      tags:
        - Domains
      summary: Add Sources to this Domain (Requires Admin Access)
      description: Add Sources to this Domain (Requires Admin Access)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                entity_ids:
                  type: array
                  items:
                    type: string
                    example: 8247ad34f124512e
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    example: success
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    put:
      security:
        - BearerAuth: []
      operationId: updateAccessibleSources
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      tags:
        - Domains
      summary: Update Sources to this Domain (Requires Admin Access)
      description: Update Sources to this Domain (Requires Admin Access)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                entity_ids:
                  type: array
                  items:
                    type: string
                    example: 8247ad34f124512e
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    example: success
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      operationId: deleteAccessibleSources
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      tags:
        - Domains
      summary: Remove Source from this Domain (Requires Admin Access)
      description: Remove Source from this Domain (Requires Admin Access)
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    example: success
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/accessible-domains:
    get:
      security:
        - BearerAuth: []
      operationId: getAccessibleDomains
      tags:
        - Domains
      summary: Get all the Domains associated with this Domain
      description: Get all the Domains associated with this Domain
      parameters:
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - allOf:
                                - type: object
                                  properties:
                                    id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                - type: object
                                  properties:
                                    domainName:
                                      type: string
                                      example: Stock Domain
                            - type: object
                              allOf:
                                - type: object
                                  properties:
                                    created_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    created_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                                - type: object
                                  properties:
                                    modified_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    modified_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: addAccessibleDomains
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      tags:
        - Domains
      summary: Add Domains to this Domain (Requires Admin Access)
      description: Add Domains to this Domain (Requires Admin Access)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                entity_ids:
                  type: array
                  items:
                    type: string
                    example: 8247ad34f124512e
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    example: success
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    put:
      security:
        - BearerAuth: []
      operationId: updateAccessibleDomains
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      tags:
        - Domains
      summary: Update accessible-domain in this Domain (Requires Admin Access)
      description: Update accessible-domain in this Domain (Requires Admin Access)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                entity_ids:
                  type: array
                  items:
                    type: string
                    example: 8247ad34f124512e
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    example: success
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      operationId: removeAccessibleDomains
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      tags:
        - Domains
      summary: Remove Domain from this Domain (Requires Admin Access)
      description: Remove Domain from this Domain (Requires Admin Access)
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    example: success
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}//pipelines/{pipeline_id}/versions/{version_id}/set-active:
    post:
      security:
        - BearerAuth: []
      operationId: setPipelineVersionActive
      tags:
        - Pipelines
      summary: Change the active version of the Pipeline
      description: Change the active version of the Pipeline
      parameters:
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: pipeline_id
          in: path
          required: true
          schema:
            type: string
        - name: version_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/accessible-workflows:
    get:
      security:
        - BearerAuth: []
      operationId: getAccessibleWorkflows
      tags:
        - Domains
      summary: Get all the workflows associated with this Domain
      description: Get all the workflows associated with this Domain
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                name:
                                  type: string
                                domain_id:
                                  type: string
                                domain_name:
                                  type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/accessible-table-groups:
    get:
      security:
        - BearerAuth: []
      operationId: getAccessibleTableGroups
      tags:
        - Domains
      summary: Get all the tablegroups associated with this Domain
      description: Get all the tablegroups associated with this Domain
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                name:
                                  type: string
                                source:
                                  type: string
                                source_name:
                                  type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/accessible-interactive-computes:
    get:
      security:
        - BearerAuth: []
      operationId: getAccessibleInteractiveComputes
      tags:
        - Domains
      summary: Get all the interactive computes associated with this Domain
      description: Get all the interactive computes associated with this Domain
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                name:
                                  type: string
                                environment_id:
                                  type: string
                                environment_name:
                                  type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/accessible-pipelines:
    get:
      security:
        - BearerAuth: []
      operationId: getAccessiblePipelines
      tags:
        - Domains
      summary: Get all the pipelines associated with this Domain
      description: Get all the pipelines associated with this Domain
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                name:
                                  type: string
                                domain_id:
                                  type: string
                                domain_name:
                                  type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/accessible-pipeline-extensions:
    get:
      security:
        - BearerAuth: []
      operationId: getAccessiblePipelineExtensions
      tags:
        - Domains
      summary: Get all the Pipeline Extensions associated with this Domain
      description: Get all the Pipeline Extensions associated with this Domain
      parameters:
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                pipeline_extension_name:
                                  type: string
                                  example: Custom Transformation Example
                                extension_type:
                                  type: string
                                  example: Spark
                                execution_type:
                                  type: string
                                  example: JAVA
                                transformations:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      alias:
                                        type: string
                                        example: AddInteger
                                      class_name:
                                        type: string
                                        example: io.infoworks.external.maskers.AddInteger
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    put:
      security:
        - BearerAuth: []
      operationId: updateAccessiblePipelineExtensions
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      tags:
        - Domains
      summary: >-
        Update accessible-pipeline-extensions in this Domain (Requires Admin
        Access)
      description: >-
        Update accessible-pipeline-extensions in this Domain (Requires Admin
        Access)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                entity_ids:
                  type: array
                  items:
                    type: string
                    example: 8247ad34f124512e
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    example: success
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: addAccessiblePipelineExtensions
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      tags:
        - Domains
      summary: Add Pipeline Extensions to this Domain (Requires Admin Access)
      description: Add Pipeline Extensions to this Domain (Requires Admin Access)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                entity_ids:
                  type: array
                  items:
                    type: string
                    example: 8247ad34f124512e
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    example: success
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      operationId: removeAccessiblePipelineExtensions
      description: Remove Pipeline Extension from this Domain (Requires Admin Access)
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      tags:
        - Domains
      summary: Remove Pipeline Extension from this Domain (Requires Admin Access)
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    example: success
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/configurations/advance/{key}:
    put:
      security:
        - BearerAuth: []
      operationId: advancedConfigurationInfo
      description: Domain Advanced Configurations
      tags:
        - Domains
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: key
          in: path
          required: true
          schema:
            type: string
            example: SPARK_ML_LIB
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - properties:
                    value:
                      type: string
                      example: 3.2.0
                - properties:
                    description:
                      type: string
                      example: Spark version
                - properties:
                    isActive:
                      type: boolean
                      example: true
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    example: success
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      operationId: updateAdvancedConfiguration
      tags:
        - Domains
      description: update advanced configs
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: key
          in: path
          required: true
          schema:
            type: string
            example: SPARK_ML_LIB
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - properties:
                    value:
                      type: string
                      example: 3.2.0
                - properties:
                    description:
                      type: string
                      example: Spark version
                - properties:
                    isActive:
                      type: boolean
                      example: true
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    example: success
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      operationId: removedAdvancedConfigs
      description: delete advanced configs
      tags:
        - Domains
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: key
          in: path
          required: true
          schema:
            type: string
            example: SPARK_ML_LIB
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    example: success
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /users:
    get:
      security:
        - BearerAuth: []
      operationId: GetUsers
      tags:
        - Users
      summary: Get the User details
      description: Get the User details
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                  - properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - properties:
                                profile:
                                  allOf:
                                    - type: object
                                      properties:
                                        name:
                                          type: string
                                          example: DF_SQLIMPORT
                                    - properties:
                                        email:
                                          type: string
                                          example: xxx@infoworks.io
                                    - properties:
                                        needs_password_reset:
                                          type: boolean
                                          example: false
                                emails:
                                  type: array
                                  items:
                                    properties:
                                      address:
                                        type: string
                                        example: xxx@infoworks.io
                                      verified:
                                        type: boolean
                                        example: true
                                display_name:
                                  type: string
                                  example: Admin
                                roles:
                                  type: array
                                  items:
                                    type: string
                                    example: modeller
                                refresh_token:
                                  type: string
                                  example: zThziQ7MoJJP...
                                status:
                                  type: object
                                  properties:
                                    is_online:
                                      type: boolean
                                      example: false
                                    last_login_details:
                                      properties:
                                        date:
                                          type: string
                                          example: '2019-11-21T12:54:05.875Z'
                                        ip_address:
                                          type: string
                                          example: 10.12.43.23
                                        user_agent:
                                          type: string
                                          example: Mozilla/****
                            - properties:
                                accessible_domains:
                                  items:
                                    type: string
                                    example: ffb38b0cc595cfcd05c54e49
                            - properties:
                                failed_logins:
                                  type: array
                                  items:
                                    example: null
                                created_at:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
                                modified_at:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
                                is_password_required:
                                  type: boolean
                                  example: false
                                login_disabled:
                                  type: boolean
                                  example: true
                                locked_till:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: createUser
      tags:
        - Users
      summary: Create a new User
      description: Create a new User
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    profile:
                      allOf:
                        - type: object
                          properties:
                            name:
                              type: string
                              example: DF_SQLIMPORT
                        - properties:
                            email:
                              type: string
                              example: xxx@infoworks.io
                    roles:
                      type: array
                      items:
                        type: string
                        example: modeller
                - type: object
                  properties:
                    password:
                      type: string
                      example: kdb***
                - properties:
                    accessible_domains:
                      items:
                        type: string
                        example: ffb38b0cc595cfcd05c54e49
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /users/{user_id}:
    parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: GetUserIdForAdmin
      tags:
        - Users
      summary: Get the details of the user linked with the user_id
      description: Get the details of the user linked with the user_id
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                  - properties:
                      result:
                        type: object
                        allOf:
                          - type: object
                            properties:
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          - properties:
                              profile:
                                allOf:
                                  - type: object
                                    properties:
                                      name:
                                        type: string
                                        example: DF_SQLIMPORT
                                  - properties:
                                      email:
                                        type: string
                                        example: xxx@infoworks.io
                                  - properties:
                                      needs_password_reset:
                                        type: boolean
                                        example: false
                              emails:
                                type: array
                                items:
                                  properties:
                                    address:
                                      type: string
                                      example: xxx@infoworks.io
                                    verified:
                                      type: boolean
                                      example: true
                              roles:
                                type: array
                                items:
                                  type: string
                                  example: modeller
                              auth_token:
                                type: string
                                example: ksvfvb***
                              status:
                                type: object
                                properties:
                                  is_online:
                                    type: boolean
                                    example: false
                                  last_login_details:
                                    properties:
                                      date:
                                        type: string
                                        example: '2019-11-21T12:54:05.875Z'
                                      ip_address:
                                        type: string
                                        example: 10.12.43.23
                                      user_agent:
                                        type: string
                                        example: Mozilla/****
                          - properties:
                              accessible_domains:
                                items:
                                  type: string
                                  example: ffb38b0cc595cfcd05c54e49
                          - properties:
                              failed_logins:
                                type: array
                                items:
                                  example: null
                              created_at:
                                type: string
                                example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      operationId: deleteUserForAdmin
      tags:
        - Users
      summary: Delete a user.
      description: Delete a user.
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      operationId: updateUserForAdmin
      tags:
        - Users
      summary: Update the User
      description: Update the User
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    profile:
                      allOf:
                        - type: object
                          properties:
                            name:
                              type: string
                              example: DF_SQLIMPORT
                        - properties:
                            email:
                              type: string
                              example: xxx@infoworks.io
                    roles:
                      type: array
                      items:
                        type: string
                        example: modeller
                - properties:
                    accessible_domains:
                      items:
                        type: string
                        example: ffb38b0cc595cfcd05c54e49
                - type: object
                  properties:
                    password:
                      type: string
                      example: kdb***
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
    get:
      security:
        - BearerAuth: []
      operationId: getDomainPipelines
      tags:
        - Pipelines
      summary: Get all pipelines for domain with `domain_id`
      description: Get all pipelines for domain with `domain_id`
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - type: object
                              properties:
                                domain_id:
                                  type: string
                                  example: ffb38b0cc595cfcd05c54e49
                                name:
                                  type: string
                                  example: test_pipeline
                                batch_engine:
                                  type: string
                                  example: SPARK
                                environment_id:
                                  type: string
                                  example: eab81a8118141ca6bdd5b698
                                environment_name:
                                  type: string
                                  example: bigquery_environment
                            - type: object
                              allOf:
                                - type: object
                                  properties:
                                    created_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    created_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                                - type: object
                                  properties:
                                    modified_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    modified_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                  - type: object
                    properties:
                      environment:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 63cd71df9f1c1e258c6e991b
                          name:
                            type: string
                            example: env_azure
                          compute_engine:
                            type: string
                            example: spark
                          platform:
                            type: string
                            example: databricks
                      ephemeral_compute:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                              example: ephemeral_compute
                            environment_id:
                              type: string
                              example: 63cd71df9f1c1e258c6e991b
                            id:
                              type: string
                              example: 63cd71df9f1c1e258c6e991b
                      interactive_compute:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                              example: interactive_compute
                            environment_id:
                              type: string
                              example: 63cd71df9f1c1e258c6e991b
                            id:
                              type: string
                              example: 63cd71df9f1c1e258c6e991b
                      storage:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 63cd71df9f1c1e258c6e991b
                            name:
                              type: string
                              example: storage
                            environment_id:
                              type: string
                              example: 63cd71df9f1c1e258c6e991b
                            description:
                              type: string
                              example: description for storage
                            storage_type:
                              type: string
                              example: gcs
                            storage_authentication:
                              type: object
                              properties:
                                authentication_mechanism:
                                  type: string
                                  example: environment_service_credential
                                scheme:
                                  type: string
                                  example: gs://
                                bucket_name:
                                  type: string
                                  example: temp-bucket-xxx
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: createPipeline
      tags:
        - Pipelines
      summary: create new pipeline for domain with `domain_id`
      description: create new pipeline for domain with `domain_id`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                batch_engine:
                  type: string
                  enum:
                    - SPARK
                    - BIGQUERY
                    - SNOWFLAKE
                storage_id:
                  type: string
                  example: e77850ad5127a2d7dab870ff
                compute_template_id:
                  type: string
                  example: e77850ad5127a2d7dab870ff
                ml_engine:
                  type: string
                  enum:
                    - SPARK
                snowflake_profile:
                  type: string
                  example: profile1
                snowflake_warehouse:
                  type: string
                  example: LOAD_WH
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines/{pipeline_id}:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
    get:
      security:
        - BearerAuth: []
      operationId: getPipeline
      tags:
        - Pipelines
      summary: Gets a `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
      description: Gets a `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        allOf:
                          - type: object
                            properties:
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          - type: object
                            properties:
                              name:
                                type: string
                                example: test_pipeline
                              description:
                                type: string
                                example: test description
                              active_version_id:
                                type: string
                                example: 5fda1077e27e6d13330e99c0
                              compute_template_id:
                                type: string
                                example: 5fda1077e27e6d13330e99c0
                              domain_id:
                                type: string
                                example: 5fda1077e27e6d13330e99c0
                              batch_engine:
                                type: string
                                example: SPARK
                              versions_count:
                                type: integer
                                format: int32
                                example: 2
                              metadata_version:
                                type: integer
                                format: int32
                                example: 3
                          - type: object
                            allOf:
                              - type: object
                                properties:
                                  created_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  created_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                              - type: object
                                properties:
                                  modified_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  modified_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      operationId: deletePipeline
      tags:
        - Pipelines
      summary: >-
        Deletes a `pipeline` with `{pipeline_id}` in `domain` with
        `{domain_id}`.
      description: >-
        Deletes a `pipeline` with `{pipeline_id}` in `domain` with
        `{domain_id}`.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    put:
      security:
        - BearerAuth: []
      operationId: updatePipeline
      tags:
        - Pipelines
      summary: >-
        Updates a `pipeline` with `{pipeline_id}` in `domain` with
        `{domain_id}`.
      description: >-
        Updates a `pipeline` with `{pipeline_id}` in `domain` with
        `{domain_id}`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: test_pipeline
                description:
                  type: string
                  example: test_pipeline
                compute_template_id:
                  type: string
                  example: 5fda1077e27e6d13330e99c0
                active_version_id:
                  type: string
                  example: 5fda1077e27e6d13330e99c0
                query_tag:
                  type: string
                  example: sales
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines/{pipeline_id}/impacted-workflows:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
    get:
      security:
        - BearerAuth: []
      operationId: PipelineImpactedWorkflows
      tags:
        - Pipelines
      summary: >-
        Gets list of workflows using pipeline with `{pipeline_id}` in `domain`
        with `{domain_id}`.
      description: >-
        Gets list of workflows using pipeline with `{pipeline_id}` in `domain`
        with `{domain_id}.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          workflows:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: 5fd5c5f7e27e6d34cf0660b8
                                name:
                                  type: string
                                  example: workflow_name
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines/{pipeline_id}/analytics-models:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: ml_engine
        in: query
        description: Machine Learning engine name
        schema:
          type: string
          example: SPARK
      - name: default_engine
        in: query
        description: This engine name will be used if ml_engine name is not provided
        schema:
          type: string
          example: SPARK
      - name: accessible_groups
        in: query
        description: This will return analytics model options groups.
        schema:
          type: boolean
          example: true
    get:
      security:
        - BearerAuth: []
      operationId: getPipelineAnalyticsModelForMLEngine
      tags:
        - Pipelines
      summary: >-
        Gets all `pipeline analytics models` for ML Engine with `{pipeline_id}`
        in `domain` with `{domain_id}`.
      description: >-
        Gets all `pipeline analytics models` for ML Engine with `{pipeline_id}`
        in `domain` with `{domain_id}`.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          pipeline_analytics_models:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: 638edc7729d59e6c974513a4
                                analytics_model_name:
                                  type: string
                                  example: model1
                                analytics_model_type:
                                  type: string
                                  example: ANALYTICS_K_MEANS_CLUSTERING
                                columns:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                        example: CC_CALL_CENTER_SK
                                      was_prediction_column:
                                        type: boolean
                                        example: false
                                ml_engine:
                                  type: string
                                  example: SPARK
                                pipeline_id:
                                  type: string
                                  example: 62f39bba5011a8c4684bfeb7
                                target_base_path:
                                  type: string
                                  example: gs://temp-bucket-xxx/test-model
                                target_relative_path:
                                  type: string
                                  example: gs://temp-bucket-xxx/test-model
                                analytics_model_node_id:
                                  type: string
                                  example: ANALYTICS_MODEL_EXPORT_d705
                          options:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: 638edc7729d59e6c974513a4
                                parent_entity_type:
                                  type: string
                                  example: pipeline
                                parent_entity_name:
                                  type: string
                                  example: pipeline
                                analytics_model_name:
                                  type: string
                                  example: model1
                                source_type:
                                  type: string
                                  example: pipeline
                                pipeline_id:
                                  type: string
                                  example: 62f39bba5011a8c4684bfeb7
                                parent_entity_id:
                                  type: string
                                  example: 62f39bba5011a8c4684bfeb7
                          optionGroup:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: 3f82400d7327a176391dcc38
                                name:
                                  type: string
                                  example: test_pl
                                domain_id:
                                  type: string
                                  example: source_type
                                domain_name:
                                  type: string
                                  example: SF_DOMAIN
                                source_type:
                                  type: string
                                  example: domain
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines/{pipeline_id}/versions:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
    get:
      security:
        - BearerAuth: []
      operationId: getPipelineVersionList
      tags:
        - Pipelines
      summary: Get list of all versions of Pipeline
      description: Get list of all versions of Pipeline
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - type: object
                              allOf:
                                - type: object
                                  properties:
                                    created_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    created_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                                - type: object
                                  properties:
                                    modified_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    modified_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                            - type: object
                              properties:
                                pipeline_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                version:
                                  type: number
                                  minimum: 1
                                description:
                                  type: string
                                is_active:
                                  type: boolean
                                  example: true
                                tags:
                                  type: object
                                type:
                                  type: string
                                  description: >
                                    For `sql` type pipeline version, `query`
                                    field will contain the encrypted value of
                                    SQL query. For `visual` type pipeline
                                    version, `model` field will contain the
                                    model information. If no value is specified
                                    for this field, by default it will be
                                    inferred as `visual`.
                                  enum:
                                    - visual
                                    - sql
                                  default: visual
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: createPipelineVersion
      tags:
        - Pipelines
      summary: Create a pipeline version
      description: Creates a new pipeline version
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    description:
                      type: string
                    is_active:
                      type: boolean
                      example: true
                    tags:
                      type: object
                    type:
                      type: string
                      description: >
                        For `sql` type pipeline version, `query` field will
                        contain the encrypted value of SQL query. For `visual`
                        type pipeline version, `model` field will contain the
                        model information. If no value is specified for this
                        field, by default it will be inferred as `visual`.
                      enum:
                        - visual
                        - sql
                      default: visual
                    query:
                      type: string
                    model:
                      type: object
                    pipeline_parameters:
                      type: array
                      items:
                        type: object
                        properties:
                          key:
                            type: string
                            example: param_key
                          value:
                            type: string
                            example: param_value
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines/{pipeline_id}/versions/{version_id}:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: version_id
        in: path
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
    get:
      security:
        - BearerAuth: []
      operationId: getPipelineVersion
      tags:
        - Pipelines
      summary: >-
        Gets a `pipelineVersion` with `pipeline_version_id` of `pipeline` with
        `{pipeline_id}` in `domain` with `{domain_id}`.
      description: >-
        Gets a `pipelineVersion` with `pipeline_version_id` of `pipeline` with
        `{pipeline_id}` in `domain` with `{domain_id}`.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                  - type: object
                    allOf:
                      - type: object
                        properties:
                          created_at:
                            type: string
                            example: '2019-11-21T12:54:05.875Z'
                      - type: object
                        properties:
                          created_by:
                            type: string
                            example: 6RkfybTRQQByEey3v
                      - type: object
                        properties:
                          modified_at:
                            type: string
                            example: '2019-11-21T12:54:05.875Z'
                      - type: object
                        properties:
                          modified_by:
                            type: string
                            example: 6RkfybTRQQByEey3v
                  - type: object
                    properties:
                      pipeline_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      version:
                        type: number
                        minimum: 1
                      description:
                        type: string
                      is_active:
                        type: boolean
                        example: true
                      tags:
                        type: object
                      type:
                        type: string
                        description: >
                          For `sql` type pipeline version, `query` field will
                          contain the encrypted value of SQL query. For `visual`
                          type pipeline version, `model` field will contain the
                          model information. If no value is specified for this
                          field, by default it will be inferred as `visual`.
                        enum:
                          - visual
                          - sql
                        default: visual
                      query:
                        type: string
                      model:
                        type: object
                      pipeline_parameters:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                              example: param_key
                            value:
                              type: string
                              example: param_value
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      operationId: removePipelineVersion
      tags:
        - Pipelines
      summary: >-
        Deletes a `pipelineVersion` with `pipeline_version_id` of `pipeline`
        with `{pipeline_id}` in `domain` with `{domain_id}`.
      description: >-
        Deletes a `pipelineVersion` with `pipeline_version_id` of `pipeline`
        with `{pipeline_id}` in `domain` with `{domain_id}`.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      operationId: updatePipelineVersion
      tags:
        - Pipelines
      summary: >-
        Update a `pipelineVersion` with `pipeline_version_id` of `pipeline` with
        `{pipeline_id}` in `domain` with `{domain_id}`.
      description: >-
        Update a `pipelineVersion` with `pipeline_version_id` of `pipeline` with
        `{pipeline_id}` in `domain` with `{domain_id}`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                is_active:
                  type: boolean
                tags:
                  type: object
                  properties:
                    general:
                      type: array
                      items:
                        type: object
                model:
                  type: object
                  properties:
                    nodes:
                      type: object
                      properties:
                        UNPIVOT_2f76-keyname:
                          type: object
                          properties:
                            loc:
                              type: string
                            loading:
                              type: boolean
                            input_ports:
                              type: object
                            input_entities:
                              type: array
                              items:
                                type: object
                            output_entities:
                              type: array
                              items:
                                type: object
                            temporary_entities:
                              type: array
                              items:
                                type: object
                            derivations:
                              type: array
                              items:
                                type: object
                            properties:
                              type: object
                            post_configurations:
                              type: object
                            name:
                              type: string
                            type:
                              type: string
                            id:
                              type: string
                    pipeline_graph:
                      type: array
                      items:
                        type: object
                        properties:
                          from:
                            type: string
                          to:
                            type: string
                          category:
                            type: string
                view_options:
                  type: object
                  properties:
                    linkStyle:
                      type: string
                    layout:
                      type: object
                      properties:
                        orientation:
                          type: string
                        layerSpacing:
                          type: number
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines/{pipeline_id}/jobs:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
    get:
      security:
        - BearerAuth: []
      operationId: getJobs_1
      tags:
        - Jobs
      summary: Gets List of Pipeline Jobs.
      description: Gets List of Pipeline Jobs.
      parameters:
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 8714887c9a8c5bb0b8794811
                            build_id:
                              type: integer
                              example: 2
                            name:
                              type: string
                              example: test_job
                            status:
                              type: string
                              enum:
                                - completed
                                - pending
                                - aborted
                                - blocked
                                - failed
                                - running
                                - canceled
                                - succeeded
                              example: completed
                            percentage:
                              type: integer
                              example: 100
                            type:
                              type: string
                              enum:
                                - source_test_connection
                                - fetch_metadata
                                - source_structured_fetch_metadata
                                - source_crawl
                                - source_crawl_chunk_load
                                - source_cdc
                                - source_unstructured_crawl
                                - source_structured_crawl
                                - source_semistructured_crawl
                                - delete_entity
                                - pipeline_metadata
                                - pipeline_build
                                - pipeline_build_restatement
                                - full_load
                                - cdc
                                - source_merge
                                - source_structured_cdc_merge
                                - source_structured_cdc
                                - source_cdc_merge
                                - source_cdc_restatement
                                - source_semistructured_cdc_merge
                                - source_semistructured_cdc
                                - metadata_cleanup_policy
                            entity_id:
                              type: string
                              example: d2f33c1d424363162692b3bf
                            entity_type:
                              type: string
                              enum:
                                - source
                                - pipeline
                                - workflow
                            sub_entity_id:
                              type: string
                              example: be034607444511f74313be63
                            sub_entity_type:
                              type: string
                              example: table_group
                            duration:
                              type: integer
                              example: 349316
                              description: This is duration of the job.
                            cluster_id:
                              type: string
                              example: j-134jnasdkjaasd
                              description: Extenal clusterId
                            compute_id:
                              type: string
                              example: be034607444511f74313be63
                              description: Infoworks compute cluster id
                            compute_name:
                              type: string
                              example: Default_Persistent_cluster
                              description: Infoworks compute name
                            created_at:
                              type: string
                              format: date-time
                              example: '2020-10-05T04:23:30.339Z'
                            created_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                              description: UserId of user who triggered the job.
                            last_updated:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
                            processed_at:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: submitJob_2
      tags:
        - Jobs
      summary: Submit Pipeline Job.
      description: Submit Pipeline Job.
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    job_type:
                      type: string
                      enum:
                        - pipeline_build
                        - pipeline_metadata
                      example: pipeline_build
                    version_id:
                      type: string
                      example: 5fd5c5f7e27e6d34cf0660b8
                      description: >-
                        if not provided it will build pipeline with active
                        version_id
                    updated_pipeline_parameters:
                      type: array
                      items:
                        type: object
                        properties:
                          key:
                            type: string
                            example: param_key
                          value:
                            type: string
                            example: param_value
                - type: object
                  title: PipelineBuildRestatementJobRequestModel
                  properties:
                    job_type:
                      type: string
                      enum:
                        - pipeline_build_restatement
                      example: pipeline_build_restatement
                    version_id:
                      type: string
                      example: 5fd5c5f7e27e6d34cf0660b8
                      description: >-
                        if not provided it will build pipeline with active
                        version_id
                    updated_pipeline_parameters:
                      type: array
                      items:
                        type: object
                        properties:
                          key:
                            type: string
                            example: param_key
                          value:
                            type: string
                            example: param_value
                    runtime_configurations:
                      type: array
                      items:
                        type: object
                        required:
                          - table_id
                        properties:
                          table_id:
                            type: string
                            example: 5f0754885406f51f04a85293
                          watermark_lower_limit:
                            type: string
                            default: $(LAST_RUN_HIGH_WATERMARK)
                          watermark_upper_limit:
                            type: string
                            default: $(INGESTION_LAST_MERGED_WATERMARK)
                - title: DeleteEntityJobRequestSchema
                  type: object
                  required:
                    - job_type
                  properties:
                    job_type:
                      type: string
                      enum:
                        - source_delete
                      example: source_delete
                    purge_metadata:
                      type: boolean
                      example: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Pipeline Build Job submitted successfully
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 5fd5c5f7e27e6d34cf0660b8
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines/{pipeline_id}/jobs/{job_id}:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getJobs
      tags:
        - Jobs
      summary: Gets Pipeline Job.
      description: Gets Pipeline Job.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: 8714887c9a8c5bb0b8794811
                  build_id:
                    type: integer
                    example: 2
                  name:
                    type: string
                    example: test_job
                  status:
                    type: string
                    enum:
                      - completed
                      - pending
                      - aborted
                      - blocked
                      - failed
                      - running
                      - canceled
                      - succeeded
                    example: completed
                  percentage:
                    type: integer
                    example: 100
                  type:
                    type: string
                    enum:
                      - source_test_connection
                      - fetch_metadata
                      - source_structured_fetch_metadata
                      - source_crawl
                      - source_crawl_chunk_load
                      - source_cdc
                      - source_unstructured_crawl
                      - source_structured_crawl
                      - source_semistructured_crawl
                      - delete_entity
                      - pipeline_metadata
                      - pipeline_build
                      - pipeline_build_restatement
                      - full_load
                      - cdc
                      - source_merge
                      - source_structured_cdc_merge
                      - source_structured_cdc
                      - source_cdc_merge
                      - source_cdc_restatement
                      - source_semistructured_cdc_merge
                      - source_semistructured_cdc
                      - metadata_cleanup_policy
                  entity_id:
                    type: string
                    example: d2f33c1d424363162692b3bf
                  entity_type:
                    type: string
                    enum:
                      - source
                      - pipeline
                      - workflow
                  sub_entity_id:
                    type: string
                    example: be034607444511f74313be63
                  sub_entity_type:
                    type: string
                    example: table_group
                  duration:
                    type: integer
                    example: 349316
                    description: This is duration of the job.
                  cluster_id:
                    type: string
                    example: j-134jnasdkjaasd
                    description: Extenal clusterId
                  compute_id:
                    type: string
                    example: be034607444511f74313be63
                    description: Infoworks compute cluster id
                  compute_name:
                    type: string
                    example: Default_Persistent_cluster
                    description: Infoworks compute name
                  created_at:
                    type: string
                    format: date-time
                    example: '2020-10-05T04:23:30.339Z'
                  created_by:
                    type: string
                    example: 6RkfybTRQQByEey3v
                    description: UserId of user who triggered the job.
                  last_updated:
                    type: string
                    example: '2019-11-21T12:54:05.875Z'
                  processed_at:
                    type: string
                    example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines/{pipeline_id}/version/{pipeline_version_id}/jobs:
    parameters:
      - name: pipeline_version_id
        in: path
        description: pipeline_version_id as HEX string
        required: true
        schema:
          type: string
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
    post:
      security:
        - BearerAuth: []
      operationId: submitJob_3
      tags:
        - Jobs
      summary: Submit Pipeline Job.
      description: Submit Pipeline Job.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                job_type:
                  type: string
                  enum:
                    - pipeline_build
                    - pipeline_metadata
                  example: pipeline_build
                version_id:
                  type: string
                  example: 5fd5c5f7e27e6d34cf0660b8
                  description: >-
                    if not provided it will build pipeline with active
                    version_id
                updated_pipeline_parameters:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                        example: param_key
                      value:
                        type: string
                        example: param_value
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Pipeline Build Job submitted successfully
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 5fd5c5f7e27e6d34cf0660b8
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines/{pipeline_id}/sql-import:
    post:
      security:
        - BearerAuth: []
      operationId: importSql
      tags:
        - Pipelines
      summary: ''
      description: import sql
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: pipeline_id
          in: path
          required: true
          schema:
            type: string
        - name: Content-Type
          in: header
          description: Http content type
          required: true
          schema:
            type: string
            enum:
              - application/json
              - multipart/form-data
              - text/plain
            default: application/json
        - name: flag_pipeline_version_active
          in: query
          description: Flag to specify whether imported pipeline should be active or not
          schema:
            type: boolean
            default: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                dry_run:
                  type: boolean
                  example: false
                sql:
                  type: string
                  example: select * from abcd
                sql_import_configuration:
                  type: object
                  properties:
                    quoted_identifier:
                      type: string
                      example: DOUBLE_QUOTE
                    sql_dialect:
                      type: string
                      example: LENIENT
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Successfully imported the SQL.
                  result:
                    type: object
                    properties:
                      status:
                        type: string
                        example: success
                      import_response:
                        type: object
                        properties:
                          processing_stage:
                            type: string
                            example: MAPPING
                          mappings:
                            type: array
                            items:
                              type: object
                              properties:
                                recommendation:
                                  type: object
                                  properties:
                                    original_table_name:
                                      type: string
                                      example: batch_based
                                    entity_type:
                                      type: string
                                      example: table
                                    to_entity_id:
                                      type: string
                                      example: 5fbcffdcd98f281e9eaef028
                          pipeline:
                            type: object
                            properties:
                              pipeline_parameters:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                    value:
                                      type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines/{pipeline_id}/config-migration:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
    get:
      security:
        - BearerAuth: []
      parameters:
        - name: version_id
          in: query
          required: false
          schema:
            type: string
            example: 63eb632340dd4c5a46a05b2a
        - name: download_file
          in: query
          required: false
          schema:
            type: boolean
            example: true
            default: false
      operationId: exportPipelineConfiguration
      tags:
        - Pipelines
      summary: Exports the pipeline configuration
      description: >-
        Exports the pipeline configuration to JSON format for pipeline with
        `pipeline_id` in domain with `domain_id`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          configuration:
                            type: object
                            properties:
                              entity_configs:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    entity_id:
                                      type: string
                                      example: 61b81903fc88e25d03c0df3e
                                    entity_type:
                                      type: string
                                      example: entity_config
                                    configuration:
                                      type: object
                                      required:
                                        - key
                                        - value
                                      properties:
                                        key:
                                          type: string
                                          example: keyName
                                        value:
                                          type: string
                                          example: keyValue
                                        description:
                                          type: string
                                          example: description about this configuration
                                        is_active:
                                          type: boolean
                                          example: false
                                        entity_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                        entity_type:
                                          type: string
                                          example: source
                              iw_mappings:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    entity_id:
                                      type: string
                                      example: 61b81903fc88e25d03c0df3e
                                    entity_type:
                                      type: string
                                      example: pipeline
                                    recommendation:
                                      type: object
                              pipeline_configs:
                                type: object
                                properties:
                                  description:
                                    type: string
                                    example: this is pipeline
                                  model:
                                    type: object
                                  view_options:
                                    type: object
                                  batch_engine:
                                    type: string
                                    example: SPARK
                              target_table_configs:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    entity_id:
                                      type: string
                                      example: 619fb00c6690e7596a39fe27
                                    entity_type:
                                      type: string
                                      example: table
                                    entity_name:
                                      type: string
                                      example: batch_based_target
                              entity:
                                type: object
                                properties:
                                  entity_id:
                                    type: string
                                    example: 9ee9667096749a6b32a3555e
                                  entity_type:
                                    type: string
                                    example: pipeline
                                  entity_name:
                                    type: string
                                    example: Pp1
                              export:
                                type: object
                                properties:
                                  exported_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                                  exported_at:
                                    type: string
                                    example: '2021-12-20T07:09:11.487Z'
            application/octet-stream:
              schema:
                type: string
                format: binary
                example: config_migration_60d1c89e8172342f76ed6a36.json
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      parameters:
        - name: use_uploaded_file
          in: query
          required: false
          schema:
            type: boolean
            example: false
            default: false
      operationId: importPipelineConfiguration
      tags:
        - Pipelines
      summary: Imports the pipeline configuration
      description: >-
        Imports the pipeline configuration from JSON format for pipeline with
        `pipeline_id` in domain with `domain_id`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              allOf:
                - type: object
                  properties:
                    configuration:
                      type: object
                      properties:
                        entity_configs:
                          type: array
                          items:
                            type: object
                            properties:
                              entity_id:
                                type: string
                                example: 61b81903fc88e25d03c0df3e
                              entity_type:
                                type: string
                                example: entity_config
                              configuration:
                                type: object
                                required:
                                  - key
                                  - value
                                properties:
                                  key:
                                    type: string
                                    example: keyName
                                  value:
                                    type: string
                                    example: keyValue
                                  description:
                                    type: string
                                    example: description about this configuration
                                  is_active:
                                    type: boolean
                                    example: false
                                  entity_id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                                  entity_type:
                                    type: string
                                    example: source
                        iw_mappings:
                          type: array
                          items:
                            type: object
                            properties:
                              entity_id:
                                type: string
                                example: 61b81903fc88e25d03c0df3e
                              entity_type:
                                type: string
                                example: pipeline
                              recommendation:
                                type: object
                        pipeline_configs:
                          type: object
                          properties:
                            description:
                              type: string
                              example: this is pipeline
                            model:
                              type: object
                            view_options:
                              type: object
                            batch_engine:
                              type: string
                              example: SPARK
                        target_table_configs:
                          type: array
                          items:
                            type: object
                            properties:
                              entity_id:
                                type: string
                                example: 619fb00c6690e7596a39fe27
                              entity_type:
                                type: string
                                example: table
                              entity_name:
                                type: string
                                example: batch_based_target
                        entity:
                          type: object
                          properties:
                            entity_id:
                              type: string
                              example: 9ee9667096749a6b32a3555e
                            entity_type:
                              type: string
                              example: pipeline
                            entity_name:
                              type: string
                              example: Pp1
                        export:
                          type: object
                          properties:
                            exported_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                            exported_at:
                              type: string
                              example: '2021-12-20T07:09:11.487Z'
                - type: object
                  properties:
                    dry_run:
                      type: boolean
                      example: true
                    import_configs:
                      type: object
                      properties:
                        run_pipeline_metadata_build:
                          type: boolean
                          example: true
                        is_pipeline_version_active:
                          type: boolean
                          example: true
                        import_data_connection:
                          type: boolean
                          example: true
                        include_optional_properties:
                          type: boolean
                          example: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          anyOf:
                            - type: object
                              properties:
                                entity_id:
                                  type: string
                                  example: 9ee9667096749a6b32a3555e
                                to_entity_id:
                                  type: string
                                  example: 9ee9667096749a6b32a3555e
                                entity_type:
                                  type: string
                                  example: pipeline
                                recommendation:
                                  type: object
                                table_upsert_status:
                                  type: object
                            - type: object
                              properties:
                                key:
                                  type: string
                                  example: pipeline_version_id
                                value:
                                  type: string
                                  example: 61c02f02ddb6aa6baa5047d8
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/lineage:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_version_id
        in: path
        description: pipeline_version_id as HEX string
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: port_type
        in: query
        description: port_type for column
        required: true
        schema:
          type: string
          example: OUTPUT
          enum:
            - OUTPUT
            - INPUT
            - TEMPORARY
      - name: node_name
        in: query
        description: >-
          node_name for node in pipeline (either node_name or node_id is
          required)
        schema:
          type: string
          example: Target
      - name: node_id
        in: query
        description: node_id for node in pipeline (either node_name or node_id is required)
        schema:
          type: string
          example: TARGET_kulo
      - name: column_name
        in: query
        description: >-
          column_name for column in pipeline (either column_name or column_id is
          required)
        schema:
          type: string
          example: FNAME
      - name: column_id
        in: query
        description: >-
          column_id for column in pipeline (either column_name or column_id is
          required)
        schema:
          type: string
          example: 0fa77936-3a01-4009-bc24-400233f1c0ef
    get:
      security:
        - BearerAuth: []
      operationId: getPipelineColumnLineage
      tags:
        - Pipelines
      summary: Gets lineage for Pipeline Column.
      description: Gets lineage for Pipeline Column.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            node_name:
                              type: string
                              example: Target
                            node_id:
                              type: string
                              example: TARGET_mytz
                            node_type:
                              type: string
                              example: TARGET
                            table_id:
                              type: string
                              example: 994ca732c829a18695bbff04
                            original_table_name:
                              type: string
                              example: BATCH_INSERTS
                            source_id:
                              type: string
                              example: 4d1594abc958e1f5bce42146
                            output_port_column:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: 942f2017-0def-45f9-81d8-1092975907ec
                                name:
                                  type: string
                                  example: FNAME
                            input_port_column:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: 0fa77936-3a01-4009-bc24-400233f1c0ef
                                name:
                                  type: string
                                  example: FNAME
                                port_name:
                                  type: string
                                  example: P0
                                input_node_id:
                                  type: string
                                  example: SOURCE_TABLE_0bn8
                                input_node_column_id:
                                  type: string
                                  example: 09546ea1-fa8a-44b9-a745-0380b22eb7b6
                                original_column_name:
                                  type: string
                                  example: FNAME
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/validate:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_version_id
        in: path
        description: pipeline_version_id as HEX string
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: validatePipelineVersion
      tags:
        - Pipelines
      summary: Validate a pipeline
      description: Validates a pipeline version
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          result:
                            type: object
                            nullable: true
                            default: null
                          status:
                            type: object
                            nullable: true
                            default: null
                          errors:
                            type: array
                            nullable: true
                            description: >
                              List of errors that occurred while pipeline
                              validation. If no errors have occurred during
                              validaton, a `null` value will be returned.
                            items:
                              type: object
                              properties:
                                error_title:
                                  type: string
                                  description: Error title
                                  example: Input entities cannot be empty
                                error_property:
                                  type: string
                                  example: input_entities
                                error_node_id:
                                  type: string
                                  description: Id of node where the error occurred
                                  example: SNOWFLAKE_TARGET_9eaf
                                error_code:
                                  type: integer
                                  example: 1
                                error_description:
                                  type: string
                                  nullable: true
                                  default: null
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/refresh-sample-data:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_version_id
        in: path
        description: pipeline_version_id as HEX string
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: pipelineRefreshSampleData
      tags:
        - Pipelines
      summary: Refresh sample data
      description: Refreshes the sample data
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          result:
                            type: object
                            nullable: true
                            default: null
                          status:
                            type: object
                            nullable: true
                            default: null
                          errors:
                            type: array
                            nullable: true
                            default: null
                            items:
                              type: object
  /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/nodes/{node_id}/schema:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_version_id
        in: path
        description: pipeline_version_id as HEX string
        required: true
        schema:
          type: string
      - name: node_id
        in: path
        required: true
        description: node_id for node in pipeline
        schema:
          type: string
          example: TARGET_kulo
    get:
      security:
        - BearerAuth: []
      operationId: getPipelineNodeSchema
      tags:
        - Pipelines
      summary: Get node schema
      description: Retrieves schema for a node in pipeline
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          result:
                            type: object
                            properties:
                              temporary_entities:
                                type: object
                              input_entities:
                                type: object
                              output_entities:
                                type: object
                                additionalProperties:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                    data_type:
                                      type: string
                                    data:
                                      type: array
                                      items:
                                        type: string
                                example:
                                  3f31a9c3-594e-4c1d-80d9-2c4c2e237769:
                                    name: FNAME
                                    data_type: varchar
                                    data: []
                                  b1103d44-fbd5-4acc-9120-39b4c46648c9:
                                    name: PROFESSION
                                    data_type: varchar
                                    data: []
                              row_count:
                                type: integer
                                default: 0
                          status:
                            type: object
                            nullable: true
                            default: null
                          errors:
                            type: array
                            nullable: true
                            default: null
                            items:
                              type: object
  /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/nodes/{node_id}/data:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_version_id
        in: path
        description: pipeline_version_id as HEX string
        required: true
        schema:
          type: string
      - name: node_id
        in: path
        required: true
        description: node_id for node in pipeline
        schema:
          type: string
          example: TARGET_kulo
      - name: limit
        in: query
        description: The numbers of items to return
        schema:
          type: integer
          default: 10
    get:
      security:
        - BearerAuth: []
      operationId: getPipelineNodeData
      tags:
        - Pipelines
      summary: Get node data
      description: Retrieves data for a node in pipeline
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          result:
                            type: object
                            properties:
                              temporary_entities:
                                type: object
                              input_entities:
                                type: object
                              output_entities:
                                type: object
                                additionalProperties:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                    data_type:
                                      type: string
                                    data:
                                      type: array
                                      items:
                                        type: string
                                example:
                                  3f31a9c3-594e-4c1d-80d9-2c4c2e237769:
                                    name: FNAME
                                    data_type: varchar
                                    data:
                                      - Fname1
                                      - Fname2
                                      - Fname3
                                      - Fname4
                                  b1103d44-fbd5-4acc-9120-39b4c46648c9:
                                    name: PROFESSION
                                    data_type: varchar
                                    data:
                                      - Profession1
                                      - Profession2
                                      - 'NULL'
                                      - Profession4
                              row_count:
                                type: integer
                                example: 10
                          status:
                            type: object
                            nullable: true
                            default: null
                          errors:
                            type: array
                            nullable: true
                            default: null
                            items:
                              type: object
  /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/nodes/{node_id}/query:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_version_id
        in: path
        description: pipeline_version_id as HEX string
        required: true
        schema:
          type: string
      - name: node_id
        in: path
        required: true
        description: node_id for node in pipeline
        schema:
          type: string
          example: TARGET_kulo
    get:
      security:
        - BearerAuth: []
      operationId: getPipelineNodeQuery
      tags:
        - Pipelines
      summary: Get node query
      description: Retrieves query for a node in pipeline
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          result:
                            type: object
                            properties:
                              query:
                                type: string
                                example: >-
                                  WITH

                                  full_ingestion AS (SELECT fname AS fname,
                                  profession AS profession FROM
                                  "TEST_DB"."TEST_SCHEMA"."TEST_TABLE")

                                  SELECT fname, profession FROM test_table LIMIT
                                  0
                          status:
                            type: object
                            nullable: true
                            default: null
                          errors:
                            type: array
                            nullable: true
                            default: null
                            items:
                              type: object
  /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/nodes/{node_id}/sql-inspection:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_version_id
        in: path
        description: pipeline_version_id as HEX string
        required: true
        schema:
          type: string
      - name: node_id
        in: path
        required: true
        description: node_id for node in pipeline
        schema:
          type: string
          example: TARGET_kulo
    get:
      security:
        - BearerAuth: []
      operationId: getPipelineNodeSqlInspection
      tags:
        - Pipelines
      summary: Get target SQL preview
      description: Retrieves SQL query preview for target node
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          result:
                            type: object
                            properties:
                              queries:
                                type: array
                                items:
                                  type: string
                                  example: CREATE DATABASE IF NOT EXISTS "TEST_DB"
                          status:
                            type: object
                            nullable: true
                            default: null
                          errors:
                            type: array
                            nullable: true
                            default: null
                            items:
                              type: object
  /domains/{domain_id}/recently-used-entities:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getRecentlyUsedEntities
      tags:
        - Domains
      summary: Get recently used entities associated with this Domain
      description: Get recently used entities associated with this Domain
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            entity_type:
                              type: string
                              example: pipeline
                            entity_id:
                              type: string
                            access_at:
                              type: string
                            access_by:
                              type: string
                            entity_name:
                              type: string
                            modified_at:
                              type: string
                            modified_by_name:
                              type: string
                            created_at:
                              type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: addRecentlyUsedEntity
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      tags:
        - Domains
      summary: Add Recently Used Entity to this Domain
      description: Add Recently Used Entity to this Domain
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                entity_type:
                  type: string
                  example: pipeline
                entity_id:
                  type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    example: success
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines/{pipeline_id}/versions/{version_id}/pipeline-version-audits:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: version_id
        in: path
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
    get:
      security:
        - BearerAuth: []
      operationId: getPipelineVersionAuditLogs
      tags:
        - Pipelines
      summary: Get Pipeline Version Audit Logs.
      description: Get Pipeline Version Audit Logs
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                      pipeline_id:
                        type: string
                      pipeline_version_id:
                        type: string
                      created_at:
                        type: string
                      created_by:
                        type: string
                      modified_at:
                        type: string
                      modified_by:
                        type: string
                      audits:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                            action:
                              type: string
                            p:
                              type: object
                              properties:
                                nodeName:
                                  type: string
                            user:
                              type: string
                            timestamp:
                              type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      operationId: Update Pipeline Version Audit Logs
      tags:
        - Pipelines
      summary: Update Pipeline Version Audit Logs
      description: Update Pipeline Version Audit Logs
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - type: object
                  properties:
                    audits:
                      type: array
                      items:
                        type: object
                        properties:
                          'n':
                            type: string
                          a:
                            type: string
                          p:
                            type: object
                            properties:
                              node_name:
                                type: string
                          u:
                            type: string
                          t:
                            type: number
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Successfully Updated a Pipeline Version Audit Logs
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines/{pipeline_id}/pipeline-audits:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: version_id
        in: path
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
    get:
      security:
        - BearerAuth: []
      operationId: getPipelineAuditLogs
      tags:
        - Pipelines
      summary: Get Pipeline Version Audit Logs.
      description: Get Pipeline Version Audit Logs
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                      pipeline_id:
                        type: string
                      audits:
                        type: array
                        items:
                          type: object
                          properties:
                            v:
                              type: string
                            a:
                              type: string
                            u:
                              type: string
                            u_name:
                              type: string
                            p:
                              type: object
                              properties:
                                version_name:
                                  type: number
                            t:
                              type: string
                      created_at:
                        type: string
                      created_by:
                        type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/comments:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getComments
      tags:
        - Domains
      summary: Get comments associated with this Domain
      description: Get comments associated with this Domain
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            comment:
                              type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: addComments
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      tags:
        - Domains
      summary: Add comment to this Domain
      description: Add comment to this Domain
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                comment:
                  type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    example: success
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/notifications:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getNotifications
      tags:
        - Domains
      summary: Get notifications associated with this Domain
      description: Get notifications associated with this Domain
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              example: user_action
                            domain_id:
                              type: string
                            created_by:
                              type: string
                            created_at:
                              type: string
                            message_type:
                              type: string
                              example: domain_user_message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/accessible-tables-pipeline-sources:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getTablesfromPipelineSources
      tags:
        - Pipelines
      summary: getTablesfromPipelineSources
      description: getTablesfromPipelineSources
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          tables:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                table:
                                  type: string
                                source:
                                  type: string
                                parent_entity_type:
                                  type: string
                                state:
                                  type: string
                                row_count:
                                  type: number
                                schema_name_at_source:
                                  type: string
                                parent_entity_name:
                                  type: string
                          parent_entities:
                            type: array
                            items:
                              type: object
                              properties:
                                key:
                                  type: string
                                name:
                                  type: string
                                category:
                                  type: string
                          tables_count:
                            type: object
                            properties:
                              pipelines:
                                type: number
                              sources:
                                type: number
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines/{pipeline_id}/versions/{version_id}/node/{node_id}:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: version_id
        in: path
        required: true
        schema:
          type: string
      - name: node_id
        in: path
        required: true
        description: node_id for node in pipeline
        schema:
          type: string
          example: TARGET_kulo
    get:
      security:
        - BearerAuth: []
      operationId: Get Table Orders With Hierachy
      tags:
        - Domains
      summary: Get Table Orders With Hierachy
      description: Get Table Orders With Hierachy
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          table:
                            type: object
                            properties:
                              id:
                                type: string
                              name:
                                type: string
                              original_table_name:
                                type: string
                              data_lake_schema:
                                type: string
                              data_lake_path:
                                type: string
                              meta_crawl_performed:
                                type: boolean
                              columns:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    sql_type:
                                      type: number
                                    is_deleted:
                                      type: boolean
                                    name:
                                      type: string
                                    original_name:
                                      type: string
                                    target_sql_type:
                                      type: number
                                    is_audit_column:
                                      type: boolean
                                    target_scale:
                                      type: string
                                    col_size:
                                      type: number
                                    precision:
                                      type: number
                                    target_precision:
                                      type: string
                                    scale:
                                      type: number
                              configuration:
                                type: object
                                properties:
                                  exclude_legacy_audit_columns:
                                    type: boolean
                                  sync_type:
                                    type: string
                                  write_supported_engines:
                                    type: array
                                    items:
                                      type: string
                                  read_supported_engines:
                                    type: array
                                    items:
                                      type: string
                                  target_table_name:
                                    type: string
                                  storage_format:
                                    type: string
                                  target_schema_name:
                                    type: string
                                  update_strategy:
                                    type: string
                                  is_scd2_table:
                                    type: boolean
                                  is_archive_enabled:
                                    type: boolean
                                  natural_keys:
                                    type: array
                                    items:
                                      type: string
                                  fetch_mechanism:
                                    type: string
                                  generate_history_view:
                                    type: boolean
                              state:
                                type: string
                              modified_at:
                                type: string
                              modified_by:
                                type: string
                              source:
                                type: string
                              is_jtds_driver:
                                type: boolean
                              schema_name_at_source:
                                type: string
                          source:
                            type: object
                            properties:
                              created_at:
                                type: string
                              created_by:
                                type: string
                              modifiedAt:
                                type: string
                              modifiedBy:
                                type: string
                              tables:
                                type: array
                                items:
                                  type: string
                              id:
                                type: string
                              name:
                                type: string
                              data_lake_schema:
                                type: string
                              data_lake_path:
                                type: string
                              type:
                                type: string
                              sub_type:
                                type: string
                              connection:
                                type: object
                                properties:
                                  connection_mode:
                                    type: string
                                  connection_url:
                                    type: string
                                  username:
                                    type: string
                                  password:
                                    type: string
                                  driver_name:
                                    type: string
                                  driver_version:
                                    type: string
                                  database:
                                    type: string
                                  enable_log_based_cdc:
                                    type: boolean
                              environment_id:
                                type: string
                              storage_id:
                                type: string
                              quoted_identifier:
                                type: string
                              transformation_extensions:
                                type: array
                                items:
                                  type: object
                              state:
                                type: string
                              filter_tables_properties:
                                type: object
                                properties:
                                  schemas_filter:
                                    type: string
                                  catalogs_filter:
                                    type: string
                                  tables_filter:
                                    type: string
                                  is_data_sync_with_filter:
                                    type: boolean
                                  is_filter_enabled:
                                    type: boolean
                              is_source_ingested:
                                type: boolean
                              is_source_connection_verified:
                                type: boolean
                              default_step:
                                type: string
                              configuration:
                                type: object
                                properties:
                                  oracle_logbased_cdc_enabled:
                                    type: boolean
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines/{pipeline_id}/upload-sql-file-pipeline:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
    put:
      security:
        - BearerAuth: []
      operationId: file upload sql pipeline migration
      summary: File upload sql pipeline migration
      description: File upload sql pipeline migration
      tags:
        - Pipelines
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  description: SQL File to be uploaded
                  type: string
                  format: binary
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines/{pipeline_id}/import-sql-mappings:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: flag_pipeline_version_active
        in: query
        description: Flag to specify whether imported pipeline should be active or not
        schema:
          type: boolean
          default: true
    put:
      security:
        - BearerAuth: []
      operationId: Import sql pipeline migration
      summary: Import sql pipeline migration
      description: Import sql pipeline migration
      tags:
        - Pipelines
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                dry_run:
                  type: boolean
                  example: false
                sql:
                  type: string
                  example: null
                sql_import_configuration:
                  type: object
                  properties:
                    sql_dialect:
                      type: string
                      example: LENIENT
                    quoted_identifier:
                      type: string
                      example: DOUBLE_QUOTE
                import_json:
                  type: object
                  properties:
                    mappings:
                      type: array
                      items:
                        type: object
                        properties:
                          entity_type:
                            type: string
                            example: table
                          to_entity_id:
                            type: string
                            example: 2f1bf594bc37fdd7edbda06c
                          recommendation:
                            type: object
                            properties:
                              original_table_name:
                                type: string
                                example: based_table
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Successfully imported the SQL.
                  result:
                    type: object
                    properties:
                      status:
                        type: string
                        example: success
                      import_response:
                        type: object
                        properties:
                          processing_stage:
                            type: string
                            example: MAPPING
                          mappings:
                            type: array
                            items:
                              type: object
                              properties:
                                recommendation:
                                  type: object
                                  properties:
                                    original_table_name:
                                      type: string
                                      example: batch_based
                                    entity_type:
                                      type: string
                                      example: table
                                    to_entity_id:
                                      type: string
                                      example: 5fbcffdcd98f281e9eaef028
                          pipeline:
                            type: object
                            properties:
                              pipeline_parameters:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                    value:
                                      type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/environment_details_pipelines_accessible_sources:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: Get Domains Pipeline and Accessibele Sources
      tags:
        - Domains
      summary: Get Domains Pipeline and Accessibele Sources
      description: Get Domains Pipeline and Accessibele Sources
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          sp2_e2e_1:
                            type: object
                            properties:
                              pipelines:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                              accessible_sources:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    name:
                                      type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows:
    get:
      security:
        - BearerAuth: []
      operationId: getDomainWorkflows
      tags:
        - Workflows
      summary: Get list of all Workflows for a `domain` with `{domain_id}`.
      description: Get list of all Workflows for a `domain` with `{domain_id}`.
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: Content-Type
          in: header
          description: Http content type
          required: true
          schema:
            type: string
            enum:
              - application/json
              - multipart/form-data
              - text/plain
            default: application/json
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - allOf:
                                - allOf:
                                    - type: object
                                      properties:
                                        name:
                                          type: string
                                        description:
                                          type: string
                                        active_version_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                        child_workflow_ids:
                                          type: array
                                          items:
                                            type: string
                                            example: e77850ad5127a2d7dab870ff
                                        impact:
                                          type: number
                                    - type: object
                                      properties:
                                        domain_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                        scheduler_username:
                                          type: string
                                          example: admin@infoworks.io
                                        schedule:
                                          oneOf:
                                            - type: object
                                              title: Generic Schedule
                                              description: Generic schedule object
                                              required:
                                                - schedule_status
                                              properties:
                                                schedule_status:
                                                  type: string
                                                  enum:
                                                    - enabled
                                                    - disabled
                                                  example: enabled
                                                start_date:
                                                  pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                                  type: string
                                                  description: Start time should be after current time.
                                                  format: date-month'/'date-mday'/'date-fullyear
                                                  example: 08/28/2023
                                                start_hour:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 23
                                                  example: 14
                                                start_min:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 59
                                                  example: 35
                                                repeat_interval_unit:
                                                  type: string
                                                  enum:
                                                    - NEVER
                                                    - MINUTE
                                                    - HOUR
                                                    - DAY
                                                    - WEEK
                                                    - MONTH
                                                  default: NEVER
                                                  example: MONTH
                                                repeat_interval_measure:
                                                  type: integer
                                                  minimum: 1
                                                repeat_on_last_day:
                                                  type: boolean
                                                  description: >
                                                    `specified_days` must be provided if
                                                    `repeat_on_last_day` is false.
                                                    Applicable for
                                                    `repeat_interval_unit=MONTH`
                                                  default: false
                                                specified_days:
                                                  type: array
                                                  description: >
                                                    Applicable when `repeat_interval_unit`
                                                    is `WEEK` or `MONTH`.
                                                  minLength: 1
                                                  items:
                                                    type: integer
                                                    minimum: 0
                                                    maximum: 31
                                                  example:
                                                    - 1
                                                    - 17
                                                    - 31
                                                ends:
                                                  type: boolean
                                                  description: >
                                                    `end_date`, `end_hour`, `end_min` must
                                                    be provided if `ends` is `true`.
                                                  default: false
                                                  example: true
                                                end_date:
                                                  pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                                  type: string
                                                  description: End time should be after start time.
                                                  format: date-month'/'date-mday'/'date-fullyear
                                                  example: 08/28/2023
                                                end_hour:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 23
                                                  example: 15
                                                end_min:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 59
                                                  example: 38
                                                is_custom_job:
                                                  type: boolean
                                                  description: >
                                                    `custom_job_details` must be provided
                                                    when `is_custom_job=true`. Applicable
                                                    when `repeat_interval_unit` is `DAY`,
                                                    `WEEK` or `MONTH`.
                                                  default: false
                                                custom_job_details:
                                                  type: object
                                                  required:
                                                    - starts_daily_at
                                                    - ends_daily_at
                                                    - repeat_interval_measure
                                                    - repeat_interval_unit
                                                  properties:
                                                    starts_daily_at:
                                                      pattern: ^{0-23}:[0-59]$
                                                      type: string
                                                      example: '12:40'
                                                    ends_daily_at:
                                                      pattern: ^{0-23}:[0-59]$
                                                      type: string
                                                      example: '17:45'
                                                    repeat_interval_measure:
                                                      type: integer
                                                      minimum: 1
                                                      example: 10
                                                    repeat_interval_unit:
                                                      type: string
                                                      enum:
                                                        - MINUTE
                                                        - HOUR
                                            - type: object
                                              title: By Minute Schedule
                                              description: Schedule job by minutes
                                              required:
                                                - schedule_status
                                                - start_date
                                                - start_hour
                                                - start_min
                                                - repeat_interval_unit
                                                - repeat_interval_measure
                                              properties:
                                                schedule_status:
                                                  type: string
                                                  enum:
                                                    - enabled
                                                  example: enabled
                                                start_date:
                                                  pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                                  type: string
                                                  description: Start time should be after current time.
                                                  format: date-month'/'date-mday'/'date-fullyear
                                                  example: 08/28/2023
                                                start_hour:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 23
                                                  example: 14
                                                start_min:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 59
                                                  example: 35
                                                repeat_interval_unit:
                                                  type: string
                                                  enum:
                                                    - MINUTE
                                                repeat_interval_measure:
                                                  type: integer
                                                  minimum: 1
                                                ends:
                                                  type: boolean
                                                  description: >
                                                    `end_date`, `end_hour`, `end_min` must
                                                    be provided if `ends` is `true`.
                                                  default: false
                                                  example: true
                                                end_date:
                                                  pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                                  type: string
                                                  description: End time should be after start time.
                                                  format: date-month'/'date-mday'/'date-fullyear
                                                  example: 08/28/2023
                                                end_hour:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 23
                                                  example: 15
                                                end_min:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 59
                                                  example: 55
                                            - type: object
                                              title: Hourly Schedule
                                              description: Schedule job hourly
                                              required:
                                                - schedule_status
                                                - start_date
                                                - start_hour
                                                - start_min
                                                - repeat_interval_unit
                                                - repeat_interval_measure
                                              properties:
                                                schedule_status:
                                                  type: string
                                                  enum:
                                                    - enabled
                                                  example: enabled
                                                start_date:
                                                  pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                                  type: string
                                                  description: Start time should be after current time.
                                                  format: date-month'/'date-mday'/'date-fullyear
                                                  example: 08/28/2023
                                                start_hour:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 23
                                                  example: 14
                                                start_min:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 59
                                                  example: 35
                                                repeat_interval_unit:
                                                  type: string
                                                  enum:
                                                    - HOUR
                                                repeat_interval_measure:
                                                  type: integer
                                                  minimum: 1
                                                ends:
                                                  type: boolean
                                                  description: >
                                                    `end_date`, `end_hour`, `end_min` must
                                                    be provided if `ends` is `true`.
                                                  default: false
                                                  example: true
                                                end_date:
                                                  pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                                  type: string
                                                  description: End time should be after start time.
                                                  format: date-month'/'date-mday'/'date-fullyear
                                                  example: 08/28/2023
                                                end_hour:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 23
                                                  example: 15
                                                end_min:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 59
                                                  example: 55
                                            - type: object
                                              title: Daily Schedule
                                              description: Schedule job daily
                                              required:
                                                - schedule_status
                                                - start_date
                                                - start_hour
                                                - start_min
                                                - repeat_interval_unit
                                                - repeat_interval_measure
                                              properties:
                                                schedule_status:
                                                  type: string
                                                  enum:
                                                    - enabled
                                                  example: enabled
                                                start_date:
                                                  pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                                  type: string
                                                  description: Start time should be after current time.
                                                  format: date-month'/'date-mday'/'date-fullyear
                                                  example: 08/28/2023
                                                start_hour:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 23
                                                  example: 14
                                                start_min:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 59
                                                  example: 35
                                                repeat_interval_unit:
                                                  type: string
                                                  enum:
                                                    - DAY
                                                repeat_interval_measure:
                                                  type: integer
                                                  minimum: 1
                                                ends:
                                                  type: boolean
                                                  description: >
                                                    `end_date`, `end_hour`, `end_min` must
                                                    be provided if `ends` is `true`.
                                                  default: false
                                                  example: true
                                                end_date:
                                                  pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                                  type: string
                                                  description: End time should be after start time.
                                                  format: date-month'/'date-mday'/'date-fullyear
                                                  example: 08/28/2023
                                                end_hour:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 23
                                                  example: 15
                                                end_min:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 59
                                                  example: 55
                                                is_custom_job:
                                                  type: boolean
                                                  description: >
                                                    `custom_job_details` must be provided
                                                    when `is_custom_job=true`
                                                  default: false
                                                  example: true
                                                custom_job_details:
                                                  type: object
                                                  required:
                                                    - starts_daily_at
                                                    - ends_daily_at
                                                    - repeat_interval_measure
                                                    - repeat_interval_unit
                                                  properties:
                                                    starts_daily_at:
                                                      pattern: ^{0-23}:[0-59]$
                                                      type: string
                                                      example: '12:40'
                                                    ends_daily_at:
                                                      pattern: ^{0-23}:[0-59]$
                                                      type: string
                                                      example: '17:45'
                                                    repeat_interval_measure:
                                                      type: integer
                                                      minimum: 1
                                                      example: 10
                                                    repeat_interval_unit:
                                                      type: string
                                                      enum:
                                                        - MINUTE
                                                        - HOUR
                                            - type: object
                                              title: Weekly Schedule
                                              description: Schedule job weekly
                                              required:
                                                - schedule_status
                                                - start_date
                                                - start_hour
                                                - start_min
                                                - repeat_interval_unit
                                                - repeat_interval_measure
                                                - specified_days
                                              properties:
                                                schedule_status:
                                                  type: string
                                                  enum:
                                                    - enabled
                                                  example: enabled
                                                start_date:
                                                  pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                                  type: string
                                                  description: Start time should be after current time.
                                                  format: date-month'/'date-mday'/'date-fullyear
                                                  example: 08/28/2023
                                                start_hour:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 23
                                                  example: 14
                                                start_min:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 59
                                                  example: 35
                                                repeat_interval_unit:
                                                  type: string
                                                  enum:
                                                    - WEEK
                                                repeat_interval_measure:
                                                  type: integer
                                                  minimum: 1
                                                specified_days:
                                                  type: array
                                                  minLength: 1
                                                  items:
                                                    type: integer
                                                    minimum: 0
                                                    maximum: 6
                                                  example:
                                                    - 0
                                                    - 2
                                                    - 5
                                                ends:
                                                  type: boolean
                                                  description: >
                                                    `end_date`, `end_hour`, `end_min` must
                                                    be provided if `ends` is `true`.
                                                  default: false
                                                  example: true
                                                end_date:
                                                  pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                                  type: string
                                                  description: End time should be after start time.
                                                  format: date-month'/'date-mday'/'date-fullyear
                                                  example: 08/28/2023
                                                end_hour:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 23
                                                  example: 15
                                                end_min:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 59
                                                  example: 55
                                                is_custom_job:
                                                  type: boolean
                                                  description: >
                                                    `custom_job_details` must be provided
                                                    when `is_custom_job=true`
                                                  default: false
                                                  example: true
                                                custom_job_details:
                                                  type: object
                                                  required:
                                                    - starts_daily_at
                                                    - ends_daily_at
                                                    - repeat_interval_measure
                                                    - repeat_interval_unit
                                                  properties:
                                                    starts_daily_at:
                                                      pattern: ^{0-23}:[0-59]$
                                                      type: string
                                                      example: '12:40'
                                                    ends_daily_at:
                                                      pattern: ^{0-23}:[0-59]$
                                                      type: string
                                                      example: '17:45'
                                                    repeat_interval_measure:
                                                      type: integer
                                                      minimum: 1
                                                      example: 10
                                                    repeat_interval_unit:
                                                      type: string
                                                      enum:
                                                        - MINUTE
                                                        - HOUR
                                            - type: object
                                              title: Monthly Schedule
                                              description: Schedule job monthly
                                              required:
                                                - schedule_status
                                                - start_date
                                                - start_hour
                                                - start_min
                                                - repeat_interval_unit
                                                - repeat_interval_measure
                                              properties:
                                                schedule_status:
                                                  type: string
                                                  enum:
                                                    - enabled
                                                  example: enabled
                                                start_date:
                                                  pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                                  type: string
                                                  description: Start time should be after current time.
                                                  format: date-month'/'date-mday'/'date-fullyear
                                                  example: 08/28/2023
                                                start_hour:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 23
                                                  example: 14
                                                start_min:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 59
                                                  example: 35
                                                repeat_interval_unit:
                                                  type: string
                                                  enum:
                                                    - MONTH
                                                repeat_interval_measure:
                                                  type: integer
                                                  minimum: 1
                                                repeat_on_last_day:
                                                  type: boolean
                                                  description: >
                                                    `specified_days` must be provided if
                                                    `repeat_on_last_day` is false.
                                                  default: false
                                                specified_days:
                                                  type: array
                                                  minLength: 1
                                                  items:
                                                    type: integer
                                                    minimum: 1
                                                    maximum: 31
                                                  example:
                                                    - 1
                                                    - 17
                                                    - 31
                                                ends:
                                                  type: boolean
                                                  description: >
                                                    `end_date`, `end_hour`, `end_min` must
                                                    be provided if `ends` is `true`.
                                                  default: false
                                                  example: true
                                                end_date:
                                                  pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                                  type: string
                                                  description: End time should be after start time.
                                                  format: date-month'/'date-mday'/'date-fullyear
                                                  example: 08/28/2023
                                                end_hour:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 23
                                                  example: 15
                                                end_min:
                                                  type: integer
                                                  minimum: 0
                                                  maximum: 59
                                                  example: 45
                                                is_custom_job:
                                                  type: boolean
                                                  description: >
                                                    `custom_job_details` must be provided
                                                    when `is_custom_job=true`
                                                  default: false
                                                  example: true
                                                custom_job_details:
                                                  type: object
                                                  required:
                                                    - starts_daily_at
                                                    - ends_daily_at
                                                    - repeat_interval_measure
                                                    - repeat_interval_unit
                                                  properties:
                                                    starts_daily_at:
                                                      pattern: ^{0-23}:[0-59]$
                                                      type: string
                                                      example: '12:40'
                                                    ends_daily_at:
                                                      pattern: ^{0-23}:[0-59]$
                                                      type: string
                                                      example: '17:45'
                                                    repeat_interval_measure:
                                                      type: integer
                                                      minimum: 1
                                                      example: 10
                                                    repeat_interval_unit:
                                                      type: string
                                                      enum:
                                                        - MINUTE
                                                        - HOUR
                                - type: object
                                  properties:
                                    id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                - type: object
                                  allOf:
                                    - type: object
                                      properties:
                                        created_at:
                                          type: string
                                          example: '2019-11-21T12:54:05.875Z'
                                    - type: object
                                      properties:
                                        created_by:
                                          type: string
                                          example: 6RkfybTRQQByEey3v
                                    - type: object
                                      properties:
                                        modified_at:
                                          type: string
                                          example: '2019-11-21T12:54:05.875Z'
                                    - type: object
                                      properties:
                                        modified_by:
                                          type: string
                                          example: 6RkfybTRQQByEey3v
                            - type: object
                              properties:
                                modified_by_name:
                                  type: string
                                  example: Admin
                                created_by_name:
                                  type: string
                                  example: Admin
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: createWorkflow
      tags:
        - Workflows
      summary: Create Workflow for a `domain` with `{domain_id}`.
      description: Create Workflow for a `domain` with `{domain_id}`.
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: Content-Type
          in: header
          description: Http content type
          required: true
          schema:
            type: string
            enum:
              - application/json
              - multipart/form-data
              - text/plain
            default: application/json
      requestBody:
        description: >-
          This is the JSON body of request containing configured Workflow
          object.
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                description:
                  type: string
                active_version_id:
                  type: string
                  example: e77850ad5127a2d7dab870ff
                child_workflow_ids:
                  type: array
                  items:
                    type: string
                    example: e77850ad5127a2d7dab870ff
                impact:
                  type: number
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}:
    get:
      security:
        - BearerAuth: []
      operationId: getWorkflow
      tags:
        - Workflows
      summary: Gets a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`.
      description: Gets a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`.
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                type: object
                properties:
                  result:
                    allOf:
                      - allOf:
                          - type: object
                            properties:
                              name:
                                type: string
                              description:
                                type: string
                              active_version_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              child_workflow_ids:
                                type: array
                                items:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                              impact:
                                type: number
                          - type: object
                            properties:
                              domain_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              scheduler_username:
                                type: string
                                example: admin@infoworks.io
                              schedule:
                                oneOf:
                                  - type: object
                                    title: Generic Schedule
                                    description: Generic schedule object
                                    required:
                                      - schedule_status
                                    properties:
                                      schedule_status:
                                        type: string
                                        enum:
                                          - enabled
                                          - disabled
                                        example: enabled
                                      start_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: Start time should be after current time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      start_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 14
                                      start_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 35
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                          - NEVER
                                          - MINUTE
                                          - HOUR
                                          - DAY
                                          - WEEK
                                          - MONTH
                                        default: NEVER
                                        example: MONTH
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                      repeat_on_last_day:
                                        type: boolean
                                        description: >
                                          `specified_days` must be provided if
                                          `repeat_on_last_day` is false.
                                          Applicable for
                                          `repeat_interval_unit=MONTH`
                                        default: false
                                      specified_days:
                                        type: array
                                        description: >
                                          Applicable when `repeat_interval_unit`
                                          is `WEEK` or `MONTH`.
                                        minLength: 1
                                        items:
                                          type: integer
                                          minimum: 0
                                          maximum: 31
                                        example:
                                          - 1
                                          - 17
                                          - 31
                                      ends:
                                        type: boolean
                                        description: >
                                          `end_date`, `end_hour`, `end_min` must
                                          be provided if `ends` is `true`.
                                        default: false
                                        example: true
                                      end_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: End time should be after start time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      end_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 15
                                      end_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 38
                                      is_custom_job:
                                        type: boolean
                                        description: >
                                          `custom_job_details` must be provided
                                          when `is_custom_job=true`. Applicable
                                          when `repeat_interval_unit` is `DAY`,
                                          `WEEK` or `MONTH`.
                                        default: false
                                      custom_job_details:
                                        type: object
                                        required:
                                          - starts_daily_at
                                          - ends_daily_at
                                          - repeat_interval_measure
                                          - repeat_interval_unit
                                        properties:
                                          starts_daily_at:
                                            pattern: ^{0-23}:[0-59]$
                                            type: string
                                            example: '12:40'
                                          ends_daily_at:
                                            pattern: ^{0-23}:[0-59]$
                                            type: string
                                            example: '17:45'
                                          repeat_interval_measure:
                                            type: integer
                                            minimum: 1
                                            example: 10
                                          repeat_interval_unit:
                                            type: string
                                            enum:
                                              - MINUTE
                                              - HOUR
                                  - type: object
                                    title: By Minute Schedule
                                    description: Schedule job by minutes
                                    required:
                                      - schedule_status
                                      - start_date
                                      - start_hour
                                      - start_min
                                      - repeat_interval_unit
                                      - repeat_interval_measure
                                    properties:
                                      schedule_status:
                                        type: string
                                        enum:
                                          - enabled
                                        example: enabled
                                      start_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: Start time should be after current time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      start_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 14
                                      start_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 35
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                          - MINUTE
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                      ends:
                                        type: boolean
                                        description: >
                                          `end_date`, `end_hour`, `end_min` must
                                          be provided if `ends` is `true`.
                                        default: false
                                        example: true
                                      end_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: End time should be after start time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      end_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 15
                                      end_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 55
                                  - type: object
                                    title: Hourly Schedule
                                    description: Schedule job hourly
                                    required:
                                      - schedule_status
                                      - start_date
                                      - start_hour
                                      - start_min
                                      - repeat_interval_unit
                                      - repeat_interval_measure
                                    properties:
                                      schedule_status:
                                        type: string
                                        enum:
                                          - enabled
                                        example: enabled
                                      start_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: Start time should be after current time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      start_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 14
                                      start_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 35
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                          - HOUR
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                      ends:
                                        type: boolean
                                        description: >
                                          `end_date`, `end_hour`, `end_min` must
                                          be provided if `ends` is `true`.
                                        default: false
                                        example: true
                                      end_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: End time should be after start time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      end_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 15
                                      end_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 55
                                  - type: object
                                    title: Daily Schedule
                                    description: Schedule job daily
                                    required:
                                      - schedule_status
                                      - start_date
                                      - start_hour
                                      - start_min
                                      - repeat_interval_unit
                                      - repeat_interval_measure
                                    properties:
                                      schedule_status:
                                        type: string
                                        enum:
                                          - enabled
                                        example: enabled
                                      start_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: Start time should be after current time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      start_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 14
                                      start_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 35
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                          - DAY
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                      ends:
                                        type: boolean
                                        description: >
                                          `end_date`, `end_hour`, `end_min` must
                                          be provided if `ends` is `true`.
                                        default: false
                                        example: true
                                      end_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: End time should be after start time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      end_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 15
                                      end_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 55
                                      is_custom_job:
                                        type: boolean
                                        description: >
                                          `custom_job_details` must be provided
                                          when `is_custom_job=true`
                                        default: false
                                        example: true
                                      custom_job_details:
                                        type: object
                                        required:
                                          - starts_daily_at
                                          - ends_daily_at
                                          - repeat_interval_measure
                                          - repeat_interval_unit
                                        properties:
                                          starts_daily_at:
                                            pattern: ^{0-23}:[0-59]$
                                            type: string
                                            example: '12:40'
                                          ends_daily_at:
                                            pattern: ^{0-23}:[0-59]$
                                            type: string
                                            example: '17:45'
                                          repeat_interval_measure:
                                            type: integer
                                            minimum: 1
                                            example: 10
                                          repeat_interval_unit:
                                            type: string
                                            enum:
                                              - MINUTE
                                              - HOUR
                                  - type: object
                                    title: Weekly Schedule
                                    description: Schedule job weekly
                                    required:
                                      - schedule_status
                                      - start_date
                                      - start_hour
                                      - start_min
                                      - repeat_interval_unit
                                      - repeat_interval_measure
                                      - specified_days
                                    properties:
                                      schedule_status:
                                        type: string
                                        enum:
                                          - enabled
                                        example: enabled
                                      start_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: Start time should be after current time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      start_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 14
                                      start_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 35
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                          - WEEK
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                      specified_days:
                                        type: array
                                        minLength: 1
                                        items:
                                          type: integer
                                          minimum: 0
                                          maximum: 6
                                        example:
                                          - 0
                                          - 2
                                          - 5
                                      ends:
                                        type: boolean
                                        description: >
                                          `end_date`, `end_hour`, `end_min` must
                                          be provided if `ends` is `true`.
                                        default: false
                                        example: true
                                      end_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: End time should be after start time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      end_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 15
                                      end_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 55
                                      is_custom_job:
                                        type: boolean
                                        description: >
                                          `custom_job_details` must be provided
                                          when `is_custom_job=true`
                                        default: false
                                        example: true
                                      custom_job_details:
                                        type: object
                                        required:
                                          - starts_daily_at
                                          - ends_daily_at
                                          - repeat_interval_measure
                                          - repeat_interval_unit
                                        properties:
                                          starts_daily_at:
                                            pattern: ^{0-23}:[0-59]$
                                            type: string
                                            example: '12:40'
                                          ends_daily_at:
                                            pattern: ^{0-23}:[0-59]$
                                            type: string
                                            example: '17:45'
                                          repeat_interval_measure:
                                            type: integer
                                            minimum: 1
                                            example: 10
                                          repeat_interval_unit:
                                            type: string
                                            enum:
                                              - MINUTE
                                              - HOUR
                                  - type: object
                                    title: Monthly Schedule
                                    description: Schedule job monthly
                                    required:
                                      - schedule_status
                                      - start_date
                                      - start_hour
                                      - start_min
                                      - repeat_interval_unit
                                      - repeat_interval_measure
                                    properties:
                                      schedule_status:
                                        type: string
                                        enum:
                                          - enabled
                                        example: enabled
                                      start_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: Start time should be after current time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      start_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 14
                                      start_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 35
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                          - MONTH
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                      repeat_on_last_day:
                                        type: boolean
                                        description: >
                                          `specified_days` must be provided if
                                          `repeat_on_last_day` is false.
                                        default: false
                                      specified_days:
                                        type: array
                                        minLength: 1
                                        items:
                                          type: integer
                                          minimum: 1
                                          maximum: 31
                                        example:
                                          - 1
                                          - 17
                                          - 31
                                      ends:
                                        type: boolean
                                        description: >
                                          `end_date`, `end_hour`, `end_min` must
                                          be provided if `ends` is `true`.
                                        default: false
                                        example: true
                                      end_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: End time should be after start time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      end_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 15
                                      end_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 45
                                      is_custom_job:
                                        type: boolean
                                        description: >
                                          `custom_job_details` must be provided
                                          when `is_custom_job=true`
                                        default: false
                                        example: true
                                      custom_job_details:
                                        type: object
                                        required:
                                          - starts_daily_at
                                          - ends_daily_at
                                          - repeat_interval_measure
                                          - repeat_interval_unit
                                        properties:
                                          starts_daily_at:
                                            pattern: ^{0-23}:[0-59]$
                                            type: string
                                            example: '12:40'
                                          ends_daily_at:
                                            pattern: ^{0-23}:[0-59]$
                                            type: string
                                            example: '17:45'
                                          repeat_interval_measure:
                                            type: integer
                                            minimum: 1
                                            example: 10
                                          repeat_interval_unit:
                                            type: string
                                            enum:
                                              - MINUTE
                                              - HOUR
                      - type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                      - type: object
                        allOf:
                          - type: object
                            properties:
                              created_at:
                                type: string
                                example: '2019-11-21T12:54:05.875Z'
                          - type: object
                            properties:
                              created_by:
                                type: string
                                example: 6RkfybTRQQByEey3v
                          - type: object
                            properties:
                              modified_at:
                                type: string
                                example: '2019-11-21T12:54:05.875Z'
                          - type: object
                            properties:
                              modified_by:
                                type: string
                                example: 6RkfybTRQQByEey3v
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      operationId: submitJob
      tags:
        - Workflows
      summary: >-
        Deletes a `workflow` with `{workflow_id}` in `domain` with
        `{domain_id}`.
      description: >-
        Deletes a `workflow` with `{workflow_id}` in `domain` with
        `{domain_id}`.
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      operationId: updateWorkflow
      tags:
        - Workflows
      summary: Update a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`.
      description: Update a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`.
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                description:
                  type: string
                active_version_id:
                  type: string
                  example: e77850ad5127a2d7dab870ff
                child_workflow_ids:
                  type: array
                  items:
                    type: string
                    example: e77850ad5127a2d7dab870ff
                impact:
                  type: number
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/config-migration:
    get:
      security:
        - BearerAuth: []
      operationId: getExportConfigForMigration
      tags:
        - Workflows
      summary: Exports workflow configuration
      description: >-
        Exports the workflow configuration to JSON format for workflow with
        `workflow_id` in domain with `domain_id`
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
        - name: version_id
          in: query
          required: false
          description: >-
            ID of the workflow version to run. If omitted, the active version is
            used.
          schema:
            type: string
            example: e77850ad5127a2d7dab870ff
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      configuration:
                        type: object
                        properties:
                          workflow:
                            allOf:
                              - type: object
                                properties:
                                  name:
                                    type: string
                                  description:
                                    type: string
                                  active_version_id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                                  child_workflow_ids:
                                    type: array
                                    items:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                  impact:
                                    type: number
                              - type: object
                                properties:
                                  domain_id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                                  scheduler_username:
                                    type: string
                                    example: admin@infoworks.io
                                  schedule:
                                    oneOf:
                                      - type: object
                                        title: Generic Schedule
                                        description: Generic schedule object
                                        required:
                                          - schedule_status
                                        properties:
                                          schedule_status:
                                            type: string
                                            enum:
                                              - enabled
                                              - disabled
                                            example: enabled
                                          start_date:
                                            pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                            type: string
                                            description: Start time should be after current time.
                                            format: date-month'/'date-mday'/'date-fullyear
                                            example: 08/28/2023
                                          start_hour:
                                            type: integer
                                            minimum: 0
                                            maximum: 23
                                            example: 14
                                          start_min:
                                            type: integer
                                            minimum: 0
                                            maximum: 59
                                            example: 35
                                          repeat_interval_unit:
                                            type: string
                                            enum:
                                              - NEVER
                                              - MINUTE
                                              - HOUR
                                              - DAY
                                              - WEEK
                                              - MONTH
                                            default: NEVER
                                            example: MONTH
                                          repeat_interval_measure:
                                            type: integer
                                            minimum: 1
                                          repeat_on_last_day:
                                            type: boolean
                                            description: >
                                              `specified_days` must be provided if
                                              `repeat_on_last_day` is false.
                                              Applicable for
                                              `repeat_interval_unit=MONTH`
                                            default: false
                                          specified_days:
                                            type: array
                                            description: >
                                              Applicable when `repeat_interval_unit`
                                              is `WEEK` or `MONTH`.
                                            minLength: 1
                                            items:
                                              type: integer
                                              minimum: 0
                                              maximum: 31
                                            example:
                                              - 1
                                              - 17
                                              - 31
                                          ends:
                                            type: boolean
                                            description: >
                                              `end_date`, `end_hour`, `end_min` must
                                              be provided if `ends` is `true`.
                                            default: false
                                            example: true
                                          end_date:
                                            pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                            type: string
                                            description: End time should be after start time.
                                            format: date-month'/'date-mday'/'date-fullyear
                                            example: 08/28/2023
                                          end_hour:
                                            type: integer
                                            minimum: 0
                                            maximum: 23
                                            example: 15
                                          end_min:
                                            type: integer
                                            minimum: 0
                                            maximum: 59
                                            example: 38
                                          is_custom_job:
                                            type: boolean
                                            description: >
                                              `custom_job_details` must be provided
                                              when `is_custom_job=true`. Applicable
                                              when `repeat_interval_unit` is `DAY`,
                                              `WEEK` or `MONTH`.
                                            default: false
                                          custom_job_details:
                                            type: object
                                            required:
                                              - starts_daily_at
                                              - ends_daily_at
                                              - repeat_interval_measure
                                              - repeat_interval_unit
                                            properties:
                                              starts_daily_at:
                                                pattern: ^{0-23}:[0-59]$
                                                type: string
                                                example: '12:40'
                                              ends_daily_at:
                                                pattern: ^{0-23}:[0-59]$
                                                type: string
                                                example: '17:45'
                                              repeat_interval_measure:
                                                type: integer
                                                minimum: 1
                                                example: 10
                                              repeat_interval_unit:
                                                type: string
                                                enum:
                                                  - MINUTE
                                                  - HOUR
                                      - type: object
                                        title: By Minute Schedule
                                        description: Schedule job by minutes
                                        required:
                                          - schedule_status
                                          - start_date
                                          - start_hour
                                          - start_min
                                          - repeat_interval_unit
                                          - repeat_interval_measure
                                        properties:
                                          schedule_status:
                                            type: string
                                            enum:
                                              - enabled
                                            example: enabled
                                          start_date:
                                            pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                            type: string
                                            description: Start time should be after current time.
                                            format: date-month'/'date-mday'/'date-fullyear
                                            example: 08/28/2023
                                          start_hour:
                                            type: integer
                                            minimum: 0
                                            maximum: 23
                                            example: 14
                                          start_min:
                                            type: integer
                                            minimum: 0
                                            maximum: 59
                                            example: 35
                                          repeat_interval_unit:
                                            type: string
                                            enum:
                                              - MINUTE
                                          repeat_interval_measure:
                                            type: integer
                                            minimum: 1
                                          ends:
                                            type: boolean
                                            description: >
                                              `end_date`, `end_hour`, `end_min` must
                                              be provided if `ends` is `true`.
                                            default: false
                                            example: true
                                          end_date:
                                            pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                            type: string
                                            description: End time should be after start time.
                                            format: date-month'/'date-mday'/'date-fullyear
                                            example: 08/28/2023
                                          end_hour:
                                            type: integer
                                            minimum: 0
                                            maximum: 23
                                            example: 15
                                          end_min:
                                            type: integer
                                            minimum: 0
                                            maximum: 59
                                            example: 55
                                      - type: object
                                        title: Hourly Schedule
                                        description: Schedule job hourly
                                        required:
                                          - schedule_status
                                          - start_date
                                          - start_hour
                                          - start_min
                                          - repeat_interval_unit
                                          - repeat_interval_measure
                                        properties:
                                          schedule_status:
                                            type: string
                                            enum:
                                              - enabled
                                            example: enabled
                                          start_date:
                                            pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                            type: string
                                            description: Start time should be after current time.
                                            format: date-month'/'date-mday'/'date-fullyear
                                            example: 08/28/2023
                                          start_hour:
                                            type: integer
                                            minimum: 0
                                            maximum: 23
                                            example: 14
                                          start_min:
                                            type: integer
                                            minimum: 0
                                            maximum: 59
                                            example: 35
                                          repeat_interval_unit:
                                            type: string
                                            enum:
                                              - HOUR
                                          repeat_interval_measure:
                                            type: integer
                                            minimum: 1
                                          ends:
                                            type: boolean
                                            description: >
                                              `end_date`, `end_hour`, `end_min` must
                                              be provided if `ends` is `true`.
                                            default: false
                                            example: true
                                          end_date:
                                            pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                            type: string
                                            description: End time should be after start time.
                                            format: date-month'/'date-mday'/'date-fullyear
                                            example: 08/28/2023
                                          end_hour:
                                            type: integer
                                            minimum: 0
                                            maximum: 23
                                            example: 15
                                          end_min:
                                            type: integer
                                            minimum: 0
                                            maximum: 59
                                            example: 55
                                      - type: object
                                        title: Daily Schedule
                                        description: Schedule job daily
                                        required:
                                          - schedule_status
                                          - start_date
                                          - start_hour
                                          - start_min
                                          - repeat_interval_unit
                                          - repeat_interval_measure
                                        properties:
                                          schedule_status:
                                            type: string
                                            enum:
                                              - enabled
                                            example: enabled
                                          start_date:
                                            pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                            type: string
                                            description: Start time should be after current time.
                                            format: date-month'/'date-mday'/'date-fullyear
                                            example: 08/28/2023
                                          start_hour:
                                            type: integer
                                            minimum: 0
                                            maximum: 23
                                            example: 14
                                          start_min:
                                            type: integer
                                            minimum: 0
                                            maximum: 59
                                            example: 35
                                          repeat_interval_unit:
                                            type: string
                                            enum:
                                              - DAY
                                          repeat_interval_measure:
                                            type: integer
                                            minimum: 1
                                          ends:
                                            type: boolean
                                            description: >
                                              `end_date`, `end_hour`, `end_min` must
                                              be provided if `ends` is `true`.
                                            default: false
                                            example: true
                                          end_date:
                                            pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                            type: string
                                            description: End time should be after start time.
                                            format: date-month'/'date-mday'/'date-fullyear
                                            example: 08/28/2023
                                          end_hour:
                                            type: integer
                                            minimum: 0
                                            maximum: 23
                                            example: 15
                                          end_min:
                                            type: integer
                                            minimum: 0
                                            maximum: 59
                                            example: 55
                                          is_custom_job:
                                            type: boolean
                                            description: >
                                              `custom_job_details` must be provided
                                              when `is_custom_job=true`
                                            default: false
                                            example: true
                                          custom_job_details:
                                            type: object
                                            required:
                                              - starts_daily_at
                                              - ends_daily_at
                                              - repeat_interval_measure
                                              - repeat_interval_unit
                                            properties:
                                              starts_daily_at:
                                                pattern: ^{0-23}:[0-59]$
                                                type: string
                                                example: '12:40'
                                              ends_daily_at:
                                                pattern: ^{0-23}:[0-59]$
                                                type: string
                                                example: '17:45'
                                              repeat_interval_measure:
                                                type: integer
                                                minimum: 1
                                                example: 10
                                              repeat_interval_unit:
                                                type: string
                                                enum:
                                                  - MINUTE
                                                  - HOUR
                                      - type: object
                                        title: Weekly Schedule
                                        description: Schedule job weekly
                                        required:
                                          - schedule_status
                                          - start_date
                                          - start_hour
                                          - start_min
                                          - repeat_interval_unit
                                          - repeat_interval_measure
                                          - specified_days
                                        properties:
                                          schedule_status:
                                            type: string
                                            enum:
                                              - enabled
                                            example: enabled
                                          start_date:
                                            pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                            type: string
                                            description: Start time should be after current time.
                                            format: date-month'/'date-mday'/'date-fullyear
                                            example: 08/28/2023
                                          start_hour:
                                            type: integer
                                            minimum: 0
                                            maximum: 23
                                            example: 14
                                          start_min:
                                            type: integer
                                            minimum: 0
                                            maximum: 59
                                            example: 35
                                          repeat_interval_unit:
                                            type: string
                                            enum:
                                              - WEEK
                                          repeat_interval_measure:
                                            type: integer
                                            minimum: 1
                                          specified_days:
                                            type: array
                                            minLength: 1
                                            items:
                                              type: integer
                                              minimum: 0
                                              maximum: 6
                                            example:
                                              - 0
                                              - 2
                                              - 5
                                          ends:
                                            type: boolean
                                            description: >
                                              `end_date`, `end_hour`, `end_min` must
                                              be provided if `ends` is `true`.
                                            default: false
                                            example: true
                                          end_date:
                                            pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                            type: string
                                            description: End time should be after start time.
                                            format: date-month'/'date-mday'/'date-fullyear
                                            example: 08/28/2023
                                          end_hour:
                                            type: integer
                                            minimum: 0
                                            maximum: 23
                                            example: 15
                                          end_min:
                                            type: integer
                                            minimum: 0
                                            maximum: 59
                                            example: 55
                                          is_custom_job:
                                            type: boolean
                                            description: >
                                              `custom_job_details` must be provided
                                              when `is_custom_job=true`
                                            default: false
                                            example: true
                                          custom_job_details:
                                            type: object
                                            required:
                                              - starts_daily_at
                                              - ends_daily_at
                                              - repeat_interval_measure
                                              - repeat_interval_unit
                                            properties:
                                              starts_daily_at:
                                                pattern: ^{0-23}:[0-59]$
                                                type: string
                                                example: '12:40'
                                              ends_daily_at:
                                                pattern: ^{0-23}:[0-59]$
                                                type: string
                                                example: '17:45'
                                              repeat_interval_measure:
                                                type: integer
                                                minimum: 1
                                                example: 10
                                              repeat_interval_unit:
                                                type: string
                                                enum:
                                                  - MINUTE
                                                  - HOUR
                                      - type: object
                                        title: Monthly Schedule
                                        description: Schedule job monthly
                                        required:
                                          - schedule_status
                                          - start_date
                                          - start_hour
                                          - start_min
                                          - repeat_interval_unit
                                          - repeat_interval_measure
                                        properties:
                                          schedule_status:
                                            type: string
                                            enum:
                                              - enabled
                                            example: enabled
                                          start_date:
                                            pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                            type: string
                                            description: Start time should be after current time.
                                            format: date-month'/'date-mday'/'date-fullyear
                                            example: 08/28/2023
                                          start_hour:
                                            type: integer
                                            minimum: 0
                                            maximum: 23
                                            example: 14
                                          start_min:
                                            type: integer
                                            minimum: 0
                                            maximum: 59
                                            example: 35
                                          repeat_interval_unit:
                                            type: string
                                            enum:
                                              - MONTH
                                          repeat_interval_measure:
                                            type: integer
                                            minimum: 1
                                          repeat_on_last_day:
                                            type: boolean
                                            description: >
                                              `specified_days` must be provided if
                                              `repeat_on_last_day` is false.
                                            default: false
                                          specified_days:
                                            type: array
                                            minLength: 1
                                            items:
                                              type: integer
                                              minimum: 1
                                              maximum: 31
                                            example:
                                              - 1
                                              - 17
                                              - 31
                                          ends:
                                            type: boolean
                                            description: >
                                              `end_date`, `end_hour`, `end_min` must
                                              be provided if `ends` is `true`.
                                            default: false
                                            example: true
                                          end_date:
                                            pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                            type: string
                                            description: End time should be after start time.
                                            format: date-month'/'date-mday'/'date-fullyear
                                            example: 08/28/2023
                                          end_hour:
                                            type: integer
                                            minimum: 0
                                            maximum: 23
                                            example: 15
                                          end_min:
                                            type: integer
                                            minimum: 0
                                            maximum: 59
                                            example: 45
                                          is_custom_job:
                                            type: boolean
                                            description: >
                                              `custom_job_details` must be provided
                                              when `is_custom_job=true`
                                            default: false
                                            example: true
                                          custom_job_details:
                                            type: object
                                            required:
                                              - starts_daily_at
                                              - ends_daily_at
                                              - repeat_interval_measure
                                              - repeat_interval_unit
                                            properties:
                                              starts_daily_at:
                                                pattern: ^{0-23}:[0-59]$
                                                type: string
                                                example: '12:40'
                                              ends_daily_at:
                                                pattern: ^{0-23}:[0-59]$
                                                type: string
                                                example: '17:45'
                                              repeat_interval_measure:
                                                type: integer
                                                minimum: 1
                                                example: 10
                                              repeat_interval_unit:
                                                type: string
                                                enum:
                                                  - MINUTE
                                                  - HOUR
                          iw_mappings:
                            type: array
                            items:
                              oneOf:
                                - type: object
                                  properties:
                                    entity_type:
                                      type: string
                                      example: pipeline
                                    recommendation:
                                      type: object
                                      properties: {}
                                    to_entity_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                - type: object
                                  properties:
                                    entity_type:
                                      type: string
                                      example: pipeline
                                    recommendation:
                                      type: object
                                      properties:
                                        pipeline_name:
                                          type: string
                                          example: Workflow_Pipeline_1
                                        domain_name:
                                          type: string
                                          example: Automation_domain
                                    selected_versions:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          version_id:
                                            type: string
                                            example: 648845a0007ecf1a1c550c5f
                                          version:
                                            type: number
                                            example: 1
                                    to_entity_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                          entity:
                            type: object
                            properties:
                              entity_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              entity_type:
                                type: string
                                enum:
                                  - workflow
                              entity_name:
                                type: string
                                example: example_workflow
                          export:
                            type: object
                            properties:
                              exported_at:
                                type: string
                              exported_by:
                                type: string
                              exported_by_username:
                                type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    put:
      security:
        - BearerAuth: []
      operationId: importConfigForMigration
      tags:
        - Workflows
      summary: Imports workflow configuration
      description: >-
        Imports the workflow configuration from JSON format for workflow with
        `workflow_id` in domain with `domain_id`.
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
      requestBody:
        description: >-
          This is the JSON body of request containing configuration of the
          Workflow object.
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    configuration:
                      type: object
                      properties:
                        workflow:
                          allOf:
                            - type: object
                              properties:
                                name:
                                  type: string
                                description:
                                  type: string
                                active_version_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                child_workflow_ids:
                                  type: array
                                  items:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                                impact:
                                  type: number
                            - type: object
                              properties:
                                domain_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                scheduler_username:
                                  type: string
                                  example: admin@infoworks.io
                                schedule:
                                  oneOf:
                                    - type: object
                                      title: Generic Schedule
                                      description: Generic schedule object
                                      required:
                                        - schedule_status
                                      properties:
                                        schedule_status:
                                          type: string
                                          enum:
                                            - enabled
                                            - disabled
                                          example: enabled
                                        start_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: Start time should be after current time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        start_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 14
                                        start_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 35
                                        repeat_interval_unit:
                                          type: string
                                          enum:
                                            - NEVER
                                            - MINUTE
                                            - HOUR
                                            - DAY
                                            - WEEK
                                            - MONTH
                                          default: NEVER
                                          example: MONTH
                                        repeat_interval_measure:
                                          type: integer
                                          minimum: 1
                                        repeat_on_last_day:
                                          type: boolean
                                          description: >
                                            `specified_days` must be provided if
                                            `repeat_on_last_day` is false.
                                            Applicable for
                                            `repeat_interval_unit=MONTH`
                                          default: false
                                        specified_days:
                                          type: array
                                          description: >
                                            Applicable when `repeat_interval_unit`
                                            is `WEEK` or `MONTH`.
                                          minLength: 1
                                          items:
                                            type: integer
                                            minimum: 0
                                            maximum: 31
                                          example:
                                            - 1
                                            - 17
                                            - 31
                                        ends:
                                          type: boolean
                                          description: >
                                            `end_date`, `end_hour`, `end_min` must
                                            be provided if `ends` is `true`.
                                          default: false
                                          example: true
                                        end_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: End time should be after start time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        end_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 15
                                        end_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 38
                                        is_custom_job:
                                          type: boolean
                                          description: >
                                            `custom_job_details` must be provided
                                            when `is_custom_job=true`. Applicable
                                            when `repeat_interval_unit` is `DAY`,
                                            `WEEK` or `MONTH`.
                                          default: false
                                        custom_job_details:
                                          type: object
                                          required:
                                            - starts_daily_at
                                            - ends_daily_at
                                            - repeat_interval_measure
                                            - repeat_interval_unit
                                          properties:
                                            starts_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '12:40'
                                            ends_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '17:45'
                                            repeat_interval_measure:
                                              type: integer
                                              minimum: 1
                                              example: 10
                                            repeat_interval_unit:
                                              type: string
                                              enum:
                                                - MINUTE
                                                - HOUR
                                    - type: object
                                      title: By Minute Schedule
                                      description: Schedule job by minutes
                                      required:
                                        - schedule_status
                                        - start_date
                                        - start_hour
                                        - start_min
                                        - repeat_interval_unit
                                        - repeat_interval_measure
                                      properties:
                                        schedule_status:
                                          type: string
                                          enum:
                                            - enabled
                                          example: enabled
                                        start_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: Start time should be after current time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        start_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 14
                                        start_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 35
                                        repeat_interval_unit:
                                          type: string
                                          enum:
                                            - MINUTE
                                        repeat_interval_measure:
                                          type: integer
                                          minimum: 1
                                        ends:
                                          type: boolean
                                          description: >
                                            `end_date`, `end_hour`, `end_min` must
                                            be provided if `ends` is `true`.
                                          default: false
                                          example: true
                                        end_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: End time should be after start time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        end_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 15
                                        end_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 55
                                    - type: object
                                      title: Hourly Schedule
                                      description: Schedule job hourly
                                      required:
                                        - schedule_status
                                        - start_date
                                        - start_hour
                                        - start_min
                                        - repeat_interval_unit
                                        - repeat_interval_measure
                                      properties:
                                        schedule_status:
                                          type: string
                                          enum:
                                            - enabled
                                          example: enabled
                                        start_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: Start time should be after current time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        start_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 14
                                        start_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 35
                                        repeat_interval_unit:
                                          type: string
                                          enum:
                                            - HOUR
                                        repeat_interval_measure:
                                          type: integer
                                          minimum: 1
                                        ends:
                                          type: boolean
                                          description: >
                                            `end_date`, `end_hour`, `end_min` must
                                            be provided if `ends` is `true`.
                                          default: false
                                          example: true
                                        end_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: End time should be after start time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        end_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 15
                                        end_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 55
                                    - type: object
                                      title: Daily Schedule
                                      description: Schedule job daily
                                      required:
                                        - schedule_status
                                        - start_date
                                        - start_hour
                                        - start_min
                                        - repeat_interval_unit
                                        - repeat_interval_measure
                                      properties:
                                        schedule_status:
                                          type: string
                                          enum:
                                            - enabled
                                          example: enabled
                                        start_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: Start time should be after current time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        start_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 14
                                        start_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 35
                                        repeat_interval_unit:
                                          type: string
                                          enum:
                                            - DAY
                                        repeat_interval_measure:
                                          type: integer
                                          minimum: 1
                                        ends:
                                          type: boolean
                                          description: >
                                            `end_date`, `end_hour`, `end_min` must
                                            be provided if `ends` is `true`.
                                          default: false
                                          example: true
                                        end_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: End time should be after start time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        end_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 15
                                        end_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 55
                                        is_custom_job:
                                          type: boolean
                                          description: >
                                            `custom_job_details` must be provided
                                            when `is_custom_job=true`
                                          default: false
                                          example: true
                                        custom_job_details:
                                          type: object
                                          required:
                                            - starts_daily_at
                                            - ends_daily_at
                                            - repeat_interval_measure
                                            - repeat_interval_unit
                                          properties:
                                            starts_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '12:40'
                                            ends_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '17:45'
                                            repeat_interval_measure:
                                              type: integer
                                              minimum: 1
                                              example: 10
                                            repeat_interval_unit:
                                              type: string
                                              enum:
                                                - MINUTE
                                                - HOUR
                                    - type: object
                                      title: Weekly Schedule
                                      description: Schedule job weekly
                                      required:
                                        - schedule_status
                                        - start_date
                                        - start_hour
                                        - start_min
                                        - repeat_interval_unit
                                        - repeat_interval_measure
                                        - specified_days
                                      properties:
                                        schedule_status:
                                          type: string
                                          enum:
                                            - enabled
                                          example: enabled
                                        start_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: Start time should be after current time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        start_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 14
                                        start_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 35
                                        repeat_interval_unit:
                                          type: string
                                          enum:
                                            - WEEK
                                        repeat_interval_measure:
                                          type: integer
                                          minimum: 1
                                        specified_days:
                                          type: array
                                          minLength: 1
                                          items:
                                            type: integer
                                            minimum: 0
                                            maximum: 6
                                          example:
                                            - 0
                                            - 2
                                            - 5
                                        ends:
                                          type: boolean
                                          description: >
                                            `end_date`, `end_hour`, `end_min` must
                                            be provided if `ends` is `true`.
                                          default: false
                                          example: true
                                        end_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: End time should be after start time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        end_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 15
                                        end_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 55
                                        is_custom_job:
                                          type: boolean
                                          description: >
                                            `custom_job_details` must be provided
                                            when `is_custom_job=true`
                                          default: false
                                          example: true
                                        custom_job_details:
                                          type: object
                                          required:
                                            - starts_daily_at
                                            - ends_daily_at
                                            - repeat_interval_measure
                                            - repeat_interval_unit
                                          properties:
                                            starts_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '12:40'
                                            ends_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '17:45'
                                            repeat_interval_measure:
                                              type: integer
                                              minimum: 1
                                              example: 10
                                            repeat_interval_unit:
                                              type: string
                                              enum:
                                                - MINUTE
                                                - HOUR
                                    - type: object
                                      title: Monthly Schedule
                                      description: Schedule job monthly
                                      required:
                                        - schedule_status
                                        - start_date
                                        - start_hour
                                        - start_min
                                        - repeat_interval_unit
                                        - repeat_interval_measure
                                      properties:
                                        schedule_status:
                                          type: string
                                          enum:
                                            - enabled
                                          example: enabled
                                        start_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: Start time should be after current time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        start_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 14
                                        start_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 35
                                        repeat_interval_unit:
                                          type: string
                                          enum:
                                            - MONTH
                                        repeat_interval_measure:
                                          type: integer
                                          minimum: 1
                                        repeat_on_last_day:
                                          type: boolean
                                          description: >
                                            `specified_days` must be provided if
                                            `repeat_on_last_day` is false.
                                          default: false
                                        specified_days:
                                          type: array
                                          minLength: 1
                                          items:
                                            type: integer
                                            minimum: 1
                                            maximum: 31
                                          example:
                                            - 1
                                            - 17
                                            - 31
                                        ends:
                                          type: boolean
                                          description: >
                                            `end_date`, `end_hour`, `end_min` must
                                            be provided if `ends` is `true`.
                                          default: false
                                          example: true
                                        end_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: End time should be after start time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        end_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 15
                                        end_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 45
                                        is_custom_job:
                                          type: boolean
                                          description: >
                                            `custom_job_details` must be provided
                                            when `is_custom_job=true`
                                          default: false
                                          example: true
                                        custom_job_details:
                                          type: object
                                          required:
                                            - starts_daily_at
                                            - ends_daily_at
                                            - repeat_interval_measure
                                            - repeat_interval_unit
                                          properties:
                                            starts_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '12:40'
                                            ends_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '17:45'
                                            repeat_interval_measure:
                                              type: integer
                                              minimum: 1
                                              example: 10
                                            repeat_interval_unit:
                                              type: string
                                              enum:
                                                - MINUTE
                                                - HOUR
                        iw_mappings:
                          type: array
                          items:
                            oneOf:
                              - type: object
                                properties:
                                  entity_type:
                                    type: string
                                    example: pipeline
                                  recommendation:
                                    type: object
                                    properties: {}
                                  to_entity_id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                              - type: object
                                properties:
                                  entity_type:
                                    type: string
                                    example: pipeline
                                  recommendation:
                                    type: object
                                    properties:
                                      pipeline_name:
                                        type: string
                                        example: Workflow_Pipeline_1
                                      domain_name:
                                        type: string
                                        example: Automation_domain
                                  selected_versions:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        version_id:
                                          type: string
                                          example: 648845a0007ecf1a1c550c5f
                                        version:
                                          type: number
                                          example: 1
                                  to_entity_id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                        entity:
                          type: object
                          properties:
                            entity_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                            entity_type:
                              type: string
                              enum:
                                - workflow
                            entity_name:
                              type: string
                              example: example_workflow
                        export:
                          type: object
                          properties:
                            exported_at:
                              type: string
                            exported_by:
                              type: string
                            exported_by_username:
                              type: string
                - type: object
                  properties:
                    dry_run:
                      type: boolean
                      example: true
                - type: object
                  properties:
                    import_configs:
                      type: object
                      properties:
                        map_active_version:
                          type: boolean
                          example: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                entity_type:
                                  type: string
                                  example: pipeline
                                recommendation:
                                  type: object
                                  properties: {}
                                to_entity_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - type: object
                              properties:
                                error:
                                  type: string
                                  example: Exmaple Error
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/start:
    post:
      security:
        - BearerAuth: []
      operationId: startWorkflow
      summary: Runs the latest workflow
      description: >-
        Runs the latest workflow with the provided `workflow_id`, `domain_id`,
        and returns `workflow_run_id`.
      tags:
        - Workflows
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
        - name: workflow_version_id
          in: query
          required: false
          description: >-
            ID of the workflow version to run. If omitted, the active version is
            used.
          schema:
            type: string
            example: e77850ad5127a2d7dab870ff
      requestBody:
        description: >-
          Optional Request Body containing Workflow Parameters to be submitted
          at Runtime and skip nodes to skip the workflow tasks at Runtime.
        content:
          application/json:
            schema:
              type: object
              properties:
                workflow_parameters:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                        example: parameter_key
                      value:
                        type: string
                        example: parameter_value
                skip_nodes:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/pause:
    post:
      security:
        - BearerAuth: []
      operationId: pauseWorkflow
      summary: This will pause all running builds of `workflow` with `{workflow_id}`.
      description: This will pause all running builds of `workflow` with `{workflow_id}`.
      tags:
        - Workflows
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
        - name: workflow_version_id
          in: query
          required: true
          description: ID of the workflow version to pause.
          schema:
            type: string
            example: e77850ad5127a2d7dab870ff
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/resume:
    post:
      security:
        - BearerAuth: []
      operationId: resumeWorkflow
      summary: This will resume all paused builds of `workflow` with `{workflow_id}`.
      description: This will resume all paused builds of `workflow` with `{workflow_id}`.
      tags:
        - Workflows
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
        - name: workflow_version_id
          in: query
          required: true
          description: ID of the workflow version to resume.
          schema:
            type: string
            example: e77850ad5127a2d7dab870ff
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/lineage:
    get:
      security:
        - BearerAuth: []
      operationId: getWorkflowLineage
      summary: Get workflow lineage
      description: |
        Retrieves the workflow lineage
      tags:
        - Workflows
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                            lineage:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: 3e2c83ee872d3ba03ed612ce
                                  lineage:
                                    type: array
                                    items:
                                      type: object
                              example:
                                - id: 3e2c83ee872d3ba03ed612ce
                                  lineage: []
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/ancestors:
    get:
      security:
        - BearerAuth: []
      operationId: getWorkflowAncestors
      summary: Get workflow ancestors
      description: |
        Retrieves the workflow ancestors
      tags:
        - Workflows
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        description: Workflow IDs of ancestors
                        items:
                          type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/runs:
    get:
      security:
        - BearerAuth: []
      operationId: getWorkflowRunsByWorkflowId
      summary: This will get all builds of `workflow` with `{workflow_id}`.
      description: This will get all builds of `workflow` with `{workflow_id}`.
      tags:
        - Workflows
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: Content-Type
          in: header
          description: Http content type
          required: true
          schema:
            type: string
            enum:
              - application/json
              - multipart/form-data
              - text/plain
            default: application/json
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                workflow_name:
                                  type: string
                                  example: example_workflow
                                job_progress:
                                  type: integer
                                  example: 87
                                workflow_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                build_number:
                                  type: integer
                                  example: 5
                                triggered_at:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
                                triggered_by:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                                    type:
                                      type: string
                                      enum:
                                        - user
                                        - wow_run
                                workflow_version_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                child_workflow_ids:
                                  type: array
                                  items:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                                workflow_graph:
                                  type: object
                                  properties:
                                    tasks:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          is_group:
                                            type: boolean
                                            example: false
                                          task_id:
                                            type: string
                                            example: SI_BS78
                                          task_type:
                                            type: string
                                            example: ingest_table_group
                                          location:
                                            type: string
                                            example: '-237 52'
                                          title:
                                            type: string
                                            example: ingest
                                          task_properties:
                                            type: object
                                            properties: {}
                                          run_properties:
                                            type: object
                                            properties:
                                              enable_exponential_backoff_for_retries:
                                                type: boolean
                                                example: true
                                              num_retries:
                                                type: integer
                                                minimum: 0
                                                example: 5
                                              retry_delay:
                                                type: integer
                                                example: 200
                                              max_retry_delay:
                                                type: integer
                                                example: 1000
                                              trigger_rule:
                                                type: string
                                                enum:
                                                  - all_success
                                                  - all_done
                                                  - all_failed
                                                  - one_failed
                                                  - one_success
                                          environment_variables_conf:
                                            description: >-
                                              List of additional environment variable
                                              config for bash node.
                                            type: array
                                            items:
                                              type: object
                                              required:
                                                - name
                                                - config_type
                                              properties:
                                                name:
                                                  type: string
                                                  example: RDBMS_PASSWORD
                                                config_type:
                                                  type: string
                                                  example: KEYVAULT
                                                  enum:
                                                    - KEYVAULT
                                                    - ADMIN
                                                config_name:
                                                  type: string
                                                  example: iw_admin_conf
                                                secret_id:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                          workflow_variables:
                                            type: array
                                            items:
                                              type: object
                                              properties:
                                                key:
                                                  type: string
                                                  example: job_id
                                                value:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                    edges:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          category:
                                            type: string
                                          from_task:
                                            type: string
                                          to_task:
                                            type: string
                                          task_id:
                                            type: number
                                workflow_parameters:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      key:
                                        type: string
                                        example: parameter_key
                                      value:
                                        type: string
                                        example: parameter_value
                                workflow_status:
                                  type: object
                                  properties:
                                    run_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    state:
                                      type: string
                                      enum:
                                        - success
                                        - failed
                                        - pending
                                        - running
                                    start_date:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                    end_date:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                tasks_status:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      task_id:
                                        type: string
                                        example: e77850ad5127a2d7dab870ff
                                      task_state:
                                        type: string
                                        example: failed
                                      task_title:
                                        type: string
                                        example: ingest_table_group
                                      task_start_time:
                                        type: string
                                        example: '2019-11-21T12:54:05.875Z'
                                      task_end_time:
                                        type: string
                                        example: '2019-11-21T12:54:05.875Z'
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - type: object
                              allOf:
                                - type: object
                                  properties:
                                    created_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    created_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                                - type: object
                                  properties:
                                    modified_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    modified_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}:
    get:
      security:
        - BearerAuth: []
      operationId: getWorkflowRun
      summary: This will get a specific build of `workflow` with `{workflow_id}`.
      description: This will get a specific build of `workflow` with `{workflow_id}`.
      tags:
        - Workflows
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
        - name: Content-Type
          in: header
          description: Http content type
          required: true
          schema:
            type: string
            enum:
              - application/json
              - multipart/form-data
              - text/plain
            default: application/json
        - name: workflow_run_id
          in: path
          required: true
          schema:
            type: string
            example: af690b4324090bd09da4505d
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        allOf:
                          - type: object
                            properties:
                              workflow_name:
                                type: string
                                example: example_workflow
                              job_progress:
                                type: integer
                                example: 87
                              workflow_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              build_number:
                                type: integer
                                example: 5
                              triggered_at:
                                type: string
                                example: '2019-11-21T12:54:05.875Z'
                              triggered_by:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                                  type:
                                    type: string
                                    enum:
                                      - user
                                      - wow_run
                              workflow_version_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              child_workflow_ids:
                                type: array
                                items:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                              workflow_graph:
                                type: object
                                properties:
                                  tasks:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        is_group:
                                          type: boolean
                                          example: false
                                        task_id:
                                          type: string
                                          example: SI_BS78
                                        task_type:
                                          type: string
                                          example: ingest_table_group
                                        location:
                                          type: string
                                          example: '-237 52'
                                        title:
                                          type: string
                                          example: ingest
                                        task_properties:
                                          type: object
                                          properties: {}
                                        run_properties:
                                          type: object
                                          properties:
                                            enable_exponential_backoff_for_retries:
                                              type: boolean
                                              example: true
                                            num_retries:
                                              type: integer
                                              minimum: 0
                                              example: 5
                                            retry_delay:
                                              type: integer
                                              example: 200
                                            max_retry_delay:
                                              type: integer
                                              example: 1000
                                            trigger_rule:
                                              type: string
                                              enum:
                                                - all_success
                                                - all_done
                                                - all_failed
                                                - one_failed
                                                - one_success
                                        environment_variables_conf:
                                          description: >-
                                            List of additional environment variable
                                            config for bash node.
                                          type: array
                                          items:
                                            type: object
                                            required:
                                              - name
                                              - config_type
                                            properties:
                                              name:
                                                type: string
                                                example: RDBMS_PASSWORD
                                              config_type:
                                                type: string
                                                example: KEYVAULT
                                                enum:
                                                  - KEYVAULT
                                                  - ADMIN
                                              config_name:
                                                type: string
                                                example: iw_admin_conf
                                              secret_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                        workflow_variables:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              key:
                                                type: string
                                                example: job_id
                                              value:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                  edges:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        category:
                                          type: string
                                        from_task:
                                          type: string
                                        to_task:
                                          type: string
                                        task_id:
                                          type: number
                              workflow_parameters:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                      example: parameter_key
                                    value:
                                      type: string
                                      example: parameter_value
                              workflow_status:
                                type: object
                                properties:
                                  run_id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                                  state:
                                    type: string
                                    enum:
                                      - success
                                      - failed
                                      - pending
                                      - running
                                  start_date:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                                  end_date:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              tasks_status:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    task_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    task_state:
                                      type: string
                                      example: failed
                                    task_title:
                                      type: string
                                      example: ingest_table_group
                                    task_start_time:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                    task_end_time:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                          - type: object
                            properties:
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          - type: object
                            allOf:
                              - type: object
                                properties:
                                  created_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  created_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                              - type: object
                                properties:
                                  modified_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  modified_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}/restart:
    post:
      security:
        - BearerAuth: []
      operationId: restartWorkflowRun
      summary: This will restart running `workflow` with `{workflow_id}`.
      description: This will restart running `workflow` with `{workflow_id}`.
      tags:
        - Workflows
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
        - name: workflow_run_id
          in: path
          required: true
          schema:
            type: string
            example: af690b4324090bd09da4505d
      requestBody:
        description: >-
          Optional Request Body containing Skip Nodes to be skip workflow tasks
          at Runtime.
        content:
          application/json:
            schema:
              type: object
              properties:
                skip_nodes:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}/cancel:
    post:
      security:
        - BearerAuth: []
      operationId: cancelWorkflowRun
      summary: >-
        This will cancel running `workflow` with `{workflow_id}` for build with
        `workflow_run_id`.
      description: >-
        This will cancel running `workflow` with `{workflow_id}` for build with
        `workflow_run_id`.
      tags:
        - Workflows
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
        - name: workflow_run_id
          in: path
          required: true
          schema:
            type: string
            example: af690b4324090bd09da4505d
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}/tasks/{task_id}/logs:
    get:
      security:
        - BearerAuth: []
      operationId: getWorkflowRunTaskLogsByAttempt
      summary: Get task logs for a workflow run
      description: >
        Retrieves the logs for a specific task in a workflow run.  It fetches
        logs for the latest attempt by default if `try_number` is not specified.
      tags:
        - Workflows
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
        - name: workflow_run_id
          in: path
          required: true
          schema:
            type: string
            example: af690b4324090bd09da4505d
        - name: task_id
          in: path
          required: true
          schema:
            type: string
            example: SI_F50E
        - name: try_number
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
      responses:
        '200':
          description: Success
          headers:
            try-number:
              schema:
                type: integer
                minimum: 1
                example: 2
              description: Attempt number for retrieved task logs
            total-attempts:
              schema:
                type: integer
                minimum: 1
                example: 4
              description: Total attempts for the task
          content:
            text/plain:
              schema:
                type: string
                description: Task log
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}/tasks/{task_id}/logs/download:
    get:
      security:
        - BearerAuth: []
      operationId: downloadWorkflowRunTaskLogs
      summary: Download task logs for a workflow run
      description: >
        Downloads the logs for a specific task in a workflow run.  The
        downloaded zip file will contain logs for all attempts of that task for
        that particular workflow run.
      tags:
        - Workflows
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
        - name: workflow_run_id
          in: path
          required: true
          schema:
            type: string
            example: af690b4324090bd09da4505d
        - name: task_id
          in: path
          required: true
          schema:
            type: string
            example: SI_F50E
      responses:
        '200':
          description: Success
          content:
            application/zip:
              schema:
                type: string
                format: binary
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/schedules:
    get:
      security:
        - BearerAuth: []
      operationId: getDomainSchedules
      tags:
        - Workflows Schedules
      summary: Schedules of Workflows belonging to this Domain.
      description: Schedules of Workflows belonging to this Domain.
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            entity_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                            schedule_type:
                              type: string
                              enum:
                                - workflow-build
                                - metadata_cleanup
                                - mongo-backup
                                - table-group-cdc
                                - table
                            schedule_username:
                              type: string
                              example: admin@infoworks.io
                            schedule_details:
                              allOf:
                                - oneOf:
                                    - type: object
                                      title: Generic Schedule
                                      description: Generic schedule object
                                      required:
                                        - schedule_status
                                      properties:
                                        schedule_status:
                                          type: string
                                          enum:
                                            - enabled
                                            - disabled
                                          example: enabled
                                        start_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: Start time should be after current time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        start_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 14
                                        start_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 35
                                        repeat_interval_unit:
                                          type: string
                                          enum:
                                            - NEVER
                                            - MINUTE
                                            - HOUR
                                            - DAY
                                            - WEEK
                                            - MONTH
                                          default: NEVER
                                          example: MONTH
                                        repeat_interval_measure:
                                          type: integer
                                          minimum: 1
                                        repeat_on_last_day:
                                          type: boolean
                                          description: >
                                            `specified_days` must be provided if
                                            `repeat_on_last_day` is false.
                                            Applicable for
                                            `repeat_interval_unit=MONTH`
                                          default: false
                                        specified_days:
                                          type: array
                                          description: >
                                            Applicable when `repeat_interval_unit`
                                            is `WEEK` or `MONTH`.
                                          minLength: 1
                                          items:
                                            type: integer
                                            minimum: 0
                                            maximum: 31
                                          example:
                                            - 1
                                            - 17
                                            - 31
                                        ends:
                                          type: boolean
                                          description: >
                                            `end_date`, `end_hour`, `end_min` must
                                            be provided if `ends` is `true`.
                                          default: false
                                          example: true
                                        end_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: End time should be after start time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        end_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 15
                                        end_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 38
                                        is_custom_job:
                                          type: boolean
                                          description: >
                                            `custom_job_details` must be provided
                                            when `is_custom_job=true`. Applicable
                                            when `repeat_interval_unit` is `DAY`,
                                            `WEEK` or `MONTH`.
                                          default: false
                                        custom_job_details:
                                          type: object
                                          required:
                                            - starts_daily_at
                                            - ends_daily_at
                                            - repeat_interval_measure
                                            - repeat_interval_unit
                                          properties:
                                            starts_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '12:40'
                                            ends_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '17:45'
                                            repeat_interval_measure:
                                              type: integer
                                              minimum: 1
                                              example: 10
                                            repeat_interval_unit:
                                              type: string
                                              enum:
                                                - MINUTE
                                                - HOUR
                                    - type: object
                                      title: By Minute Schedule
                                      description: Schedule job by minutes
                                      required:
                                        - schedule_status
                                        - start_date
                                        - start_hour
                                        - start_min
                                        - repeat_interval_unit
                                        - repeat_interval_measure
                                      properties:
                                        schedule_status:
                                          type: string
                                          enum:
                                            - enabled
                                          example: enabled
                                        start_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: Start time should be after current time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        start_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 14
                                        start_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 35
                                        repeat_interval_unit:
                                          type: string
                                          enum:
                                            - MINUTE
                                        repeat_interval_measure:
                                          type: integer
                                          minimum: 1
                                        ends:
                                          type: boolean
                                          description: >
                                            `end_date`, `end_hour`, `end_min` must
                                            be provided if `ends` is `true`.
                                          default: false
                                          example: true
                                        end_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: End time should be after start time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        end_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 15
                                        end_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 55
                                    - type: object
                                      title: Hourly Schedule
                                      description: Schedule job hourly
                                      required:
                                        - schedule_status
                                        - start_date
                                        - start_hour
                                        - start_min
                                        - repeat_interval_unit
                                        - repeat_interval_measure
                                      properties:
                                        schedule_status:
                                          type: string
                                          enum:
                                            - enabled
                                          example: enabled
                                        start_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: Start time should be after current time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        start_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 14
                                        start_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 35
                                        repeat_interval_unit:
                                          type: string
                                          enum:
                                            - HOUR
                                        repeat_interval_measure:
                                          type: integer
                                          minimum: 1
                                        ends:
                                          type: boolean
                                          description: >
                                            `end_date`, `end_hour`, `end_min` must
                                            be provided if `ends` is `true`.
                                          default: false
                                          example: true
                                        end_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: End time should be after start time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        end_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 15
                                        end_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 55
                                    - type: object
                                      title: Daily Schedule
                                      description: Schedule job daily
                                      required:
                                        - schedule_status
                                        - start_date
                                        - start_hour
                                        - start_min
                                        - repeat_interval_unit
                                        - repeat_interval_measure
                                      properties:
                                        schedule_status:
                                          type: string
                                          enum:
                                            - enabled
                                          example: enabled
                                        start_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: Start time should be after current time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        start_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 14
                                        start_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 35
                                        repeat_interval_unit:
                                          type: string
                                          enum:
                                            - DAY
                                        repeat_interval_measure:
                                          type: integer
                                          minimum: 1
                                        ends:
                                          type: boolean
                                          description: >
                                            `end_date`, `end_hour`, `end_min` must
                                            be provided if `ends` is `true`.
                                          default: false
                                          example: true
                                        end_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: End time should be after start time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        end_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 15
                                        end_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 55
                                        is_custom_job:
                                          type: boolean
                                          description: >
                                            `custom_job_details` must be provided
                                            when `is_custom_job=true`
                                          default: false
                                          example: true
                                        custom_job_details:
                                          type: object
                                          required:
                                            - starts_daily_at
                                            - ends_daily_at
                                            - repeat_interval_measure
                                            - repeat_interval_unit
                                          properties:
                                            starts_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '12:40'
                                            ends_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '17:45'
                                            repeat_interval_measure:
                                              type: integer
                                              minimum: 1
                                              example: 10
                                            repeat_interval_unit:
                                              type: string
                                              enum:
                                                - MINUTE
                                                - HOUR
                                    - type: object
                                      title: Weekly Schedule
                                      description: Schedule job weekly
                                      required:
                                        - schedule_status
                                        - start_date
                                        - start_hour
                                        - start_min
                                        - repeat_interval_unit
                                        - repeat_interval_measure
                                        - specified_days
                                      properties:
                                        schedule_status:
                                          type: string
                                          enum:
                                            - enabled
                                          example: enabled
                                        start_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: Start time should be after current time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        start_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 14
                                        start_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 35
                                        repeat_interval_unit:
                                          type: string
                                          enum:
                                            - WEEK
                                        repeat_interval_measure:
                                          type: integer
                                          minimum: 1
                                        specified_days:
                                          type: array
                                          minLength: 1
                                          items:
                                            type: integer
                                            minimum: 0
                                            maximum: 6
                                          example:
                                            - 0
                                            - 2
                                            - 5
                                        ends:
                                          type: boolean
                                          description: >
                                            `end_date`, `end_hour`, `end_min` must
                                            be provided if `ends` is `true`.
                                          default: false
                                          example: true
                                        end_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: End time should be after start time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        end_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 15
                                        end_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 55
                                        is_custom_job:
                                          type: boolean
                                          description: >
                                            `custom_job_details` must be provided
                                            when `is_custom_job=true`
                                          default: false
                                          example: true
                                        custom_job_details:
                                          type: object
                                          required:
                                            - starts_daily_at
                                            - ends_daily_at
                                            - repeat_interval_measure
                                            - repeat_interval_unit
                                          properties:
                                            starts_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '12:40'
                                            ends_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '17:45'
                                            repeat_interval_measure:
                                              type: integer
                                              minimum: 1
                                              example: 10
                                            repeat_interval_unit:
                                              type: string
                                              enum:
                                                - MINUTE
                                                - HOUR
                                    - type: object
                                      title: Monthly Schedule
                                      description: Schedule job monthly
                                      required:
                                        - schedule_status
                                        - start_date
                                        - start_hour
                                        - start_min
                                        - repeat_interval_unit
                                        - repeat_interval_measure
                                      properties:
                                        schedule_status:
                                          type: string
                                          enum:
                                            - enabled
                                          example: enabled
                                        start_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: Start time should be after current time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        start_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 14
                                        start_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 35
                                        repeat_interval_unit:
                                          type: string
                                          enum:
                                            - MONTH
                                        repeat_interval_measure:
                                          type: integer
                                          minimum: 1
                                        repeat_on_last_day:
                                          type: boolean
                                          description: >
                                            `specified_days` must be provided if
                                            `repeat_on_last_day` is false.
                                          default: false
                                        specified_days:
                                          type: array
                                          minLength: 1
                                          items:
                                            type: integer
                                            minimum: 1
                                            maximum: 31
                                          example:
                                            - 1
                                            - 17
                                            - 31
                                        ends:
                                          type: boolean
                                          description: >
                                            `end_date`, `end_hour`, `end_min` must
                                            be provided if `ends` is `true`.
                                          default: false
                                          example: true
                                        end_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: End time should be after start time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        end_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 15
                                        end_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 45
                                        is_custom_job:
                                          type: boolean
                                          description: >
                                            `custom_job_details` must be provided
                                            when `is_custom_job=true`
                                          default: false
                                          example: true
                                        custom_job_details:
                                          type: object
                                          required:
                                            - starts_daily_at
                                            - ends_daily_at
                                            - repeat_interval_measure
                                            - repeat_interval_unit
                                          properties:
                                            starts_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '12:40'
                                            ends_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '17:45'
                                            repeat_interval_measure:
                                              type: integer
                                              minimum: 1
                                              example: 10
                                            repeat_interval_unit:
                                              type: string
                                              enum:
                                                - MINUTE
                                                - HOUR
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/schedules:
    get:
      security:
        - BearerAuth: []
      operationId: getWorkflowSchedule
      tags:
        - Workflows Schedules
      summary: Schedules of particular Workflow belonging to this Domain.
      description: Schedules of particular Workflow belonging to this Domain.
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      entity_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      schedule_type:
                        type: string
                        enum:
                          - workflow-build
                          - metadata_cleanup
                          - mongo-backup
                          - table-group-cdc
                          - table
                      schedule_username:
                        type: string
                        example: admin@infoworks.io
                      schedule_details:
                        allOf:
                          - oneOf:
                              - type: object
                                title: Generic Schedule
                                description: Generic schedule object
                                required:
                                  - schedule_status
                                properties:
                                  schedule_status:
                                    type: string
                                    enum:
                                      - enabled
                                      - disabled
                                    example: enabled
                                  start_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: Start time should be after current time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  start_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 14
                                  start_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 35
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - NEVER
                                      - MINUTE
                                      - HOUR
                                      - DAY
                                      - WEEK
                                      - MONTH
                                    default: NEVER
                                    example: MONTH
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                  repeat_on_last_day:
                                    type: boolean
                                    description: >
                                      `specified_days` must be provided if
                                      `repeat_on_last_day` is false. Applicable
                                      for `repeat_interval_unit=MONTH`
                                    default: false
                                  specified_days:
                                    type: array
                                    description: >
                                      Applicable when `repeat_interval_unit` is
                                      `WEEK` or `MONTH`.
                                    minLength: 1
                                    items:
                                      type: integer
                                      minimum: 0
                                      maximum: 31
                                    example:
                                      - 1
                                      - 17
                                      - 31
                                  ends:
                                    type: boolean
                                    description: >
                                      `end_date`, `end_hour`, `end_min` must be
                                      provided if `ends` is `true`.
                                    default: false
                                    example: true
                                  end_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: End time should be after start time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  end_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 15
                                  end_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 38
                                  is_custom_job:
                                    type: boolean
                                    description: >
                                      `custom_job_details` must be provided when
                                      `is_custom_job=true`. Applicable when
                                      `repeat_interval_unit` is `DAY`, `WEEK` or
                                      `MONTH`.
                                    default: false
                                  custom_job_details:
                                    type: object
                                    required:
                                      - starts_daily_at
                                      - ends_daily_at
                                      - repeat_interval_measure
                                      - repeat_interval_unit
                                    properties:
                                      starts_daily_at:
                                        pattern: ^{0-23}:[0-59]$
                                        type: string
                                        example: '12:40'
                                      ends_daily_at:
                                        pattern: ^{0-23}:[0-59]$
                                        type: string
                                        example: '17:45'
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                        example: 10
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                          - MINUTE
                                          - HOUR
                              - type: object
                                title: By Minute Schedule
                                description: Schedule job by minutes
                                required:
                                  - schedule_status
                                  - start_date
                                  - start_hour
                                  - start_min
                                  - repeat_interval_unit
                                  - repeat_interval_measure
                                properties:
                                  schedule_status:
                                    type: string
                                    enum:
                                      - enabled
                                    example: enabled
                                  start_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: Start time should be after current time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  start_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 14
                                  start_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 35
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - MINUTE
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                  ends:
                                    type: boolean
                                    description: >
                                      `end_date`, `end_hour`, `end_min` must be
                                      provided if `ends` is `true`.
                                    default: false
                                    example: true
                                  end_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: End time should be after start time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  end_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 15
                                  end_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 55
                              - type: object
                                title: Hourly Schedule
                                description: Schedule job hourly
                                required:
                                  - schedule_status
                                  - start_date
                                  - start_hour
                                  - start_min
                                  - repeat_interval_unit
                                  - repeat_interval_measure
                                properties:
                                  schedule_status:
                                    type: string
                                    enum:
                                      - enabled
                                    example: enabled
                                  start_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: Start time should be after current time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  start_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 14
                                  start_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 35
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - HOUR
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                  ends:
                                    type: boolean
                                    description: >
                                      `end_date`, `end_hour`, `end_min` must be
                                      provided if `ends` is `true`.
                                    default: false
                                    example: true
                                  end_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: End time should be after start time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  end_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 15
                                  end_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 55
                              - type: object
                                title: Daily Schedule
                                description: Schedule job daily
                                required:
                                  - schedule_status
                                  - start_date
                                  - start_hour
                                  - start_min
                                  - repeat_interval_unit
                                  - repeat_interval_measure
                                properties:
                                  schedule_status:
                                    type: string
                                    enum:
                                      - enabled
                                    example: enabled
                                  start_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: Start time should be after current time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  start_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 14
                                  start_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 35
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - DAY
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                  ends:
                                    type: boolean
                                    description: >
                                      `end_date`, `end_hour`, `end_min` must be
                                      provided if `ends` is `true`.
                                    default: false
                                    example: true
                                  end_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: End time should be after start time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  end_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 15
                                  end_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 55
                                  is_custom_job:
                                    type: boolean
                                    description: >
                                      `custom_job_details` must be provided when
                                      `is_custom_job=true`
                                    default: false
                                    example: true
                                  custom_job_details:
                                    type: object
                                    required:
                                      - starts_daily_at
                                      - ends_daily_at
                                      - repeat_interval_measure
                                      - repeat_interval_unit
                                    properties:
                                      starts_daily_at:
                                        pattern: ^{0-23}:[0-59]$
                                        type: string
                                        example: '12:40'
                                      ends_daily_at:
                                        pattern: ^{0-23}:[0-59]$
                                        type: string
                                        example: '17:45'
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                        example: 10
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                          - MINUTE
                                          - HOUR
                              - type: object
                                title: Weekly Schedule
                                description: Schedule job weekly
                                required:
                                  - schedule_status
                                  - start_date
                                  - start_hour
                                  - start_min
                                  - repeat_interval_unit
                                  - repeat_interval_measure
                                  - specified_days
                                properties:
                                  schedule_status:
                                    type: string
                                    enum:
                                      - enabled
                                    example: enabled
                                  start_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: Start time should be after current time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  start_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 14
                                  start_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 35
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - WEEK
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                  specified_days:
                                    type: array
                                    minLength: 1
                                    items:
                                      type: integer
                                      minimum: 0
                                      maximum: 6
                                    example:
                                      - 0
                                      - 2
                                      - 5
                                  ends:
                                    type: boolean
                                    description: >
                                      `end_date`, `end_hour`, `end_min` must be
                                      provided if `ends` is `true`.
                                    default: false
                                    example: true
                                  end_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: End time should be after start time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  end_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 15
                                  end_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 55
                                  is_custom_job:
                                    type: boolean
                                    description: >
                                      `custom_job_details` must be provided when
                                      `is_custom_job=true`
                                    default: false
                                    example: true
                                  custom_job_details:
                                    type: object
                                    required:
                                      - starts_daily_at
                                      - ends_daily_at
                                      - repeat_interval_measure
                                      - repeat_interval_unit
                                    properties:
                                      starts_daily_at:
                                        pattern: ^{0-23}:[0-59]$
                                        type: string
                                        example: '12:40'
                                      ends_daily_at:
                                        pattern: ^{0-23}:[0-59]$
                                        type: string
                                        example: '17:45'
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                        example: 10
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                          - MINUTE
                                          - HOUR
                              - type: object
                                title: Monthly Schedule
                                description: Schedule job monthly
                                required:
                                  - schedule_status
                                  - start_date
                                  - start_hour
                                  - start_min
                                  - repeat_interval_unit
                                  - repeat_interval_measure
                                properties:
                                  schedule_status:
                                    type: string
                                    enum:
                                      - enabled
                                    example: enabled
                                  start_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: Start time should be after current time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  start_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 14
                                  start_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 35
                                  repeat_interval_unit:
                                    type: string
                                    enum:
                                      - MONTH
                                  repeat_interval_measure:
                                    type: integer
                                    minimum: 1
                                  repeat_on_last_day:
                                    type: boolean
                                    description: >
                                      `specified_days` must be provided if
                                      `repeat_on_last_day` is false.
                                    default: false
                                  specified_days:
                                    type: array
                                    minLength: 1
                                    items:
                                      type: integer
                                      minimum: 1
                                      maximum: 31
                                    example:
                                      - 1
                                      - 17
                                      - 31
                                  ends:
                                    type: boolean
                                    description: >
                                      `end_date`, `end_hour`, `end_min` must be
                                      provided if `ends` is `true`.
                                    default: false
                                    example: true
                                  end_date:
                                    pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                    type: string
                                    description: End time should be after start time.
                                    format: date-month'/'date-mday'/'date-fullyear
                                    example: 08/28/2023
                                  end_hour:
                                    type: integer
                                    minimum: 0
                                    maximum: 23
                                    example: 15
                                  end_min:
                                    type: integer
                                    minimum: 0
                                    maximum: 59
                                    example: 45
                                  is_custom_job:
                                    type: boolean
                                    description: >
                                      `custom_job_details` must be provided when
                                      `is_custom_job=true`
                                    default: false
                                    example: true
                                  custom_job_details:
                                    type: object
                                    required:
                                      - starts_daily_at
                                      - ends_daily_at
                                      - repeat_interval_measure
                                      - repeat_interval_unit
                                    properties:
                                      starts_daily_at:
                                        pattern: ^{0-23}:[0-59]$
                                        type: string
                                        example: '12:40'
                                      ends_daily_at:
                                        pattern: ^{0-23}:[0-59]$
                                        type: string
                                        example: '17:45'
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                        example: 10
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                          - MINUTE
                                          - HOUR
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/schedules/enable:
    put:
      security:
        - BearerAuth: []
      operationId: setWorkflowSchedule
      summary: Enable Workflow Schedule
      description: Enable Workflow Schedule
      tags:
        - Workflows Schedules
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
      requestBody:
        description: Schedule Details
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  title: Generic Schedule
                  description: Generic schedule object
                  required:
                    - schedule_status
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                        - disabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - NEVER
                        - MINUTE
                        - HOUR
                        - DAY
                        - WEEK
                        - MONTH
                      default: NEVER
                      example: MONTH
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    repeat_on_last_day:
                      type: boolean
                      description: >
                        `specified_days` must be provided if
                        `repeat_on_last_day` is false. Applicable for
                        `repeat_interval_unit=MONTH`
                      default: false
                    specified_days:
                      type: array
                      description: >
                        Applicable when `repeat_interval_unit` is `WEEK` or
                        `MONTH`.
                      minLength: 1
                      items:
                        type: integer
                        minimum: 0
                        maximum: 31
                      example:
                        - 1
                        - 17
                        - 31
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 38
                    is_custom_job:
                      type: boolean
                      description: >
                        `custom_job_details` must be provided when
                        `is_custom_job=true`. Applicable when
                        `repeat_interval_unit` is `DAY`, `WEEK` or `MONTH`.
                      default: false
                    custom_job_details:
                      type: object
                      required:
                        - starts_daily_at
                        - ends_daily_at
                        - repeat_interval_measure
                        - repeat_interval_unit
                      properties:
                        starts_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '12:40'
                        ends_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '17:45'
                        repeat_interval_measure:
                          type: integer
                          minimum: 1
                          example: 10
                        repeat_interval_unit:
                          type: string
                          enum:
                            - MINUTE
                            - HOUR
                - type: object
                  title: By Minute Schedule
                  description: Schedule job by minutes
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - MINUTE
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 55
                - type: object
                  title: Hourly Schedule
                  description: Schedule job hourly
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - HOUR
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 55
                - type: object
                  title: Daily Schedule
                  description: Schedule job daily
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - DAY
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 55
                    is_custom_job:
                      type: boolean
                      description: >
                        `custom_job_details` must be provided when
                        `is_custom_job=true`
                      default: false
                      example: true
                    custom_job_details:
                      type: object
                      required:
                        - starts_daily_at
                        - ends_daily_at
                        - repeat_interval_measure
                        - repeat_interval_unit
                      properties:
                        starts_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '12:40'
                        ends_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '17:45'
                        repeat_interval_measure:
                          type: integer
                          minimum: 1
                          example: 10
                        repeat_interval_unit:
                          type: string
                          enum:
                            - MINUTE
                            - HOUR
                - type: object
                  title: Weekly Schedule
                  description: Schedule job weekly
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                    - specified_days
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - WEEK
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    specified_days:
                      type: array
                      minLength: 1
                      items:
                        type: integer
                        minimum: 0
                        maximum: 6
                      example:
                        - 0
                        - 2
                        - 5
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 55
                    is_custom_job:
                      type: boolean
                      description: >
                        `custom_job_details` must be provided when
                        `is_custom_job=true`
                      default: false
                      example: true
                    custom_job_details:
                      type: object
                      required:
                        - starts_daily_at
                        - ends_daily_at
                        - repeat_interval_measure
                        - repeat_interval_unit
                      properties:
                        starts_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '12:40'
                        ends_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '17:45'
                        repeat_interval_measure:
                          type: integer
                          minimum: 1
                          example: 10
                        repeat_interval_unit:
                          type: string
                          enum:
                            - MINUTE
                            - HOUR
                - type: object
                  title: Monthly Schedule
                  description: Schedule job monthly
                  required:
                    - schedule_status
                    - start_date
                    - start_hour
                    - start_min
                    - repeat_interval_unit
                    - repeat_interval_measure
                  properties:
                    schedule_status:
                      type: string
                      enum:
                        - enabled
                      example: enabled
                    start_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: Start time should be after current time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    start_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 14
                    start_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 35
                    repeat_interval_unit:
                      type: string
                      enum:
                        - MONTH
                    repeat_interval_measure:
                      type: integer
                      minimum: 1
                    repeat_on_last_day:
                      type: boolean
                      description: >
                        `specified_days` must be provided if
                        `repeat_on_last_day` is false.
                      default: false
                    specified_days:
                      type: array
                      minLength: 1
                      items:
                        type: integer
                        minimum: 1
                        maximum: 31
                      example:
                        - 1
                        - 17
                        - 31
                    ends:
                      type: boolean
                      description: >
                        `end_date`, `end_hour`, `end_min` must be provided if
                        `ends` is `true`.
                      default: false
                      example: true
                    end_date:
                      pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                      type: string
                      description: End time should be after start time.
                      format: date-month'/'date-mday'/'date-fullyear
                      example: 08/28/2023
                    end_hour:
                      type: integer
                      minimum: 0
                      maximum: 23
                      example: 15
                    end_min:
                      type: integer
                      minimum: 0
                      maximum: 59
                      example: 45
                    is_custom_job:
                      type: boolean
                      description: >
                        `custom_job_details` must be provided when
                        `is_custom_job=true`
                      default: false
                      example: true
                    custom_job_details:
                      type: object
                      required:
                        - starts_daily_at
                        - ends_daily_at
                        - repeat_interval_measure
                        - repeat_interval_unit
                      properties:
                        starts_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '12:40'
                        ends_daily_at:
                          pattern: ^{0-23}:[0-59]$
                          type: string
                          example: '17:45'
                        repeat_interval_measure:
                          type: integer
                          minimum: 1
                          example: 10
                        repeat_interval_unit:
                          type: string
                          enum:
                            - MINUTE
                            - HOUR
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/schedules/disable:
    put:
      security:
        - BearerAuth: []
      operationId: disableWorkflowSchedule
      summary: Disable Workflow Schedule
      description: Disable Workflow Schedule
      tags:
        - Workflows Schedules
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/schedules/user:
    put:
      security:
        - BearerAuth: []
      operationId: changeWorkflowScheduleUser
      summary: Change Workflow Schedule User
      description: Change Workflow Schedule User
      tags:
        - Workflows Schedules
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: string
                        example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/parents:
    get:
      security:
        - BearerAuth: []
      operationId: getWorkflowParents
      tags:
        - Workflows
      summary: Gets parents workflow details of the workflow
      description: Gets parents workflow details of the workflow.
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                type: object
                properties:
                  result:
                    allOf:
                      - allOf:
                          - type: object
                            properties:
                              workflow_parents:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: 67062be0d4876873f1276852
                                    name:
                                      type: string
                                      example: w3
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/versions:
    get:
      security:
        - BearerAuth: []
      operationId: getWorkflowVersions
      tags:
        - Workflow Versions
      summary: Get all versions of a workflow
      description: >-
        Get all versions of a workflow with `{workflow_id}` in domain with
        `{domain_id}`.
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                version:
                                  type: number
                                  example: 1
                                description:
                                  type: string
                                  example: Initial version of the workflow
                                workflow_graph:
                                  type: object
                                  properties:
                                    tasks:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          is_group:
                                            type: boolean
                                            example: false
                                          task_id:
                                            type: string
                                            example: SI_BS78
                                          task_type:
                                            type: string
                                            example: ingest_table_group
                                          location:
                                            type: string
                                            example: '-237 52'
                                          title:
                                            type: string
                                            example: ingest
                                          task_properties:
                                            type: object
                                            properties: {}
                                          run_properties:
                                            type: object
                                            properties:
                                              enable_exponential_backoff_for_retries:
                                                type: boolean
                                                example: true
                                              num_retries:
                                                type: integer
                                                minimum: 0
                                                example: 5
                                              retry_delay:
                                                type: integer
                                                example: 200
                                              max_retry_delay:
                                                type: integer
                                                example: 1000
                                              trigger_rule:
                                                type: string
                                                enum:
                                                  - all_success
                                                  - all_done
                                                  - all_failed
                                                  - one_failed
                                                  - one_success
                                          environment_variables_conf:
                                            description: >-
                                              List of additional environment variable
                                              config for bash node.
                                            type: array
                                            items:
                                              type: object
                                              required:
                                                - name
                                                - config_type
                                              properties:
                                                name:
                                                  type: string
                                                  example: RDBMS_PASSWORD
                                                config_type:
                                                  type: string
                                                  example: KEYVAULT
                                                  enum:
                                                    - KEYVAULT
                                                    - ADMIN
                                                config_name:
                                                  type: string
                                                  example: iw_admin_conf
                                                secret_id:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                          workflow_variables:
                                            type: array
                                            items:
                                              type: object
                                              properties:
                                                key:
                                                  type: string
                                                  example: job_id
                                                value:
                                                  type: string
                                                  example: e77850ad5127a2d7dab870ff
                                    edges:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          category:
                                            type: string
                                          from_task:
                                            type: string
                                          to_task:
                                            type: string
                                          task_id:
                                            type: number
                                child_workflow_version_ids:
                                  type: array
                                  items:
                                    type: string
                                    example: d5a2c3fa46e1e7f8fb1cf123
                                workflow_parameters:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      key:
                                        type: string
                                        example: parameter_key
                                      value:
                                        type: string
                                        example: parameter_value
                                view_options:
                                  type: object
                                  properties:
                                    zoom_level:
                                      type: number
                                      example: 1
                                    pan_position:
                                      type: object
                                      properties:
                                        x:
                                          type: number
                                          example: 0
                                        'y':
                                          type: number
                                          example: 0
                                is_paused:
                                  type: boolean
                                  example: false
                                is_active:
                                  type: boolean
                                  example: false
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - type: object
                              allOf:
                                - type: object
                                  properties:
                                    created_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    created_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                                - type: object
                                  properties:
                                    modified_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    modified_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                            - type: object
                              properties:
                                workflow_id:
                                  type: string
                                  example: f132c1fa46e1e7f8fb1cf566
                                created_by_name:
                                  type: string
                                  example: Admin
                                modified_by_name:
                                  type: string
                                  example: Admin
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: createWorkflowVersion
      tags:
        - Workflow Versions
      summary: Create a new version of a workflow
      description: >-
        Create a new version of a workflow with `{workflow_id}` in domain with
        `{domain_id}`.
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
        - name: source_workflow_version_id
          in: query
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
      requestBody:
        description: >-
          This is the JSON body of request containing configured Workflow
          Version object.
        content:
          application/json:
            schema:
              type: object
              properties:
                version:
                  type: number
                  example: 1
                description:
                  type: string
                  example: Initial version of the workflow
                workflow_graph:
                  type: object
                  properties:
                    tasks:
                      type: array
                      items:
                        type: object
                        properties:
                          is_group:
                            type: boolean
                            example: false
                          task_id:
                            type: string
                            example: SI_BS78
                          task_type:
                            type: string
                            example: ingest_table_group
                          location:
                            type: string
                            example: '-237 52'
                          title:
                            type: string
                            example: ingest
                          task_properties:
                            type: object
                            properties: {}
                          run_properties:
                            type: object
                            properties:
                              enable_exponential_backoff_for_retries:
                                type: boolean
                                example: true
                              num_retries:
                                type: integer
                                minimum: 0
                                example: 5
                              retry_delay:
                                type: integer
                                example: 200
                              max_retry_delay:
                                type: integer
                                example: 1000
                              trigger_rule:
                                type: string
                                enum:
                                  - all_success
                                  - all_done
                                  - all_failed
                                  - one_failed
                                  - one_success
                          environment_variables_conf:
                            description: >-
                              List of additional environment variable config for
                              bash node.
                            type: array
                            items:
                              type: object
                              required:
                                - name
                                - config_type
                              properties:
                                name:
                                  type: string
                                  example: RDBMS_PASSWORD
                                config_type:
                                  type: string
                                  example: KEYVAULT
                                  enum:
                                    - KEYVAULT
                                    - ADMIN
                                config_name:
                                  type: string
                                  example: iw_admin_conf
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                          workflow_variables:
                            type: array
                            items:
                              type: object
                              properties:
                                key:
                                  type: string
                                  example: job_id
                                value:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                    edges:
                      type: array
                      items:
                        type: object
                        properties:
                          category:
                            type: string
                          from_task:
                            type: string
                          to_task:
                            type: string
                          task_id:
                            type: number
                child_workflow_version_ids:
                  type: array
                  items:
                    type: string
                    example: d5a2c3fa46e1e7f8fb1cf123
                workflow_parameters:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                        example: parameter_key
                      value:
                        type: string
                        example: parameter_value
                view_options:
                  type: object
                  properties:
                    zoom_level:
                      type: number
                      example: 1
                    pan_position:
                      type: object
                      properties:
                        x:
                          type: number
                          example: 0
                        'y':
                          type: number
                          example: 0
                is_paused:
                  type: boolean
                  example: false
                is_active:
                  type: boolean
                  example: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/versions/{workflow_version_id}:
    get:
      security:
        - BearerAuth: []
      operationId: getWorkflowVersion
      tags:
        - Workflow Versions
      summary: Get a specific version of a workflow
      description: >-
        Get a specific version of a workflow with `{workflow_id}` in domain with
        `{domain_id}`.
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
        - name: workflow_version_id
          in: path
          required: true
          schema:
            type: string
            example: d5a2c3fa46e1e7f8fb1cf123
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        allOf:
                          - type: object
                            properties:
                              version:
                                type: number
                                example: 1
                              description:
                                type: string
                                example: Initial version of the workflow
                              workflow_graph:
                                type: object
                                properties:
                                  tasks:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        is_group:
                                          type: boolean
                                          example: false
                                        task_id:
                                          type: string
                                          example: SI_BS78
                                        task_type:
                                          type: string
                                          example: ingest_table_group
                                        location:
                                          type: string
                                          example: '-237 52'
                                        title:
                                          type: string
                                          example: ingest
                                        task_properties:
                                          type: object
                                          properties: {}
                                        run_properties:
                                          type: object
                                          properties:
                                            enable_exponential_backoff_for_retries:
                                              type: boolean
                                              example: true
                                            num_retries:
                                              type: integer
                                              minimum: 0
                                              example: 5
                                            retry_delay:
                                              type: integer
                                              example: 200
                                            max_retry_delay:
                                              type: integer
                                              example: 1000
                                            trigger_rule:
                                              type: string
                                              enum:
                                                - all_success
                                                - all_done
                                                - all_failed
                                                - one_failed
                                                - one_success
                                        environment_variables_conf:
                                          description: >-
                                            List of additional environment variable
                                            config for bash node.
                                          type: array
                                          items:
                                            type: object
                                            required:
                                              - name
                                              - config_type
                                            properties:
                                              name:
                                                type: string
                                                example: RDBMS_PASSWORD
                                              config_type:
                                                type: string
                                                example: KEYVAULT
                                                enum:
                                                  - KEYVAULT
                                                  - ADMIN
                                              config_name:
                                                type: string
                                                example: iw_admin_conf
                                              secret_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                        workflow_variables:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              key:
                                                type: string
                                                example: job_id
                                              value:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                  edges:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        category:
                                          type: string
                                        from_task:
                                          type: string
                                        to_task:
                                          type: string
                                        task_id:
                                          type: number
                              child_workflow_version_ids:
                                type: array
                                items:
                                  type: string
                                  example: d5a2c3fa46e1e7f8fb1cf123
                              workflow_parameters:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                      example: parameter_key
                                    value:
                                      type: string
                                      example: parameter_value
                              view_options:
                                type: object
                                properties:
                                  zoom_level:
                                    type: number
                                    example: 1
                                  pan_position:
                                    type: object
                                    properties:
                                      x:
                                        type: number
                                        example: 0
                                      'y':
                                        type: number
                                        example: 0
                              is_paused:
                                type: boolean
                                example: false
                              is_active:
                                type: boolean
                                example: false
                          - type: object
                            properties:
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          - type: object
                            allOf:
                              - type: object
                                properties:
                                  created_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  created_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                              - type: object
                                properties:
                                  modified_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  modified_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                          - type: object
                            properties:
                              workflow_id:
                                type: string
                                example: f132c1fa46e1e7f8fb1cf566
                              created_by_name:
                                type: string
                                example: Admin
                              modified_by_name:
                                type: string
                                example: Admin
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    put:
      security:
        - BearerAuth: []
      operationId: updateWorkflowVersion
      tags:
        - Workflow Versions
      summary: Update a specific version of a workflow
      description: >-
        Update a specific version of a workflow with `{workflow_id}` in domain
        with `{domain_id}`.
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
        - name: workflow_version_id
          in: path
          required: true
          schema:
            type: string
            example: d5a2c3fa46e1e7f8fb1cf123
      requestBody:
        description: >-
          This is the JSON body of request containing updated Workflow Version
          object.
        content:
          application/json:
            schema:
              type: object
              properties:
                version:
                  type: number
                  example: 1
                description:
                  type: string
                  example: Initial version of the workflow
                workflow_graph:
                  type: object
                  properties:
                    tasks:
                      type: array
                      items:
                        type: object
                        properties:
                          is_group:
                            type: boolean
                            example: false
                          task_id:
                            type: string
                            example: SI_BS78
                          task_type:
                            type: string
                            example: ingest_table_group
                          location:
                            type: string
                            example: '-237 52'
                          title:
                            type: string
                            example: ingest
                          task_properties:
                            type: object
                            properties: {}
                          run_properties:
                            type: object
                            properties:
                              enable_exponential_backoff_for_retries:
                                type: boolean
                                example: true
                              num_retries:
                                type: integer
                                minimum: 0
                                example: 5
                              retry_delay:
                                type: integer
                                example: 200
                              max_retry_delay:
                                type: integer
                                example: 1000
                              trigger_rule:
                                type: string
                                enum:
                                  - all_success
                                  - all_done
                                  - all_failed
                                  - one_failed
                                  - one_success
                          environment_variables_conf:
                            description: >-
                              List of additional environment variable config for
                              bash node.
                            type: array
                            items:
                              type: object
                              required:
                                - name
                                - config_type
                              properties:
                                name:
                                  type: string
                                  example: RDBMS_PASSWORD
                                config_type:
                                  type: string
                                  example: KEYVAULT
                                  enum:
                                    - KEYVAULT
                                    - ADMIN
                                config_name:
                                  type: string
                                  example: iw_admin_conf
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                          workflow_variables:
                            type: array
                            items:
                              type: object
                              properties:
                                key:
                                  type: string
                                  example: job_id
                                value:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                    edges:
                      type: array
                      items:
                        type: object
                        properties:
                          category:
                            type: string
                          from_task:
                            type: string
                          to_task:
                            type: string
                          task_id:
                            type: number
                child_workflow_version_ids:
                  type: array
                  items:
                    type: string
                    example: d5a2c3fa46e1e7f8fb1cf123
                workflow_parameters:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                        example: parameter_key
                      value:
                        type: string
                        example: parameter_value
                view_options:
                  type: object
                  properties:
                    zoom_level:
                      type: number
                      example: 1
                    pan_position:
                      type: object
                      properties:
                        x:
                          type: number
                          example: 0
                        'y':
                          type: number
                          example: 0
                is_paused:
                  type: boolean
                  example: false
                is_active:
                  type: boolean
                  example: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      operationId: deleteWorkflowVersion
      tags:
        - Workflow Versions
      summary: Delete a specific version of a workflow
      description: >-
        Delete a specific version of a workflow with `{workflow_id}` in domain
        with `{domain_id}`.
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
        - name: workflow_version_id
          in: path
          required: true
          schema:
            type: string
            example: d5a2c3fa46e1e7f8fb1cf123
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/versions/{workflow_version_id}/audits:
    get:
      security:
        - BearerAuth: []
      operationId: getWorkflowVersionAuditLogs
      tags:
        - Workflow Versions
      summary: Get audit logs for a specific version of a workflow
      description: >-
        Get audit logs for a specific version of a workflow with `{workflow_id}`
        in domain with `{domain_id}`.
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
        - name: workflow_version_id
          in: path
          required: true
          schema:
            type: string
            example: d5a2c3fa46e1e7f8fb1cf123
        - name: resolve_ref
          in: query
          required: false
          schema:
            type: boolean
            default: false
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - type: object
                              properties:
                                entity_type:
                                  type: string
                                  example: table_group
                            - type: object
                              properties:
                                entity_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - properties:
                                modification:
                                  type: string
                                  example: Changed connection type to tpt from jdbc
                            - type: object
                              properties:
                                modified_at:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
                            - type: object
                              properties:
                                modified_by:
                                  type: string
                                  example: 6RkfybTRQQByEey3v
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/versions/{workflow_version_id}/set-active:
    post:
      security:
        - BearerAuth: []
      operationId: setActiveVersion
      tags:
        - Workflow Versions
      summary: Set a specific version of a workflow as active
      description: >-
        Set a specific version of a workflow with `{workflow_id}` in domain with
        `{domain_id}` as active.
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
        - name: workflow_version_id
          in: path
          required: true
          schema:
            type: string
            example: d5a2c3fa46e1e7f8fb1cf123
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/versions/{workflow_version_id}/tasks/{task_id}/variables:
    post:
      security:
        - BearerAuth: []
      operationId: setWorkflowVariableForWorkflow
      tags:
        - Workflow Versions
      summary: Set workflow variables for a task in a specific version of a workflow
      description: >-
        Set workflow variables for a task in a specific version of a workflow
        with `{workflow_id}` in domain with `{domain_id}`.
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
        - name: workflow_version_id
          in: path
          required: true
          schema:
            type: string
            example: d5a2c3fa46e1e7f8fb1cf123
        - name: task_id
          in: path
          required: true
          schema:
            type: string
            example: SI_F50E
      requestBody:
        description: This is the JSON body of request containing workflow variable.
        content:
          application/json:
            schema:
              type: object
              properties:
                key:
                  type: string
                  example: variable_key
                value:
                  type: string
                  example: variable_value
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}/tasks/{task_id}/variables:
    post:
      security:
        - BearerAuth: []
      operationId: setWorkflowVariableForWorkflowRun
      tags:
        - Workflows
      summary: Set workflow variables for a task in a workflow run
      description: >-
        Set workflow variables for a task in a workflow run with
        `{workflow_run_id}` for workflow with `{workflow_id}` in domain with
        `{domain_id}`.
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: workflow_id
          in: path
          required: true
          schema:
            type: string
            example: f132c1fa46e1e7f8fb1cf566
        - name: workflow_run_id
          in: path
          required: true
          schema:
            type: string
            example: af690b4324090bd09da4505d
        - name: task_id
          in: path
          required: true
          schema:
            type: string
            example: SI_F50E
      requestBody:
        description: This is the JSON body of request containing workflow variable.
        content:
          application/json:
            schema:
              type: object
              properties:
                key:
                  type: string
                  example: variable_key
                value:
                  type: string
                  example: variable_value
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /subscribers:
    get:
      security:
        - BearerAuth: []
      operationId: getNonAdminSubscriberList
      tags:
        - Subscribers
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      summary: Get a list of subscribers.
      description: Get a list of subscribers.
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - properties:
                      result:
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                            - type: object
                              allOf:
                                - type: object
                                  properties:
                                    created_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    created_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                                - type: object
                                  properties:
                                    modified_at:
                                      type: string
                                      example: '2019-11-21T12:54:05.875Z'
                                - type: object
                                  properties:
                                    modified_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                            - allOf:
                                - properties:
                                    name:
                                      type: string
                                      example: John Steinbeck
                                    email:
                                      type: string
                                      example: john@steinbeck.org
                                - properties:
                                    slack_details:
                                      properties:
                                        username:
                                          type: string
                                          example: UADWH8P6E
                                        channels:
                                          items:
                                            type: string
                                            example: random-facts
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /subscribers/{subscriber_id}:
    parameters:
      - name: subscriber_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getNonAdminSubscriber
      tags:
        - Subscribers
      summary: Get a subscriber.
      description: Get a subscriber.
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        allOf:
                          - type: object
                            properties:
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          - type: object
                            allOf:
                              - type: object
                                properties:
                                  created_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  created_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                              - type: object
                                properties:
                                  modified_at:
                                    type: string
                                    example: '2019-11-21T12:54:05.875Z'
                              - type: object
                                properties:
                                  modified_by:
                                    type: string
                                    example: 6RkfybTRQQByEey3v
                          - allOf:
                              - properties:
                                  name:
                                    type: string
                                    example: John Steinbeck
                                  email:
                                    type: string
                                    example: john@steinbeck.org
                              - properties:
                                  slack_details:
                                    properties:
                                      username:
                                        type: string
                                        example: UADWH8P6E
                                      channels:
                                        items:
                                          type: string
                                          example: random-facts
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /prodops/jobs:
    post:
      security:
        - BearerAuth: []
      operationId: getJobsForProdOps
      tags:
        - Jobs
      summary: Get the jobs details
      description: >-
        Get the jobs details (This operation is only for `operations_analyst`
        user)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - date_range
              properties:
                date_range:
                  oneOf:
                    - type: object
                      required:
                        - type
                        - unit
                        - value
                      properties:
                        type:
                          type: string
                          example: last
                        unit:
                          type: string
                          enum:
                            - day
                            - hour
                          example: day
                        value:
                          type: integer
                          example: 6
                    - type: object
                      required:
                        - type
                        - start_date
                        - end_date
                      properties:
                        type:
                          type: string
                          example: custom
                        start_date:
                          type: integer
                          example: 1652355912000
                        end_date:
                          type: integer
                          example: 1652355912000
                order_by:
                  type: string
                  enum:
                    - asc
                    - desc
                  minLength: 1
                  example: asc
                  default: desc
                sort_by:
                  type: string
                  example: createdAt
                  minLength: 1
                offset:
                  type: integer
                  example: 5
                  minimum: 0
                limit:
                  type: integer
                  example: 10
                  default: 20
                  minimum: -1
                run_time_hour:
                  type: integer
                  example: 0.2
                  minimum: 0
                  default: Infinity
                domain_ids:
                  type: array
                  items:
                    type: string
                    example: e77850ad5127a2d7dab870ff
                source_ids:
                  type: array
                  items:
                    type: string
                    example: e77850ad5127a2d7dab870ff
                job_types:
                  type: array
                  items:
                    type: string
                    enum:
                      - source_test_connection
                      - fetch_metadata
                      - source_structured_fetch_metadata
                      - source_crawl
                      - source_crawl_chunk_load
                      - source_cdc
                      - dictionary_crawl
                      - source_unstructured_crawl
                      - source_structured_crawl
                      - source_semistructured_crawl
                      - delete_entity
                      - generate_sample
                      - pipeline_metadata
                      - pipeline_build
                      - full_load
                      - cdc
                      - source_merge
                      - source_structured_cdc_merge
                      - source_structured_cdc
                      - source_cdc_merge
                      - source_cdc_restatement
                      - source_semistructured_cdc_merge
                      - source_semistructured_cdc
                      - metadata_cleanup_policy
                      - metadata_backup
                      - export_data
                entity_type:
                  type: string
                  minLength: 1
                  example: source
                  enum:
                    - pipeline
                    - source
                status:
                  type: string
                  minLength: 1
                  items:
                    type: string
                    enum:
                      - pending
                      - aborted
                      - blocked
                      - failed
                      - running
                      - canceled
                      - completed
                      - succeeded
                      - toprocess
                      - terminated
                additional_filters:
                  type: object
                  example:
                    _id:
                      $in:
                        - $oid: 2154859ca27ec87b09f39303
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 8714887c9a8c5bb0b8794811
                            build_id:
                              type: integer
                              example: 2
                            name:
                              type: string
                              example: test_job
                            status:
                              type: string
                              enum:
                                - completed
                                - pending
                                - aborted
                                - blocked
                                - failed
                                - running
                                - canceled
                                - succeeded
                              example: completed
                            percentage:
                              type: integer
                              example: 100
                            type:
                              type: string
                              enum:
                                - source_test_connection
                                - fetch_metadata
                                - source_structured_fetch_metadata
                                - source_crawl
                                - source_crawl_chunk_load
                                - source_cdc
                                - source_unstructured_crawl
                                - source_structured_crawl
                                - source_semistructured_crawl
                                - delete_entity
                                - pipeline_metadata
                                - pipeline_build
                                - pipeline_build_restatement
                                - full_load
                                - cdc
                                - source_merge
                                - source_structured_cdc_merge
                                - source_structured_cdc
                                - source_cdc_merge
                                - source_cdc_restatement
                                - source_semistructured_cdc_merge
                                - source_semistructured_cdc
                                - metadata_cleanup_policy
                            entity_id:
                              type: string
                              example: d2f33c1d424363162692b3bf
                            entity_type:
                              type: string
                              enum:
                                - source
                                - pipeline
                                - workflow
                            sub_entity_id:
                              type: string
                              example: be034607444511f74313be63
                            sub_entity_type:
                              type: string
                              example: table_group
                            duration:
                              type: integer
                              example: 349316
                              description: This is duration of the job.
                            cluster_id:
                              type: string
                              example: j-134jnasdkjaasd
                              description: Extenal clusterId
                            compute_id:
                              type: string
                              example: be034607444511f74313be63
                              description: Infoworks compute cluster id
                            compute_name:
                              type: string
                              example: Default_Persistent_cluster
                              description: Infoworks compute name
                            created_at:
                              type: string
                              format: date-time
                              example: '2020-10-05T04:23:30.339Z'
                            created_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                              description: UserId of user who triggered the job.
                            last_updated:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
                            processed_at:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /prodops/jobs/{job_id}:
    parameters:
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getJobsWithIdForProdOps
      tags:
        - Jobs
      summary: Get the job details with `job_id`
      description: >-
        Get the job details with `job_id` (This operation is only for
        `operations_analyst` user)
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 8714887c9a8c5bb0b8794811
                          build_id:
                            type: integer
                            example: 2
                          name:
                            type: string
                            example: test_job
                          status:
                            type: string
                            enum:
                              - completed
                              - pending
                              - aborted
                              - blocked
                              - failed
                              - running
                              - canceled
                              - succeeded
                            example: completed
                          percentage:
                            type: integer
                            example: 100
                          type:
                            type: string
                            enum:
                              - source_test_connection
                              - fetch_metadata
                              - source_structured_fetch_metadata
                              - source_crawl
                              - source_crawl_chunk_load
                              - source_cdc
                              - source_unstructured_crawl
                              - source_structured_crawl
                              - source_semistructured_crawl
                              - delete_entity
                              - pipeline_metadata
                              - pipeline_build
                              - pipeline_build_restatement
                              - full_load
                              - cdc
                              - source_merge
                              - source_structured_cdc_merge
                              - source_structured_cdc
                              - source_cdc_merge
                              - source_cdc_restatement
                              - source_semistructured_cdc_merge
                              - source_semistructured_cdc
                              - metadata_cleanup_policy
                          entity_id:
                            type: string
                            example: d2f33c1d424363162692b3bf
                          entity_type:
                            type: string
                            enum:
                              - source
                              - pipeline
                              - workflow
                          sub_entity_id:
                            type: string
                            example: be034607444511f74313be63
                          sub_entity_type:
                            type: string
                            example: table_group
                          duration:
                            type: integer
                            example: 349316
                            description: This is duration of the job.
                          cluster_id:
                            type: string
                            example: j-134jnasdkjaasd
                            description: Extenal clusterId
                          compute_id:
                            type: string
                            example: be034607444511f74313be63
                            description: Infoworks compute cluster id
                          compute_name:
                            type: string
                            example: Default_Persistent_cluster
                            description: Infoworks compute name
                          created_at:
                            type: string
                            format: date-time
                            example: '2020-10-05T04:23:30.339Z'
                          created_by:
                            type: string
                            example: 6RkfybTRQQByEey3v
                            description: UserId of user who triggered the job.
                          last_updated:
                            type: string
                            example: '2019-11-21T12:54:05.875Z'
                          processed_at:
                            type: string
                            example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /prodops/jobs/{job_id}/cancel:
    parameters:
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: cancelJobByIdForProdOps
      tags:
        - Jobs
      summary: Cancel the job with `job_id`
      description: >-
        Cancel the job with `job_id` (This operation is only for
        `operations_analyst` user)
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /prodops/jobs/{job_id}/resubmit:
    parameters:
      - name: Content-Type
        in: header
        description: Http content type
        required: true
        schema:
          type: string
          enum:
            - application/json
            - multipart/form-data
            - text/plain
          default: application/json
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Jobs
      summary: Resubmit Failed tables for ingestion
      description: >-
        Resubmit Failed tables for ingestion (This operation is only for
        `operations_analyst` user)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      status:
                        type: string
                        example: success
                      id:
                        type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /prodops/workflow_runs:
    post:
      security:
        - BearerAuth: []
      summary: Get Workflows
      description: >-
        Get Workflows runs (This operation is only for `operations_analyst`
        user)
      tags:
        - Workflows
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - date_range
              properties:
                date_range:
                  oneOf:
                    - type: object
                      required:
                        - type
                        - unit
                        - value
                      properties:
                        type:
                          type: string
                          example: last
                        unit:
                          type: string
                          enum:
                            - day
                            - hour
                          example: day
                        value:
                          type: integer
                          example: 6
                    - type: object
                      required:
                        - type
                        - start_date
                        - end_date
                      properties:
                        type:
                          type: string
                          example: custom
                        start_date:
                          type: integer
                          example: 1652355912000
                        end_date:
                          type: integer
                          example: 1652355912000
                order_by:
                  type: string
                  enum:
                    - asc
                    - desc
                  minLength: 1
                  example: asc
                  default: desc
                sort_by:
                  type: string
                  example: createdAt
                  minLength: 1
                offset:
                  type: integer
                  example: 5
                  minimum: 0
                limit:
                  type: integer
                  example: 10
                  default: 20
                  minimum: -1
                run_time_hour:
                  type: integer
                  example: 0.2
                  minimum: 0
                  default: Infinity
                domain_ids:
                  type: array
                  items:
                    type: string
                    example: e77850ad5127a2d7dab870ff
                source_ids:
                  type: array
                  items:
                    type: string
                    example: e77850ad5127a2d7dab870ff
                entity_type:
                  type: string
                  minLength: 1
                  example: source
                  enum:
                    - pipeline
                    - source
                status:
                  type: string
                  minLength: 1
                  items:
                    type: string
                    enum:
                      - success
                      - failed
                      - pending
                      - running
                additional_filters:
                  type: object
                  example:
                    _id:
                      $in:
                        - $oid: 2154859ca27ec87b09f39303
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        type: object
                        properties:
                          total_count:
                            type: integer
                            minimum: 0
                            description: Total count of workflows
                            example: 10
                          items:
                            type: array
                            items:
                              type: object
                              allOf:
                                - type: object
                                  properties:
                                    created_by:
                                      type: string
                                      example: 6RkfybTRQQByEey3v
                                - properties:
                                    created_by_user_email:
                                      type: string
                                      description: User email
                                      example: admin@infoworks.io
                                    created_by_user_name:
                                      type: string
                                      description: User name
                                      example: Infoworks Admin
                                    domain_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    domain_name:
                                      type: string
                                      description: Domain name
                                    is_paused:
                                      type: boolean
                                      example: false
                                    last_exec_end_time:
                                      type: string
                                      example: '2022-06-14 07:55:57.334000+00:00'
                                    last_exec_start_time:
                                      type: string
                                      example: '2022-06-14 07:55:55.549158+00:00'
                                    last_exec_status:
                                      type: string
                                      example: success
                                    workflow_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    workflow_name:
                                      type: string
                                      example: new_workflow
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /prodops/workflow_runs/{run_id}/jobs:
    parameters:
      - name: run_id
        in: path
        description: Cluster Job Run Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getProdopsJobs
      tags:
        - Workflows
      summary: Retrieves the job details
      description: >-
        Retrieve the details and status of any job. This is applicable only for
        the Operations Analyst user.
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 8714887c9a8c5bb0b8794811
                            build_id:
                              type: integer
                              example: 2
                            name:
                              type: string
                              example: test_job
                            status:
                              type: string
                              enum:
                                - completed
                                - pending
                                - aborted
                                - blocked
                                - failed
                                - running
                                - canceled
                                - succeeded
                              example: completed
                            percentage:
                              type: integer
                              example: 100
                            type:
                              type: string
                              enum:
                                - source_test_connection
                                - fetch_metadata
                                - source_structured_fetch_metadata
                                - source_crawl
                                - source_crawl_chunk_load
                                - source_cdc
                                - source_unstructured_crawl
                                - source_structured_crawl
                                - source_semistructured_crawl
                                - delete_entity
                                - pipeline_metadata
                                - pipeline_build
                                - pipeline_build_restatement
                                - full_load
                                - cdc
                                - source_merge
                                - source_structured_cdc_merge
                                - source_structured_cdc
                                - source_cdc_merge
                                - source_cdc_restatement
                                - source_semistructured_cdc_merge
                                - source_semistructured_cdc
                                - metadata_cleanup_policy
                            entity_id:
                              type: string
                              example: d2f33c1d424363162692b3bf
                            entity_type:
                              type: string
                              enum:
                                - source
                                - pipeline
                                - workflow
                            sub_entity_id:
                              type: string
                              example: be034607444511f74313be63
                            sub_entity_type:
                              type: string
                              example: table_group
                            duration:
                              type: integer
                              example: 349316
                              description: This is duration of the job.
                            cluster_id:
                              type: string
                              example: j-134jnasdkjaasd
                              description: Extenal clusterId
                            compute_id:
                              type: string
                              example: be034607444511f74313be63
                              description: Infoworks compute cluster id
                            compute_name:
                              type: string
                              example: Default_Persistent_cluster
                              description: Infoworks compute name
                            created_at:
                              type: string
                              format: date-time
                              example: '2020-10-05T04:23:30.339Z'
                            created_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                              description: UserId of user who triggered the job.
                            last_updated:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
                            processed_at:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /prodops/workflows/restart:
    post:
      security:
        - BearerAuth: []
      operationId: restartMultipleWorkflowRunsForProdOps
      tags:
        - Workflows
      summary: Restart Multiple Workflows
      description: >-
        Restart Multiple Workflows (This operation is only for
        `operations_analyst` user)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: object
                    properties:
                      workflow_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      run_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      skip_nodes:
                        type: array
                        items:
                          type: string
                          example: DM_AA38
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        type: object
                        properties:
                          ids:
                            type: array
                            items:
                              type: object
                              properties:
                                workflow_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                run_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                error:
                                  type: string
                                  example: Example Error Message
                                  nullable: true
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /prodops/workflows/cancel:
    post:
      security:
        - BearerAuth: []
      operationId: cancelMultipleWorkflowRunsForProdOps
      tags:
        - Workflows
      summary: Cancel Multiple Workflows
      description: >-
        Cancel Multiple Workflows (This operation is only for
        `operations_analyst` user)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: object
                    properties:
                      workflow_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      run_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      skip_nodes:
                        type: array
                        items:
                          type: string
                          example: DM_AA38
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /prodops/locked-entities/{locked_entity_id}:
    parameters:
      - name: locked_entity_id
        in: path
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getLockedEntityForProdOps
      summary: Get a specific currently Locked Entity.
      description: Get a specific currently Locked Entity for Prodops user.
      tags:
        - Locked Entities
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        properties:
                          entity_state:
                            type: string
                            example: crawling
                          entity_type:
                            type: string
                            example: table_group
                          entity_name:
                            type: string
                            example: northwind_group
                          entity_id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                          job_id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                          job_type:
                            type: string
                            example: source_ingest
                          job_status:
                            type: string
                            example: blocked
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /prodops/locked-entities:
    get:
      security:
        - BearerAuth: []
      operationId: getLockedEntitiesForProdOps
      summary: Get All Currently Locked Entities.
      description: Get All Currently Locked Entities.
      tags:
        - Locked Entities
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                properties:
                  total_count:
                    type: integer
                    minimum: 0
                    example: 10
                  result:
                    items:
                      properties:
                        entity_state:
                          type: string
                          example: crawling
                        entity_type:
                          type: string
                          example: table_group
                        entity_name:
                          type: string
                          example: northwind_group
                        entity_id:
                          type: string
                          example: e77850ad5127a2d7dab870ff
                        job_id:
                          type: string
                          example: e77850ad5127a2d7dab870ff
                        job_type:
                          type: string
                          example: source_ingest
                        job_status:
                          type: string
                          example: blocked
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /prodops/unlock-entities:
    post:
      security:
        - BearerAuth: []
      operationId: unlockEntitiesForProdOps
      summary: Unlock Currently Locked Entities.
      description: Unlocks all Currently Locked Entities.
      tags:
        - Locked Entities
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        items:
                          properties:
                            id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                            error:
                              type: string
                              example: Example Error
                              nullable: true
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /prodops/metrics:
    post:
      security:
        - BearerAuth: []
      tags:
        - Metrics
      operationId: MetricsForProdOps
      summary: Fetch the metrics for a given time period
      description: Fetch the metrics for a given time period
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  required:
                    - date_range
                  properties:
                    date_range:
                      type: object
                      required:
                        - type
                        - unit
                        - value
                      properties:
                        type:
                          type: string
                          example: last
                        unit:
                          type: string
                          enum:
                            - day
                            - hour
                          example: day
                        value:
                          type: integer
                          example: 6
                - type: object
                  required:
                    - date_range
                  properties:
                    date_range:
                      type: object
                      required:
                        - type
                        - start_date
                        - end_date
                      properties:
                        type:
                          type: string
                          example: custom
                        start_date:
                          type: integer
                          example: 1652355912000
                        end_date:
                          type: integer
                          example: 1652355912000
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                properties:
                  workflow:
                    type: object
                    properties:
                      success:
                        type: integer
                        example: 1739
                      failed:
                        type: integer
                        example: 1123
                      inprogress:
                        type: integer
                        example: 11
                      pending:
                        type: integer
                        example: 2
                  pipeline:
                    type: object
                    properties:
                      success:
                        type: integer
                        example: 1139
                      failed:
                        type: integer
                        example: 56
                      inprogress:
                        type: integer
                        example: 1
                      pending:
                        type: integer
                        example: 0
                  onboarding:
                    type: object
                    properties:
                      success:
                        type: integer
                        example: 538
                      failed:
                        type: integer
                        example: 676
                      inprogress:
                        type: integer
                        example: 1
                      pending:
                        type: integer
                        example: 1
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /licenses/active/violations:
    get:
      security:
        - BearerAuth: []
      operationId: getActiveLicenseViolations
      tags:
        - License
      summary: Get Active License Violations
      description: Get Active License Violations
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          installation_id:
                            type: string
                            example: 1181f08b-a5d5-4182-9ac3-a10b5c63bbc4
                          license_type:
                            type: string
                            example: enterprise
                          license_start_date:
                            type: string
                            example: '2022-06-07T18:30:00.000Z'
                          license_end_date:
                            type: string
                            example: '2022-08-07T18:30:00.000Z'
                          users:
                            type: object
                            properties:
                              used:
                                type: integer
                                example: 5
                              licensed:
                                type: integer
                                example: 10
                          cores_licensed:
                            type: integer
                            example: 20
                          source_connectors:
                            type: object
                            properties:
                              used:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                      example: rdbms
                                    sub_type:
                                      type: string
                                      example: mysql
                              licensed:
                                type: array
                                items:
                                  type: string
                                  enum:
                                    - source_connector_analytics_datarobot
                                    - source_connector_api_digitalocean
                                    - source_connector_cms_salesforce
                                    - source_connector_file_structured
                                    - source_connector_file_mainframe
                                    - source_connector_file_json
                                    - source_connector_rdbms_teradata
                                    - source_connector_rdbms_oracle
                                    - source_connector_rdbms_sqlserver
                                    - source_connector_rdbms_netezza
                                    - source_connector_rdbms_postgresql
                                    - source_connector_rdbms_mysql
                                    - source_connector_file_parquet
                                    - source_connector_rdbms_db2_as400
                                    - source_connector_rdbms_db2_luw
                                    - source_connector_rdbms_db2_zos
                                    - source_connector_streaming_kafka
                                    - source_connector_streaming_confluent_cloud
                                    - source_connector_metadata_sync_deltatables
                                    - source_connector_metadata_sync_snowflake
                                    - source_connector_metadata_sync_bigquery
                                    - source_connector_metadata_sync_hive
                                    - source_connector_rdbms_access
                                    - source_connector_crm_actcrm
                                    - source_connector_marketing_acton
                                    - >-
                                      source_connector_collaboration_activedirectory
                                    - source_connector_erp_acumatica
                                    - source_connector_marketing_adobeanalytics
                                    - source_connector_collaboration_airtable
                                    - source_connector_collaboration_alfresco
                                    - >-
                                      source_connector_analytics_awsdatamanagement
                                    - source_connector_analytics_amazonathena
                                    - source_connector_nosql_amazondynamodb
                                    - >-
                                      source_connector_ecommerce_amazonmarketplace
                                    - source_connector_analytics_redshift
                                    - source_connector_analytics_apachehive
                                    - source_connector_nosql_apachecouchdb
                                    - source_connector_productivity_asana
                                    - source_connector_finance_authorizenet
                                    - source_connector_finance_avalara
                                    - source_connector_api_aas
                                    - source_connector__azuretables
                                    - >-
                                      source_connector_collaboration_azuredatamanagement
                                    - source_connector_collaboration_azuredevops
                                    - source_connector_rdbms_azuresynapse
                                    - source_connector_ecommerce_basecamp
                                    - source_connector_ecommerce_bigcommerce
                                    - source_connector_marketing_bingads
                                    - source_connector_marketing_bing
                                    - source_connector_finance_financialedgenxt
                                    - source_connector_file_box
                                    - source_connector_productivity_bugzilla
                                    - source_connector_crm_bullhorncrm
                                    - source_connector_nosql_cassandra
                                    - source_connector_collaboration_confluence
                                    - source_connector_nosql_cosmosdb
                                    - source_connector_nosql_couchbase
                                    - source_connector_collaboration_docusign
                                    - source_connector_file_dropbox
                                    - source_connector_crm_d365businesscentral
                                    - source_connector_crm_d365finop
                                    - source_connector_crm_d365sales
                                    - source_connector_crm_dynamicscrm
                                    - source_connector_crm_dynamicsgp
                                    - source_connector_crm_dynamicsnav
                                    - source_connector_marketing_ebay
                                    - source_connector_finance_edgaronline
                                    - source_connector_nosql_elasticsearch
                                    - source_connector_collaboration_email
                                    - source_connector_rdbms_enterprisedb
                                    - source_connector_erp_epicorerp
                                    - source_connector_collaboration_evernote
                                    - source_connector_finance_exactonline
                                    - source_connector_productivity_excel
                                    - source_connector_productivity_excelonline
                                    - >-
                                      source_connector_productivity_excelservices
                                    - source_connector_productivity_exchange
                                    - source_connector_marketing_facebook
                                    - source_connector_marketing_facebookads
                                    - source_connector_ecommerce_fedex
                                    - source_connector_finance_financialforce
                                    - source_connector_finance_freshbooks
                                    - source_connector_crm_freshdesk
                                    - source_connector_storage_ftp
                                    - source_connector_collaboration_github
                                    - source_connector_collaboration_gmail
                                    - source_connector_marketing_googleads
                                    - >-
                                      source_connector_marketing_googleadsmanager
                                    - source_connector_marketing_googleanalytics
                                    - source_connector_edw_googlebigquery
                                    - >-
                                      source_connector_collaboration_googlecalendar
                                    - source_connector_file_googlecloudstorage
                                    - >-
                                      source_connector_collaboration_googlecontacts
                                    - source_connector_file_googledirectory
                                    - source_connector_file_googledrive
                                    - source_connector_api_googlesearch
                                    - source_connector_marketing_googlecm
                                    - source_connector_file_googlesheets
                                    - source_connector_storage_hdfs
                                    - source_connector_api_highrise
                                    - source_connector_api_hpcc
                                    - source_connector_marketing_hubspot
                                    - >-
                                      source_connector_storage_ibmcloudobjectstorage
                                    - source_connector_edw_ibmcloudsqlquery
                                    - source_connector_marketing_instagram
                                    - source_connector_collaboration_jira
                                    - source_connector_productivity_kintone
                                    - source_connector_collaboration_ldap
                                    - source_connector_marketing_linkedin
                                    - source_connector_marketing_linkedinads
                                    - source_connector_ecommerce_magento
                                    - source_connector_marketing_mailchimp
                                    - source_connector_marketing_marketo
                                    - source_connector_nosql_marklogic
                                    - source_connector_collaboration_cds
                                    - source_connector_collaboration_onedrive
                                    - >-
                                      source_connector_collaboration_microsoftplanner
                                    - source_connector_collaboration_msteams
                                    - source_connector_nosql_mongodb
                                    - >-
                                      source_connector_collaboration_microsoftproject
                                    - source_connector_accounting_myob
                                    - source_connector_erp_netsuite
                                    - source_connector_api_odata
                                    - source_connector_api_odoo
                                    - source_connector_collaboration_office365
                                    - source_connector_collaboration_onenote
                                    - source_connector_api_openexchangerates
                                    - source_connector_marketing_oracleeloqua
                                    - source_connector_sales_oraclesalescloud
                                    - source_connector_api_paypal
                                    - source_connector_marketing_pinterest
                                    - source_connector_analytics_presto
                                    - source_connector_api_quandl
                                    - source_connector_accounting_quickbase
                                    - source_connector_finance_quickbooks
                                    - source_connector_finance_quickbooksonline
                                    - source_connector_accounting_quickbookspos
                                    - source_connector_api_reckon
                                    - source_connector_nosql_redis
                                    - source_connector_api_rest
                                    - source_connector_api_rss
                                    - source_connector_erp_sage200
                                    - source_connector_erp_sage300
                                    - source_connector_finance_sage50uk
                                    - source_connector_finance_sageintacct
                                    - >-
                                      source_connector_collaboration_salesforcechatter
                                    - >-
                                      source_connector_analytics_sfeinsteinanalytics
                                    - >-
                                      source_connector_marketing_sfmarketingcloud
                                    - source_connector_crm_salesforcepardot
                                    - source_connector_erp_saperp
                                    - source_connector_erp_sapbusinessone
                                    - source_connector_erp_sapbusinessonedi
                                    - source_connector_erp_sapbydesign
                                    - source_connector_erp_sapconcur
                                    - source_connector_erp_sapfieldglass
                                    - source_connector_analytics_saphana
                                    - source_connector_crm_saphybrisc4c
                                    - source_connector_erp_sapgateway
                                    - source_connector_hr_sapsuccessfactors
                                    - source_connector_marketing_sendgrid
                                    - source_connector_erp_servicenow
                                    - source_connector_productivity_sharepoint
                                    - source_connector_ecommerce_shopify
                                    - source_connector_rdbms_singlestore
                                    - source_connector_collaboration_slack
                                    - source_connector_productivity_smartsheet
                                    - source_connector_marketing_snapchatads
                                    - source_connector_rdbms_snowflake
                                    - source_connector_nosql_splunk
                                    - source_connector_analytics_ssas
                                    - source_connector_api_square
                                    - source_connector_api_streak
                                    - source_connector_api_stripe
                                    - source_connector_crm_sugarcrm
                                    - source_connector_crm_suitecrm
                                    - source_connector_api_surveymonkey
                                    - source_connector_analytics_sybaseiq
                                    - source_connector_accounting_tally
                                    - source_connector_api_taxjar
                                    - source_connector_api_trello
                                    - source_connector_api_tsheets
                                    - source_connector_api_twilio
                                    - source_connector_marketing_twitter
                                    - source_connector_api_twitterads
                                    - source_connector_api_ups
                                    - source_connector_api_usps
                                    - source_connector_crm_veevavault
                                    - source_connector_object_storage_wasabi
                                    - source_connector_ecommerce_wavefinancial
                                    - source_connector_ecommerce_woocommerce
                                    - source_connector_ecommerce_wordpress
                                    - source_connector_analytics_xbase
                                    - source_connector_accounting_xero
                                    - >-
                                      source_connector_productivity_xeroworkflowmax
                                    - source_connector_file_xml
                                    - >-
                                      source_connector_marketing_youtubeanalytics
                                    - source_connector_crm_zendesk
                                    - source_connector_finance_zohobooks
                                    - source_connector_crm_zohocrm
                                    - source_connector_accounting_zuora
                          generic_jdbc_connectors:
                            type: object
                            properties:
                              used:
                                type: integer
                                example: 0
                              licensed:
                                type: integer
                                example: 10
                          transformation_component:
                            type: object
                            properties:
                              is_licensed:
                                type: boolean
                                example: true
                              used:
                                type: integer
                                example: 10
                          environment_types:
                            type: object
                            properties:
                              used:
                                type: array
                                items:
                                  type: string
                                  example: gcp_dataproc
                                  enum:
                                    - azure_databricks
                                    - aws_databricks
                                    - gcp_databricks
                                    - gcp_dataproc
                                    - aws_emr
                                    - snowflake
                                    - bigQuery
                              licensed:
                                type: array
                                items:
                                  type: string
                                  enum:
                                    - azure_databricks
                                    - aws_databricks
                                    - gcp_databricks
                                    - gcp_dataproc
                                    - aws_emr
                                    - snowflake
                                    - bigQuery
                          orchestrator_component:
                            type: object
                            properties:
                              used:
                                type: integer
                                example: 0
                              licensed:
                                type: integer
                                example: 10
                          lock_environment_templates:
                            type: boolean
                            example: false
                          sql_migration:
                            type: boolean
                            example: true
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /licenses/active:
    get:
      security:
        - BearerAuth: []
      operationId: getActiveLicense
      tags:
        - License
      summary: Get Active License
      description: Get Active License
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          installation_id:
                            type: string
                            example: 1181f08b-a5d5-4182-9ac3-a10b5c63bbc4
                          license_type:
                            type: string
                            example: enterprise
                          license_start_date:
                            type: string
                            example: '2022-06-07T18:30:00.000Z'
                          license_end_date:
                            type: string
                            example: '2022-08-07T18:30:00.000Z'
                          features:
                            type: object
                            properties:
                              cores:
                                type: object
                                properties:
                                  value:
                                    type: integer
                                    example: 20
                              users:
                                type: object
                                properties:
                                  value:
                                    type: integer
                                    example: 10
                              generic_jdbc_connectors:
                                type: object
                                properties:
                                  value:
                                    type: integer
                                    example: 10
                              source_connector_cms_salesforce:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_file_structured:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_file_mainframe:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_file_json:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_rdbms_teradata:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_rdbms_oracle:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_rdbms_sqlserver:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_rdbms_netezza:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_rdbms_postgresql:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_rdbms_mysql:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_file_parquet:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_rdbms_db2_as400:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_rdbms_db2_luw:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_rdbms_db2_zos:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_streaming_kafka:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_streaming_confluent_cloud:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_metadata_sync_deltatables:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_metadata_sync_snowflake:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_metadata_sync_bigquery:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_metadata_sync_hive:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_rdbms_access:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_crm_actcrm:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_marketing_acton:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_collaboration_activedirectory:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_erp_acumatica:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_marketing_adobeanalytics:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_collaboration_airtable:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_collaboration_alfresco:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_analytics_awsdatamanagement:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_analytics_amazonathena:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_nosql_amazondynamodb:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_ecommerce_amazonmarketplace:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_analytics_redshift:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_analytics_apachehive:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_nosql_apachecouchdb:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_finance_authorizenet:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_finance_avalara:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_api_aas:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector__azuretables:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_collaboration_azuredatamanagement:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_collaboration_azuredevops:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_rdbms_azuresynapse:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_ecommerce_basecamp:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_ecommerce_bigcommerce:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_marketing_bingads:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_marketing_bing:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_finance_financialedgenxt:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_file_box:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_productivity_bugzilla:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_crm_bullhorncrm:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_nosql_cassandra:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_collaboration_confluence:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_nosql_cosmosdb:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_nosql_couchbase:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_analytics_datarobot:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_api_digitalocean:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_collaboration_docusign:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_file_dropbox:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_crm_d365businesscentral:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_crm_d365finop:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_crm_dynamicscrm:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_crm_dynamicsgp:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_crm_dynamicsnav:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_marketing_ebay:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_finance_edgaronline:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_nosql_elasticsearch:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_collaboration_email:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_rdbms_enterprisedb:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_erp_epicorerp:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_collaboration_evernote:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_finance_exactonline:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_productivity_excel:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_productivity_excelonline:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_productivity_excelservices:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_productivity_exchange:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_marketing_facebook:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_marketing_facebookads:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_ecommerce_fedex:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_finance_financialforce:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_finance_freshbooks:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_crm_freshdesk:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_storage_ftp:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              source_connector_collaboration_github:
                                type: object
                                properties:
                                  value:
                                    type: boolean
                                    example: true
                              supported_environments:
                                type: object
                                properties:
                                  value:
                                    type: array
                                    items:
                                      type: string
                                      enum:
                                        - azure_databricks
                                        - aws_databricks
                                        - gcp_databricks
                                        - gcp_dataproc
                                        - aws_emr
                                        - snowflake
                                        - bigQuery
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /licenses:
    get:
      security:
        - BearerAuth: []
      operationId: getAllLicenses
      tags:
        - License
      summary: Get All Licenses
      description: Get All Licenses
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            installation_id:
                              type: string
                              example: 1181f08b-a5d5-4182-9ac3-a10b5c63bbc4
                            license_type:
                              type: string
                              example: enterprise
                            license_start_date:
                              type: string
                              example: '2022-06-07T18:30:00.000Z'
                            license_end_date:
                              type: string
                              example: '2022-08-07T18:30:00.000Z'
                            features:
                              type: object
                              properties:
                                cores:
                                  type: object
                                  properties:
                                    value:
                                      type: integer
                                      example: 20
                                users:
                                  type: object
                                  properties:
                                    value:
                                      type: integer
                                      example: 10
                                generic_jdbc_connectors:
                                  type: object
                                  properties:
                                    value:
                                      type: integer
                                      example: 10
                                source_connector_cms_salesforce:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_file_structured:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_file_mainframe:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_file_json:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_rdbms_teradata:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_rdbms_oracle:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_rdbms_sqlserver:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_rdbms_netezza:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_rdbms_postgresql:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_rdbms_mysql:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_file_parquet:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_rdbms_db2_as400:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_rdbms_db2_luw:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_rdbms_db2_zos:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_streaming_kafka:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_streaming_confluent_cloud:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_metadata_sync_deltatables:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_metadata_sync_snowflake:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_metadata_sync_bigquery:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_metadata_sync_hive:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_rdbms_access:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_crm_actcrm:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_marketing_acton:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_collaboration_activedirectory:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_erp_acumatica:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_marketing_adobeanalytics:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_collaboration_airtable:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_collaboration_alfresco:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_analytics_awsdatamanagement:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_analytics_amazonathena:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_nosql_amazondynamodb:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_ecommerce_amazonmarketplace:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_analytics_redshift:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_analytics_apachehive:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_nosql_apachecouchdb:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_finance_authorizenet:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_finance_avalara:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_api_aas:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector__azuretables:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_collaboration_azuredatamanagement:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_collaboration_azuredevops:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_rdbms_azuresynapse:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_ecommerce_basecamp:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_ecommerce_bigcommerce:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_marketing_bingads:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_marketing_bing:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_finance_financialedgenxt:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_file_box:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_productivity_bugzilla:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_crm_bullhorncrm:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_nosql_cassandra:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_collaboration_confluence:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_nosql_cosmosdb:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_nosql_couchbase:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_analytics_datarobot:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_api_digitalocean:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_collaboration_docusign:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_file_dropbox:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_crm_d365businesscentral:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_crm_d365finop:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_crm_dynamicscrm:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_crm_dynamicsgp:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_crm_dynamicsnav:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_marketing_ebay:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_finance_edgaronline:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_nosql_elasticsearch:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_collaboration_email:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_rdbms_enterprisedb:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_erp_epicorerp:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_collaboration_evernote:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_finance_exactonline:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_productivity_excel:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_productivity_excelonline:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_productivity_excelservices:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_productivity_exchange:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_marketing_facebook:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_marketing_facebookads:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_ecommerce_fedex:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_finance_financialforce:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_finance_freshbooks:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_crm_freshdesk:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_storage_ftp:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                source_connector_collaboration_github:
                                  type: object
                                  properties:
                                    value:
                                      type: boolean
                                      example: true
                                supported_environments:
                                  type: object
                                  properties:
                                    value:
                                      type: array
                                      items:
                                        type: string
                                        enum:
                                          - azure_databricks
                                          - aws_databricks
                                          - gcp_databricks
                                          - gcp_dataproc
                                          - aws_emr
                                          - snowflake
                                          - bigQuery
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipeline-groups:
    post:
      security:
        - BearerAuth: []
      summary: Create Pipeline Groups
      description: Create Pipeline Groups
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: Content-Type
          in: header
          description: Http content type
          required: true
          schema:
            type: string
            enum:
              - application/json
              - multipart/form-data
              - text/plain
            default: application/json
      tags:
        - Pipeline Groups
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  required:
                    - data_environment
                    - name
                    - snowflake_warehouse
                    - snowflake_profile
                    - compute_cluster
                    - execution_engine
                  properties:
                    name:
                      type: string
                      example: pipeline_group
                    description:
                      type: string
                      example: pipeline_group
                    snowflake_profile:
                      type: string
                      example: profile1
                    snowflake_warehouse:
                      type: string
                      example: warehouse_snowflake
                    data_environment:
                      type: string
                      example: environment_abc
                    compute_cluster:
                      type: string
                      example: environment_persistent
                    batch_engine:
                      type: string
                      example: azure
                    pipelines:
                      type: array
                      items:
                        oneOf:
                          - type: object
                            required:
                              - pipeline_id
                            properties:
                              pipeline_id:
                                type: string
                                example: pipeline_id_1
                              run_active_version:
                                type: boolean
                                example: true
                              execution_order:
                                type: number
                                example: 1
                              version:
                                type: number
                                example: 1
                    custom_tags:
                      type: array
                      items:
                        type: string
                      example:
                        - custom1
                        - custom2
                        - custom3
                    query_tags:
                      type: array
                      items:
                        oneOf:
                          - type: object
                            properties:
                              query_tag_id:
                                type: string
                                example: query_tag_1
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 5fa948e77758f33e0e83ec6b
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    get:
      security:
        - BearerAuth: []
      operationId: getDomainPipelineGroups
      tags:
        - Pipeline Groups
      summary: Get all pipeline groups for domain with `domain_id`
      description: Get all pipeline groups for domain with `domain_id`
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: include_accessible_pipeline_groups
          in: query
          description: >-
            include pipeline groups from accessible domains to current domain as
            well
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            pipeline_group_details:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: 63cd71df9f1c1e258c6e991b
                                environment_id:
                                  type: string
                                  example: 63cd71df9f1c1e258c6e991b
                                domain_id:
                                  type: string
                                  example: 63cd71df9f1c1e258c6e991b
                                name:
                                  type: string
                                  example: pipeline_group_dummy
                                batch_engine:
                                  type: string
                                  example: azure
                                createdAt:
                                  type: string
                                  example: 2023-01-22T17:26:55:895Z
                                createdBy:
                                  type: string
                                  example: 6RkfybTRQQByEey3v
                                modifiedAt:
                                  type: string
                                  example: 2023-01-22T17:26:55:895Z
                                modifiedBy:
                                  type: string
                                  example: 6RkfybTRQQByEey3v
                            additional_env_details:
                              type: object
                              properties:
                                environment:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: 63cd71df9f1c1e258c6e991b
                                    name:
                                      type: string
                                      example: env_azure
                                    compute_engine:
                                      type: string
                                      example: spark
                                    platform:
                                      type: string
                                      example: databricks
                                ephemeral_compute:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                        example: ephemeral_compute
                                      environment_id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                interactive_compute:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                        example: interactive_compute
                                      environment_id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                storage:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      name:
                                        type: string
                                        example: storage
                                      environment_id:
                                        type: string
                                        example: 63cd71df9f1c1e258c6e991b
                                      description:
                                        type: string
                                        example: description for storage
                                      storage_type:
                                        type: string
                                        example: gcs
                                      storage_authentication:
                                        type: object
                                        properties:
                                          authentication_mechanism:
                                            type: string
                                            example: environment_service_credential
                                          scheme:
                                            type: string
                                            example: gs://
                                          bucket_name:
                                            type: string
                                            example: temp-bucket-xxx
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipeline-groups/{pipeline_group_id}:
    parameters:
      - name: pipeline_group_id
        in: path
        description: pipeline_group_id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      summary: Get pipeline group
      description: Get pipeline group
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: Content-Type
          in: header
          description: Http content type
          required: true
          schema:
            type: string
            enum:
              - application/json
              - multipart/form-data
              - text/plain
            default: application/json
      tags:
        - Pipeline Groups
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        oneOf:
                          - allOf:
                              - allOf:
                                  - type: object
                                    properties:
                                      id:
                                        type: string
                                        example: e77850ad5127a2d7dab870ff
                                  - type: object
                                    required:
                                      - data_environment
                                      - name
                                      - snowflake_warehouse
                                      - snowflake_profile
                                      - compute_cluster
                                      - execution_engine
                                    properties:
                                      name:
                                        type: string
                                        example: pipeline_group
                                      description:
                                        type: string
                                        example: pipeline_group
                                      snowflake_profile:
                                        type: string
                                        example: profile1
                                      snowflake_warehouse:
                                        type: string
                                        example: warehouse_snowflake
                                      data_environment:
                                        type: string
                                        example: environment_abc
                                      compute_cluster:
                                        type: string
                                        example: environment_persistent
                                      batch_engine:
                                        type: string
                                        example: azure
                                      pipelines:
                                        type: array
                                        items:
                                          oneOf:
                                            - type: object
                                              required:
                                                - pipeline_id
                                              properties:
                                                pipeline_id:
                                                  type: string
                                                  example: pipeline_id_1
                                                run_active_version:
                                                  type: boolean
                                                  example: true
                                                execution_order:
                                                  type: number
                                                  example: 1
                                                version:
                                                  type: number
                                                  example: 1
                                      custom_tags:
                                        type: array
                                        items:
                                          type: string
                                        example:
                                          - custom1
                                          - custom2
                                          - custom3
                                      query_tags:
                                        type: array
                                        items:
                                          oneOf:
                                            - type: object
                                              properties:
                                                query_tag_id:
                                                  type: string
                                                  example: query_tag_1
                              - type: object
                                allOf:
                                  - type: object
                                    properties:
                                      created_at:
                                        type: string
                                        example: '2019-11-21T12:54:05.875Z'
                                  - type: object
                                    properties:
                                      created_by:
                                        type: string
                                        example: 6RkfybTRQQByEey3v
                                  - type: object
                                    properties:
                                      modified_at:
                                        type: string
                                        example: '2019-11-21T12:54:05.875Z'
                                  - type: object
                                    properties:
                                      modified_by:
                                        type: string
                                        example: 6RkfybTRQQByEey3v
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      summary: Delete Pipeline Group
      description: Delete Pipeline Group
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: Content-Type
          in: header
          description: Http content type
          required: true
          schema:
            type: string
            enum:
              - application/json
              - multipart/form-data
              - text/plain
            default: application/json
      tags:
        - Pipeline Groups
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      summary: Update Pipeline Group
      description: Update Pipeline Group
      operationId: updatePipelineGroup
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: Content-Type
          in: header
          description: Http content type
          required: true
          schema:
            type: string
            enum:
              - application/json
              - multipart/form-data
              - text/plain
            default: application/json
      tags:
        - Pipeline Groups
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  required:
                    - data_environment
                    - name
                    - snowflake_warehouse
                    - snowflake_profile
                    - compute_cluster
                    - execution_engine
                  properties:
                    name:
                      type: string
                      example: pipeline_group
                    description:
                      type: string
                      example: pipeline_group
                    snowflake_profile:
                      type: string
                      example: profile1
                    snowflake_warehouse:
                      type: string
                      example: warehouse_snowflake
                    data_environment:
                      type: string
                      example: environment_abc
                    compute_cluster:
                      type: string
                      example: environment_persistent
                    batch_engine:
                      type: string
                      example: azure
                    pipelines:
                      type: array
                      items:
                        oneOf:
                          - type: object
                            required:
                              - pipeline_id
                            properties:
                              pipeline_id:
                                type: string
                                example: pipeline_id_1
                              run_active_version:
                                type: boolean
                                example: true
                              execution_order:
                                type: number
                                example: 1
                              version:
                                type: number
                                example: 1
                    custom_tags:
                      type: array
                      items:
                        type: string
                      example:
                        - custom1
                        - custom2
                        - custom3
                    query_tags:
                      type: array
                      items:
                        oneOf:
                          - type: object
                            properties:
                              query_tag_id:
                                type: string
                                example: query_tag_1
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 5fa958e77758f33e0e83ec6b
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/accessible-pipeline-groups:
    get:
      security:
        - BearerAuth: []
      summary: Get Accessible pipeline group
      description: Get Accessible pipeline group
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: Content-Type
          in: header
          description: Http content type
          required: true
          schema:
            type: string
            enum:
              - application/json
              - multipart/form-data
              - text/plain
            default: application/json
      tags:
        - Pipeline Groups
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                pipeline_group_id:
                                  type: string
                                  example: ffb38b0cc595cfcd05c54e49
                                name:
                                  type: string
                                  example: test_pipeline
                                domain_name:
                                  type: string
                                  example: test_domain
                                domain_id:
                                  type: string
                                  example: 2568b22469ce46065c11ddb2
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/jobs:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_group_id
        in: path
        description: pipeline_group_id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getPipelineGroupsJobs_1
      tags:
        - Jobs
      summary: Gets List of Pipeline Jobs.
      description: Gets List of Pipeline Jobs.
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: string
        - name: Content-Type
          in: header
          description: Http content type
          required: true
          schema:
            type: string
            enum:
              - application/json
              - multipart/form-data
              - text/plain
            default: application/json
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: List of Jobs
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 63cd71df9f1c1e258c6e991b
                            type:
                              type: string
                              example: pipeline-group-build
                            status:
                              type: string
                              example: completed
                            percentage:
                              type: number
                              example: 100
                            duration:
                              type: number
                              example: 19134
                            created_at:
                              type: string
                              example: '2023-01-22T17:26:55.895Z'
                            created_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                            last_updated:
                              type: string
                              example: '2023-01-22T17:26:55.895Z'
                            processed_at:
                              type: string
                              example: '2023-01-22T17:26:55.895Z'
                            entity_type:
                              type: string
                              example: pipeline-group
                            entity_id:
                              type: string
                              example: 63cd71df9f1c1e258c6e991b
                            triggered_by:
                              type: object
                              properties:
                                parent:
                                  type: string
                                  example: null
                                client_host_id:
                                  type: string
                                  example: null
                                user_id:
                                  type: string
                                  example: null
                            custom_tags:
                              type: array
                              items:
                                type: object
                                properties:
                                  key:
                                    type: string
                                    example: null
                                  value:
                                    type: string
                                    example: null
                            build_started_at:
                              type: string
                              example: null
                            build_ended_at:
                              type: string
                              example: null
                            cluster_id:
                              type: string
                              example: null
                            queue_info:
                              type: string
                              example: null
                            job_list:
                              type: array
                              items:
                                type: string
                                example: null
                            domain_id:
                              type: string
                              example: null
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: submitPipelineGroupJob_2
      tags:
        - Jobs
      summary: Submit Pipeline Job.
      description: Submit Pipeline Job.
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    job_type:
                      type: string
                      enum:
                        - pipeline_group_build
                      example: pipeline_group_build
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Pipeline Build Job submitted successfully
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 5fd5c5f7e27e6d34cf0660b8
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/jobs/{job_id}:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
      - name: pipeline_group_id
        in: path
        description: pipeline_group_id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getPipelineGroupsJobviaJobID
      tags:
        - Jobs
      summary: Gets Pipeline Groups Job.
      description: Gets Pipeline  Groups Job.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 63cd71df9f1c1e258c6e991b
                      type:
                        type: string
                        example: pipeline_group_build
                      status:
                        type: string
                        example: failed
                      percentage:
                        type: number
                      duration:
                        type: number
                        example: 19199
                      created_at:
                        type: string
                        example: '2023-01-22T17:26:55.895Z'
                      created_by:
                        type: string
                        example: 6RkfybTRQQByEey3v
                      last_updated:
                        type: string
                        example: '2023-01-22T17:27:07.487Z'
                      processed_at:
                        type: string
                        example: '2023-01-22T17:26:58.609Z'
                      entity_type:
                        type: string
                        example: pipeline_group
                      entity_id:
                        type: string
                        example: 63cd41299f1c1e258c6e9753
                      triggered_by:
                        type: object
                        properties:
                          parent:
                            type: string
                            example: restapi
                          client_host_id:
                            type: string
                            example: 10.253.8.4
                          user_id:
                            type: string
                            example: 6RkfybTRQQByEey3v
                      custom_tags:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                              example: tag1
                            value:
                              type: string
                              example: val1
                      build_started_at:
                        type: string
                        example: '2023-01-22T17:27:06.356Z'
                      build_ended_at:
                        type: string
                        example: '2023-01-22T17:27:25.555Z'
                      cluster_id:
                        type: string
                        example: 0116-132644-ohcnfchr
                      queue_info:
                        type: string
                      job_list:
                        type: array
                        items:
                          type: string
                          example: 63cd71df9f1c1e258c6e991a
                      domain_id:
                        type: string
                        example: 0451ef3e5fd83029e98ab3c1
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/jobs/{job_id}/pipeline-jobs:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
      - name: pipeline_group_id
        in: path
        description: pipeline_group_id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getJobs_job_id
      tags:
        - Jobs
      summary: Gets Pipeline Groups Job.
      description: Gets Pipeline  Groups Job.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          job_type:
                            type: string
                            enum:
                              - pipeline_group_build
                            example: pipeline_group_build
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/jobs/{job_id}/runs:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
      - name: pipeline_group_id
        in: path
        description: pipeline_group_id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getJobs_runs
      tags:
        - Jobs
      summary: Gets Pipeline Groups Job.
      description: Gets Pipeline  Groups Job.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: 8714887c9a8c5bb0b8794811
                  build_id:
                    type: integer
                    example: 2
                  name:
                    type: string
                    example: test_job
                  status:
                    type: string
                    enum:
                      - completed
                      - pending
                      - aborted
                      - blocked
                      - failed
                      - running
                      - canceled
                      - succeeded
                    example: completed
                  percentage:
                    type: integer
                    example: 100
                  type:
                    type: string
                    enum:
                      - source_test_connection
                      - fetch_metadata
                      - source_structured_fetch_metadata
                      - source_crawl
                      - source_crawl_chunk_load
                      - source_cdc
                      - source_unstructured_crawl
                      - source_structured_crawl
                      - source_semistructured_crawl
                      - delete_entity
                      - pipeline_metadata
                      - pipeline_build
                      - pipeline_build_restatement
                      - full_load
                      - cdc
                      - source_merge
                      - source_structured_cdc_merge
                      - source_structured_cdc
                      - source_cdc_merge
                      - source_cdc_restatement
                      - source_semistructured_cdc_merge
                      - source_semistructured_cdc
                      - metadata_cleanup_policy
                  entity_id:
                    type: string
                    example: d2f33c1d424363162692b3bf
                  entity_type:
                    type: string
                    enum:
                      - source
                      - pipeline
                      - workflow
                  sub_entity_id:
                    type: string
                    example: be034607444511f74313be63
                  sub_entity_type:
                    type: string
                    example: table_group
                  duration:
                    type: integer
                    example: 349316
                    description: This is duration of the job.
                  cluster_id:
                    type: string
                    example: j-134jnasdkjaasd
                    description: Extenal clusterId
                  compute_id:
                    type: string
                    example: be034607444511f74313be63
                    description: Infoworks compute cluster id
                  compute_name:
                    type: string
                    example: Default_Persistent_cluster
                    description: Infoworks compute name
                  created_at:
                    type: string
                    format: date-time
                    example: '2020-10-05T04:23:30.339Z'
                  created_by:
                    type: string
                    example: 6RkfybTRQQByEey3v
                    description: UserId of user who triggered the job.
                  last_updated:
                    type: string
                    example: '2019-11-21T12:54:05.875Z'
                  processed_at:
                    type: string
                    example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/jobs/{job_id}/logs:
    parameters:
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
      - name: num_lines
        in: query
        description: Number of lines of log required
        schema:
          type: integer
          default: 100
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_group_id
        in: path
        description: pipeline_group_id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: get_pipeline_group_job_logs_admin
      tags:
        - Jobs
      summary: Get the job log as text stream with `job_id`
      description: Get the job log as text stream with `job_id`
      responses:
        '200':
          description: Ok.
          content:
            application/octet-stream:
              schema:
                type: string
                example: >
                  [INFO] 2020-12-22 13:44:52,730 [main]
                  io.infoworks.saas.ingestion.commons.utils.HeartBeatJob:24 ::
                  Starting job for 5fe1f854e27e6d67b923f7c4
                   [INFO] 2020-12-22 13:44:52,732 [main] io.infoworks.saas.ingestion.commons.utils.HeartbeatUpdater:30 :: Starting heartbeats thread
                   [INFO] 2020-12-22 13:44:55,876 [main] io.infoworks.saas.ingestion.core.crawl.util.CrawlHelper:523 :: connector path :/opt/infoworks/lib/ingestion/connectors/mysql
                   [INFO] 2020-12-22 13:44:55,876 [main] io.infoworks.saas.ingestion.core.crawl.util.CrawlHelper:526 :: Loading connector specific jars for :mysql
                   [INFO] 2020-12-22 13:44:55,885 [main] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver
                   [INFO] 2020-12-22 13:44:56,330 [main] io.infoworks.saas.ingestion.core.connectors.jdbc.sourcecrawler.AbstractJDBCSourceCrawler:83 :: Granted 1 connections
                   [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.utils.ConnectionPool:24 :: Releasing 1 connections to pool
                   [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.connectors.jdbc.sourcecrawler.AbstractJDBCSourceCrawler:83 :: Granted 1 connections
                   [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.utils.ConnectionPool:24 :: Releasing 1 connections to pool
                   [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.connectors.jdbc.sourcecrawler.AbstractJDBCSourceCrawler:83 :: Granted 1 connections
                   [INFO] 2020-12-22 13:44:56,334 [main] io.infoworks.saas.ingestion.core.utils.ConnectionPool:24 :: Releasing 1 connections to pool
                   [INFO] 2020-12-22 13:44:56,335 [main] io.infoworks.saas.ingestion.core.connectors.jdbc.sourcecrawler.AbstractJDBCSourceCrawler:83 :: Granted 1 connections
                   [INFO] 2020-12-22 13:44:56,335 [main] io.infoworks.saas.ingestion.core.utils.ConnectionPool:24 :: Releasing 1 connections to pool
                   [INFO] 2020-12-22 13:44:56,542 [pool-1-thread-1] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver
                   [INFO] 2020-12-22 13:44:56,546 [pool-1-thread-4] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver
                   [INFO] 2020-12-22 13:44:56,550 [pool-1-thread-2] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver
                   [INFO] 2020-12-22 13:44:56,553 [pool-1-thread-3] io.infoworks.saas.ingestion.core.utils.ClassResolverFactory:214 :: Resolving connector class io.infoworks.connectors.rdbms.mysql.classresolver.ClassResolver
                   [INFO] 2020-12-22 13:44:56,824 [pool-1-thread-4] io.infoworks.platform.metadb.core.sync.store.MongoDBMetaStore:37 :: Initializing mongodb meta store ...
                   [INFO] 2020-12-22 13:44:56,892 [pool-1-thread-4] io.infoworks.platform.common.encryption.AES256:94 :: Attempting to decrypt data using AES-256
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/jobs/{job_id}/logs/download:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: job_id
        in: path
        description: Job Id
        required: true
        schema:
          type: string
      - name: pipeline_group_id
        in: path
        description: pipeline_group_id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Jobs
      summary: Download iw job logs zip for iw_job with job_id
      description: Download iw job logs zip for iw_job with `job_id`
      responses:
        '200':
          description: Ok.
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
                example: log_file_5fe1f854e27e6d67b923f7c4.zip
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/configurations/advance/:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_group_id
        in: path
        description: pipeline_group_id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getJobs_configuration
      tags:
        - Pipeline Groups
      summary: Gets List of Advance Config pipeline group.
      description: Gets List of Advance Config pipeline group.
      parameters:
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      results:
                        type: array
                        items:
                          allOf:
                            - type: object
                              required:
                                - key
                                - value
                              properties:
                                key:
                                  type: string
                                  example: keyName
                                value:
                                  type: string
                                  example: keyValue
                                description:
                                  type: string
                                  example: description about this configuration
                                is_active:
                                  type: boolean
                                  example: false
                                entity_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                entity_type:
                                  type: string
                                  example: source
                            - properties:
                                parent_entity_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                parent_entity_type:
                                  type: string
                                  example: pipeline-group
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      operationId: advancedConfiguration_post
      tags:
        - Pipeline Groups
      summary: Advance Configuration Pipeline Group.
      description: Advance Configuration Pipeline Group.
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  required:
                    - key
                    - value
                  properties:
                    key:
                      type: string
                      example: keyName
                    value:
                      type: string
                      example: keyValue
                    description:
                      type: string
                      example: description about this configuration
                    is_active:
                      type: boolean
                      example: false
                    entity_id:
                      type: string
                      example: e77850ad5127a2d7dab870ff
                    entity_type:
                      type: string
                      example: source
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Successfully added Advance configuration
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 5fd5c5f7e27e6d34cf0660b8
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipeline-groups/{pipeline_group_id}/configurations/advance/{key}:
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: path
        required: true
        schema:
          type: string
          example: SPARK_ML_LIB
      - name: pipeline_group_id
        in: path
        description: pipeline_group_id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Pipeline Groups
      summary: Get Pipelinegroup advance configuration
      description: Get Pipelinegroup advance configuration
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        allOf:
                          - properties:
                              key:
                                type: string
                                example: keyName
                              value:
                                type: string
                                example: keyValue
                              description:
                                type: string
                                example: description about this configuration
                              isActive:
                                type: boolean
                                example: true
                              entityId:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              entityType:
                                type: string
                                example: pipeline-group
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    put:
      security:
        - BearerAuth: []
      tags:
        - Pipeline Groups
      summary: update advance configuration for a pipeline group
      description: update advance configuration for a pipeline group
      requestBody:
        description: Table ingestion Configuration
        content:
          application/json:
            schema:
              type: array
              required:
                - key
                - value
                - entityId
                - entityType
              items:
                type: object
                properties:
                  key:
                    type: string
                    example: a
                  value:
                    type: string
                    example: aa
                  entityId:
                    type: string
                    example: 5a6ea49ce4b00234296e37d5
                  entityType:
                    type: string
                    example: pipeline
                    enum:
                      - table
                      - pipeline
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully updated advance configuration
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      tags:
        - Pipeline Groups
      summary: Delete advance configuration for a pipeline group
      description: Delete advance configuration for a pipeline group
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully deleted advance configuration
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/manage-secrets/cache:
    delete:
      security:
        - BearerAuth: []
      summary: Clear cache for service authentication or secret
      description: Clear cache in infoworks services for authentication or secrets value.
      operationId: clearSecretsCache
      tags:
        - Service Authentication Cache
      parameters:
        - in: query
          name: secret_id
          schema:
            type: string
            default: null
          description: Optional secret id to clear cache, clear all if not passed
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/manage-secrets/service-auth:
    get:
      security:
        - BearerAuth: []
      summary: List service authentication mechanisms
      description: Get a list of service authentication mechanisms
      operationId: listServiceAuth
      tags:
        - Service Authentication
      parameters:
        - in: query
          name: resolve_ref
          schema:
            type: boolean
            default: null
          description: Fetch username of user who created and last modified the resource
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: List of service authentication mechanisms.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              allOf:
                                - type: object
                                  properties:
                                    id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                - type: object
                                  properties:
                                    name:
                                      type: string
                                      example: azure service auth
                                    description:
                                      type: string
                                      example: azure service auth
                                    service_type:
                                      type: string
                                      enum:
                                        - azure
                                      example: azure
                                    authentication_type:
                                      type: string
                                      enum:
                                        - service_principal
                                        - managed_identity
                                      example: service_principal
                                    entity_type:
                                      type: string
                                      enum:
                                        - secret_store_authentication
                                        - authentication_service
                                      example: secret_store_authentication
                                    authentication_properties:
                                      type: object
                                      properties:
                                        subscription_id:
                                          type: string
                                          example: 7cbb31b2-b2eb-4dad-8a3e-b100b4e2b841
                                        client_id:
                                          type: string
                                          example: 6b2db80a-1f27-4305-b960-b5019cc57a67
                                        object_id:
                                          type: string
                                          example: 22a2d391-977b-4844-aa0f-dea4d8875f7b
                                        tenant_id:
                                          type: string
                                          example: ebfb8680-a5f0-429d-979e-189595b7560f
                                - type: object
                                  allOf:
                                    - type: object
                                      properties:
                                        created_at:
                                          type: string
                                          example: '2019-11-21T12:54:05.875Z'
                                    - type: object
                                      properties:
                                        created_by:
                                          type: string
                                          example: 6RkfybTRQQByEey3v
                                    - type: object
                                      properties:
                                        modified_at:
                                          type: string
                                          example: '2019-11-21T12:54:05.875Z'
                                    - type: object
                                      properties:
                                        modified_by:
                                          type: string
                                          example: 6RkfybTRQQByEey3v
                                - type: object
                                  properties:
                                    created_by_username:
                                      type: string
                                      description: >-
                                        This field is returned only when
                                        `resolve_ref` is set to `true`
                                      example: Infoworks Admin
                                    modified_by_username:
                                      type: string
                                      description: >-
                                        This field is returned only when
                                        `resolve_ref` is set to `true`
                                      example: Infoworks Admin
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      summary: Create a service authentication mechanism
      description: Create a service authentication mechanism
      operationId: createServiceAuth
      tags:
        - Service Authentication
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - allOf:
                    - type: object
                      required:
                        - name
                        - service_type
                      properties:
                        name:
                          type: string
                          example: azure service auth
                        description:
                          type: string
                          example: azure service auth
                        service_type:
                          type: string
                          enum:
                            - azure
                          example: azure
                    - type: object
                      required:
                        - authentication_type
                        - authentication_properties
                      properties:
                        authentication_type:
                          type: string
                          enum:
                            - service_principal
                            - managed_identity
                          example: service_principal
                        entity_type:
                          type: string
                          enum:
                            - secret_store_authentication
                            - authentication_service
                          example: secret_store_authentication
                        authentication_properties:
                          type: object
                          required:
                            - subscription_id
                            - object_id
                            - client_id
                            - tenant_id
                            - client_secret
                          properties:
                            subscription_id:
                              type: string
                              example: 7cbb31b2-b2eb-4dad-8a3e-b100b4e2b841
                            client_id:
                              type: string
                              example: 6b2db80a-1f27-4305-b960-b5019cc57a67
                            object_id:
                              type: string
                              example: 22a2d391-977b-4844-aa0f-dea4d8875f7b
                            tenant_id:
                              type: string
                              example: ebfb8680-a5f0-429d-979e-189595b7560f
                            client_secret:
                              type: object
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                    - infoworks_managed
                                    - secret_store
                                  example: infoworks_managed
                                password:
                                  type: string
                                  example: clientSecretEnteredByUserOrSecretId
                - allOf:
                    - type: object
                      required:
                        - name
                        - service_type
                      properties:
                        name:
                          type: string
                          example: azure service auth
                        description:
                          type: string
                          example: azure service auth
                        service_type:
                          type: string
                          enum:
                            - azure
                          example: azure
                    - type: object
                      required:
                        - authentication_type
                      properties:
                        authentication_type:
                          type: string
                          enum:
                            - managed_identity
                          example: managed_identity
                        entity_type:
                          type: string
                          enum:
                            - secret_store_authentication
                            - authentication_service
                          example: secret_store_authentication
                        authentication_properties:
                          type: object
                          properties:
                            client_id:
                              type: string
                              example: 6b2db80a-1f27-4305-b960-b5019cc57a67
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 5fa948e77758f33e0e83ec6b
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/manage-secrets/service-auth/{service_auth_id}:
    parameters:
      - name: service_auth_id
        in: path
        description: Service Authentication Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      summary: Get service authentication mechanism
      description: Get service authentication mechanism
      operationId: getServiceAuth
      tags:
        - Service Authentication
      parameters:
        - in: query
          name: resolve_ref
          schema:
            type: boolean
            default: null
          description: Fetch username of user who created and last modified the resource
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        oneOf:
                          - type: object
                            allOf:
                              - type: object
                                properties:
                                  id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                              - type: object
                                properties:
                                  name:
                                    type: string
                                    example: azure service auth
                                  description:
                                    type: string
                                    example: azure service auth
                                  service_type:
                                    type: string
                                    enum:
                                      - azure
                                    example: azure
                                  authentication_type:
                                    type: string
                                    enum:
                                      - service_principal
                                      - managed_identity
                                    example: service_principal
                                  entity_type:
                                    type: string
                                    enum:
                                      - secret_store_authentication
                                      - authentication_service
                                    example: secret_store_authentication
                                  authentication_properties:
                                    type: object
                                    properties:
                                      subscription_id:
                                        type: string
                                        example: 7cbb31b2-b2eb-4dad-8a3e-b100b4e2b841
                                      client_id:
                                        type: string
                                        example: 6b2db80a-1f27-4305-b960-b5019cc57a67
                                      object_id:
                                        type: string
                                        example: 22a2d391-977b-4844-aa0f-dea4d8875f7b
                                      tenant_id:
                                        type: string
                                        example: ebfb8680-a5f0-429d-979e-189595b7560f
                              - type: object
                                allOf:
                                  - type: object
                                    properties:
                                      created_at:
                                        type: string
                                        example: '2019-11-21T12:54:05.875Z'
                                  - type: object
                                    properties:
                                      created_by:
                                        type: string
                                        example: 6RkfybTRQQByEey3v
                                  - type: object
                                    properties:
                                      modified_at:
                                        type: string
                                        example: '2019-11-21T12:54:05.875Z'
                                  - type: object
                                    properties:
                                      modified_by:
                                        type: string
                                        example: 6RkfybTRQQByEey3v
                              - type: object
                                properties:
                                  created_by_username:
                                    type: string
                                    description: >-
                                      This field is returned only when
                                      `resolve_ref` is set to `true`
                                    example: Infoworks Admin
                                  modified_by_username:
                                    type: string
                                    description: >-
                                      This field is returned only when
                                      `resolve_ref` is set to `true`
                                    example: Infoworks Admin
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      summary: Update service authentication mechanism
      description: Update service authentication mechanism
      operationId: updateServiceAuth
      tags:
        - Service Authentication
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  type: string
                  example: azure service auth 1
                description:
                  type: string
                  example: azure service auth 1
                service_type:
                  type: string
                  enum:
                    - azure
                  example: azure
                authentication_type:
                  type: string
                  enum:
                    - managed_identity
                    - service_principal
                  example: service_principal
                entity_type:
                  type: string
                  enum:
                    - secret_store_authentication
                    - authentication_service
                  example: secret_store_authentication
                authentication_properties:
                  type: object
                  properties:
                    subscription_id:
                      type: string
                      example: 7cbb31b2-b2eb-4dad-8a3e-b100b4e2b841
                    client_id:
                      type: string
                      example: 6b2db80a-1f27-4305-b960-b5019cc57a67
                    object_id:
                      type: string
                      example: 22a2d391-977b-4844-aa0f-dea4d8875f7b
                    tenant_id:
                      type: string
                      example: ebfb8680-a5f0-429d-979e-189595b7560f
                    client_secret:
                      type: string
                      example: kjansdkjabndkabfjkasklkasndlk=
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 5fa948e77758f33e0e83ec6b
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      summary: Delete service authentication mechanism
      description: Delete service authentication mechanism
      operationId: deleteServiceAuth
      tags:
        - Service Authentication
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/manage-secrets/secret-store:
    get:
      security:
        - BearerAuth: []
      summary: List secret stores
      description: List secret stores
      operationId: listSecretStores
      tags:
        - Secret Store
      parameters:
        - in: query
          name: resolve_ref
          schema:
            type: boolean
            default: null
          description: Fetch username of user who created and last modified the resource
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          oneOf:
                            - allOf:
                                - allOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                    - type: object
                                      properties:
                                        name:
                                          type: string
                                          example: key_vault1
                                        description:
                                          type: string
                                          example: this is default key vault
                                        service_type:
                                          type: string
                                          enum:
                                            - azure
                                          example: azure
                                - type: object
                                  properties:
                                    key_vault_uri:
                                      type: string
                                      example: https://azure.com/keyvault/a13794
                                    service_authentication:
                                      type: string
                                      example: 5fad09437758f33e0e83ef8e
                                - type: object
                                  allOf:
                                    - type: object
                                      properties:
                                        created_at:
                                          type: string
                                          example: '2019-11-21T12:54:05.875Z'
                                    - type: object
                                      properties:
                                        created_by:
                                          type: string
                                          example: 6RkfybTRQQByEey3v
                                    - type: object
                                      properties:
                                        modified_at:
                                          type: string
                                          example: '2019-11-21T12:54:05.875Z'
                                    - type: object
                                      properties:
                                        modified_by:
                                          type: string
                                          example: 6RkfybTRQQByEey3v
                                - type: object
                                  properties:
                                    created_by_username:
                                      type: string
                                      description: >-
                                        This field is returned only when
                                        `resolve_ref` is set to `true`
                                      example: Infoworks Admin
                                    modified_by_username:
                                      type: string
                                      description: >-
                                        This field is returned only when
                                        `resolve_ref` is set to `true`
                                      example: Infoworks Admin
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      summary: Create secret store
      description: Create secret store
      operationId: createSecretStore
      tags:
        - Secret Store
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - allOf:
                    - type: object
                      required:
                        - name
                        - service_type
                      properties:
                        name:
                          type: string
                          example: azure key vault
                        description:
                          type: string
                          example: azure key vault
                        service_type:
                          type: string
                          enum:
                            - azure
                          example: azure
                    - type: object
                      required:
                        - key_vault_uri
                        - service_authentication
                      properties:
                        key_vault_uri:
                          type: string
                          example: https://azure.com/keyvault/a13794
                        service_authentication:
                          type: string
                          example: 5fad09437758f33e0e83ef8e
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 5fa948e77758f33e0e83ec6b
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/manage-secrets/secret-store/{secret_store_id}:
    parameters:
      - name: secret_store_id
        in: path
        description: secret store id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      summary: Get secret store
      description: Get secret store
      operationId: getSecretStore
      tags:
        - Secret Store
      parameters:
        - in: query
          name: resolve_ref
          schema:
            type: boolean
            default: null
          description: Fetch username of user who created and last modified the resource
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        oneOf:
                          - allOf:
                              - allOf:
                                  - type: object
                                    properties:
                                      id:
                                        type: string
                                        example: e77850ad5127a2d7dab870ff
                                  - type: object
                                    properties:
                                      name:
                                        type: string
                                        example: key_vault1
                                      description:
                                        type: string
                                        example: this is default key vault
                                      service_type:
                                        type: string
                                        enum:
                                          - azure
                                        example: azure
                              - type: object
                                properties:
                                  key_vault_uri:
                                    type: string
                                    example: https://azure.com/keyvault/a13794
                                  service_authentication:
                                    type: string
                                    example: 5fad09437758f33e0e83ef8e
                              - type: object
                                allOf:
                                  - type: object
                                    properties:
                                      created_at:
                                        type: string
                                        example: '2019-11-21T12:54:05.875Z'
                                  - type: object
                                    properties:
                                      created_by:
                                        type: string
                                        example: 6RkfybTRQQByEey3v
                                  - type: object
                                    properties:
                                      modified_at:
                                        type: string
                                        example: '2019-11-21T12:54:05.875Z'
                                  - type: object
                                    properties:
                                      modified_by:
                                        type: string
                                        example: 6RkfybTRQQByEey3v
                              - type: object
                                properties:
                                  created_by_username:
                                    type: string
                                    description: >-
                                      This field is returned only when
                                      `resolve_ref` is set to `true`
                                    example: Infoworks Admin
                                  modified_by_username:
                                    type: string
                                    description: >-
                                      This field is returned only when
                                      `resolve_ref` is set to `true`
                                    example: Infoworks Admin
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      summary: Update secret store
      description: Update secret store
      operationId: updateSecretStore
      tags:
        - Secret Store
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  type: string
                  example: azure key vault 1
                description:
                  type: string
                  example: azure key vault 1
                service_type:
                  type: string
                  enum:
                    - azure
                  example: azure
                key_vault_uri:
                  type: string
                  example: https://azure.com/keyvault/a3467
                service_authentication:
                  type: string
                  example: 5fad09437758f33e0e83ef8e
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 5fa948e77758f33e0e83ec6b
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      summary: Delete secret store
      description: Delete secret store
      operationId: deleteSecretStore
      tags:
        - Secret Store
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/manage-secrets/secrets:
    get:
      security:
        - BearerAuth: []
      summary: List secrets
      description: Retrieves the list of secrets that are accessible to the user.
      operationId: listSecrets
      tags:
        - Secrets
      parameters:
        - in: query
          name: resolve_ref
          schema:
            type: boolean
            default: null
          description: Fetch username of user who created and last modified the resource
        - in: query
          name: fetch_all
          description: >
            Use this parameter to retrieve the list of all secrets. (Only for
            admin user).
          schema:
            type: boolean
            default: null
          required: false
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          oneOf:
                            - allOf:
                                - allOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                    - type: object
                                      properties:
                                        name:
                                          type: string
                                          example: azure key vault
                                        description:
                                          type: string
                                          example: azure key vault
                                        secret_store:
                                          type: string
                                          example: 5fad039f7758f33e0e83ef82
                                        secret_store_service_type:
                                          type: string
                                          description: >-
                                            This field is returned only when
                                            `resolve_ref` is set to `true`
                                          enum:
                                            - azure
                                          example: azure
                                        domains:
                                          type: array
                                          description: >-
                                            Ids of domains in which the secret is
                                            accessible.
                                          items:
                                            type: string
                                            example: 5fad039f7758f33e0e83ef82
                                - type: object
                                  properties:
                                    secret_name:
                                      type: string
                                      example: akbkadljasnl
                                - type: object
                                  allOf:
                                    - type: object
                                      properties:
                                        created_at:
                                          type: string
                                          example: '2019-11-21T12:54:05.875Z'
                                    - type: object
                                      properties:
                                        created_by:
                                          type: string
                                          example: 6RkfybTRQQByEey3v
                                    - type: object
                                      properties:
                                        modified_at:
                                          type: string
                                          example: '2019-11-21T12:54:05.875Z'
                                    - type: object
                                      properties:
                                        modified_by:
                                          type: string
                                          example: 6RkfybTRQQByEey3v
                                - type: object
                                  properties:
                                    created_by_username:
                                      type: string
                                      description: >-
                                        This field is returned only when
                                        `resolve_ref` is set to `true`
                                      example: Infoworks Admin
                                    modified_by_username:
                                      type: string
                                      description: >-
                                        This field is returned only when
                                        `resolve_ref` is set to `true`
                                      example: Infoworks Admin
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      summary: Create secret
      description: Create secret
      operationId: createSecret
      tags:
        - Secrets
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - allOf:
                    - type: object
                      required:
                        - name
                        - secret_store
                      properties:
                        name:
                          type: string
                          example: azure key vault
                        description:
                          type: string
                          example: azure key vault
                        secret_store:
                          type: string
                          example: 5fad039f7758f33e0e83ef82
                        domains:
                          type: array
                          description: Ids of domains in which the secret is accessible.
                          items:
                            type: string
                            example: 5fad039f7758f33e0e83ef82
                    - type: object
                      required:
                        - secret_name
                      properties:
                        secret_name:
                          type: string
                          example: db_password
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 5fa948e77758f33e0e83ec6b
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/manage-secrets/secrets/{secret_id}:
    parameters:
      - name: secret_id
        in: path
        description: secret id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      summary: Get secret
      description: Get secret
      operationId: getSecret
      tags:
        - Secrets
      parameters:
        - in: query
          name: resolve_ref
          schema:
            type: boolean
            default: null
          description: Fetch username of user who created and last modified the resource
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        oneOf:
                          - allOf:
                              - allOf:
                                  - type: object
                                    properties:
                                      id:
                                        type: string
                                        example: e77850ad5127a2d7dab870ff
                                  - type: object
                                    properties:
                                      name:
                                        type: string
                                        example: azure key vault
                                      description:
                                        type: string
                                        example: azure key vault
                                      secret_store:
                                        type: string
                                        example: 5fad039f7758f33e0e83ef82
                                      secret_store_service_type:
                                        type: string
                                        description: >-
                                          This field is returned only when
                                          `resolve_ref` is set to `true`
                                        enum:
                                          - azure
                                        example: azure
                                      domains:
                                        type: array
                                        description: >-
                                          Ids of domains in which the secret is
                                          accessible.
                                        items:
                                          type: string
                                          example: 5fad039f7758f33e0e83ef82
                              - type: object
                                properties:
                                  secret_name:
                                    type: string
                                    example: akbkadljasnl
                              - type: object
                                allOf:
                                  - type: object
                                    properties:
                                      created_at:
                                        type: string
                                        example: '2019-11-21T12:54:05.875Z'
                                  - type: object
                                    properties:
                                      created_by:
                                        type: string
                                        example: 6RkfybTRQQByEey3v
                                  - type: object
                                    properties:
                                      modified_at:
                                        type: string
                                        example: '2019-11-21T12:54:05.875Z'
                                  - type: object
                                    properties:
                                      modified_by:
                                        type: string
                                        example: 6RkfybTRQQByEey3v
                              - type: object
                                properties:
                                  created_by_username:
                                    type: string
                                    description: >-
                                      This field is returned only when
                                      `resolve_ref` is set to `true`
                                    example: Infoworks Admin
                                  modified_by_username:
                                    type: string
                                    description: >-
                                      This field is returned only when
                                      `resolve_ref` is set to `true`
                                    example: Infoworks Admin
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      summary: Update secret
      description: Update secret
      operationId: updateSecret
      tags:
        - Secrets
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  type: string
                  example: azure key vault 1
                description:
                  type: string
                  example: azure key vault 1
                secret_store:
                  type: string
                  example: 5fad039f7758f33e0e83ef82
                secret_name:
                  type: string
                  example: db_password_1
                domains:
                  type: array
                  description: Ids of domains in which the secret is accessible.
                  items:
                    type: string
                    example: 5fad039f7758f33e0e83ef82
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 5fa948e77758f33e0e83ec6b
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      summary: Delete secret
      description: Delete secret
      operationId: deleteSecret
      tags:
        - Secrets
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /event-notifications:
    get:
      security:
        - BearerAuth: []
      summary: List event notifications
      description: Get a list of event notification
      operationId: listEventNotifications
      tags:
        - Event Notifications
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: List of event notifications.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: 63db8ce15d11392288d7f03b
                                event:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: 63db8ce15d11392288d7f03b
                                    event_type:
                                      type: string
                                      example: NOTIFICATION
                                    created_at:
                                      type: string
                                      example: 1675332833722
                                    created_by:
                                      type: string
                                      example: 63db8c395d11392288d7efc6
                                    message:
                                      type: object
                                    event_entity:
                                      type: object
                                created_at:
                                  type: string
                                  example: 1675332833741
                                created_by:
                                  type: string
                                  example: Artifact Consumer
                                entities_affected:
                                  type: array
                                  items:
                                    type: string
                                    example: ''
                                read:
                                  type: boolean
                                  example: true/false
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /engagement/data/aggregate:
    get:
      security:
        - BearerAuth: []
      summary: Aggregate details
      description: Get Aggregate datails
      operationId: listServiceAuth
      tags:
        - Engagement Metrics
      parameters:
        - in: query
          name: interval_type
          schema:
            type: string
            default: null
        - in: query
          name: duration
          schema:
            type: string
            default: null
        - in: query
          name: timestamp
          schema:
            type: string
            default: null
        - in: query
          name: top_limit
          schema:
            type: string
            default: null
        - in: query
          name: jobs_count_limit
          schema:
            type: string
            default: null
          description: Fetch username of user who created and last modified the resource
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: List of Data Aggregate.
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      message:
                        type: string
                      result:
                        type: object
                        properties:
                          duration:
                            type: number
                          last_updated_at:
                            type: number
                          interval_type:
                            type: string
                          interval_type_user:
                            type: string
                          top_limit:
                            type: number
                          jobs_count_limit:
                            type: number
                          top_level_artifacts:
                            type: object
                            properties:
                              total_data_sources:
                                type: number
                              total_pipelines:
                                type: number
                              total_workflows:
                                type: number
                              total_cubes:
                                type: number
                              total_data_models:
                                type: number
                          trends:
                            type: object
                            properties:
                              result:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    table_count:
                                      type: number
                                    data_model_count:
                                      type: number
                                    jobs_executed_count:
                                      type: number
                                    start_interval_value:
                                      type: number
                                    end_interval_value:
                                      type: number
                              total_data_model_count:
                                type: number
                              total_jobs_executed_count:
                                type: number
                              total_table_count:
                                type: number
                          records:
                            type: array
                            items:
                              type: object
                              properties:
                                records_processed:
                                  type: number
                                records_ingested:
                                  type: number
                                start_interval_value:
                                  type: number
                                end_interval_value:
                                  type: number
                          recent_jobs:
                            type: array
                            items:
                              type: object
                          top_data_sources:
                            type: array
                            items:
                              type: object
                          top_pipelines:
                            type: array
                            items:
                              type: object
                          top_workflows:
                            type: array
                            items:
                              type: object
                          top_active_domains:
                            type: array
                            items:
                              type: object
                          total_top_level_artifacts:
                            type: object
                            properties:
                              total_data_sources:
                                type: number
                              total_pipelines:
                                type: number
                              total_workflows:
                                type: number
                              total_cubes:
                                type: number
                              total_data_models:
                                type: number
                          active_users:
                            type: array
                            items:
                              type: object
                              properties:
                                user_count:
                                  type: number
                                start_interval_value:
                                  type: number
                                end_interval_value:
                                  type: number
                          active_users_by_role:
                            type: array
                            items:
                              type: object
                              properties:
                                values:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      user_role:
                                        type: string
                                      user_count:
                                        type: number
                                start_interval_value:
                                  type: number
                                end_interval_value:
                                  type: number
                          users_count_by_role:
                            type: array
                            items:
                              type: object
                              properties:
                                user_role:
                                  type: string
                                total_user_count:
                                  type: number
                                active_user_count:
                                  type: number
                          data_sources:
                            type: array
                            items:
                              type: object
                              properties:
                                start_interval_value:
                                  type: number
                                end_interval_value:
                                  type: number
                          jobs:
                            type: array
                            items:
                              type: object
                              properties:
                                start_interval_value:
                                  type: number
                                end_interval_value:
                                  type: number
                                values:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      job_type:
                                        type: string
                                      count:
                                        type: number
                          pipeline_count:
                            type: array
                            items:
                              type: object
                              properties:
                                start_interval_value:
                                  type: number
                                end_interval_value:
                                  type: number
                                count:
                                  type: number
                          workflow_count:
                            type: array
                            items:
                              type: object
                              properties:
                                start_interval_value:
                                  type: number
                                end_interval_value:
                                  type: number
                                count:
                                  type: number
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /engagement/jobs/job-status:
    get:
      security:
        - BearerAuth: []
      summary: List Job status
      description: Get Job status
      operationId: list job-status
      tags:
        - Engagement Metrics
      parameters:
        - in: query
          name: interval_type
          schema:
            type: string
            default: null
        - in: query
          name: duration
          schema:
            type: string
            default: null
        - in: query
          name: timestamp
          schema:
            type: string
            default: null
        - in: query
          name: limit
          schema:
            type: string
            default: null
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: List of Job Status Response.
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      message:
                        type: string
                      result:
                        type: object
                        properties:
                          duration:
                            type: number
                          result:
                            type: array
                            items:
                              type: object
                              properties:
                                status:
                                  type: string
                                entity_id:
                                  type: string
                                entity_type:
                                  type: string
                                entity_name:
                                  type: string
                                job_id:
                                  type: string
                                job_type:
                                  type: string
                                start_time:
                                  type: number
                                end_time:
                                  type: number
                                executed_by:
                                  type: string
                          last_updated_at:
                            type: number
                          interval_type:
                            type: string
                          interval_type_user:
                            type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /data-catalog/data-models:
    get:
      security:
        - BearerAuth: []
      summary: Data Model Details
      description: Get Data Model details
      tags:
        - Data Catalog
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: List of Data Models.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        allOf:
                          - type: object
                            properties:
                              table_name:
                                type: string
                                example: oracle_source
                              table_id:
                                type: string
                                example: 63c79645373d557660c43823
                              domain_name:
                                type: string
                                example: rdbms_domain
                              domain_id:
                                type: string
                                example: 63c79645373d557660c43823
                              data_environment:
                                type: object
                                properties:
                                  environment_details:
                                    type: object
                                    properties:
                                      environment:
                                        type: object
                                        properties:
                                          id:
                                            type: string
                                            example: 63cd71df9f1c1e258c6e991b
                                          name:
                                            type: string
                                            example: env_azure
                                          compute_engine:
                                            type: string
                                            example: spark
                                          platform:
                                            type: string
                                            example: databricks
                                          description:
                                            type: string
                                            example: Test Description
                                      ephemeral_compute:
                                        type: array
                                        items:
                                          type: object
                                          properties:
                                            name:
                                              type: string
                                              example: ephemeral_compute
                                            environment_id:
                                              type: string
                                              example: 63cd71df9f1c1e258c6e991b
                                            id:
                                              type: string
                                              example: 63cd71df9f1c1e258c6e991b
                                      interactive_compute:
                                        type: array
                                        items:
                                          type: object
                                          properties:
                                            name:
                                              type: string
                                              example: interactive_compute
                                            environment_id:
                                              type: string
                                              example: 63cd71df9f1c1e258c6e991b
                                            id:
                                              type: string
                                              example: 63cd71df9f1c1e258c6e991b
                                      storage:
                                        type: array
                                        items:
                                          type: object
                                          properties:
                                            id:
                                              type: string
                                              example: 63cd71df9f1c1e258c6e991b
                                            name:
                                              type: string
                                              example: storage
                                            environment_id:
                                              type: string
                                              example: 63cd71df9f1c1e258c6e991b
                              data_environment_id:
                                type: string
                                example: 63c79645373d557660c43823
                              status:
                                type: string
                                example: ready
                              created_at:
                                type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /data-catalog/favorites:
    get:
      security:
        - BearerAuth: []
      summary: Favorite Entity Details
      description: Get Favorite Entity details
      tags:
        - Data Catalog
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: List of Favorite Entities.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        allOf:
                          - type: object
                            properties:
                              name:
                                type: string
                                example: fav_source
                              id:
                                type: string
                                example: 45c79645373d557660c43823
                              source_type:
                                type: string
                                example: kafka
                              source_schema:
                                type: string
                                example: APEX_040000
                              is_ingested:
                                type: boolean
                                example: true
                              data_environment:
                                type: object
                                properties:
                                  environment_details:
                                    type: object
                                    properties:
                                      environment:
                                        type: object
                                        properties:
                                          id:
                                            type: string
                                            example: 63cd71df9f1c1e258c6e991b
                                          name:
                                            type: string
                                            example: env_azure
                                          compute_engine:
                                            type: string
                                            example: spark
                                          platform:
                                            type: string
                                            example: databricks
                                          description:
                                            type: string
                                            example: Test Description
                                      ephemeral_compute:
                                        type: array
                                        items:
                                          type: object
                                          properties:
                                            name:
                                              type: string
                                              example: ephemeral_compute
                                            environment_id:
                                              type: string
                                              example: 63cd71df9f1c1e258c6e991b
                                            id:
                                              type: string
                                              example: 63cd71df9f1c1e258c6e991b
                                      interactive_compute:
                                        type: array
                                        items:
                                          type: object
                                          properties:
                                            name:
                                              type: string
                                              example: interactive_compute
                                            environment_id:
                                              type: string
                                              example: 63cd71df9f1c1e258c6e991b
                                            id:
                                              type: string
                                              example: 63cd71df9f1c1e258c6e991b
                                      storage:
                                        type: array
                                        items:
                                          type: object
                                          properties:
                                            id:
                                              type: string
                                              example: 63cd71df9f1c1e258c6e991b
                                            name:
                                              type: string
                                              example: storage
                                            environment_id:
                                              type: string
                                              example: 63cd71df9f1c1e258c6e991b
                              data_environment_id:
                                type: string
                              status:
                                type: string
                                example: ready
                              created_at:
                                type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /pipeline-version-locks/pipelines/{pipeline_id}:
    get:
      security:
        - BearerAuth: []
      operationId: getPipelineVersionLocks
      tags:
        - Pipeline Version Locks
      summary: Get all pipeline version locks for pipeline with pipeline_id
      description: Get all pipeline version locks for pipeline with pipeline_id
      parameters:
        - name: pipeline_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: array
                    items:
                      type: object
                      properties:
                        result:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: 63cd71df9f1c1e258c6e991b
                              pipeline_id:
                                type: string
                                example: 63cd71df9f1c1e258c6e991b
                              pipeline_version_id:
                                type: string
                                example: 63cd71df9f1c1e258c6e991b
                              version_name:
                                type: string
                                example: 1
                              modified_at:
                                type: string
                                example: 2023-01-22T17:26:55:895Z
                              created_by:
                                type: string
                                example: 6RkfybTRQQByEey3v
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /pipeline-version-locks/pipelines/{pipeline_id}/pipeline-version/{pipeline_version_id}:
    get:
      security:
        - BearerAuth: []
      operationId: getPipelineVersionLock
      tags:
        - Pipeline Version Lock
      summary: >-
        Put pipeline version lock for pipeline with pipeline_id and pipeline
        version with pipeline_version_id
      description: >-
        Put pipeline version lock for pipeline with pipeline_id and pipeline
        version with pipeline_version_id
      parameters:
        - name: pipeline_id
          in: path
          required: true
          schema:
            type: string
        - name: pipeline_version_id
          in: path
          description: pipeline_version_id as HEX string
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 63cd71df9f1c1e258c6e991b
                            pipeline_id:
                              type: string
                              example: 63cd71df9f1c1e258c6e991b
                            pipeline_version_id:
                              type: string
                              example: 63cd71df9f1c1e258c6e991b
                            version_name:
                              type: string
                              example: 1
                            modified_at:
                              type: string
                              example: 2023-01-22T17:26:55:895Z
                            created_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    put:
      security:
        - BearerAuth: []
      operationId: putPipelineVersionLock
      tags:
        - Pipeline Version Lock
      summary: >-
        Put pipeline version lock for pipeline with pipeline_id and pipeline
        version with pipeline_version_id
      description: >-
        Put pipeline version lock for pipeline with pipeline_id and pipeline
        version with pipeline_version_id
      parameters:
        - name: pipeline_id
          in: path
          required: true
          schema:
            type: string
        - name: pipeline_version_id
          in: path
          description: pipeline_version_id as HEX string
          required: true
          schema:
            type: string
      requestBody:
        description: Pipeline version lock configuration
        content:
          application/json:
            schema:
              type: object
              properties:
                version_name:
                  type: string
                  example: 1
        required: true
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 5fa948e77758f33e0e83ec6b
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      operationId: deletePipelineVersionLock
      tags:
        - Pipeline Version Lock
      summary: Delete pipeline version lock for pipeline_id, pipeline_version_id
      description: Delete pipeline version lock pipeline_id, pipeline_version_id
      parameters:
        - name: pipeline_id
          in: path
          required: true
          schema:
            type: string
        - name: pipeline_version_id
          in: path
          description: pipeline_version_id as HEX string
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /pipeline-version-locks/pipelines/{pipeline_id}/pipeline-version/{pipeline_version_id}/is-locked:
    get:
      security:
        - BearerAuth: []
      operationId: getPipelineVersionLockStatus
      tags:
        - Pipeline Version Lock
      summary: get pipeline version lock status for pipeline_id, pipeline_version_id
      description: get pipeline version lock status for pipeline_id, pipeline_version_id
      parameters:
        - name: pipeline_id
          in: path
          required: true
          schema:
            type: string
        - name: pipeline_version_id
          in: path
          description: pipeline_version_id as HEX string
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          version_locked:
                            type: boolean
                            example: true
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/jobflows:
    get:
      operationId: listJobflows
      summary: List Jobflows
      description: Retrieves the list of all jobflows
      tags:
        - Jobflows
      security:
        - BearerAuth: []
      parameters:
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 653f60e6be4fada0100078e7
                            name:
                              type: string
                              example: Source_Crawl_Jobflow
                            custom_tags:
                              type: array
                              items: {}
                            description:
                              type: string
                              example: Jobflow for Source Crawl
                            created_at:
                              type: string
                              format: date-time
                              example: '2023-10-30T07:51:21.468Z'
                            created_by:
                              type: string
                              example: System
                            modified_at:
                              type: string
                              format: date-time
                              example: '2024-01-12T10:00:21.468Z'
                            jobflow_graph:
                              type: object
                              required:
                                - tasks
                                - edges
                              properties:
                                tasks:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      is_group:
                                        type: boolean
                                      task_type:
                                        type: string
                                      task_id:
                                        type: string
                                      title:
                                        type: string
                                      description:
                                        type: string
                                      task_properties:
                                        type: object
                                        properties:
                                          job_type:
                                            type: string
                                          entity_type:
                                            type: string
                                        required:
                                          - job_type
                                          - entity_type
                                      run_properties:
                                        type: object
                                        properties:
                                          trigger_rule:
                                            type: string
                                        required:
                                          - trigger_rule
                                edges:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      from_task:
                                        type: string
                                      to_task:
                                        type: string
                                      category:
                                        type: string
                          example:
                            id: 653f60e6be4fada0100078e7
                            name: Source_Crawl_Jobflow
                            custom_tags: []
                            description: Jobflow with Dummy Node
                            created_at: '2023-10-30T07:51:21.468Z'
                            created_by: System
                            modified_at: '2024-01-12T10:00:21.468Z'
                            jobflow_graph:
                              tasks:
                                - is_group: false
                                  task_type: entity_state_update
                                  task_id: BS_A8E9
                                  title: Entity state update
                                  description: ''
                                  task_properties:
                                    job_type: source_crawl
                                    entity_type: source
                                  run_properties:
                                    trigger_rule: all_success
                                - is_group: false
                                  task_type: ingestion_pre_execute_task
                                  task_id: BS_A8E5
                                  title: Pre-ingestion-ob
                                  description: ''
                                  task_properties:
                                    job_type: source_crawl
                                    entity_type: source
                                  run_properties:
                                    trigger_rule: all_success
                                - is_group: false
                                  task_type: job_submission_task
                                  task_id: BS_A8E6
                                  title: Job submission task
                                  description: ''
                                  task_properties:
                                    job_type: source_crawl
                                    entity_type: source
                                  run_properties:
                                    trigger_rule: all_success
                                - is_group: false
                                  task_type: job_cleanup_task
                                  task_id: BS_A8E8
                                  title: Job cleanup tasks
                                  description: ''
                                  task_properties: {}
                                  run_properties:
                                    trigger_rule: all_done
                              edges:
                                - from_task: BS_A8E9
                                  to_task: BS_A8E5
                                  category: LINK
                                - from_task: BS_A8E5
                                  to_task: BS_A8E6
                                  category: LINK
                                - from_task: BS_A8E6
                                  to_task: BS_A8E8
                                  category: LINK
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /admin/jobflows/{jobflow_id_or_name}:
    parameters:
      - name: jobflow_id_or_name
        in: path
        description: Job Flow Id or Name
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      summary: Get Jobflow
      description: Retrieves the jobflow details
      operationId: getJobflow
      tags:
        - Jobflows
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: string
                                example: 653f60e6be4fada0100078e7
                              name:
                                type: string
                                example: Source_Crawl_Jobflow
                              custom_tags:
                                type: array
                                items: {}
                              description:
                                type: string
                                example: Jobflow for Source Crawl
                              created_at:
                                type: string
                                format: date-time
                                example: '2023-10-30T07:51:21.468Z'
                              created_by:
                                type: string
                                example: System
                              modified_at:
                                type: string
                                format: date-time
                                example: '2024-01-12T10:00:21.468Z'
                              jobflow_graph:
                                type: object
                                required:
                                  - tasks
                                  - edges
                                properties:
                                  tasks:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        is_group:
                                          type: boolean
                                        task_type:
                                          type: string
                                        task_id:
                                          type: string
                                        title:
                                          type: string
                                        description:
                                          type: string
                                        task_properties:
                                          type: object
                                          properties:
                                            job_type:
                                              type: string
                                            entity_type:
                                              type: string
                                          required:
                                            - job_type
                                            - entity_type
                                        run_properties:
                                          type: object
                                          properties:
                                            trigger_rule:
                                              type: string
                                          required:
                                            - trigger_rule
                                  edges:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        from_task:
                                          type: string
                                        to_task:
                                          type: string
                                        category:
                                          type: string
                            example:
                              id: 653f60e6be4fada0100078e7
                              name: Source_Crawl_Jobflow
                              custom_tags: []
                              description: Jobflow with Dummy Node
                              created_at: '2023-10-30T07:51:21.468Z'
                              created_by: System
                              modified_at: '2024-01-12T10:00:21.468Z'
                              jobflow_graph:
                                tasks:
                                  - is_group: false
                                    task_type: entity_state_update
                                    task_id: BS_A8E9
                                    title: Entity state update
                                    description: ''
                                    task_properties:
                                      job_type: source_crawl
                                      entity_type: source
                                    run_properties:
                                      trigger_rule: all_success
                                  - is_group: false
                                    task_type: ingestion_pre_execute_task
                                    task_id: BS_A8E5
                                    title: Pre-ingestion-ob
                                    description: ''
                                    task_properties:
                                      job_type: source_crawl
                                      entity_type: source
                                    run_properties:
                                      trigger_rule: all_success
                                  - is_group: false
                                    task_type: job_submission_task
                                    task_id: BS_A8E6
                                    title: Job submission task
                                    description: ''
                                    task_properties:
                                      job_type: source_crawl
                                      entity_type: source
                                    run_properties:
                                      trigger_rule: all_success
                                  - is_group: false
                                    task_type: job_cleanup_task
                                    task_id: BS_A8E8
                                    title: Job cleanup tasks
                                    description: ''
                                    task_properties: {}
                                    run_properties:
                                      trigger_rule: all_done
                                edges:
                                  - from_task: BS_A8E9
                                    to_task: BS_A8E5
                                    category: LINK
                                  - from_task: BS_A8E5
                                    to_task: BS_A8E6
                                    category: LINK
                                  - from_task: BS_A8E6
                                    to_task: BS_A8E8
                                    category: LINK
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /billing/daily-metering-data:
    get:
      security:
        - BearerAuth: []
      operationId: getDailyMeteringData
      tags:
        - Billing Metering Data
      summary: Get daily billing metering data
      description: Get daily billing metering data
      parameters:
        - name: start-date
          in: query
          description: Starting Date - timestamp
          schema:
            type: number
            example: 1578681000000
        - name: end-date
          in: query
          description: Ending Date - timestamp
          schema:
            type: number
            example: 1674325800000
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: d57850ad5127a2d7dab870ff
                            usage_date:
                              type: integer
                              example: 1664389800000
                            average_cores:
                              type: integer
                              example: 0.5678520833333334
                            cumulative_average_cores:
                              type: integer
                              example: 0.3436064583333336
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /billing/billing-information:
    get:
      security:
        - BearerAuth: []
      operationId: getBillingInformation
      tags:
        - Billing Metering Data
      summary: Get billing information
      description: Get billing information
      parameters:
        - name: start-date
          in: query
          description: Starting Date - timestamp
          schema:
            type: number
            example: 1578681000000
        - name: end-date
          in: query
          description: Ending Date - timestamp
          schema:
            type: number
            example: 1674325800000
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: countInfoForJobs
                                jobs_count:
                                  type: integer
                                  example: 1566
                                total_time_count:
                                  type: integer
                                  example: 97.118
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: coresInfoForJobs
                                average_core_hour_sum:
                                  type: integer
                                  example: 9.500529166666668
                                average_core_hours:
                                  type: integer
                                  example: 0.00866046414463689
                                core_hour_count:
                                  type: integer
                                  example: 228.01270000000005
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: coresInfoForInteractiveCluster
                                average_core_hours:
                                  type: integer
                                  example: 24.968809442418717
                                core_hour_count:
                                  type: integer
                                  example: 657378.815
                                total_time_count:
                                  type: integer
                                  example: 59488.582
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /billing/snowflake-daily-metering-data:
    get:
      security:
        - BearerAuth: []
      operationId: getSnowflakeDailyMeteringData
      tags:
        - Billing Metering Data
      summary: Get snowflake daily billing metering data
      description: Get snowflake daily billing metering data
      parameters:
        - name: start-date
          in: query
          description: Starting Date - timestamp
          schema:
            type: number
            example: 1578681000000
        - name: end-date
          in: query
          description: Ending Date - timestamp
          schema:
            type: number
            example: 1674325800000
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: d57850ad5127a2d7dab870ff
                            usage_date:
                              type: integer
                              example: 1664389800000
                            average_daily_credits:
                              type: integer
                              example: 0
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /billing/snowflake-billing-information:
    get:
      security:
        - BearerAuth: []
      operationId: getSnowflakeBillingInformation
      tags:
        - Billing Metering Data
      summary: Get snowflake billing information
      description: Get snowflake billing information
      parameters:
        - name: start-date
          in: query
          description: Starting Date - timestamp
          schema:
            type: number
            example: 1578681000000
        - name: end-date
          in: query
          description: Ending Date - timestamp
          schema:
            type: number
            example: 1674325800000
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: creditsInfoForSnowflakeCompute
                          average_daily_credits_count:
                            type: integer
                            example: 18.531307911941045
                          total_credits_count:
                            type: integer
                            example: 20328.844779399325
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /billing/metrics-config:
    get:
      security:
        - BearerAuth: []
      operationId: getMetricsConfig
      tags:
        - Billing Metering Data
      summary: Get metrics configuration
      description: Get metrics configuration
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 63f5c47a16740b2791c3168e
                          last_updated_at:
                            type: integer
                            example: 1675346570657
                          last_billed_at:
                            type: integer
                            example: 1675348203544
                          last_cluster_billed_at:
                            type: integer
                            example: 1671544831251
                          last_updated_workflow:
                            type: integer
                            example: 1675337497773
                          last_billed_workflow:
                            type: integer
                            example: 1675339205459
                          last_core_updated_at:
                            type: integer
                            example: 1670956200000
                          last_updated_db_cleanup_at:
                            type: integer
                            example: 1670869800000
                          last_refreshed_at:
                            type: integer
                            example: 1677051007969
                          last_snowflake_metric_updated_at:
                            type: integer
                            example: 1670956200000
                          last_snowflake_metric_queried_at:
                            type: integer
                            example: 1677051007970
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /billing/workflow-run-metering-variables/{workflow_run_id}:
    parameters:
      - name: workflow_run_id
        in: path
        required: true
        description: Workflow Run Id
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      operationId: getWorkflowRunMeteringVariables
      tags:
        - Workflow Run Metering variables
      summary: Get workflow run metering variables
      description: Get workflow run metering variables
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          total_time:
                            type: number
                            example: 18.531307911941045
                          total_cores:
                            type: number
                            example: 12
                          core_hour:
                            type: number
                            example: 0.00356
                          actual_core_hour_used:
                            type: number
                            example: 0.00356
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /billing/refresh-billing-details:
    post:
      security:
        - BearerAuth: []
      operationId: refreshBillingDetails
      tags:
        - Billing Metering Data
      summary: Submit a request for refreshing billing details
      description: Submit a request for refreshing billing details
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /data-connections-subtypes:
    get:
      security:
        - BearerAuth: []
      operationId: getDataConnectionsListForAllSubtypes
      tags:
        - Target Data Connections
      summary: Get the Data Connections for each subtype
      description: Get the Data Connections for each subtype
      parameters:
        - name: environment_platform
          in: query
          description: Specify environment platform
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                  - properties:
                      result:
                        type: object
                        properties:
                          BIGQUERY:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: 45559a53b44f57dfbc8be3d3
                                name:
                                  type: string
                                  example: test_connection
                          SNOWFLAKE:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: 45559a53b44f57dfbc8be3d3
                                name:
                                  type: string
                                  example: test_connection
                          COSMOS_DB:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: 45559a53b44f57dfbc8be3d3
                                name:
                                  type: string
                                  example: test_connection
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /validate-entity-names:
    get:
      security:
        - BearerAuth: []
      tags:
        - Validation
      parameters:
        - name: target_type
          in: query
          description: Specify Target Type
          schema:
            type: string
        - name: entity_names
          in: query
          description: Entity names object should be passed as JSON string
          schema:
            type: string
      summary: Use to validate entity names
      description: Use to validate entity names
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
  /server-time:
    get:
      security:
        - BearerAuth: []
      summary: Get Server Time
      description: Get Server Timezone Offset
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      current_date:
                        type: string
                      timezone_offset:
                        type: number
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /server-timezone:
    get:
      security:
        - BearerAuth: []
      tags:
        - Getting Server Timezone
      summary: Use to get server timezone
      description: Use to get server timezone
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                  - properties:
                      result:
                        type: string
                        example: IST
  /verify-refresh-token:
    put:
      security:
        - BearerAuth: []
      operationId: verifyRefreshToken
      tags:
        - Validation
      summary: Used to verify users refresh token
      description: Used to verify users refresh token
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                scheduler_username:
                  type: string
                scheduler_auth_token:
                  type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /config-migration-file-upload:
    put:
      security:
        - BearerAuth: []
      parameters:
        - name: entity_type
          in: query
          required: true
          schema:
            type: string
            enum:
              - source
              - workflow
              - pipeline
            example: source
        - name: entity_id
          in: query
          required: true
          schema:
            type: string
            example: 596d9322132d468367c7f074
      operationId: configMigrationFileUpload
      tags:
        - Configurations
      summary: Upload config migration json file
      description: Upload config migration json file
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
              example: config_migration_63eb5b2840dd4c5a46a05ab6.json
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /general-configs:
    get:
      security:
        - BearerAuth: []
      summary: >-
        Get values for 4 general configs(login_contact_info, login_welcome_text,
        login_message, is_quiescent_enabled)
      description: >-
        Get values for 4 general configs(login_contact_info, login_welcome_text,
        login_message, is_quiescent_enabled)
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          is_quiescent_enabled:
                            type: string
                            example: false
                          login_contact_info:
                            type: string
                          login_welcome_text:
                            type: string
                          login_message:
                            type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /get-cdata-connectors:
    get:
      security:
        - BearerAuth: []
      parameters:
        - required: true
          name: source_type
          in: query
          description: Source Type name
          schema:
            type: string
        - name: source_sub_type
          required: true
          in: query
          description: Source Sub Type name
          schema:
            type: string
        - name: driver_name
          required: true
          in: query
          description: Driver name
          schema:
            type: string
      summary: Get connection parameters for generic jdbc sources
      description: Get connection parameters for generic jdbc sources
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          properties:
                            type: array
                            items:
                              type: object
                              properties:
                                description:
                                  type: string
                                  example: >-
                                    The handle assigned to the Act! Premium
                                    Cloud account.
                                isRequired:
                                  type: boolean
                                  example: true
                                name:
                                  type: string
                                  example: ActCloudName
                                value:
                                  type: string
                                  example: abc
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /schedules/entity-schedule:
    get:
      security:
        - BearerAuth: []
      operationId: getEntityScheduleDetails
      tags:
        - Scheduling Information
      summary: Get a particular entity schedule details
      description: Get a particular entity schedule details
      parameters:
        - name: entity_id
          in: query
          description: Entity ID
          required: false
          schema:
            type: string
        - name: entity_type
          in: query
          description: Entity Type
          required: true
          schema:
            type: string
            enum:
              - workflow
              - metadata_cleanup_policy
              - system_config
              - table_group
              - table
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          type: object
                          properties:
                            entity_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                            schedule_type:
                              type: string
                              enum:
                                - workflow-build
                                - metadata_cleanup
                                - mongo-backup
                                - table-group-cdc
                                - table
                            schedule_username:
                              type: string
                              example: admin@infoworks.io
                            schedule_details:
                              allOf:
                                - oneOf:
                                    - type: object
                                      title: Generic Schedule
                                      description: Generic schedule object
                                      required:
                                        - schedule_status
                                      properties:
                                        schedule_status:
                                          type: string
                                          enum:
                                            - enabled
                                            - disabled
                                          example: enabled
                                        start_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: Start time should be after current time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        start_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 14
                                        start_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 35
                                        repeat_interval_unit:
                                          type: string
                                          enum:
                                            - NEVER
                                            - MINUTE
                                            - HOUR
                                            - DAY
                                            - WEEK
                                            - MONTH
                                          default: NEVER
                                          example: MONTH
                                        repeat_interval_measure:
                                          type: integer
                                          minimum: 1
                                        repeat_on_last_day:
                                          type: boolean
                                          description: >
                                            `specified_days` must be provided if
                                            `repeat_on_last_day` is false.
                                            Applicable for
                                            `repeat_interval_unit=MONTH`
                                          default: false
                                        specified_days:
                                          type: array
                                          description: >
                                            Applicable when `repeat_interval_unit`
                                            is `WEEK` or `MONTH`.
                                          minLength: 1
                                          items:
                                            type: integer
                                            minimum: 0
                                            maximum: 31
                                          example:
                                            - 1
                                            - 17
                                            - 31
                                        ends:
                                          type: boolean
                                          description: >
                                            `end_date`, `end_hour`, `end_min` must
                                            be provided if `ends` is `true`.
                                          default: false
                                          example: true
                                        end_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: End time should be after start time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        end_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 15
                                        end_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 38
                                        is_custom_job:
                                          type: boolean
                                          description: >
                                            `custom_job_details` must be provided
                                            when `is_custom_job=true`. Applicable
                                            when `repeat_interval_unit` is `DAY`,
                                            `WEEK` or `MONTH`.
                                          default: false
                                        custom_job_details:
                                          type: object
                                          required:
                                            - starts_daily_at
                                            - ends_daily_at
                                            - repeat_interval_measure
                                            - repeat_interval_unit
                                          properties:
                                            starts_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '12:40'
                                            ends_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '17:45'
                                            repeat_interval_measure:
                                              type: integer
                                              minimum: 1
                                              example: 10
                                            repeat_interval_unit:
                                              type: string
                                              enum:
                                                - MINUTE
                                                - HOUR
                                    - type: object
                                      title: By Minute Schedule
                                      description: Schedule job by minutes
                                      required:
                                        - schedule_status
                                        - start_date
                                        - start_hour
                                        - start_min
                                        - repeat_interval_unit
                                        - repeat_interval_measure
                                      properties:
                                        schedule_status:
                                          type: string
                                          enum:
                                            - enabled
                                          example: enabled
                                        start_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: Start time should be after current time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        start_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 14
                                        start_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 35
                                        repeat_interval_unit:
                                          type: string
                                          enum:
                                            - MINUTE
                                        repeat_interval_measure:
                                          type: integer
                                          minimum: 1
                                        ends:
                                          type: boolean
                                          description: >
                                            `end_date`, `end_hour`, `end_min` must
                                            be provided if `ends` is `true`.
                                          default: false
                                          example: true
                                        end_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: End time should be after start time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        end_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 15
                                        end_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 55
                                    - type: object
                                      title: Hourly Schedule
                                      description: Schedule job hourly
                                      required:
                                        - schedule_status
                                        - start_date
                                        - start_hour
                                        - start_min
                                        - repeat_interval_unit
                                        - repeat_interval_measure
                                      properties:
                                        schedule_status:
                                          type: string
                                          enum:
                                            - enabled
                                          example: enabled
                                        start_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: Start time should be after current time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        start_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 14
                                        start_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 35
                                        repeat_interval_unit:
                                          type: string
                                          enum:
                                            - HOUR
                                        repeat_interval_measure:
                                          type: integer
                                          minimum: 1
                                        ends:
                                          type: boolean
                                          description: >
                                            `end_date`, `end_hour`, `end_min` must
                                            be provided if `ends` is `true`.
                                          default: false
                                          example: true
                                        end_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: End time should be after start time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        end_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 15
                                        end_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 55
                                    - type: object
                                      title: Daily Schedule
                                      description: Schedule job daily
                                      required:
                                        - schedule_status
                                        - start_date
                                        - start_hour
                                        - start_min
                                        - repeat_interval_unit
                                        - repeat_interval_measure
                                      properties:
                                        schedule_status:
                                          type: string
                                          enum:
                                            - enabled
                                          example: enabled
                                        start_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: Start time should be after current time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        start_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 14
                                        start_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 35
                                        repeat_interval_unit:
                                          type: string
                                          enum:
                                            - DAY
                                        repeat_interval_measure:
                                          type: integer
                                          minimum: 1
                                        ends:
                                          type: boolean
                                          description: >
                                            `end_date`, `end_hour`, `end_min` must
                                            be provided if `ends` is `true`.
                                          default: false
                                          example: true
                                        end_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: End time should be after start time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        end_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 15
                                        end_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 55
                                        is_custom_job:
                                          type: boolean
                                          description: >
                                            `custom_job_details` must be provided
                                            when `is_custom_job=true`
                                          default: false
                                          example: true
                                        custom_job_details:
                                          type: object
                                          required:
                                            - starts_daily_at
                                            - ends_daily_at
                                            - repeat_interval_measure
                                            - repeat_interval_unit
                                          properties:
                                            starts_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '12:40'
                                            ends_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '17:45'
                                            repeat_interval_measure:
                                              type: integer
                                              minimum: 1
                                              example: 10
                                            repeat_interval_unit:
                                              type: string
                                              enum:
                                                - MINUTE
                                                - HOUR
                                    - type: object
                                      title: Weekly Schedule
                                      description: Schedule job weekly
                                      required:
                                        - schedule_status
                                        - start_date
                                        - start_hour
                                        - start_min
                                        - repeat_interval_unit
                                        - repeat_interval_measure
                                        - specified_days
                                      properties:
                                        schedule_status:
                                          type: string
                                          enum:
                                            - enabled
                                          example: enabled
                                        start_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: Start time should be after current time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        start_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 14
                                        start_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 35
                                        repeat_interval_unit:
                                          type: string
                                          enum:
                                            - WEEK
                                        repeat_interval_measure:
                                          type: integer
                                          minimum: 1
                                        specified_days:
                                          type: array
                                          minLength: 1
                                          items:
                                            type: integer
                                            minimum: 0
                                            maximum: 6
                                          example:
                                            - 0
                                            - 2
                                            - 5
                                        ends:
                                          type: boolean
                                          description: >
                                            `end_date`, `end_hour`, `end_min` must
                                            be provided if `ends` is `true`.
                                          default: false
                                          example: true
                                        end_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: End time should be after start time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        end_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 15
                                        end_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 55
                                        is_custom_job:
                                          type: boolean
                                          description: >
                                            `custom_job_details` must be provided
                                            when `is_custom_job=true`
                                          default: false
                                          example: true
                                        custom_job_details:
                                          type: object
                                          required:
                                            - starts_daily_at
                                            - ends_daily_at
                                            - repeat_interval_measure
                                            - repeat_interval_unit
                                          properties:
                                            starts_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '12:40'
                                            ends_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '17:45'
                                            repeat_interval_measure:
                                              type: integer
                                              minimum: 1
                                              example: 10
                                            repeat_interval_unit:
                                              type: string
                                              enum:
                                                - MINUTE
                                                - HOUR
                                    - type: object
                                      title: Monthly Schedule
                                      description: Schedule job monthly
                                      required:
                                        - schedule_status
                                        - start_date
                                        - start_hour
                                        - start_min
                                        - repeat_interval_unit
                                        - repeat_interval_measure
                                      properties:
                                        schedule_status:
                                          type: string
                                          enum:
                                            - enabled
                                          example: enabled
                                        start_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: Start time should be after current time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        start_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 14
                                        start_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 35
                                        repeat_interval_unit:
                                          type: string
                                          enum:
                                            - MONTH
                                        repeat_interval_measure:
                                          type: integer
                                          minimum: 1
                                        repeat_on_last_day:
                                          type: boolean
                                          description: >
                                            `specified_days` must be provided if
                                            `repeat_on_last_day` is false.
                                          default: false
                                        specified_days:
                                          type: array
                                          minLength: 1
                                          items:
                                            type: integer
                                            minimum: 1
                                            maximum: 31
                                          example:
                                            - 1
                                            - 17
                                            - 31
                                        ends:
                                          type: boolean
                                          description: >
                                            `end_date`, `end_hour`, `end_min` must
                                            be provided if `ends` is `true`.
                                          default: false
                                          example: true
                                        end_date:
                                          pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                          type: string
                                          description: End time should be after start time.
                                          format: date-month'/'date-mday'/'date-fullyear
                                          example: 08/28/2023
                                        end_hour:
                                          type: integer
                                          minimum: 0
                                          maximum: 23
                                          example: 15
                                        end_min:
                                          type: integer
                                          minimum: 0
                                          maximum: 59
                                          example: 45
                                        is_custom_job:
                                          type: boolean
                                          description: >
                                            `custom_job_details` must be provided
                                            when `is_custom_job=true`
                                          default: false
                                          example: true
                                        custom_job_details:
                                          type: object
                                          required:
                                            - starts_daily_at
                                            - ends_daily_at
                                            - repeat_interval_measure
                                            - repeat_interval_unit
                                          properties:
                                            starts_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '12:40'
                                            ends_daily_at:
                                              pattern: ^{0-23}:[0-59]$
                                              type: string
                                              example: '17:45'
                                            repeat_interval_measure:
                                              type: integer
                                              minimum: 1
                                              example: 10
                                            repeat_interval_unit:
                                              type: string
                                              enum:
                                                - MINUTE
                                                - HOUR
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /schedules/check-service:
    get:
      security:
        - BearerAuth: []
      operationId: checkScheduleService
      tags:
        - Scheduling Information
      summary: Used to check whether scheduler service is working or not
      description: Used to check whether scheduler service is working or not
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /save-entity-schedule:
    put:
      security:
        - BearerAuth: []
      operationId: saveEntityScheduleDetails
      tags:
        - Scheduling Information
      summary: Used to save a particular entity schedule details
      description: Used to save a particular entity schedule details
      deprecated: true
      parameters:
        - name: entity_id
          in: query
          description: Entity ID
          required: false
          schema:
            type: string
        - name: entity_type
          in: query
          description: Entity Type
          required: true
          schema:
            type: string
            enum:
              - workflow
              - metadata_cleanup_policy
              - system_config
              - table_group
              - table
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                entity_id:
                  type: string
                  example: e77850ad5127a2d7dab870ff
                schedule_type:
                  type: string
                  enum:
                    - workflow-build
                    - metadata_cleanup
                    - mongo-backup
                    - table-group-cdc
                    - table
                schedule_username:
                  type: string
                  example: admin@infoworks.io
                schedule_details:
                  allOf:
                    - oneOf:
                        - type: object
                          title: Generic Schedule
                          description: Generic schedule object
                          required:
                            - schedule_status
                          properties:
                            schedule_status:
                              type: string
                              enum:
                                - enabled
                                - disabled
                              example: enabled
                            start_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: Start time should be after current time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            start_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 14
                            start_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 35
                            repeat_interval_unit:
                              type: string
                              enum:
                                - NEVER
                                - MINUTE
                                - HOUR
                                - DAY
                                - WEEK
                                - MONTH
                              default: NEVER
                              example: MONTH
                            repeat_interval_measure:
                              type: integer
                              minimum: 1
                            repeat_on_last_day:
                              type: boolean
                              description: >
                                `specified_days` must be provided if
                                `repeat_on_last_day` is false. Applicable for
                                `repeat_interval_unit=MONTH`
                              default: false
                            specified_days:
                              type: array
                              description: >
                                Applicable when `repeat_interval_unit` is `WEEK`
                                or `MONTH`.
                              minLength: 1
                              items:
                                type: integer
                                minimum: 0
                                maximum: 31
                              example:
                                - 1
                                - 17
                                - 31
                            ends:
                              type: boolean
                              description: >
                                `end_date`, `end_hour`, `end_min` must be
                                provided if `ends` is `true`.
                              default: false
                              example: true
                            end_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: End time should be after start time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            end_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 15
                            end_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 38
                            is_custom_job:
                              type: boolean
                              description: >
                                `custom_job_details` must be provided when
                                `is_custom_job=true`. Applicable when
                                `repeat_interval_unit` is `DAY`, `WEEK` or
                                `MONTH`.
                              default: false
                            custom_job_details:
                              type: object
                              required:
                                - starts_daily_at
                                - ends_daily_at
                                - repeat_interval_measure
                                - repeat_interval_unit
                              properties:
                                starts_daily_at:
                                  pattern: ^{0-23}:[0-59]$
                                  type: string
                                  example: '12:40'
                                ends_daily_at:
                                  pattern: ^{0-23}:[0-59]$
                                  type: string
                                  example: '17:45'
                                repeat_interval_measure:
                                  type: integer
                                  minimum: 1
                                  example: 10
                                repeat_interval_unit:
                                  type: string
                                  enum:
                                    - MINUTE
                                    - HOUR
                        - type: object
                          title: By Minute Schedule
                          description: Schedule job by minutes
                          required:
                            - schedule_status
                            - start_date
                            - start_hour
                            - start_min
                            - repeat_interval_unit
                            - repeat_interval_measure
                          properties:
                            schedule_status:
                              type: string
                              enum:
                                - enabled
                              example: enabled
                            start_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: Start time should be after current time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            start_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 14
                            start_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 35
                            repeat_interval_unit:
                              type: string
                              enum:
                                - MINUTE
                            repeat_interval_measure:
                              type: integer
                              minimum: 1
                            ends:
                              type: boolean
                              description: >
                                `end_date`, `end_hour`, `end_min` must be
                                provided if `ends` is `true`.
                              default: false
                              example: true
                            end_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: End time should be after start time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            end_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 15
                            end_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 55
                        - type: object
                          title: Hourly Schedule
                          description: Schedule job hourly
                          required:
                            - schedule_status
                            - start_date
                            - start_hour
                            - start_min
                            - repeat_interval_unit
                            - repeat_interval_measure
                          properties:
                            schedule_status:
                              type: string
                              enum:
                                - enabled
                              example: enabled
                            start_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: Start time should be after current time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            start_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 14
                            start_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 35
                            repeat_interval_unit:
                              type: string
                              enum:
                                - HOUR
                            repeat_interval_measure:
                              type: integer
                              minimum: 1
                            ends:
                              type: boolean
                              description: >
                                `end_date`, `end_hour`, `end_min` must be
                                provided if `ends` is `true`.
                              default: false
                              example: true
                            end_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: End time should be after start time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            end_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 15
                            end_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 55
                        - type: object
                          title: Daily Schedule
                          description: Schedule job daily
                          required:
                            - schedule_status
                            - start_date
                            - start_hour
                            - start_min
                            - repeat_interval_unit
                            - repeat_interval_measure
                          properties:
                            schedule_status:
                              type: string
                              enum:
                                - enabled
                              example: enabled
                            start_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: Start time should be after current time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            start_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 14
                            start_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 35
                            repeat_interval_unit:
                              type: string
                              enum:
                                - DAY
                            repeat_interval_measure:
                              type: integer
                              minimum: 1
                            ends:
                              type: boolean
                              description: >
                                `end_date`, `end_hour`, `end_min` must be
                                provided if `ends` is `true`.
                              default: false
                              example: true
                            end_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: End time should be after start time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            end_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 15
                            end_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 55
                            is_custom_job:
                              type: boolean
                              description: >
                                `custom_job_details` must be provided when
                                `is_custom_job=true`
                              default: false
                              example: true
                            custom_job_details:
                              type: object
                              required:
                                - starts_daily_at
                                - ends_daily_at
                                - repeat_interval_measure
                                - repeat_interval_unit
                              properties:
                                starts_daily_at:
                                  pattern: ^{0-23}:[0-59]$
                                  type: string
                                  example: '12:40'
                                ends_daily_at:
                                  pattern: ^{0-23}:[0-59]$
                                  type: string
                                  example: '17:45'
                                repeat_interval_measure:
                                  type: integer
                                  minimum: 1
                                  example: 10
                                repeat_interval_unit:
                                  type: string
                                  enum:
                                    - MINUTE
                                    - HOUR
                        - type: object
                          title: Weekly Schedule
                          description: Schedule job weekly
                          required:
                            - schedule_status
                            - start_date
                            - start_hour
                            - start_min
                            - repeat_interval_unit
                            - repeat_interval_measure
                            - specified_days
                          properties:
                            schedule_status:
                              type: string
                              enum:
                                - enabled
                              example: enabled
                            start_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: Start time should be after current time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            start_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 14
                            start_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 35
                            repeat_interval_unit:
                              type: string
                              enum:
                                - WEEK
                            repeat_interval_measure:
                              type: integer
                              minimum: 1
                            specified_days:
                              type: array
                              minLength: 1
                              items:
                                type: integer
                                minimum: 0
                                maximum: 6
                              example:
                                - 0
                                - 2
                                - 5
                            ends:
                              type: boolean
                              description: >
                                `end_date`, `end_hour`, `end_min` must be
                                provided if `ends` is `true`.
                              default: false
                              example: true
                            end_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: End time should be after start time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            end_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 15
                            end_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 55
                            is_custom_job:
                              type: boolean
                              description: >
                                `custom_job_details` must be provided when
                                `is_custom_job=true`
                              default: false
                              example: true
                            custom_job_details:
                              type: object
                              required:
                                - starts_daily_at
                                - ends_daily_at
                                - repeat_interval_measure
                                - repeat_interval_unit
                              properties:
                                starts_daily_at:
                                  pattern: ^{0-23}:[0-59]$
                                  type: string
                                  example: '12:40'
                                ends_daily_at:
                                  pattern: ^{0-23}:[0-59]$
                                  type: string
                                  example: '17:45'
                                repeat_interval_measure:
                                  type: integer
                                  minimum: 1
                                  example: 10
                                repeat_interval_unit:
                                  type: string
                                  enum:
                                    - MINUTE
                                    - HOUR
                        - type: object
                          title: Monthly Schedule
                          description: Schedule job monthly
                          required:
                            - schedule_status
                            - start_date
                            - start_hour
                            - start_min
                            - repeat_interval_unit
                            - repeat_interval_measure
                          properties:
                            schedule_status:
                              type: string
                              enum:
                                - enabled
                              example: enabled
                            start_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: Start time should be after current time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            start_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 14
                            start_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 35
                            repeat_interval_unit:
                              type: string
                              enum:
                                - MONTH
                            repeat_interval_measure:
                              type: integer
                              minimum: 1
                            repeat_on_last_day:
                              type: boolean
                              description: >
                                `specified_days` must be provided if
                                `repeat_on_last_day` is false.
                              default: false
                            specified_days:
                              type: array
                              minLength: 1
                              items:
                                type: integer
                                minimum: 1
                                maximum: 31
                              example:
                                - 1
                                - 17
                                - 31
                            ends:
                              type: boolean
                              description: >
                                `end_date`, `end_hour`, `end_min` must be
                                provided if `ends` is `true`.
                              default: false
                              example: true
                            end_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: End time should be after start time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            end_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 15
                            end_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 45
                            is_custom_job:
                              type: boolean
                              description: >
                                `custom_job_details` must be provided when
                                `is_custom_job=true`
                              default: false
                              example: true
                            custom_job_details:
                              type: object
                              required:
                                - starts_daily_at
                                - ends_daily_at
                                - repeat_interval_measure
                                - repeat_interval_unit
                              properties:
                                starts_daily_at:
                                  pattern: ^{0-23}:[0-59]$
                                  type: string
                                  example: '12:40'
                                ends_daily_at:
                                  pattern: ^{0-23}:[0-59]$
                                  type: string
                                  example: '17:45'
                                repeat_interval_measure:
                                  type: integer
                                  minimum: 1
                                  example: 10
                                repeat_interval_unit:
                                  type: string
                                  enum:
                                    - MINUTE
                                    - HOUR
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /save-entity-user:
    put:
      security:
        - BearerAuth: []
      operationId: saveEntityUserDetails
      tags:
        - Scheduling Information
      summary: Used to save a particular entity schedule user details
      description: Used to save a particular entity schedule user details
      deprecated: true
      parameters:
        - name: entity_id
          in: query
          description: Entity ID
          required: false
          schema:
            type: string
        - name: entity_type
          in: query
          description: Entity Type
          required: true
          schema:
            type: string
            enum:
              - workflow
              - metadata_cleanup_policy
              - system_config
              - table_group
              - table
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                scheduler_username:
                  type: string
                scheduler_auth_token:
                  type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /save-entity-user-and-schedule:
    put:
      security:
        - BearerAuth: []
      operationId: saveEntityUserAndScheduleDetails
      tags:
        - Scheduling Information
      summary: Used to save a particular entity schedule and its user details
      description: Used to save a particular entity schedule and its user details
      parameters:
        - name: entity_id
          in: query
          description: Entity ID
          required: false
          schema:
            type: string
        - name: entity_type
          in: query
          description: Entity Type
          required: true
          schema:
            type: string
            enum:
              - workflow
              - metadata_cleanup_policy
              - system_config
              - table_group
              - table
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    scheduler_username:
                      type: string
                    scheduler_auth_token:
                      type: string
                - type: object
                  properties:
                    schedule:
                      oneOf:
                        - type: object
                          title: Generic Schedule
                          description: Generic schedule object
                          required:
                            - schedule_status
                          properties:
                            schedule_status:
                              type: string
                              enum:
                                - enabled
                                - disabled
                              example: enabled
                            start_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: Start time should be after current time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            start_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 14
                            start_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 35
                            repeat_interval_unit:
                              type: string
                              enum:
                                - NEVER
                                - MINUTE
                                - HOUR
                                - DAY
                                - WEEK
                                - MONTH
                              default: NEVER
                              example: MONTH
                            repeat_interval_measure:
                              type: integer
                              minimum: 1
                            repeat_on_last_day:
                              type: boolean
                              description: >
                                `specified_days` must be provided if
                                `repeat_on_last_day` is false. Applicable for
                                `repeat_interval_unit=MONTH`
                              default: false
                            specified_days:
                              type: array
                              description: >
                                Applicable when `repeat_interval_unit` is `WEEK`
                                or `MONTH`.
                              minLength: 1
                              items:
                                type: integer
                                minimum: 0
                                maximum: 31
                              example:
                                - 1
                                - 17
                                - 31
                            ends:
                              type: boolean
                              description: >
                                `end_date`, `end_hour`, `end_min` must be
                                provided if `ends` is `true`.
                              default: false
                              example: true
                            end_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: End time should be after start time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            end_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 15
                            end_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 38
                            is_custom_job:
                              type: boolean
                              description: >
                                `custom_job_details` must be provided when
                                `is_custom_job=true`. Applicable when
                                `repeat_interval_unit` is `DAY`, `WEEK` or
                                `MONTH`.
                              default: false
                            custom_job_details:
                              type: object
                              required:
                                - starts_daily_at
                                - ends_daily_at
                                - repeat_interval_measure
                                - repeat_interval_unit
                              properties:
                                starts_daily_at:
                                  pattern: ^{0-23}:[0-59]$
                                  type: string
                                  example: '12:40'
                                ends_daily_at:
                                  pattern: ^{0-23}:[0-59]$
                                  type: string
                                  example: '17:45'
                                repeat_interval_measure:
                                  type: integer
                                  minimum: 1
                                  example: 10
                                repeat_interval_unit:
                                  type: string
                                  enum:
                                    - MINUTE
                                    - HOUR
                        - type: object
                          title: By Minute Schedule
                          description: Schedule job by minutes
                          required:
                            - schedule_status
                            - start_date
                            - start_hour
                            - start_min
                            - repeat_interval_unit
                            - repeat_interval_measure
                          properties:
                            schedule_status:
                              type: string
                              enum:
                                - enabled
                              example: enabled
                            start_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: Start time should be after current time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            start_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 14
                            start_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 35
                            repeat_interval_unit:
                              type: string
                              enum:
                                - MINUTE
                            repeat_interval_measure:
                              type: integer
                              minimum: 1
                            ends:
                              type: boolean
                              description: >
                                `end_date`, `end_hour`, `end_min` must be
                                provided if `ends` is `true`.
                              default: false
                              example: true
                            end_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: End time should be after start time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            end_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 15
                            end_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 55
                        - type: object
                          title: Hourly Schedule
                          description: Schedule job hourly
                          required:
                            - schedule_status
                            - start_date
                            - start_hour
                            - start_min
                            - repeat_interval_unit
                            - repeat_interval_measure
                          properties:
                            schedule_status:
                              type: string
                              enum:
                                - enabled
                              example: enabled
                            start_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: Start time should be after current time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            start_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 14
                            start_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 35
                            repeat_interval_unit:
                              type: string
                              enum:
                                - HOUR
                            repeat_interval_measure:
                              type: integer
                              minimum: 1
                            ends:
                              type: boolean
                              description: >
                                `end_date`, `end_hour`, `end_min` must be
                                provided if `ends` is `true`.
                              default: false
                              example: true
                            end_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: End time should be after start time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            end_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 15
                            end_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 55
                        - type: object
                          title: Daily Schedule
                          description: Schedule job daily
                          required:
                            - schedule_status
                            - start_date
                            - start_hour
                            - start_min
                            - repeat_interval_unit
                            - repeat_interval_measure
                          properties:
                            schedule_status:
                              type: string
                              enum:
                                - enabled
                              example: enabled
                            start_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: Start time should be after current time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            start_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 14
                            start_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 35
                            repeat_interval_unit:
                              type: string
                              enum:
                                - DAY
                            repeat_interval_measure:
                              type: integer
                              minimum: 1
                            ends:
                              type: boolean
                              description: >
                                `end_date`, `end_hour`, `end_min` must be
                                provided if `ends` is `true`.
                              default: false
                              example: true
                            end_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: End time should be after start time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            end_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 15
                            end_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 55
                            is_custom_job:
                              type: boolean
                              description: >
                                `custom_job_details` must be provided when
                                `is_custom_job=true`
                              default: false
                              example: true
                            custom_job_details:
                              type: object
                              required:
                                - starts_daily_at
                                - ends_daily_at
                                - repeat_interval_measure
                                - repeat_interval_unit
                              properties:
                                starts_daily_at:
                                  pattern: ^{0-23}:[0-59]$
                                  type: string
                                  example: '12:40'
                                ends_daily_at:
                                  pattern: ^{0-23}:[0-59]$
                                  type: string
                                  example: '17:45'
                                repeat_interval_measure:
                                  type: integer
                                  minimum: 1
                                  example: 10
                                repeat_interval_unit:
                                  type: string
                                  enum:
                                    - MINUTE
                                    - HOUR
                        - type: object
                          title: Weekly Schedule
                          description: Schedule job weekly
                          required:
                            - schedule_status
                            - start_date
                            - start_hour
                            - start_min
                            - repeat_interval_unit
                            - repeat_interval_measure
                            - specified_days
                          properties:
                            schedule_status:
                              type: string
                              enum:
                                - enabled
                              example: enabled
                            start_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: Start time should be after current time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            start_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 14
                            start_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 35
                            repeat_interval_unit:
                              type: string
                              enum:
                                - WEEK
                            repeat_interval_measure:
                              type: integer
                              minimum: 1
                            specified_days:
                              type: array
                              minLength: 1
                              items:
                                type: integer
                                minimum: 0
                                maximum: 6
                              example:
                                - 0
                                - 2
                                - 5
                            ends:
                              type: boolean
                              description: >
                                `end_date`, `end_hour`, `end_min` must be
                                provided if `ends` is `true`.
                              default: false
                              example: true
                            end_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: End time should be after start time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            end_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 15
                            end_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 55
                            is_custom_job:
                              type: boolean
                              description: >
                                `custom_job_details` must be provided when
                                `is_custom_job=true`
                              default: false
                              example: true
                            custom_job_details:
                              type: object
                              required:
                                - starts_daily_at
                                - ends_daily_at
                                - repeat_interval_measure
                                - repeat_interval_unit
                              properties:
                                starts_daily_at:
                                  pattern: ^{0-23}:[0-59]$
                                  type: string
                                  example: '12:40'
                                ends_daily_at:
                                  pattern: ^{0-23}:[0-59]$
                                  type: string
                                  example: '17:45'
                                repeat_interval_measure:
                                  type: integer
                                  minimum: 1
                                  example: 10
                                repeat_interval_unit:
                                  type: string
                                  enum:
                                    - MINUTE
                                    - HOUR
                        - type: object
                          title: Monthly Schedule
                          description: Schedule job monthly
                          required:
                            - schedule_status
                            - start_date
                            - start_hour
                            - start_min
                            - repeat_interval_unit
                            - repeat_interval_measure
                          properties:
                            schedule_status:
                              type: string
                              enum:
                                - enabled
                              example: enabled
                            start_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: Start time should be after current time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            start_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 14
                            start_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 35
                            repeat_interval_unit:
                              type: string
                              enum:
                                - MONTH
                            repeat_interval_measure:
                              type: integer
                              minimum: 1
                            repeat_on_last_day:
                              type: boolean
                              description: >
                                `specified_days` must be provided if
                                `repeat_on_last_day` is false.
                              default: false
                            specified_days:
                              type: array
                              minLength: 1
                              items:
                                type: integer
                                minimum: 1
                                maximum: 31
                              example:
                                - 1
                                - 17
                                - 31
                            ends:
                              type: boolean
                              description: >
                                `end_date`, `end_hour`, `end_min` must be
                                provided if `ends` is `true`.
                              default: false
                              example: true
                            end_date:
                              pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                              type: string
                              description: End time should be after start time.
                              format: date-month'/'date-mday'/'date-fullyear
                              example: 08/28/2023
                            end_hour:
                              type: integer
                              minimum: 0
                              maximum: 23
                              example: 15
                            end_min:
                              type: integer
                              minimum: 0
                              maximum: 59
                              example: 45
                            is_custom_job:
                              type: boolean
                              description: >
                                `custom_job_details` must be provided when
                                `is_custom_job=true`
                              default: false
                              example: true
                            custom_job_details:
                              type: object
                              required:
                                - starts_daily_at
                                - ends_daily_at
                                - repeat_interval_measure
                                - repeat_interval_unit
                              properties:
                                starts_daily_at:
                                  pattern: ^{0-23}:[0-59]$
                                  type: string
                                  example: '12:40'
                                ends_daily_at:
                                  pattern: ^{0-23}:[0-59]$
                                  type: string
                                  example: '17:45'
                                repeat_interval_measure:
                                  type: integer
                                  minimum: 1
                                  example: 10
                                repeat_interval_unit:
                                  type: string
                                  enum:
                                    - MINUTE
                                    - HOUR
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /tables/:
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: Get multiple table Ids
      description: Get multiple table Ids
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        original_table_name:
                          type: string
                        data_lake_path:
                          type: string
                        meta_crawl_performed:
                          type: boolean
                        columns:
                          type: array
                          items:
                            type: object
                            properties:
                              sql_type:
                                type: number
                              is_deleted:
                                type: boolean
                              name:
                                type: string
                              original_name:
                                type: string
                              target_sql_type:
                                type: number
                              col_type_name:
                                type: string
                              is_audit_column:
                                type: boolean
                              target_scale:
                                type: string
                              col_size:
                                type: number
                              precision:
                                type: number
                              target_precision:
                                type: string
                              scale:
                                type: number
                        configuration:
                          type: object
                          properties:
                            exclude_legacy_audit_columns:
                              type: boolean
                            sync_type:
                              type: string
                            write_supported_engines:
                              type: array
                              items:
                                type: string
                            read_supported_engines:
                              type: array
                              items:
                                type: string
                            target_table_name:
                              type: string
                            storage_format:
                              type: string
                            target_schema_name:
                              type: string
                            is_scd2_table:
                              type: boolean
                            is_archive_enabled:
                              type: boolean
                            natural_keys:
                              type: array
                              items:
                                type: object
                            generate_history_view:
                              type: boolean
                            segmented_load_columns:
                              type: array
                              items:
                                type: object
                        state:
                          type: string
                        created_at:
                          type: string
                        source:
                          type: string
                        last_ingested_cdc_value:
                          type: object
                        is_jtds_driver:
                          type: boolean
                        schema_name_at_source:
                          type: string
                        catalog_name:
                          type: string
                        catalog_is_database:
                          type: boolean
                        has_catalog:
                          type: boolean
                        data_warehouse_type:
                          type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /tables/{table_id}/metadata:
    parameters:
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
    patch:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: update table metadata
      description: update table metadata
      requestBody:
        description: Table Metadata
        content:
          application/json:
            schema:
              type: object
              properties:
                tags_to_add:
                  type: array
                  items:
                    type: string
                    example: sales
                tags_to_remove:
                  type: array
                  items:
                    type: string
                    example: engg
                is_favorite:
                  type: boolean
                  example: true
                description:
                  type: string
                  example: descriptions
                columns_descriptions:
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                        example: Id
                      description:
                        type: string
                        example: hello
            examples:
              EntityMetadata:
                value:
                  tags_to_add:
                    - sales
                  tags_to_remove:
                    - engg
                  is_favorite: true
                  description: description
                  columns_descriptions:
                    - name: Id
                      description: hello
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully updated metadata
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: get table metadata
      description: get table metadata
      responses:
        '200':
          description: get table metadata
          content:
            application/json:
              schema:
                type: object
                properties:
                  tags:
                    type: array
                    items:
                      type: string
                      example: sales
                  is_favorite:
                    type: boolean
                    example: true
                  description:
                    type: string
                    example: description
              examples:
                EntityMetadata:
                  value:
                    tags:
                      - sales
                    is_favorite: true
                    description: description
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /tables/{table_id}/lineage:
    parameters:
      - name: table_id
        in: path
        description: Table Id.
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      tags:
        - Tables
      summary: get table lineage
      description: get table lineage
      responses:
        '200':
          description: get table lineage
          content:
            application/json:
              schema:
                type: object
                properties:
                  table:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      parent_entity_type:
                        type: string
                        example: source
                      parent_entity_id:
                        type: string
                      parent_entity_name:
                        type: string
                      has_catalog:
                        type: boolean
                        example: true
                      catalog_name:
                        type: string
                      catalog_is_database:
                        type: boolean
                        example: true
                  domains:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      pipelines:
                        type: array
                        items:
                          allOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                version_id:
                                  type: string
                                name:
                                  type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /notification/{entity_type}/{entity_id}/subscribers:
    parameters:
      - name: entity_type
        in: path
        description: entity_type
        required: true
        schema:
          type: string
      - name: entity_id
        in: path
        description: entity_id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      summary: Get Entity Subscriber
      description: Get Entity Subscriber
      operationId: list Entity Subscriber
      tags:
        - User Notification Subscribe
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: List of User Notification Subscribe.
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: successfully posted
                      result:
                        type: object
                        properties:
                          status:
                            type: number
                          result:
                            type: object
                            properties:
                              entity_id:
                                example: da2zd253f7417a1g274e6e01
                              entity_type:
                                type: string
                                example: source
                              users:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: 6707acc7d292612e3dd9c129
                                    type:
                                      type: string
                                      example: external
                                    notify_events:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          event_job_type:
                                            type: string
                                            example: fetch_metadata
                                          notify_on:
                                            type: array
                                            items:
                                              type: string
                                              example: SUCCESS
                                    notify_via:
                                      type: array
                                      items:
                                        type: string
                                        example: EMAIL
                                    updated_by:
                                      type: string
                                      example: qmekmfrt
                                    updated_at:
                                      type: number
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      summary: Update Entity Subscriber
      description: Update Entity Subscriber
      operationId: Update Entity Subscriber
      tags:
        - User Notification Subscribe
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    entity_id:
                      type: string
                      example: da2zd253f7417a1g274e6e01
                    entity_type:
                      type: string
                      example: source
                    users:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 6707acc7d292612e3dd9c129
                          type:
                            type: string
                            example: external
                          notify_via:
                            type: array
                            items:
                              type: string
                              example: EMAIL
                          notify_events:
                            type: array
                            items:
                              type: object
                              properties:
                                event_job_type:
                                  type: string
                                  example: fetch_metadata
                                notify_on:
                                  type: array
                                  items:
                                    type: string
                                    example: SUCCESS
      responses:
        '200':
          description: List of User Notification Subscribe.
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: successfully posted
                      result:
                        type: object
                        properties:
                          status:
                            type: number
                          result:
                            type: object
                            properties:
                              entity_id:
                                example: da2zd253f7417a1g274e6e01
                              entity_type:
                                type: string
                                example: source
                              users:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: 6707acc7d292612e3dd9c129
                                    type:
                                      type: string
                                      example: external
                                    notify_events:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          event_job_type:
                                            type: string
                                            example: fetch_metadata
                                          notify_on:
                                            type: array
                                            items:
                                              type: string
                                              example: SUCCESS
                                    notify_via:
                                      type: array
                                      items:
                                        type: string
                                        example: EMAIL
                                    updated_by:
                                      type: string
                                      example: qmekmfrt
                                    updated_at:
                                      type: number
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /notification/subscribe:
    post:
      security:
        - BearerAuth: []
      summary: Subscribe Notification
      description: Subscribe Notification
      operationId: Subscribe Notification
      tags:
        - User Notification Subscribe
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    entity_id:
                      type: string
                      example: da2zd253f7417a1g274e6e01
                    entity_type:
                      type: string
                      example: source
                    users:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 6707acc7d292612e3dd9c129
                          type:
                            type: string
                            example: external
                          notify_via:
                            type: array
                            items:
                              type: string
                              example: EMAIL
                          notify_events:
                            type: array
                            items:
                              type: object
                              properties:
                                event_job_type:
                                  type: string
                                  example: fetch_metadata
                                notify_on:
                                  type: array
                                  items:
                                    type: string
                                    example: SUCCESS
      responses:
        '200':
          description: List of User Aggregate.
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      message:
                        type: string
                      result:
                        type: object
                        properties:
                          status:
                            type: number
                          result:
                            type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /notification/unsubscribe:
    put:
      security:
        - BearerAuth: []
      summary: Unsubscribe Notification
      description: Unsubscribe Notification
      operationId: Unsubscribe Notification
      tags:
        - User Notification Subscribe
      parameters:
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    entity_id:
                      type: string
                    entity_type:
                      type: string
                    user:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
      responses:
        '200':
          description: List of Job Status Response.
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      message:
                        type: string
                      result:
                        type: object
                        properties:
                          status:
                            type: number
                          result:
                            type: string
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /users/self:
    get:
      operationId: GetSelf
      tags:
        - Self
      summary: Get the self details
      description: Get the self details
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                  - properties:
                      result:
                        type: object
                        allOf:
                          - type: object
                            properties:
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          - properties:
                              profile:
                                allOf:
                                  - type: object
                                    properties:
                                      name:
                                        type: string
                                        example: DF_SQLIMPORT
                                  - properties:
                                      email:
                                        type: string
                                        example: xxx@infoworks.io
                                  - properties:
                                      needs_password_reset:
                                        type: boolean
                                        example: false
                                      is_slack:
                                        type: boolean
                                        example: false
                                      medium:
                                        properties:
                                          slack_details:
                                            type: object
                              emails:
                                type: array
                                items:
                                  properties:
                                    address:
                                      type: string
                                      example: xxx@infoworks.io
                              roles:
                                type: array
                                items:
                                  type: string
                                  example: analyst
                              auth_token:
                                type: string
                                example: ksvfvb***
                              status:
                                type: object
                                properties:
                                  is_idle:
                                    type: boolean
                                    example: false
                                  is_online:
                                    type: boolean
                                    example: true
                                  last_login_details:
                                    properties:
                                      date:
                                        type: string
                                        example: '2019-11-21T12:54:05.875Z'
                                      ip_address:
                                        type: string
                                        example: 10.12.43.23
                                      user_agent:
                                        type: string
                                        example: Mozilla/****
                          - properties:
                              accessible_domains:
                                items:
                                  type: string
                                  example: ffb38b0cc595cfcd05c54e49
                          - properties:
                              heartbeat:
                                type: string
                                example: '2019-11-21T12:54:05.875Z'
                              failed_logins:
                                type: array
                                items:
                                  example: null
                              created_at:
                                type: string
                                example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /users/{user_id}/reset-password:
    parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
    patch:
      security:
        - BearerAuth: []
      operationId: resetUserPassword
      tags:
        - Users
      summary: Reset password for user
      description: Reset password for user
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    old_password:
                      type: string
                      example: kdb***
                - type: object
                  properties:
                    new_password:
                      type: string
                      example: kdb***
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /users/{user_id}/delete-schedules:
    parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
    delete:
      security:
        - BearerAuth: []
      operationId: deleteSchedulesForUser
      tags:
        - Users
      summary: Delete all schedules for a specific user
      description: Delete all schedules for a specific user
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /users/{user_id}/toggle-user-login:
    parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
    patch:
      security:
        - BearerAuth: []
      operationId: toggleUserLoginAbility
      tags:
        - Users
      summary: Toggle user login ability
      description: Toggle user login ability
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - properties:
                      result:
                        type: object
                        properties:
                          login_disabled:
                            type: boolean
                            example: true
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /users/{user_id}/accessible-domains:
    parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
    post:
      security:
        - BearerAuth: []
      operationId: AddDomainsToUser
      tags:
        - Users
      summary: Add the domain to the user linked with the user_id
      description: Add the domain to the user linked with the user_id
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                entity_ids:
                  type: array
                  items:
                    example: 195ebb5847e08c1eca8368e4
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /users/unlock:
    post:
      security:
        - BearerAuth: []
      operationId: unlock user
      tags:
        - Users
      parameters:
        - name: user_email
          example: abc@gmail.com
          in: query
          required: true
          schema:
            type: string
      summary: Unlock the user
      description: Unlock the user by providing email id
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /users/self/presets:
    get:
      security:
        - BearerAuth: []
      summary: List presets
      description: Get a list of presets of a particular type for a user
      operationId: listPresets
      tags:
        - Presets
      parameters:
        - in: query
          name: type
          required: true
          schema:
            type: string
            enum:
              - prodops_filter
          description: Type of presets to fetch for the user
        - name: offset
          in: query
          description: >-
            The number of items to skip before starting to collect the result
            set
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: The numbers of items to return
          schema:
            type: integer
            default: 10
        - name: sort_by
          in: query
          description: Sort result on field
          schema:
            type: string
        - name: order_by
          in: query
          description: order  ascending | descending
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
        - name: filter
          in: query
          description: Filter results query
          schema:
            type: string
      responses:
        '200':
          description: List of presets.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      limit:
                        type: integer
                        example: 10
                      offset:
                        type: integer
                        example: 0
                      links:
                        type: object
                        properties:
                          base:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                          self:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                          next:
                            type: string
                            format: uri
                            example: >-
                              https://localhost:3001/v3/{admin/{workflows/{|
                              |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                      total_count:
                        type: integer
                        example: 10
                    x-examples:
                      example-1: {}
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                  example: 67a1e86f770b8c2230e18e00
                                user_id:
                                  type: string
                                  example: 6RkfybTRQQByEey3v
                                name:
                                  type: string
                                  example: preset1
                                type:
                                  type: string
                                  example: prodops_filter
                                configuration:
                                  type: object
                                is_default:
                                  type: boolean
                                  example: true
                                created_at:
                                  type: string
                                  format: date-time
                                  example: '2025-02-04T10:14:07.024Z'
                                modified_at:
                                  type: string
                                  format: date-time
                                  example: '2025-02-05T06:05:00.096Z'
                                username:
                                  type: string
                                  example: Infoworks Admin
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    post:
      security:
        - BearerAuth: []
      summary: Create a preset
      description: Creates a user-defined preset
      operationId: createPreset
      tags:
        - Presets
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    name:
                      type: string
                      example: preset1
                    type:
                      type: string
                      example: prodops_filter
                    configuration:
                      type: object
                    is_default:
                      type: boolean
                      example: true
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 5fa948e77758f33e0e83ec6b
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
  /users/self/presets/{preset_id}:
    parameters:
      - name: preset_id
        in: path
        description: Preset Id
        required: true
        schema:
          type: string
    get:
      security:
        - BearerAuth: []
      summary: Get preset
      description: Get preset details
      operationId: getPreset
      tags:
        - Presets
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: string
                                example: 67a1e86f770b8c2230e18e00
                              user_id:
                                type: string
                                example: 6RkfybTRQQByEey3v
                              name:
                                type: string
                                example: preset1
                              type:
                                type: string
                                example: prodops_filter
                              configuration:
                                type: object
                              is_default:
                                type: boolean
                                example: true
                              created_at:
                                type: string
                                format: date-time
                                example: '2025-02-04T10:14:07.024Z'
                              modified_at:
                                type: string
                                format: date-time
                                example: '2025-02-05T06:05:00.096Z'
                              username:
                                type: string
                                example: Infoworks Admin
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    patch:
      security:
        - BearerAuth: []
      summary: Update preset
      description: Update preset
      operationId: updatePreset
      tags:
        - Presets
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    name:
                      type: string
                      example: preset1
                    type:
                      type: string
                      example: prodops_filter
                    configuration:
                      type: object
                    is_default:
                      type: boolean
                      example: true
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 5fa948e77758f33e0e83ec6b
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
    delete:
      security:
        - BearerAuth: []
      summary: Delete preset
      description: Delete preset
      operationId: deletePreset
      tags:
        - Presets
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10006
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10005
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10004
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Something went wrong
                      details:
                        type: object
                        properties: {}
                  - type: object
                    properties:
                      iw_code:
                        type: string
                        example: IW10002
                      help:
                        type: string
                        example: http://api.infoworks.io/help/IW10002
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    BasicAuth:
      type: http
      scheme: basic