Skip to content

Change a connected system through its own protocol, with its undo kept and the result read back from the system

What you can call today

Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.

POST
/v1/protocol-connections/{id}/change
curl --request POST \  --url https://api.xovris.ai/v1/protocol-connections/example/change \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "target": null, "verb": null, "args": null }'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

id
required
string
Media typeapplication/json
object
target
verb
args

Example

{  "target": null,  "verb": null,  "args": null}

Done.

Media typeapplication/json
object

Example generated

{}

Done: something new was made, and the answer is it.

Media typeapplication/json
object
state
required
string
Allowed values: verified failed undone
result
required
object
key
additional properties
readBack
required
object
ok
required
boolean
seen
required
object
key
additional properties
undo
required
One of:
object
verb
required
string
args
required
object
key
additional properties
noUndo
required
One of:
string
rolledBack
required
One of:
object
ok
required
boolean
seen
required
object
key
additional properties
changeId
required
string

Example

{  "state": "verified",  "result": {},  "readBack": {    "ok": true,    "seen": {}  },  "undo": {    "verb": "string",    "args": {}  },  "noUndo": "string",  "rolledBack": {    "ok": true,    "seen": {}  },  "changeId": "string"}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Signed in, but this token or role may not do this. The answer names the permission it needs.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Nothing with that id here, or it belongs to another workspace. Nothing was changed.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

Your data is never used to train our AI. How your data is kept

A problem is called fixed only once it works again. How each fix is checked

XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.