Skip to content

Read one kind of thing you run, with its things, their readings and its open incidents

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.

GET
/v1/estate/{kind}
curl --request GET \  --url https://api.xovris.ai/v1/estate/example \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

kind
required
string

One kind of thing this workspace runs: its things, their readings and its open incidents.

Media typeapplication/json
object
at
required
string
kind
required
object
id
required
string
name
required
string
one
required
string
family
required
string
truth
required
string
lamp
required
string
state
required
string
total
required
integer
read
required
integer
things
required
Array<object>
object
id
required
string
name
required
string
hostname
string
state
required
string
lastReadAt
required
Any of:
string
readings
required
Array<object>
object
id
required
string
source
required
string
label
required
string
state
required
string
lastReadAt
required
Any of:
string
more
required
integer
openIncidents
required
integer
needsYou
required
integer
incidents
required
Array<object>
object
id
required
string
title
required
string
severity
required
string
openedAt
required
string
stage
required
string
words
required
string
waitsOn
required
string
assetRef
Any of:
string
cause
required
Any of:
object
headline
required
string
proof
required
string
by
required
string
faultClass
required
Any of:
string
lastReadAt
required
Any of:
string
wouldRead
required
object
line
required
string
connect
required
string
readers
required
Array<object>
object
by
required
string
name
required
string
partial
required
boolean
withheld
required
Array<object>
object
source
required
string
action
required
string
decisionId
required
string
failed
required
Array<object>
object
source
required
string
fenced
required
Any of:
object
leftOut
required
integer

Example generated

{  "at": "example",  "kind": {    "id": "example",    "name": "example",    "one": "example",    "family": "example",    "truth": "example",    "lamp": "example",    "state": "example",    "total": 1,    "read": 1,    "things": [      {        "id": "example",        "name": "example",        "hostname": "example",        "state": "example",        "lastReadAt": "example",        "readings": [          {            "id": "example",            "source": "example",            "label": "example",            "state": "example",            "lastReadAt": "example"          }        ]      }    ],    "more": 1,    "openIncidents": 1,    "needsYou": 1,    "incidents": [      {        "id": "example",        "title": "example",        "severity": "example",        "openedAt": "example",        "stage": "example",        "words": "example",        "waitsOn": "example",        "assetRef": "example",        "cause": {          "headline": "example",          "proof": "example",          "by": "example",          "faultClass": "example"        }      }    ],    "lastReadAt": "example",    "wouldRead": {      "line": "example",      "connect": "example",      "readers": [        {          "by": "example",          "name": "example"        }      ]    },    "partial": true  },  "withheld": [    {      "source": "example",      "action": "example",      "decisionId": "example"    }  ],  "failed": [    {      "source": "example"    }  ],  "fenced": {    "leftOut": 1  }}

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.