DDX (Tevor) REST API - Amazon Web Services...DDX (Tevor) REST API Adder Technology DDX (Trevor) REST...

GET /auth/local Authenticate User using Local strategy (Username/Password) and return JWT.

Model Model Schema

Try it out!

Computers

GET /computers Return a list of Computers

DDX (Tevor) REST APIAdder Technology DDX (Trevor) REST API.

Implementation NotesThis endpoint allows a user to be authenticated by username/password supplied over clear text(HTTPS should be used). A JSON Web Token is returned (JWT) which can be passed in theAuthorization header of each subsequent API call.

Response Class (Status 200)

{ "token": "string"}

Response Content Type application/hal+json

Parameters

Parameter Value Description ParameterType Data Type

body (required)

Parameter content type:

application/hal+json

User logincredentials

{ "username": "string", "password": "string"}

Click to set as parameter value

Response MessagesHTTP StatusCode Reason Response Model Headers

401 Unauthorised. Invalid or nocredentials provided.

Model Model Schema

[ { "id": 0, "primaryConsole": 0, "connectedConsoles": [ 0 ], "currentAccessMode": "VIEWONLY", "name": "string", "description": "string", "ports": [ 0 ], "thumbnail": true, "computerNo": 0, "_links": { "self": { "href": "string" }, "ports": { "href": "string" }, "primaryConsole": { "href": "string" }, "consoles": { "href": "string" } } }]

Parameters

Authorization (required) JSON Web Token(JWT). Format:Bearer JWT

header string

403 Forbidden.

Try it out!

POST /computers Add a new Computer

Model Model Schema

Try it out!

DELETE /computers/{id} Delete Computer from system.

403 Forbidden.

Parameters

Authorization (required) JSON WebToken(JWT).Format:Bearer JWT

header string

body (required)

Computerattributes.

{ "name": "string", "description": "string", "ports": [ 0 ], "thumbnail": true, "computerNo": 0}

201 Resource Created.

403 Forbidden.

Parameters

header string

Try it out!

GET /computers/{id} Get details of a single Computer.

Model Model Schema

id (required) Computer ID path double

if-match (required) ETAG thatrepresents thecurrent Computerstate

header string

204 Successful Operation (NoContent).

403 Forbidden.

404 Document Not Found.

409 Conflict.

412 Precondition Failed.

{ "id": 0, "primaryConsole": 0, "connectedConsoles": [ 0 ], "currentAccessMode": "VIEWONLY", "name": "string", "description": "string", "ports": [ 0 ], "thumbnail": true, "computerNo": 0, "_links": { "self": { "href": "string" }, "ports": { "href": "string"

Try it out!

PUT /computers/{id} Update a Computer

Model Model Schema

}, "primaryConsole": { "href": "string" }, "consoles": { "href": "string" } }}

Parameters

header string

403 Forbidden.

Parameters

header string

body Computerattributes to

Try it out!

Consoles

DELETE /consoles Delete multiple Consoles from system.

(required)

be updated.{ "name": "string", "description": "string", "ports": [ 0 ], "thumbnail": true, "computerNo": 0}

if-match (required) ETAG thatrepresentsthe currentComputerstate

header string

403 Forbidden.

409 Conflict.

Parameters

header string

ids (required) Comma seperatedlist of Console IDs

query string

Try it out!

GET /consoles Return a list of Consoles

Model Model Schema

403 Forbidden.

[ { "id": 0, "connectedComputer": 0, "currentAccessMode": "VIEWONLY", "computerAccess": [ { "id": 0, "access": "VIEWONLY" } ], "currentUser": 0, "name": "string", "description": "string", "ports": [ 0 ], "userLogin": true, "computerPermissions": [ null ], "autoLogoutTime": 1, "_links": { "self": { "href": "string" }, "ports": { "href": "string" },

Try it out!

POST /consoles Add a new Console

Model Model Schema

"accessList": { "href": "string" }, "computer": { "href": "string" }, "user": { "href": "string" } } }]

Parameters

header string

