Resume a paused takeover from where it stopped
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.
const url = 'https://api.xovris.ai/v1/setup/takeovers/example/resume';const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.xovris.ai/v1/setup/takeovers/example/resume \ --header 'Authorization: Bearer <token>'Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”Started: the answer says where to follow it.
object
object
object
object
object
object
object
object
object
Example
{ "ok": true, "id": "string", "integration": "string", "name": "string", "purpose": "fix", "undoOf": "string", "mode": "guided", "state": "string", "preflight": { "go": "takeover", "policy": { "origin": "string", "terms": "allowed", "termsUrl": "string", "termsFingerprint": "string", "readAt": "string", "officialRoute": { "rung": 2, "how": "string" }, "note": "string" } }, "way": "string", "card": { "title": "string", "lines": [ "string" ], "digest": "string" }, "steps": [ { "id": "string", "kind": "fill", "intent": "string", "consequence": "none", "done": true, "kept": true } ], "log": [ { "at": "string", "actor": "person", "kind": "string", "target": { "role": "string", "name": "string" }, "url": "string", "verdict": "done", "why": "string" } ], "waitingFor": "string", "question": "string", "waitingKind": "string", "takenBack": true, "questionKind": "go_ahead", "resumable": true, "handover": { "available": true, "why": "string" }, "handedTo": "string", "handedFrom": "string", "yourTurn": true, "liveView": "string", "stay": { "state": "refused", "line": "string", "next": "string", "pressWhat": "string", "since": "string", "act": "payment" }, "carriesOnByItself": true, "doItYourself": { "label": "string", "method": "string", "path": "string", "body": { "integration": "string", "guided": true } }, "secret": { "saved": true, "ending": "string" }, "keyCheck": { "provider": "string", "proved": true }, "keyCatch": { "label": "string", "method": "string", "path": "string" }, "unverified": true, "tests": { "url": "string", "expectStatus": 1, "before": { "status": 1, "at": "string", "error": "string" }, "after": { "status": 1, "at": "string", "error": "string" }, "passed": true, "connection": { "status": 1, "at": "string", "error": "string", "url": "string", "passed": true } }, "undo": { "job": "string", "available": true }, "source": { "docs": "string", "readAt": "string" }, "createdAt": "string", "approvedAt": "string", "endedAt": "string", "run": { "id": "string", "startedAt": "string" }}Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}default
Section titled “default”Any other refusal or failure. The answer says what happened and what to do next.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}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.