Wegalvanize Robot Activations API

openapi: 3.2.0
info:
  title: HighBond API Reference Robot Activations 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: Robot Activations
  x-displayName: Script version activations
  description: 'The Robots app provides two environments for managing and running analytic scripts that you author in Analytics: **development mode** and **production**.


    In development mode, you can test newly committed versions of scripts against data that you have segregated for testing purposes. Once you are satisfied that the

    scripts are working properly, you can activate them and make them your production version.


    Learn more about development mode and production.'
paths:
  /orgs/{org_id}/robots/{robot_id}/robot_activations:
    get:
      tags:
      - Robot Activations
      operationId: getRobotActivations
      summary: Get a robot's script activation history
      description: Get information about a robot's script activation history.
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/robotIdParam'
      responses:
        '200':
          description: OK.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/GetRobotActivationsResponse'
              example:
                data:
                - id: 2
                  type: robot_activations
                  attributes:
                    activated_at: '2019-02-11T19:59:49.008Z'
                    comment: Version 2 replaces version 1
                    version: 2
                  relationships:
                    activator:
                      data:
                        id: 2
                        type: user
                - id: 1
                  type: robot_activations
                  attributes:
                    activated_at: '2019-02-11T19:49:49.008Z'
                    comment: Version 1 comes first
                    version: 1
                  relationships:
                    activator:
                      data:
                        id: 2
                        type: user
                included:
                - id: 2
                  type: user
                  attributes:
                    name: Example User
                    email: example_user@example.com
                    user_type: user
        '400':
          $ref: '#/components/responses/MissingRobotId'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '415':
          $ref: '#/components/responses/NotJsonapiMediaType'
  /orgs/{org_id}/robots/{robot_id}/robot_apps/{robot_app_id}/activate:
    post:
      tags:
      - Robot Activations
      operationId: createRobotActivation
      summary: Activate a script version
      description: You can activate a script version in a robot's development history that has an environment with runtime `Python 3.11` and includes `HCL 3.0.*` in its requirements. When you activate a version, the scripts in that version become the scripts that run in production tasks.
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/robotIdParam'
      - $ref: '#/components/parameters/robotAppIdParam'
      - in: query
        name: force
        description: Overwrites the production scripts with the selected development mode version and ignores conflicts. Forcing the activation sets any existing tasks that are affected by the conflict to an idle status. When a task is set to idle, you must provide the missing parameter input or select the new script names before you can restart the task.
        required: false
        schema:
          type: boolean
          example: true
      - in: query
        name: comment
        description: An informative statement in the version history that explains what you are activating.
        required: false
        schema:
          type: string
          example: activate this
      requestBody:
        description: Empty body
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRobotActivationRequest'
      responses:
        '200':
          description: Created.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CreateRobotActivationResponse'
        '400':
          $ref: '#/components/responses/MissingRobotId'
        '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/RobotActivationError'
components:
  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.
    CreateRobotActivationResponse:
      type: object
      description: The data associated with the resource.
      required:
      - data
      properties:
        data:
          $ref: '#/components/schemas/RobotActivation'
    Errors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    RobotActivation:
      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_activations"`).
          example: robot_activations
        attributes:
          type: object
          description: The attributes associated with the resource.
          properties:
            activated_at:
              type: string
              description: The date when the script was activated.
              example: '2019-03-21T20:22:48.282Z'
            comment:
              type: string
              description: An informative statement in the version history of the script.
              example: The orthogonal features, when combined, can explode into complexity
            version:
              type: integer
              description: The script version number.
              example: 1
        relationships:
          type: object
          description: The relationships associated with the resource.
          properties:
            activator:
              type: object
              description: User that activated the script activation.
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: string
                      description: The ID of the user.
                    type:
                      type: string
                      description: The classification of the object (`"user"`).
          example:
            activator:
              data:
                id: 2
                type: user
    GetRobotActivationsResponse:
      type: object
      description: The data associated with the resource.
      required:
      - data
      properties:
        data:
          type: array
          description: The data associated with the resource.
          items:
            $ref: '#/components/schemas/RobotActivation'
        included:
          type: array
          description: All users related to the resource
          items:
            type: object
            properties:
              id:
                type: string
                description: The ID of the user.
              type:
                type: string
                description: The classification of the object (`"user"`).
              attributes:
                type: object
                description: The attributes associated with the flow.
                properties:
                  name:
                    type: string
                    description: Name of the user
                  email:
                    type: string
                    description: Email of the user.
                  user_type:
                    type: string
                    description: User type.
    CreateRobotActivationRequest:
      type: string
    RobotActivationError:
      type: object
      required:
      - errors
      properties:
        errors:
          type: array
          items:
            type: object
            required:
            - status
            - source
            - meta
            properties:
              status:
                type: string
                description: A HTTP response status code indicating an unprocessable entity.
                enum:
                - '422'
              source:
                type: object
                properties:
                  parameter:
                    type: string
                    description: Indicates the parameter in conflict. Parameters are compared between the current production version of the script and the version you are activating.
                    example: version
              meta:
                type: object
                properties:
                  task_id:
                    type: integer
                    description: The ID of the robot task.
                    example: 1
                  conflicts:
                    type: object
                    properties:
                      missing_analytics:
                        type: array
                        description: Specifies a script name conflict. This occurs when when a script that is selected to run in an existing production task or tasks has been renamed in the development script version or removed from the development script version.
                        items:
                          type: string
                        example:
                        - Monitored zero administration superstructure
                      missing_values:
                        type: array
                        description: Specifies a parameter conflict. This occurs when a new input parameter has been added in the development script version.
                        items:
                          type: string
                        example:
                        - Adaptive attitude-oriented customer loyalty
                      changed_attributes:
                        type: array
                        description: Specifies a parameter conflict. This occurs when the attributes of an existing input parameter have been changed in the development script version.
                        items:
                          type: string
                        example:
                        - Streamlined background algorithm
  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.
    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.

                '
    MissingRobotId:
      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, robot_id, is missing.
    Forbidden:
      description: Forbidden.
    BadCredentials:
      description: Bad credentials.
  parameters:
    robotAppIdParam:
      in: path
      name: robot_app_id
      description: The ID of the robot app.
      required: true
      schema:
        type: string
        example: 2
    robotIdParam:
      in: path
      name: robot_id
      description: The ID of the robot.
      required: true
      schema:
        type: string
        example: 2
    orgIdParam:
      in: path
      name: org_id
      description: The ID of the HighBond instance.
      required: true
      schema:
        type: string
        example: 1
  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