403 Forbidden.

Parameters

body (required)

Consoleattributes.

{ "name": "string", "description": "string", "ports": [ 0 ], "userLogin": true, "computerPermissions": [ null ],

Try it out!

DELETE /consoles/{id} Delete Console from system.

Try it out!

"autoLogoutTime": 1}

403 Forbidden.

Parameters

header string

id (required) Console ID path double

if-match (required) ETAG thatrepresents thecurrent Consolestate

header string

403 Forbidden.

409 Conflict.

GET /consoles/{id} Get details of a single Console.

Model Model SchemaResponse Class (Status 200)

{ "id": 0, "connectedComputer": 0, "currentAccessMode": "VIEWONLY", "computerAccess": [ { "id": 0, "access": "VIEWONLY" } ], "currentUser": 0, "name": "string", "description": "string", "ports": [ 0 ], "userLogin": true, "computerPermissions": [ null ], "autoLogoutTime": 1, "_links": { "self": { "href": "string" }, "ports": { "href": "string" }, "accessList": { "href": "string" }, "computer": { "href": "string" }, "user": { "href": "string" } }}

Parameters

Try it out!

PUT /consoles/{id} Update a Console

Model Model Schema

header string

403 Forbidden.

Parameters

header string

body (required)

Consoleattributes tobe updated.

{ "name": "string", "description": "string", "ports": [ 0 ], "userLogin": true, "computerPermissions": [ null ], "autoLogoutTime": 1}

Try it out!

POST /consoles/{id}/switch Switch Console to a Computer.

Model Model Schema

if-match (required) ETAG thatrepresentsthe currentConsolestate

header string

403 Forbidden.

409 Conflict.

Parameters

Authorization (required) JSON WebToken (JWT).Format:Bearer JWT

header string

body (required)

Computer andswitch mode.

{ "computerId": 0, "mode": "VIEWONLY"}

Try it out!

Diagnostics

GET /diagnostics/faults Return a list of Diagnostic faults.

Model Model Schema

Try it out!

GET /diagnostics/events Return a list of Diagnostic events.

Content).

403 Forbidden.

[ { "name": "string", "description": "string", "time": "string" }]

Parameters

header string

403 Forbidden.

Model Model Schema

Try it out!

GET /diagnostics/temperatures Return a list of Diagnostic temperatures.

Model Model Schema

[ { "name": "string", "description": "string", "time": "string" }]

Parameters

header string

403 Forbidden.

[ { "name": "string", "value": "string" }]

Parameters

Authorization (required) JSON Web Token header string

Try it out!

GET /diagnostics/supplies Return a list of Diagnostic supplies.

Model Model Schema

Try it out!

(JWT). Format:Bearer JWT

403 Forbidden.

[ { "name": "string", "value": "string" }]

Parameters

header string

403 Forbidden.

GET /edids Return a list of Edids

Model Model Schema

Try it out!

POST /edids Add a new Edid

Model Model Schema

[ { "id": 0, "edidName": "string", "clonedEDID": 0, "originatingPort": 0, "_links": { "self": { "href": "string" } } }]

Parameters

header string

403 Forbidden.

Parameters

body Edid attributes. body

