Wegalvanize Robots API

openapi: 3.2.0
info:
  title: HighBond API Reference Robots 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
  description: 'A robot is a tool that lets you automate repetitive tasks using scripts built in Analytics. Once you create the scripts, you upload them to a robot in the Robots app

    and configure the task automation that you need. The robot then handles the recurring tasks according to your configuration.


    Learn more about robots.'
paths:
  /orgs/{org_id}/robots:
    get:
      tags:
      - Robots
      operationId: getRobots
      summary: Get a list of robots
      description: Get a list of all the robots in your HighBond instance.
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/robotNameParam'
      responses:
        '200':
          description: OK.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetRobotsResponse'
              example:
                data:
                - id: 1
                  type: robot
                  attributes:
                    active_app_version: 1
                    app_versions_count: 1
                    automated: false
                    category: acl
                    count: 1
                    created_at: '2019-02-09T13:17:26Z'
                    description: Sample description
                    delete_failed: false
                    discarded_at: '2019-02-09T13:17:26Z'
                    folder_id: 1
                    kept_tasks_count: 1
                    last_committed_at: '2019-02-09T13:17:26Z'
                    last_run_at: 2019-02-09T
                    name: Heavy Duty Wooden Coat
                    production_updated_at: '2019-02-09T13:17:26Z'
                    share_tables_in_development: false
                    share_tables_in_production: false
                - id: 2
                  type: robot
                  attributes:
                    active_app_version: 2
                    app_versions_count: 1
                    automated: false
                    category: highbond
                    count: 1
                    created_at: '2019-02-09T13:17:26Z'
                    description: Sample description
                    delete_failed: false
                    discarded_at: '2019-02-09T13:17:26Z'
                    folder_id: null
                    kept_tasks_count: 1
                    last_committed_at: '2019-02-09T13:17:26Z'
                    last_run_at: 2019-02-09T
                    name: Enormous Paper Pants
                    production_updated_at: '2019-02-09T13:17:26Z'
                    share_tables_in_development: false
                    share_tables_in_production: false
        '400':
          $ref: '#/components/responses/MissingOrgId'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '415':
          $ref: '#/components/responses/NotJsonapiMediaType'
    post:
      tags:
      - Robots
      operationId: createRobot
      summary: Create a robot
      description: Create a robot to automate repetitive tasks. The robot contains analytic scripts and related files, and carries out any scheduled tasks that you configure.
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      requestBody:
        description: The data required to create a robot.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRobotRequest'
      responses:
        '200':
          description: Created.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetRobotResponse'
        '400':
          $ref: '#/components/responses/MissingOrgId'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '415':
          $ref: '#/components/responses/NotJsonapiMediaType'
        '422':
          description: Unprocessable entity.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RobotsError'
  /orgs/{org_id}/robots/{id}:
    put:
      tags:
      - Robots
      operationId: putRobot
      summary: Update a robot
      description: Update a robot's attributes.
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/resourceIdParam'
      requestBody:
        description: The data required to update a robot.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRobotRequest'
      responses:
        '200':
          description: Updated.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetRobotResponse'
        '400':
          $ref: '#/components/responses/MissingResourceId'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '415':
          $ref: '#/components/responses/NotJsonapiMediaType'
        '422':
          description: Unprocessable entity.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/RobotsError'
    delete:
      tags:
      - Robots
      operationId: deleteRobot
      summary: Delete a robot
      description: 'Permanently delete a robot.


        > **Caution —**

        Deleting a robot also permanently deletes any associated tasks.'
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/resourceIdParam'
      responses:
        '200':
          description: Deleted.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetRobotResponse'
        '400':
          $ref: '#/components/responses/MissingOrgId'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '415':
          $ref: '#/components/responses/NotJsonapiMediaType'
components:
  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.
    NotJsonapiMediaType:
      description: Unsupported media type.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/Errors'
          example:
            errors:
            - status: 415
              code: unsupported_media_type
              title: Unsupported media type
              detail: 'The endpoint supports only the application/vnd.api+json Content-Type. This request specified application/json.

                '
    BadCredentials:
      description: Bad credentials.
    Forbidden:
      description: Forbidden.
    MissingResourceId:
      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, id, is missing.
  schemas:
    Robot:
      type: object
      description: The data associated with the resource.
      required:
      - id
      - type
      - attributes
      properties:
        id:
          type: string
          description: The ID of the robot.
          example: 1
        type:
          type: string
          description: The classification of the object (`"robot"`).
          example: robot
        attributes:
          type: object
          description: The attributes associated with the resource.
          required:
          - name
          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'
            folder_id:
              type: number
              description: The Folder ID.
              example: 1
            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
    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.
    GetRobotsResponse:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          description: The data associated with the resource.
          items:
            $ref: '#/components/schemas/Robot'
    Errors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    GetRobotResponse:
      type: object
      required:
      - data
      properties:
        data:
          $ref: '#/components/schemas/Robot'
    CreateRobotRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: The name of the robot.
          example: R2D2
        description:
          type: string
          description: The description of the robot.
          example: Sample description
        category:
          type: string
          description: The category of the robot.
          enum:
          - acl
          - highbond
          - workflow
          default: acl
          example: workflow
    RobotsError:
      type: object
      required:
      - errors
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              status:
                type: string
                description: A HTTP response status code indicating an unprocessable entity.
                enum:
                - '422'
                example: '422'
              source:
                type: object
                properties:
                  pointer:
                    type: string
                    description: Indicates the specific source of the error.
                    example: /data/attributes/name
              title:
                type: string
                description: A title of the error.
                example: can't be blank
              detail:
                type: string
                description: A descriptive statement of the error.
                example: Name can't be blank
  parameters:
    resourceIdParam:
      in: path
      name: id
      description: The ID of the requested resource.
      required: true
      schema:
        type: string
        example: 9999
    orgIdParam:
      in: path
      name: org_id
      description: The ID of the HighBond instance.
      required: true
      schema:
        type: string
        example: 1
    robotNameParam:
      in: query
      name: name
      description: The name of the robot.
      required: false
      schema:
        type: string
        example: Test Robot
  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