Wegalvanize Robots Folders API

openapi: 3.2.0
info:
  title: HighBond API Reference Robots Folders API
  version: 1.1.0
  description: Welcome to the API documentation for HighBond.
  x-logo:
    url: ./assets/logo.png
    altText: HighBond Logo
servers:
- url: '{protocol}://{server}/v1'
  variables:
    protocol:
      default: https
    server:
      default: apis-us.highbond.com
      enum:
      - apis-us.highbond.com
      - apis-ca.highbond.com
      - apis-eu.highbond.com
      - apis-ap.highbond.com
      - apis-au.highbond.com
      - apis-af.highbond.com
      - apis-sa.highbond.com
      - apis-jp.highbond.com
security:
- bearerToken: []
tags:
- name: Robots Folders
  x-displayName: Robots Folders
  description: Folders to organize Robots.
paths:
  /orgs/{org_id}/robots_folders:
    get:
      tags:
      - Robots Folders
      operationId: listFolders
      summary: List Folders
      description: Get a list of Robots Folders.
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      responses:
        '200':
          description: Success.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ListRobotsFoldersResponse'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      tags:
      - Robots Folders
      operationId: createFolder
      summary: Create Folder
      description: Create a Robots Folder.
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      requestBody:
        description: The data required to create a Robots Folder.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRobotsFolderRequest'
      responses:
        '200':
          description: Success.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RobotsFolderResponse'
        '400':
          $ref: '#/components/responses/MissingOrgId'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          description: 'Unprocessable entity.

            '
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                - status: 422
                  title: Unprocessable Entity
  /orgs/{org_id}/robots_folders/{folder_id}:
    get:
      tags:
      - Robots Folders
      operationId: getFolder
      summary: Get Robots Folder
      description: Get a Robots Folder.
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/folderIdParam'
      - $ref: '#/components/parameters/robotCategoryParam'
      responses:
        '200':
          description: Success.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RobotsFolderResponse'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      tags:
      - Robots Folders
      operationId: updateFolder
      summary: Update Folder
      description: Updates a Robots Folder.
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/folderIdParam'
      requestBody:
        description: The data required to update a Folder.
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/UpdateRobotsFolderRequest'
      responses:
        '200':
          description: Updated.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RobotsFolderResponse'
        '400':
          $ref: '#/components/responses/MissingFolderId'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      tags:
      - Robots Folders
      operationId: deleteFolder
      summary: Delete Folder
      description: Deletes a Robots Folder.
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/folderIdParam'
      responses:
        '200':
          description: Deleted.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RobotsFolderResponse'
        '400':
          $ref: '#/components/responses/MissingFolderId'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /orgs/{org_id}/robots_folders/{folder_id}/robots:
    get:
      tags:
      - Robots Folders
      operationId: getRobotsInFolder
      summary: List Robots in a Folder
      description: List Robots in a Folder.
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/folderIdParam'
      responses:
        '200':
          description: Success.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ListRobotsInFolderResponse'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    robotCategoryParam:
      in: query
      name: category
      description: The Robots category for the Folder.
      required: false
      schema:
        type: string
        enum:
        - acl
        - highbond
        - workflow
    folderIdParam:
      in: path
      name: folder_id
      description: The ID of the folder.
      required: true
      schema:
        type: number
        example: 2
    orgIdParam:
      in: path
      name: org_id
      description: The ID of the HighBond instance.
      required: true
      schema:
        type: string
        example: 1
  schemas:
    Error:
      type: object
      required:
      - status
      properties:
        status:
          type: string
          description: The HTTP status code.
        source:
          type: object
          description: Indicates which part of the request document caused the error.
          required:
          - pointer
          properties:
            pointer:
              type: string
              description: 'A JSON Pointer <a href="https://tools.ietf.org/html/rfc6901" target="_blank">(RFC6901)</a> to the associated entity

                in the request document.

                '
        code:
          type: string
          description: Application-specific error code, expressed as a string value.
        title:
          type: string
          description: A short, human-readable summary of the problem.
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
    UpdateRobotsFolderRequest:
      type: object
      description: The data associated with the resource.
      required:
      - data
      properties:
        data:
          type: object
          description: The data associated with the resource.
          required:
          - type
          - attributes
          properties:
            type:
              type: string
              description: The classification of the object (`"robots_folders"`).
              example: robots_folders
            attributes:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the Robots Folder.
                  example: updated test folder
    Errors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    ListRobotsInFolderResponse:
      type: object
      description: The data associated with the resource.
      properties:
        data:
          type: array
          description: The data associated with the resource.
          items:
            type: object
            properties:
              id:
                type: number
                description: The Folder ID.
                example: 1
              type:
                type: string
                description: The classification of the object (`"robot"`).
                example: robot
              attributes:
                type: object
                description: The attributes associated with the resource.
                properties:
                  active_app_version:
                    type: number
                    description: The active version of the robot.
                    example: 1
                  app_versions_count:
                    type: number
                    description: The number of script versions committed to the robot.
                    example: 1
                  automated:
                    type: boolean
                    description: Is the robot automated.
                    example: false
                  category:
                    type: string
                    description: The category of the robot.
                    enum:
                    - acl
                    - highbond
                    - workflow
                    default: acl
                    example: workflow
                  count:
                    type: number
                    description: The number of robots in the account.
                    example: 1
                  created_at:
                    type: string
                    description: Date when the robot was created.
                    example: '2019-02-09T13:17:26Z'
                  description:
                    type: string
                    description: The description of the robot.
                    example: Sample description
                  delete_failed:
                    type: boolean
                    description: Specifies if the robot deletion failed.
                    example: false
                  discarded_at:
                    type: string
                    description: Date when the robot was discarded.
                    example: '2019-02-09T13:17:26Z'
                  kept_tasks_count:
                    type: number
                    description: The number of tasks associated with the robot.
                    example: 1
                  last_committed_at:
                    type: string
                    description: Date when the robot was last committed.
                    example: '2019-02-09T13:17:26Z'
                  last_run_at:
                    type: string
                    description: Date when the robot was last run.
                    example: '2019-02-09T13:17:26Z'
                  name:
                    type: string
                    description: The name of the robot.
                    example: R2D2
                  production_updated_at:
                    type: string
                    description: Date when the Production tab was last updated.
                    example: '2019-02-09T13:17:26Z'
                  share_tables_in_development:
                    type: boolean
                    description: Specifies if the robot shares tables in the Development tab.
                    example: false
                  share_tables_in_production:
                    type: boolean
                    description: Specifies if the robot shares tables in the Production tab.
                    example: false
              relationships:
                type: object
                properties:
                  folder:
                    type: object
                    description: The folder associated with the robot.
                    properties:
                      data:
                        type: object
                        description: The data associated with the resource.
                        properties:
                          id:
                            type: number
                            description: The Folder ID.
                            example: 1
                          type:
                            type: string
                            description: The classification of the object (`"folder"`).
                            example: folder
    RobotsFolderResponse:
      type: object
      properties:
        id:
          type: number
          description: The Folder ID.
          example: 1
        type:
          type: string
          description: The classification of the object (`"robots_folders"`).
          example: robots_folders
        attributes:
          type: object
          description: The attributes associated with the resource.
          properties:
            name:
              type: string
              description: The name of the Robots Folder.
              example: test folder
            category:
              type: string
              description: Category of the Robots Folder.
              example: highbond
            created_at:
              type: string
              description: The date the Robots Folder was created.
              example: '2019-02-09T13:17:26Z'
            created_by:
              type: string
              description: User who created the Folder.
              example: xyz
            discarded_at:
              type: string
              description: Date when the Robots Folder was discarded.
              example: '2019-02-09T13:17:26Z'
            delete_failed:
              type: string
              description: Specifies if the Robots Folder deletion failed.
              example: false
    ListRobotsFoldersResponse:
      type: object
      description: The data associated with the resource.
      properties:
        data:
          type: array
          description: The data associated with the resource.
          items:
            type: object
            properties:
              id:
                type: number
                description: The Folder ID.
                example: 1
              type:
                type: string
                description: The classification of the object (`"robots_folders"`).
                example: robots_folders
              attributes:
                type: object
                description: The attributes associated with the resource.
                properties:
                  name:
                    type: string
                    description: The name of the Robots Folder.
                    example: test folder
                  category:
                    type: string
                    description: Category of the Robots Folder.
                    example: highbond
                  created_at:
                    type: string
                    description: The date the Robots Folder was created.
                    example: '2019-02-09T13:17:26Z'
                  created_by:
                    type: string
                    description: User who created the Folder.
                    example: xyz
                  discarded_at:
                    type: string
                    description: Date when the Robots Folder was discarded.
                    example: '2019-02-09T13:17:26Z'
                  delete_failed:
                    type: string
                    description: Specifies if the Robots Folder deletion failed.
                    example: false
    CreateRobotsFolderRequest:
      type: object
      description: The data associated with the resource.
      required:
      - data
      properties:
        data:
          type: object
          description: The data associated with the resource.
          required:
          - type
          - attributes
          properties:
            type:
              type: string
              description: The classification of the object (`"robots_folders"`).
              example: robots_folders
            attributes:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the Robots Folder.
                  example: test folder
                category:
                  type: string
                  description: Category of the Robots Folder.
                  example: highbond
  responses:
    NotFound:
      description: Not found.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/Errors'
          example:
            errors:
            - status: '404'
              title: Not Found
              detail: The requested resource does not exist.
    MissingOrgId:
      description: Bad request.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/Errors'
          example:
            errors:
            - status: 400
              code: parameter_missing
              title: Parameter missing
              detail: The required parameter, org_id, is missing.
    MissingFolderId:
      description: Bad request.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/Errors'
          example:
            errors:
            - status: 400
              code: parameter_missing
              title: Parameter missing
              detail: The required parameter, folder_id, is missing.
    Forbidden:
      description: Forbidden.
    BadCredentials:
      description: Bad credentials.
  securitySchemes:
    bearerToken:
      description: 'HighBond offers the industry-standard OAuth 2.0 flow for connecting to the HighBond platform. OAuth 2.0 provides a

        safe and secure way to access data, while protecting your account credentials.

        '
      type: http
      scheme: bearer
      bearerFormat: oauth2