{ "port": 0

Try it out!

DELETE /edids/{id} Delete Edid from system.

(required)

403 Forbidden.

Implementation NotesDelete's a cloned EDID from the system.

Parameters

header string

id (required) Edid ID path double

if-match (required) ETAG thatrepresents thecurrent Edid state

header string

403 Forbidden.

Try it out!

GET /edids/{id} Get details of a single Edid.

Model Model Schema

Try it out!

409 Conflict.

{ "id": 0, "edidName": "string", "clonedEDID": 0, "originatingPort": 0, "_links": { "self": { "href": "string" } }}

Parameters

header string

id (required) Edid ID path double

403 Forbidden.

Groups

GET /groups Return a list of Groups

Model Model Schema

Try it out!

[ { "id": 0, "name": "string", "description": "string", "computerPermissions": [ null ], "autoDisconnectTime": 1, "admin": true, "_links": { "self": { "href": "string" }, "users": { "href": "string" }, "accessList": { "href": "string" } } }]

Parameters

header string

403 Forbidden.

POST /groups Add a new Group

Model Model Schema

Try it out!

DELETE /groups/{id} Delete Group from system.

Parameters

header string

body (required)

Groupattributes.

{ "name": "string", "description": "string", "computerPermissions": [ null ], "autoDisconnectTime": 1, "admin": true}

403 Forbidden.

Parameters

header string

id (required) Group ID path double

Try it out!

GET /groups/{id} Get details of a single Group.

Model Model Schema

if-match (required) ETAG thatrepresents thecurrent Groupstate

header string

403 Forbidden.

409 Conflict.

{ "id": 0, "name": "string", "description": "string", "computerPermissions": [ null ], "autoDisconnectTime": 1, "admin": true, "_links": { "self": { "href": "string" }, "users": { "href": "string" }, "accessList": { "href": "string" } }}

Try it out!

PUT /groups/{id} Update a Group

Model Model Schema

Parameters

header string

403 Forbidden.

Parameters

header string

body (required)

Groupattributes tobe updated.

{ "name": "string", "description": "string", "computerPermissions": [ null ], "autoDisconnectTime": 1, "admin": true}

Try it out!

Network

GET /system/network Get network settings.

Model Model Schema

if-match (required) ETAG thatrepresentsthe currentGroup state

header string

403 Forbidden.

409 Conflict.

{ "dhcp": true, "ipAddress": "string", "netMask": "string", "gateway": "string", "httpServer": true, "networkServiceDiscovery": true, "macAddress": "string", "_links": { "self": { "href": "string" } }}

ParametersParameter Value Description Parameter

Type Data Type

Try it out!

PUT /system/network Update network settings.

Model Model Schema

Type Data Type

header string

403 Forbidden.

Parameters

Authorization (required) JSON WebToken(JWT).Format:BearerJWT

header string

if-match (required) ETAG thatrepresentsthecurrentNetworksettingsstate

header string

body (required)

Parameter contenttype:

Networksettingattributes.

{ "dhcp": true, "ipAddress": "string", "netMask": "string", "gateway": "string", "httpServer": true, "networkServiceDiscovery": true}

Response Messages

HTTP Status Reason Response Model Headers

Try it out!

GET /system/osd Get OSD settings.

Model Model Schema

HTTP StatusCode

Reason Response Model Headers

403 Forbidden.

409 Conflict.

{ "thumbnails": true, "layoutAuto": true, "displaySysInfo": true, "remoteOsd": true, "_links": { "self": { "href": "string" } }}

Parameters

header string

401 Unauthorised. Invalid or no

credentials provided.

Try it out!

PUT /system/osd Update OSD settings.

Model Model Schema

Try it out!

403 Forbidden.

Parameters

header string

if-match (required) ETAG thatrepresentsthe currentNetworksettingsstate

header string

body (required)

Networksettingattributes.

{ "thumbnails": true, "layoutAuto": true, "displaySysInfo": true, "remoteOsd": true}

403 Forbidden.

409 Conflict.

GET /ports Return a list of system ports.

Model Model Schema

Try it out!

GET /ports/{portNumber} Get details of a single Port.

[ { "id": 0, "type": "TRANSMITTER", "computerConsoleId": 0, "computerConsoleName": "string", "status": "DISCONNECTED", "validType": "TRANSMITTER", "uptime": 0, "_links": { "self": { "href": "string" }, "console|computer": { "href": "string" } } }]

Parameters

header string

403 Forbidden.

Model Model Schema

Try it out!

Receivers

GET /receivers Return a list of Receivers

{ "id": 0, "type": "TRANSMITTER", "computerConsoleId": 0, "computerConsoleName": "string", "status": "DISCONNECTED", "validType": "TRANSMITTER", "uptime": 0, "_links": { "self": { "href": "string" }, "console|computer": { "href": "string" } }}

Parameters

header string

portNumber (required) Port Number path double

403 Forbidden.

Model Model Schema

[ { "port": 0, "consoleId": 0, "firmware": "string", "firmwareAvailable": "string", "uniqueId": "string", "monitorNo": 0, "monitorInfo": { "model": "string", "serialNo": "string", "width": 0, "height": 0, "refreshRate": 0, "edidName": "string" }, "recoveryMode": true, "video": true, "usbEnable": true, "_links": { "self": { "href": "string" }, "console": { "href": "string" }, "operations": { "href": "string" } } }]

Parameters

header string

Try it out!

GET /receivers/{portNumber} Get details of a single Receiver.

Model Model Schema

403 Forbidden.

{ "port": 0, "consoleId": 0, "firmware": "string", "firmwareAvailable": "string", "uniqueId": "string", "monitorNo": 0, "monitorInfo": { "model": "string", "serialNo": "string", "width": 0, "height": 0, "refreshRate": 0, "edidName": "string" }, "recoveryMode": true, "video": true, "usbEnable": true, "_links": { "self": { "href": "string" }, "console": { "href": "string" }, "operations": { "href": "string" } }}

Parameters

header string

Try it out!

PUT /receivers/{portNumber} Update a Receiver

Model Model Schema

portNumber (required) Receiver's Portnumber

path double

403 Forbidden.

Parameters

Authorization (required) JSON WebToken (JWT).Format: BearerJWT

header string

portNumber (required) Receiver ID path double

body (required)

Receiverattributes tobe updated.

{ "usbEnable": true}

if-match (required) ETAG thatrepresents thecurrentReceiver state

header string

Try it out!

GET /receivers/{portNumber}/upgradeSync Get the status of the firmware sync update operation

Model Model Schema

Try it out!

POST /receivers/{portNumber}/upgradeSync Sync-upgrade the System firmware

403 Forbidden.

409 Conflict.

{ "state": "IN_PROGRESS", "info": "string", "error": 0}

Parameters

Implementation NotesSynchronising allows Transmitters / Receivers to be upgraded (sync'ed) to the System firmwareversion

Parameters

header string

Try it out!

GET /receivers/{portNumber}/reboot Get the status of the reboot operation

Model Model Schema

Try it out!

POST /receivers/{portNumber}/reboot Reboot the Receiver

403 Forbidden.

Parameters

header string

Try it out!

POST /receivers/{portNumber}/recover Recover the Receiver

Try it out!

POST /receivers/{portNumber}/cancelRecover Cancel Receiver recovery

403 Forbidden.

Implementation NotesPrepares the Receiver so that it may boot into a special recovery mode

Parameters

header string

403 Forbidden.

Parameters

Parameter Value DescriptionParameterType Data Type

Try it out!

System

GET /system/systemInfo Return the System information.

Model Model Schema

Parameter Value Description Type Data Type

header string

403 Forbidden.

{ "firmware": "string", "swVersion": "string", "webVersion": "string", "imageType": "PRIMARY", "description": "string", "location": "string", "ignoreFirmwareMismatch": true, "edidId": 0, "_links": { "self": { "href": "string" } }}

ParametersParameter

Try it out!

PUT /system/systemInfo Update the System information.

Model Model Schema

header string

403 Forbidden.

Parameters

Authorization (required) JSON WebToken(JWT).Format:BearerJWT

header string

body (required)

Parameter contenttype:

Systeminformationattributesto beupdated.

{ "description": "string", "location": "string", "ignoreFirmwareMismatch": true, "edidId": 0}

if-match (required) ETAG thatrepresentsthe currentSysteminformationstate

header string

204 Successful Operation (No

Try it out!

GET /system/systemInfo/uptime Return the System uptime.

Model Model Schema

Try it out!

GET /system/upgrade Get the status of the firmware update operation

Model Model Schema

403 Forbidden.

409 Conflict.

{ "uptime": 0}

Parameters

header string

403 Forbidden.

{ "state": "IN_PROGRESS",

Try it out!

POST /system/upgrade Upgrade the System firmware

Try it out!

GET /system/upgradeSync Get the status of the firmware sync update operation

Model Model Schema

Try it out!

"info": "string", "error": 0}

Parameters

header string

File N…Choose File Firmware imagefile

formData undefined

403 Forbidden.

POST /system/upgradeSync Sync-upgrade the System firmware

Try it out!

GET /system/restore Get the status of the System restore configuration operation

Model Model Schema

Try it out!

POST /system/restore Restore the System configuration from a backup file

Parameters

header string

403 Forbidden.

Parameters

Try it out!

GET /system/reboot Get the status of the System reboot operation

Model Model Schema

Try it out!

POST /system/reboot Reboot the System

header string

File N…Choose File Configurationbackup file

formData undefined

403 Forbidden.

Parameters

header string

Response Messages

HTTP Status

Try it out!

POST /system/backup Backup (download) the System configuration file

Try it out!

Transmitters

GET /transmitters Return a list of Transmitters

Model Model Schema

HTTP StatusCode

Reason Response Model Headers

403 Forbidden.

Parameters

header string

403 Forbidden.

[ { "port": 0, "computerId": 0, "firmware": "string", "firmwareAvailable": "string",

Try it out!

GET /transmitters/{portNumber} Get details of a single Transmitter.

Model Model Schema

"uniqueId": "string", "monitorNo": 0, "recoveryMode": true, "video": true, "usbModeType": "NONE", "useSystemEdid": true, "edidId": 0, "_links": { "self": { "href": "string" }, "computer": { "href": "string" }, "operations": { "href": "string" } } }]

Parameters

header string

403 Forbidden.

{ "port": 0, "computerId": 0,

Try it out!

PUT /transmitters/{portNumber} Update a Transmitter

"firmware": "string", "firmwareAvailable": "string", "uniqueId": "string", "monitorNo": 0, "recoveryMode": true, "video": true, "usbModeType": "NONE", "useSystemEdid": true, "edidId": 0, "_links": { "self": { "href": "string" }, "computer": { "href": "string" }, "operations": { "href": "string" } }}

Parameters

header string

portNumber (required) Transmitter's Portnumber

path double

403 Forbidden.

Parameters

Model Model Schema

Try it out!

GET /transmitters/{portNumber}/upgradeSync Get the status of the firmware sync update operation

Model Model Schema

header string

portNumber (required) TransmitterID

path double

body (required)

Transmitterattributes tobe updated.

{ "usbModeType": "NONE", "useSystemEdid": true, "edidId": 0}

if-match (required) ETAG thatrepresentsthe currentTransmitterstate

header string

403 Forbidden.

409 Conflict.

Try it out!

POST /transmitters/{portNumber}/upgradeSync Sync-upgrade the System firmware

Try it out!

GET /transmitters/{portNumber}/reboot Get the status of the reboot operation

"state": "IN_PROGRESS", "info": "string", "error": 0}

Parameters

portNumber (required) Transmitter ID path double

Parameters

header string

403 Forbidden.

Model Model Schema

Try it out!

POST /transmitters/{portNumber}/reboot Reboot the Transmitter

Try it out!

POST /transmitters/{portNumber}/recover Recover the Transmitter

Parameters

header string

403 Forbidden.

Try it out!

POST /transmitters/{portNumber}/cancelRecover Cancel Transmitter recovery

Implementation NotesPrepares the Transmitter so that it may boot into a special recovery mode

Parameters

header string

403 Forbidden.

Parameters

header string

403 Forbidden.

Try it out!

GET /users Return a list of Users

Model Model Schema

[ { "id": 0, "consoles": [ 0 ], "connectedComputers": [ 0 ], "username": "string", "forenames": "string", "surname": "string", "computerPermissions": [ null ], "autoDisconnectTime": 1, "groupIds": [ 0 ], "admin": true, "_links": { "self": { "href": "string" }, "group": { "href": "string" }, "consoles": { "href": "string" }, "accessList": { "href": "string" }, "computer": { "href": "string" }, "keyShortcuts": { "href": "string" }

Try it out!

POST /users Add a new User

Parameters

header string

403 Forbidden.

Parameters

header string

body (required)

User attributes. body undefined

Try it out!

GET /users/me Get details of an authenticated in User.

Model Model Schema

403 Forbidden.

{ "id": 0, "consoles": [ 0 ], "connectedComputers": [ 0 ], "username": "string", "forenames": "string", "surname": "string", "computerPermissions": [ null ], "autoDisconnectTime": 1, "groupIds": [ 0 ], "admin": true, "_links": { "self": { "href": "string" }, "group": { "href": "string" }, "consoles": { "href": "string" }, "accessList": { "href": "string" }, "computer": { "href": "string" }, "keyShortcuts": { "href": "string" } }}

Try it out!

DELETE /users/{id} Delete User from system.

Parameters

header string

Parameters

header string

id (required) User ID path double

if-match (required) ETAG thatrepresents thecurrent User state

header string

403 Forbidden.

409 Conflict.

Try it out!

GET /users/{id} Get details of a single User.

Model Model Schema

{ "id": 0, "consoles": [ 0 ], "connectedComputers": [ 0 ], "username": "string", "forenames": "string", "surname": "string", "computerPermissions": [ null ], "autoDisconnectTime": 1, "groupIds": [ 0 ], "admin": true, "_links": { "self": { "href": "string" }, "group": { "href": "string" }, "consoles": { "href": "string" }, "accessList": { "href": "string" }, "computer": { "href": "string" }, "keyShortcuts": { "href": "string" } }}

Try it out!

PUT /users/{id} Update a User

Model Model Schema

Parameters

header string

403 Forbidden.

Parameters

header string

body (required)

Userattributes tobe updated.

{ "username": "string", "forenames": "string", "surname": "string", "computerPermissions": [ null ], "autoDisconnectTime": 1, "groupIds": [ 0 ],

Try it out!

PUT /users/{id}/password Update a User's password.

Model Model Schema

"admin": true}

if-match (required) ETAG thatrepresentsthe currentUser state

header string

403 Forbidden.

409 Conflict.

Implementation NotesA controllers that updates a User's password. The new password is passed in clear text (HTTPSshould be used).

Parameters

header string

body NewPassword.

{ "newPassword": "string"

Try it out!

(required)

403 Forbidden.

[ BASE URL: /api , API VERSION: 3.0.16 ]

DDX (Tevor) REST API - Amazon Web Services...DDX (Tevor) REST API Adder Technology DDX (Trevor) REST...

Documents

Transcript of DDX (Tevor) REST API - Amazon Web Services...DDX (Tevor) REST API Adder Technology DDX (Trevor) REST...

Web API, REST API and Web Scraping

Joomla REST API

REST API Specification

Unisphere Management REST API Reference Guide · Unisphere Management REST API Reference Guide The Unisphere Management REST API lets you manage Unisphere through web browsers.and

Lenovo XClarity Administrator REST API Guide · Lenovo XClarity Administrator REST API Guide ... Administrator..

REST API Getting Started Guide - Emboticsftp.embotics.com/REST/v2.3/vCommander REST API Getting Started... · REST API Getting Started Guide vCommander version 5.2 REST API version

SalesTaxPAL - REST API · directly from your applications or test the APIs from Google POSTMAN rest client. • Download the REST API examples • Open google POSTMAN - REST API testing

SFDC REST API

REST-ful API Design

Rest API Security

API Deep Dive: APIC EM Rest API

Wcf rest api introduction

REST API - HumanAPI_Description

WP REST API

Salesforce REST API

Entando rest api

Creating a proxy REST API with IBM API Management 4.0.0files.meetup.com/19095698/How to create a REST API... · Creating a proxy REST API with IBM API Management 4.0.0.0 April 29,

REST and Web API

REST API Fields

Rest API Guide - e-shot™ · Rest API Guide Getting Started Rest API Guide 7 Getting Started Overview The REST API adheres to the OData standard for reads with all requests to write