Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wegalvanize Robot Tasks API

When you create a task, a robot runs the task according to the settings that you configure. A task can be scheduled or run ad hoc (manually).Each task has its own unique settings.Learn more about tasks.

Wegalvanize Robot Tasks API is one of 69 APIs that Wegalvanize publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Robot Tasks. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 11 operations across 5 paths, and defines 17 schemas. It is described by OpenAPI 3.0.2, at version 1.1.0.

Requests are made against a single base URL, {protocol}://{server}/v1.

11 operations 5 paths 17 schemas 2 DELETE3 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.1.0
Base URL
https://apis-us.highbond.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Wegalvanize Robot Tasks API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (oauth2) (bearerToken). By default, every request must be authenticated.

  • bearerToken — 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 pr…

Paths & Operations 11

Across 5 paths, the API surfaces 11 operations — 2 DELETE, 3 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Robot Tasks 11

When you create a task, a robot runs the task according to the settings that you configure. A task can be scheduled or run ad hoc (manually). Each task has its own unique settings…

GET
/orgs/{org_id}/robots/{robot_id}/robot_tasks
List tasks in a robot
getRobotTasks 3 params → 200400401403404415
POST
/orgs/{org_id}/robots/{robot_id}/robot_tasks
Create a robot task
createRobotTask 2 params body → 200400401403404415422
PUT
/orgs/{org_id}/robot_tasks/{id}
Update a robot task
putRobotTask 2 params body → 200400401403404415422
DELETE
/orgs/{org_id}/robot_tasks/{id}
Delete a robot task
deleteRobotTask 2 params → 200400401403404415
POST
/orgs/{org_id}/robot_tasks/{id}/run_now
Run a robot task
runRobotTask 3 params → 200400401403404415
GET
/orgs/{org_id}/robot_tasks/{robot_task_id}/values
List values in a robot task
getValues 2 params → 200400401403404415
PUT
/orgs/{org_id}/robot_tasks/{robot_task_id}/values
Update values in a robot task
putValues 2 params body → 200400401403404415422
GET
/orgs/{org_id}/robot_tasks/{robot_task_id}/schedule
Get a robot task's schedule
getSchedule 2 params → 200400401403404415
POST
/orgs/{org_id}/robot_tasks/{robot_task_id}/schedule
Create a robot task's schedule
createSchedule 2 params body → 200400401403404415422
PUT
/orgs/{org_id}/robot_tasks/{robot_task_id}/schedule
Update a robot task's schedule
putSchedule 2 params body → 200400401403404415422
DELETE
/orgs/{org_id}/robot_tasks/{robot_task_id}/schedule
Delete a robot task's schedule
deleteSchedule 2 params → 200400401403404415

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Error (5 properties), RobotTaskValue (3 properties), RobotTask (3 properties), RobotTaskSchedule (3 properties). Each schema is shown below with its type and property counts.

GetRunRobotTaskResponse
object
1 property
RobotTaskValue
object
The data associated with the resource.
3 properties 3 required
Error
object
5 properties 1 required
Errors
object
1 property
CreateRobotTaskScheduleRequest
object
The data associated with the resource.
1 property 1 required
StringValue
string
RobotTaskSchedule
object
The data associated with the resource.
3 properties 3 required
GetRobotTaskResponse
object
1 property 1 required
UpdateRobotTaskValuesRequest
object
1 property 1 required
RobotsError
object
1 property 1 required
CreateRobotTaskRequest
object
1 property 1 required
RobotTaskRequestValue
A user-facing input parameter, which lets a user specify script input values in advance. This allows an analytic script to run unattended, either immediately,…
GetRobotTasksResponse
object
1 property
RobotTask
object
The data associated with the resource.
3 properties 3 required
GetRobotTaskScheduleResponse
object
The data associated with the resource.
1 property 1 required
GetRobotTaskValuesResponse
object
1 property 1 required
StringValues
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wegalvanize-robot-tasks-api-openapi.yml Raw ↑

Other APIs Wegalvanize publishes across the network.

Wegalvanize Actions API
Wegalvanize Activities API
Wegalvanize Analyses API
Wegalvanize Attachments API
Wegalvanize Collaborators API
Wegalvanize Collections API
Wegalvanize Compliance Maps API
Wegalvanize Control performance schedules API
Wegalvanize Control test plans API
Wegalvanize Control tests API
Wegalvanize Controls API
Wegalvanize Custom attributes API