Retrieve the status of an relations export for a project

GET

/api/v4/projects/{id}/export_relations/status

Retrieves the status of a relations export for a project.

Authorizations

http
oauth2

Parameters

Path Parameters

required

One of:

string
integer

string

The ID or URL-encoded path of the project

Query Parameters

relation

string

nullable

Project relation name

Responses

200

application/json

object

relation

string

status

string

error

string

updated_at

string format: date-time

batched

boolean

batches_count

integer

total_objects_count

integer

batches

object

status

string

batch_number

integer

objects_count

integer

error

string

updated_at

string format: date-time

Example

{
  "relation": "issues",
  "status": "started",
  "error": "Error message",
  "updated_at": "2012-05-28T04:42:42-07:00",
  "batched": true,
  "batches_count": 2,
  "total_objects_count": 100,
  "batches": {
    "status": "started",
    "batch_number": 1,
    "objects_count": 100,
    "error": "Error message",
    "updated_at": "2012-05-28T04:42:42-07:00"
  }
}

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

503

Service unavailable