Skip to content

Change an issue's fields, each change kept on its history

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/issues/{id}/fields
curl --request POST \  --url https://api.xovris.ai/v1/issues/example/fields \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{}'

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

Example generated

{}

Done.

Media typeapplication/json
object
parentIssue
required
One of:
object
id
required
string
title
required
string
status
required
string
children
required
Array<object>
object
id
required
string
title
required
string
status
required
string
relations
required
Array<object>
object
kind
required
string
Allowed values: related blocks blocked_by duplicate_of duplicated_by
issue
required
object
id
required
string
title
required
string
status
required
string
labelsInUse
required
Array<object>
object
label
required
string
issues
required
number
labels
required
Array<string>
estimate
required
One of:
number
due
required
One of:
string
stage
required
One of:
string
Allowed values: in_progress todo backlog in_review
parent
required
One of:
string
links
required
Array<object>
object
url
required
string
title
required
One of:
string
description
required
One of:
string
cycle
required
One of:
string
snooze
required
One of:
string
changed
required
object
cycle
string
stage
string
description
string
due
string
links
string
snooze
string
labels
string
parent
string
estimate
string

Example

{  "parentIssue": {    "id": "string",    "title": "string",    "status": "string"  },  "children": [    {      "id": "string",      "title": "string",      "status": "string"    }  ],  "relations": [    {      "kind": "related",      "issue": {        "id": "string",        "title": "string",        "status": "string"      }    }  ],  "labelsInUse": [    {      "label": "string",      "issues": 1    }  ],  "labels": [    "string"  ],  "estimate": 1,  "due": "string",  "stage": "in_progress",  "parent": "string",  "links": [    {      "url": "string",      "title": "string"    }  ],  "description": "string",  "cycle": "string",  "snooze": "string",  "changed": {    "cycle": "string",    "stage": "string",    "description": "string",    "due": "string",    "links": "string",    "snooze": "string",    "labels": "string",    "parent": "string",    "estimate": "string"  }}

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

Media typeapplication/json
object

Example generated

{}

Started: the answer says where to follow it.

Media typeapplication/json
object

Example generated

{}

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.