Device API

Use the Device API to identify all available users with unattended Bot Runner licenses, or filter for users by name.

All API calls must contain either an authentication token from Authentication API (generates JSON Web token) or a bearer token from OAuth services. You cannot use both together in an API.
Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<bearer token>>

More information: https://helloreverb.com

Contact Info: hello@helloreverb.com

Version: 1.0.0

All rights reserved

http://apache.org/licenses/LICENSE-2.0.html

Access

APIKey KeyParamName:X-Authorization KeyInQuery:false KeyInHeader:true

Methods

Models

Table of Contents

Device

Up

delete /{id}

Delete a device (idDelete)

Use this endpoint to delete a device. You must specify the device ID.

Path parameters

id (required)

Path Parameter — ID of the device format: int64

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

204

Return 'nocontent'

400

Bad Request. Error

401

Authentication required. Error

404

Not Found. ErrorMessage

500

Server error. Error

Up

post /runasusers/default

Assign default deployment device (runasusersDefaultPost)

Use this endpoint to set a specific device as the default deployment device for the specific user. You must have User management rights or admin rights.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body RunAsUserDefaultDevice (required)

Body Parameter —

Return type

RunAsUserDefaultDevice

Example data

Content-Type: application/json

{
  "deviceId" : 1046,
  "userId" : 589
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Returns the details of the default device that was set for the user RunAsUserDefaultDevice

400

Bad Request. Error

401

Authentication required. Error

404

Not Found. ErrorMessage

500

Server error. Error

Up

post /runasusers/default/unset

Unset the default deployment device (runasusersDefaultUnsetPost)

<p>Use this endpoint to unset a specific device as the default deployment device for the specific user.</p> <ul> <li>Only userId is a required parameter.</li> <li>deviceId value will be ignored.</li> </ul>

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body RunAsUserDefaultDevice (required)

Body Parameter —

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Returns an empty response

400

Bad Request. Error

401

Authentication required. Error

404

Not Found. ErrorMessage

500

Server error. Error

Up

post /runasusers/list

List available run as users (runasusersListPost)

Use this endpoint to retrieve a list of available users with unattended Bot Runner licenses. This endpoint returns an user id, which is a numeric value that is used by APIs to identify users. You must be assigned a custom role that is associated with a Run As user device.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body FilterRequest (required)

Body Parameter —

Return type

DeviceRunAsUserResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 6,
    "total" : 6,
    "offset" : 0
  },
  "list" : [ {
    "id" : 9,
    "device" : "DESKTOP-DBO6SIE",
    "deviceId" : 3,
    "username" : "ubr01_rt"
  }, {
    "id" : 9,
    "device" : "DESKTOP-DBO6SIE",
    "deviceId" : 3,
    "username" : "ubr01_rt"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Returns list of run as users available to the user DeviceRunAsUserResponse

400

Bad Request. Error

401

Authentication required. Error

404

Not Found. ErrorMessage

500

Server error. Error

Models

Methods

Table of Contents

DeviceRunAsUser
DeviceRunAsUserResponse
Error
ErrorMessage
Filter
FilterRequest
PageRequest
RunAsUserDefaultDevice
Sort

`DeviceRunAsUser` Up

id (optional)

Integer ID of the user

example: 9

username (optional)

String User name associated with the user

example: ubr01_rt

device (optional)

String Default device name attached to the user if availble. Else the device is "Picked at run time".

example: DESKTOP-DBO6SIE

deviceId (optional)

Integer ID of the device if available. Else -1 is displayed.

example: 3

`DeviceRunAsUserResponse` Up

page (optional)

Object

list (optional)

array[DeviceRunAsUser]

`Error` Up

code (optional)

String Error code

message (optional)

String Error Message

`ErrorMessage` Up

message (optional)

String Error Message

`Filter` Up

Filter rules

operator (optional)

String Operator

Enum:

NONE

lt

le

eq

ne

ge

gt

substring

and

or

not

operands (optional)

array[Filter]

example: {operator=substring, field=id, value=9}

field (optional)

String Filter field

example: name

value (optional)

String Filter value

example: bot

`FilterRequest` Up

Filter request, which includes filtering, sorting and pagination rules

filter (optional)

Filter

sort (optional)

array[Sort] Sort directions

page (optional)

PageRequest

`PageRequest` Up

Pagination rules

offset (optional)

Integer Page starting index

length (optional)

Integer Page length

example: 100

`RunAsUserDefaultDevice` Up

deviceId (optional)

Integer ID of the device to be set as the default device for the users.

example: 1046

userId (optional)

Integer ID of the user whose default device is being set.

example: 589

`Sort` Up

By default, search results are sorted in descending order with respect to their IDs. An alternative sorting is specified by using the sort query parameter.

field (optional)

String Field name to sort by

example: username

direction (optional)

String Sorting direction

Enum:

asc

desc