Check issue import status

Deprecated

GET

/repositories/{workspace}/{repo_slug}/issues/import

When using GET, this endpoint reports the status of the current import task.

After the job has been scheduled, but before it starts executing, the endpoint returns a 202 response with status ACCEPTED.

Once it starts running, it is a 202 response with status STARTED and progress filled.

After it is finished, it becomes a 200 response with status SUCCESS or FAILURE.

Authorizations

• oauth2
  issue:write repository:admin
• basic
• api_key

Parameters

Path Parameters

repo_slug

required

string

This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

workspace

required

string

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

Responses

200

Import job complete with either FAILURE or SUCCESS status

Media type application/json

Issue Job Status

The status of an import or export job

object

type

string

status

The status of the import/export job

string

Allowed values: ACCEPTED STARTED RUNNING FAILURE

phase

The phase of the import/export job

string

total

The total number of issues being imported/exported

integer

count

The total number of issues already imported/exported

integer

pct

The percentage of issues already imported/exported

number

<= 100

Example

{
  "status": "ACCEPTED"
}

202

Import job started

Media type application/json

Issue Job Status

The status of an import or export job

object

type

string

status

The status of the import/export job

string

Allowed values: ACCEPTED STARTED RUNNING FAILURE

phase

The phase of the import/export job

string

total

The total number of issues being imported/exported

integer

count

The total number of issues already imported/exported

integer

pct

The percentage of issues already imported/exported

number

<= 100

Examples

Example response

{
  "type": "issue_job_status",
  "status": "ACCEPTED",
  "phase": "Attachments",
  "total": 15,
  "count": 0,
  "percent": 0
}

401

The request wasn’t authenticated properly

Media type application/json

Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object

type

required

string

error

object

message

required

string

detail

string

data

Optional structured data that is endpoint-specific.

object

key

additional properties

any

key

additional properties

any

Example ^generated

{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}

403

When the authenticated user does not have admin permission on the repo

Media type application/json

Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object

type

required

string

error

object

message

required

string

detail

string

data

Optional structured data that is endpoint-specific.

object

key

additional properties

any

key

additional properties

any

Example ^generated

{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}

404

No export job has begun

Media type application/json

Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object

type

required

string

error

object

message

required

string

detail

string

data

Optional structured data that is endpoint-specific.

object

key

additional properties

any

key

additional properties

any

Example ^generated

{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}