x-tagGroups:
- name: Core resources
  tags:
  - Robots Agents
  - Robots
  - Robot Tasks
  - Robot Jobs
  - Robot Apps
  - Robot Script Versions
  - Robot Activations
  - Robot Files
  - Robot Working Files
  - Robot Collaborators
  - Robots Folders Collaborators
  - Robot Users
  - Robots Folders
  - Storyboards
  - Collections
  - Questionnaires
  - Analyses
  - Surveys
  - Event Reports
  - Tables
  - Table columns
  - Records
  - Record columns
  - Record statuses
  - Interpretations
  - Metrics
  - Workflow Groups
  - Results Users
  - Results Triggers
  - Project types
  - Custom attributes
  - Request item statuses
  - Projects
  - Projects Admin
  - Planning files
  - Results files
  - Objectives
  - Narratives
  - Risks
  - Controls
  - Control performance schedules
  - Mitigations
  - Control test plans
  - Control tests
  - Attachments
  - Walkthroughs
  - Issues
  - Actions
  - Collaborators
  - Request Items
  - To-dos
  - Sign-offs
  - Entities
  - Scheduler Filters
  - Frameworks
  - Handlers
  - Workflows in Asset Inventory/Asset Manager
  - Asset types
  - Asset record types
  - Attribute types
  - Assets
  - Asset Relationships
  - Asset records
  - Asset Record Relationships
  - Events
  - Template Toolkits
  - Toolkits
  - Roles
  - Role Deletion
  - Compliance Maps
  - Time entries
  - Non-project time categories
  - Timesheets
  - Importer
  - System Users
  - Organizations
  - Impact Reports
  - Activities
  - Users
  - Groups
  - Scheduled Users
  - Scheduled Projects
  - Scheduled Hours
  - Extract
  - Strategy