openapi: 3.2.0
info:
  version: v2.222.1
  title: Corva Workflow Roles API
  description: 'The Corva API is a powerful interface providing great flexibility and extensibility with Corva. Whether your needs are simple UI visualizations, data entry, replication/sync tasks, real-time stream processing, or complex machine learning CPU-intensive apps, the Corva API is the way to make it happen. Our concepts are split into three distinct silos: data apps, visualization apps, and a REST API'
  termsOfService: https://www.corva.ai/terms-and-conditions/
  contact:
    name: Corva API Team
    email: support@corva.ai
security:
- api_key: []
tags:
- name: WorkflowRoles
paths:
  /v2/workflow_roles:
    get:
      summary: List WorkflowRoles
      tags:
      - WorkflowRoles
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          type: object
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowRoleList'
      parameters:
      - in: query
        name: page
        description: Number of page
        schema:
          type: integer
      - in: query
        name: per_page
        description: Number of items to list per page
        schema:
          type: integer
      operationId: getV2WorkflowRoles
      x-operation-id-source: derived
components:
  schemas:
    WorkflowRoleIndex:
      properties:
        id:
          type: integer
          format: int64
        type:
          type: string
        attributes:
          type: object
          properties:
            id:
              type: integer
              format: int64
            workflow_id:
              type: int64
            role:
              type: string
            position:
              type: integer
            segment:
              type: string
            image_url:
              type: string
            description:
              type: text
        relationships:
          type: object
          properties:
            workflow:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: int64
                    type:
                      type: string
      example:
        id: 12
        type: workflow_role
        attributes:
          id: 12
          workflow_id: 12345
          role: Drilling Engineer
          position: 1
          segment: drilling
          image_url: https://cdn.cloudfront.net/workflow_roles/workflow_12345_role_drilling_engineer
          description: ''
        relationships:
          workflow:
            data:
              id: 12345
              type: workflow
    AuthorizationError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 403
        message: Access denied
    WorkflowRoleList:
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowRoleIndex'
        included:
          type: array
          items:
            properties:
              id:
                type: integer
              type:
                type: string
              attributes:
                type: object
      example:
        data:
        - id: 12
          type: workflow_role
          attributes:
            id: 12
            workflow_id: 12345
            name: Drilling Engineer
            position: 1
            segment: drilling
            image_url: https://cdn.cloudfront.net/workflow_roles/workflow_12345_role_drilling_engineer
            description: ''
          relationships:
            workflow:
              data:
                id: 12345
                type: workflow
        included:
        - id: 12345
          type: workflow
          attributes:
            id: 12345
            name: Drilling Engineer Workflow
            caption: ''
            segment: drilling
            introduction: long text
            created_at: '2023-09-30T12:33:34.555Z'
            updated_at: '2023-09-30T12:33:34.555Z'
    AuthenticationError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 401
        message: Missing authentication. Please try again.
    NotFoundError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 404
        message: Not found
  securitySchemes:
    api_key:
      type: apiKey
      name: authorization
      in: header