GIgitlab
group_import_and_export

Retrieve the status of an relations export for a group

Retrieves the status of a relations export for a group.

get/api/v4/groups/{id}/export_relations/status

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idstring required

The ID of a group

Query parameters

relationstring

Group relation name

Response

Retrieve the status of an relations export for a group

relationstring required
status'pending' | 'started' | 'finished' | 'failed' required
errorstring required
updated_atstring date-time required
batchedboolean required
batches_countinteger required
total_objects_countinteger required

Example response

[
  {
    "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"
    }
  }
]

Changes

No recorded changes to this operation across all 5 revisions of this API.