Robot task runs, also known as robot jobs, are individual executions of a robot task. For example, for any given robot task, you can schedule a task run once every 24 hours, or you can initiate a task run manually at any time.
openapi: 3.0.2
info:
title: HighBond API Reference Actions Robot Jobs API
version: 1.1.0
description: "\nWelcome to the API documentation for HighBond.\n\n## Introduction\nThe HighBond API is the developer interface for the HighBond platform. You can use it to automate interactions with HighBond,\nbuild reporting, and integrate HighBond with other systems in your company. This introduction contains information you should\nknow before you get started.\n\nThe HighBond API is organized around <a href=\"https://en.wikipedia.org/wiki/Representational_state_transfer\" target=\"_blank\">REST</a> and is built on the\n<a href=\"https://jsonapi.org/format/\" target=\"_blank\">JSON API v1.0 specification</a>.\n\n> **Warning —**\nThis API interacts with your company's live data. It gives you the power to delete important data that your\ncompany needs. Carefully consider the consequences of your actions when using this API. If you are not sure, contact the\nperson or group who administers HighBond in your company.\n\n### Permissions\nUsers can generate and manage API tokens in their user profiles in HighBond. Because these tokens are tied to users, not companies, your permissions in the API are the same as your permissions in HighBond.\n\n> **Note —**\nYou must be a System Admin in at least one HighBond instance to access the API.\n\nIf you leave your company and your HighBond user account is deleted, your application will break. Before getting started, consider the long-term requirements of your application. You may wish to create a system account in HighBond and build your application from that, but verify that your company's security policies permit accounts that aren't tied to particular people.\n\nHighBond uses the <a href=\"https://tools.ietf.org/html/rfc6749\" target=\"_blank\">OAuth 2.0 authorization framework</a> to control access to the API.\n\n\n### Apps\nApps are components in HighBond that provide specific functionality. You can use this API to interact with data in the apps you have access to.\n\nThe apps available to you depend on the edition of HighBond (standard or premium) in use, and whether or not your company has purchased any add-on apps.\nFor more information, see <a href=\"https://help.highbond.com/helpdocs/highbond/en-us/Default.htm#cshid=lp-product-editions\" target=\"_blank\">Subscriptions, editions, and capabilities</a>.\n\n### Rate limitations\nThe API safeguards against bursts of usage to help maximize its stability. For most endpoints, you cannot make more than 6 requests per second.\n\nThe following endpoints have a stricter rate limitation of 3 requests per minute:\n\n* Groups\n* Users\n\nTreat these limits as a maximum and avoid making unnecessary requests to the API.\n\nIf you make too many requests, the API responds with a `429` \"Too many requests\" status.\n\n## Getting started\nTo start interacting with your HighBond organization via the API, you need a few things:\n\n* An authentication token from your HighBond instance\n* The correct region URL for your HighBond instance\n* Information about the HighBond instance and resource IDs you want to interact with\n\nIf you need assistance with any of these, contact a HighBond administrator at your company, or email <a href=\"mailto:support@wegalvanize.com\">support@wegalvanize.com</a>.\n\n### Authentication\nAll requests require authentication. To authenticate, use Launchpad to create a HighBond API (bearer) token for your account. The token is a string that authenticates you\nand allows you to securely access the HighBond API.\n\nFor help creating a token, see <a href=\"https://help.highbond.com/helpdocs/highbond/en-us/Default.htm#cshid=lp-access-tokens\" target=\"_blank\">Creating and managing access tokens</a>.\n\nOnce you have created your token, you can provide it in the header of your request:\n```\nAuthorization: Bearer <TOKEN>\n```\n > **Important —**\nIf you do not authenticate yourself, the API fails. The API responds to authentication failures with a `401` \"Bad credentials\" status.\n\n<security-definitions />\n\n### Token security\nHighBond uses the <a href=\"https://tools.ietf.org/html/rfc6749#section-1.3.1\" target=\"_blank\">Authorization Code workflow</a> to generate tokens.\n\nTo enable continuous access to the API, and to provide full ownership and accountability to users, Galvanize does not impose an expiration date\non the token. You can <a href=\"https://help.highbond.com/helpdocs/highbond/en-us/Default.htm#cshid=lp-access-tokens\" target=\"_blank\">delete a token in\nLaunchpad</a> when you no longer need access to the API.\n\n> **Important —**\nYour access token provides many privileges, so keep it secure and private. Galvanize recommends that you encrypt your\nmachine to securely store the token. Avoid sharing your token in publicly accessible areas such GitHub or within client-side code.\n\n### API regions\n\nThe HighBond service is provided from different regions in order to give customers options for where your data is stored, and to enable you to\ncomply with data privacy location requirements.\n\nYour request URL must include one of the following region codes, based on where your HighBond instance resides:\n\n* **United States** — `https://apis-us.diligentoneplatform.com`\n* **Canada** — `https://apis-ca.diligentoneplatform.com`\n* **Europe** — `https://apis-eu.diligentoneplatform.com`\n* **Asia** — `https://apis-ap.diligentoneplatform.com`\n* **Australia** — `https://apis-au.diligentoneplatform.com`\n* **Africa** — `https://apis-af.diligentoneplatform.com`\n* **South America** — `https://apis-sa.diligentoneplatform.com`\n* **Japan** — `https://apis-jp.diligentoneplatform.com`\n\nAdditionally, for government clients, there are two government \"regions\":\n* **Gov** (US federal) — `https://apis.diligentoneplatform-gov.com`\n* **SLED** (state, local, and education; non-federal) — `https://apis.diligentoneplatform-gov2.com`\n\n> **Important —**\nAll API requests must be made over <a href=\"https://en.wikipedia.org/wiki/HTTPS\" target=\"_blank\">HTTPS</a>. Calls over HTTP respond with the `301` \"Moved Permanently\" status.\n\n\n### HighBond instance and resource IDs\nRequests require a HighBond instance ID and the ID of the resource you are interacting with. These IDs are numeric keys that uniquely\nidentify the HighBond instance and every resource in that instance.\n\nThe easiest way to get your HighBond instance ID is to log in to HighBond and take the ID from the URL:\n```\nhttps://accounts.highbond.com/orgs/12345\n```\n\nTo obtain IDs for resources like collections, analyses, tables, and robots, you can navigate to the item you want to reference, and take the IDs from the URL.\nFor example, this URL shows a collection ID:\n```\nhttps://example-company.results.highbond.com/projects/55843\n```\n\n> **Tip —**\nThe `GET` methods in this API also return IDs that you can use to identify resources you can act on.\n\n\n## Making requests\nOnce you have all the information you need, you can start making requests in an API client of your choice.\n\n### HTTP methods\nThe API uses the appropriate HTTP method for each action:\n* `GET` — used for retrieving resources\n* `POST` — used for creating resources\n* `PUT` / `PATCH` — used for updating resources\n* `DELETE` — used for deleting resources\n\n\n### Content type\nAlways specify the `Content-Type` of your request in the header. Supported content types are:\n* JSON API\n* JSON (for backwards compatibility)\n\n```\nContent-Type: application/vnd.api+json\nContent-Type: application/json\n```\n\nA complete **Get a table** request using `curl` would look like this:\n```\ncurl -H \"Authorization: Bearer XYZ\" -H \"Content-Type: application/vnd.api+json\" https://apis-us.highbond.com/v1/orgs/11594/tables/388930\n```\n\n### Requesting the API to return only specific fields\nFor certain resources, such as control tests, you can request the API to return only specific fields using the `fields` query parameter. Sparse fieldsets are\nhelpful for limiting your responses to only the data you require.\n\n> **Note —**\nThe `type` argument must specify the resource you want to retrieve. The value of the `fields` parameter must be a comma-delimited list that specifies\nthe name of the field(s) to be returned. Avoid whitespace before or after each comma.\n```\nfields[type]=field_name1,field_name2,fieldname3\n```\n\nA complete **Get a control test** request that only returns the `assigned_user`, `control`, and `testing_round_number` fields would look like this:\n\n```\ncurl -H \"Authorization: Bearer XYZ\" -H \"Content-Type: application/vnd.api+json\" https://apis-us.highbond.com/v1/orgs/12345/control_tests/105?fields[control_tests]=assigned_user,control,testing_round_number\n```\n\n### Requesting the API to return related resources\nTo reduce the number of requests, you may use the `include` query parameter to return related resources in the response along with the requested primary resources. Such responses are called \"compound documents\".\n\nAccepted values for the `include` parameter are documented in the `Query Parameters` section of each API method.\n\n> **Note —**\nThe `include` parameter must be a comma-delimited list that specifies\nthe name of the relationship(s) or nested relationship(s) to be returned. Avoid whitespace before or after each comma.\n\nExample - requesting a relationship and a nested relationship\n```\ninclude=control,control.objective\n```\n\nA complete **Get a control test** request that returns the `control` relationship, and `control.objective` nested relationship would look like this:\n\n```\ncurl -H \"Authorization: Bearer XYZ\" -H \"Content-Type: application/vnd.api+json\" https://apis.highbond.com/v1/orgs/12345/control_tests/105?include=control,control.objective\n```\n\n\n### Blank fields\nBlank fields are included in all response schemas as `\"\"` or `null` instead of being omitted.\n\n\n### Time zones\nAll timestamps are returned in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.\n\nSome requests that create new data, such as creating a robot task's schedule, allow you to provide time zone information.\nFor API requests that allow for a timestamp to be specified, you must explicitly provide an ISO 8601 timestamp with time zone information.\n\n```\n\"starts_at\": \"2019-03-21T16:25:00.478Z\",\n\"starts_at_timezone\": \"America/Los_Angeles\",\n```\n\n\n### Rich text fields\n\nSome requests and responses contain rich text fields that include HTML tags. These are typically description fields. If you need to format text,\nthe best approach is to upload your raw data first and apply formatting later in the user interface.\n\n> **Note —**\nImages that exist in rich text fields are returned in responses, but they are not rendered. You cannot upload new images to rich text fields using the API.\n\n\n### User identifiers\nA unique identifier (UID) is an alphanumeric string that is associated with a user in HighBond. UIDs make it possible to address users,\nso that they can be accessed and interacted with using the API. Some requests that allow you to assign items to users, such as creating an objective,\nrequire you to specify a user's UID.\n\nTo obtain a user's UID:\n\n1. Sign in to <a href=\"https://accounts.highbond.com/login\" target=\"_blank\">HighBond</a>.\n2. If your company uses more than one instance in HighBond, make sure <a href=\"https://help.highbond.com/helpdocs/highbond/en-us/Default.htm#cshid=lp-switch-instances\"\ntarget=\"_blank\">the appropriate instance is active</a>.\n3. Select **Options > Users (#)**.\n4. Navigate to the appropriate user and click the user's name.\n5. In the **User Details** side panel, copy the UID to your clipboard.\nOnce you have copied the UID, you can specify it in your request.\n\n\n### Pagination\nWhen a response consists of a large number of items, the API breaks it into separate pages for performance reasons. You can control the way the API paginates your results by specifying how many items you want to have per page, and which page you want the API to return.\n\nFor example, if you request a list of controls, the request could look like this: `{protocol}://{server}/v1/orgs/{org_id}/objectives/{objective_id}/controls?page[size]=25&page[number]=Mg==`\n\nWhere:\n\n* `page[size]=25` specifies that there should be 25 items per page. Different endpoints have different default values and maximum numbers of values you can have per page.\n* `page[number]=Mg==` specifies that the API should return the second page of results (the 26th through 50th items that match the request).\n\n > **Note —**\n In most cases, page numbers must be encoded in Base64. In this example, `Mg==` is the Base64 encoded value for `2`.\n\nAdditionally, responses include the `links` parameter, which provides URLs for the `prev` and `next` attributes (or `null` values if all of the items are on one page). Those URLs include the above parameters, so you can paste them into subsequent requests if needed.\n\n\n\n## Errors\nHighBond uses standard <a href=\"https://en.wikipedia.org/wiki/List_of_HTTP_status_codes\" target=\"_blank\">HTTP response codes</a>\nto indicate the success or failure of a request. The range of a code indicates information about why it succeeded or failed:\n\n* **`2xx` range —** Success\n* **`4xx` range —** Error given the information provided\n* **`5xx` range —** Server failed to fulfil a valid request\n\nSome common errors that occur when making requests include:\n* **`400` Bad request —** When a parameter is missing (such as the `org_id` or resource `id`), when more\nthan one unique resource is specified in the request, or when a specified data type is incompatible with the endpoint\n* **`401` Bad credentials —** When there is an authentication error\n* **`403` Forbidden —** When there is an authorization problem based on your <a href=\"https://help.highbond.com/helpdocs/highbond/en-us/Default.htm#cshid=lp-managing-apps\"\ntarget=\"_blank\">role in a HighBond app</a> or <a href=\"https://help.highbond.com/helpdocs/highbond/en-us/Default.htm#cshid=lp-assigning-subscriptions\" target=\"_blank\">subscription</a>\n* **`404` Not found —** When there is a problem on the client side due to an incorrect URL or resource deletion\n* **`415` Unsupported media type —** When the `Content-Type` specified is unsupported\n* **`422` Unprocessable entity —** When a required attribute is missing (such as the name of a resource), or when a conflict occurs\n(such as a script activation conflict)\n\n\n## Versioning\nAll API endpoints use a version number in the path. As can be seen in the examples, `/v1/` specifies version 1 of the API.\n\nOver time, the API will evolve. New API versions will be introduced and existing versions may be updated.\n\nSome API updates are considered a breaking change, requiring a new version of the API to be introduced. An example of a breaking\nchange is fields being changed or removed. By introducing a new version, API consumers can safely continue to use prior API versions.\n\nThe other type of API update is a non-breaking change. You should expect non-breaking change updates to existing API versions.\nAn example of a non-breaking change is adding a field to a response object. Non-breaking changes are additive. While they do\nchange the response body, they should not impact the API consumer.\n"
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 Jobs
x-displayName: Robot task runs
description: 'Robot task runs, also known as robot jobs, are individual executions of a robot task. For example, for any given robot task, you can schedule a task run once every 24 hours, or you can initiate a task run manually at any time.
'
paths:
/orgs/{org_id}/robots/{robot_id}/jobs:
get:
tags:
- Robot Jobs
operationId: getRobotJobs
summary: List robot task runs
description: Get a list of task runs for a robot.
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/robotIdParam'
- $ref: '#/components/parameters/robotEnvParam'
- $ref: '#/components/parameters/robotJobsIncludeParam'
- $ref: '#/components/parameters/robotPageSizeParam'
- $ref: '#/components/parameters/robotPageNumberParam'
responses:
'200':
description: OK.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/GetRobotJobsResponse'
example:
data:
- id: '1'
type: robot_jobs
attributes:
app_version: 1
completed_at: '2019-03-21T20:32:48.282Z'
count: 1
delete_failed: false
discarded_at: null
environment: production
error_code: null
queued_at: '2019-03-21T20:22:48.282Z'
result_analytics:
- name: Test HB robot flow
logs:
- key: 1234567\/12345\/audit_logs.json
file_name: Test task.json
success: true
result_downloadable: true
status: success
trigger_type: schedule
agent_count: null
relationships:
robot:
data:
id: '1'
type: robot
task:
data:
id: '1'
type: task
triggered_by:
data:
id: '1'
type: user
- id: '2'
type: robot_jobs
attributes:
app_version: 1
completed_at: '2019-03-21T20:52:48.282Z'
count: 2
delete_failed: false
discarded_at: null
environment: production
error_code: null
queued_at: '2019-03-21T20:42:48.282Z'
result_analytics:
- name: Test HB robot flow
logs:
- key: 1234567\/12345\/audit_logs.json
file_name: Test task.json
success: true
result_downloadable: true
status: success
trigger_type: schedule
agent_count: null
relationships:
robot:
data:
id: '1'
type: robot
task:
data:
id: '1'
type: task
triggered_by:
data:
id: '1'
type: user
links:
prev: /v1/orgs/{org_id}/robots/{robot_id}/jobs?env={env}&page[size]=2&page[number]=1
next: /v1/orgs/{org_id}/robots/{robot_id}/jobs?env={env}&page[size]=2&page[number]=3
'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/jobs/{job_id}:
delete:
tags:
- Robot Jobs
operationId: deleteRobotJobs
summary: Delete robot task run
description: Delete a single robot task run.
parameters:
- $ref: '#/components/parameters/orgIdParam'
- $ref: '#/components/parameters/robotJobIdParam'
responses:
'200':
description: OK.
'401':
$ref: '#/components/responses/BadCredentials'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
description: Unprocessable entity.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/RobotsError'
components:
schemas:
RobotJob:
type: object
description: The data associated with the resource.
required:
- id
- type
- attributes
properties:
id:
type: string
description: The ID of the task run.
example: 1
type:
type: string
description: The classification of the object (`"robot_jobs"`).
example: robot_jobs
attributes:
type: object
description: The attributes associated with the resource.
properties:
app_version:
type: integer
description: The version of the script.
example: 1
completed_at:
type: string
description: The date the task run was completed.
example: '2019-03-21T20:22:48.282Z'
count:
type: integer
description: The folder name that is automatically created in the Robots Agent. The folder corresponds to an individual task run.
example: 1
delete_failed:
type: boolean
description: If a user made a request to delete a task run, this indicates whether the deletion failed.
example: false
discarded_at:
type: string
description: If a user made a request to delete a task run, this is the time the user made the request.
example: null
environment:
type: string
description: The environment of the script.
enum:
- production
- development
error_code:
type: string
description: If the task run failed due to a known reason, this error code indicates that reason. Not all failed task runs have associated error codes.
example: null
queued_at:
type: string
description: The date the task run was queued to execute.
example: '2019-03-21T20:22:48.282Z'
result_analytics:
type: array
description: Includes analytics information about the task run.
items:
type: object
properties:
name:
type: string
description: The name of the script.
logs:
type: array
description: Information about the system trace logs.
items:
type: object
properties:
key:
type: string
description: The key HighBond uses to download the system trace log file.
file_name:
type: string
description: The file name for the system trace log.
success:
type: boolean
description: Indicates whether this particular script executed successfully.
example: true
result_downloadable:
type: boolean
description: Indicates whether you can download the result files in the UI.
example: true
status:
type: string
description: The status of the task run.
enum:
- success
- failed
- cancelled
- queued
- running
- skipped
trigger_type:
type: string
description: The trigger type of the task run.
enum:
- schedule
- manual
- event
agent_count:
type: string
description: For ACL Robot task runs that run with an on-premise agent, this is the ID of the agent that ran it. For all other robot types, this value is `null`.
example: null
relationships:
type: object
description: List of associated objects with the robot task run.
properties:
robot:
type: object
description: Information about the robot associated with the task run.
properties:
data:
type: object
description: Data about the robot.
properties:
id:
type: string
description: The ID of the robot.
type:
type: string
description: The classification of the object (`"robot"`).
task:
type: object
description: Information about the task associated with the task run.
properties:
data:
type: object
description: Data about the task.
properties:
id:
type: string
description: The ID of the task.
type:
type: string
description: The classification of the object (`"task"`).
triggered_by:
type: object
description: Information about the user who triggered the task run.
properties:
data:
type: object
description: Data about the user.
properties:
id:
type: string
description: The ID of the user. In addition to the user IDs used elsewhere in the HighBond API, each user also has an ID specific to Robots. To see a list of users and their Robots IDs in the response, use the `include=triggered_by` parameter.
type:
type: string
description: The classification of the object (`"user"`).
Errors:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
GetRobotJobsResponse:
type: object
properties:
data:
type: array
description: The data associated with the resource.
items:
$ref: '#/components/schemas/RobotJob'
links:
type: object
properties:
prev:
type: string
description: Previous page url
next:
type: string
description: Next page url
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.
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
responses:
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.
'
Forbidden:
description: Forbidden.
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.
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.
BadCredentials:
description: Bad credentials.
parameters:
robotJobsIncludeParam:
in: query
name: include
description: If specified, the associated objects will be included in the `included` list
required: false
schema:
type: string
enum:
- robot
- task
- triggered_by
example: robot,task,triggered_by
robotEnvParam:
in: query
name: env
description: The environment of an analytic script.
required: false
schema:
type: string
enum:
- development
- production
default: development
example: production
robotPageSizeParam:
in: query
name: page[size]
description: The number of items returned per page. Default is 100.
required: false
schema:
type: string
example: 100
robotPageNumberParam:
in: query
name: page[number]
description: The page number of records to return. Default is 1.
required: false
schema:
type: string
example: 1
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
robotJobIdParam:
in: path
name: job_id
description: The ID of the robot job.
required: true
schema:
type: string
example: 2
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:
-
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/wegalvanize/refs/heads/main/openapi/wegalvanize-robot-jobs-api-openapi.yml