Read a materialized export artifact manifest.

GET

/api/user/data-export/artifacts/{artifactId}

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/user/data-export/artifacts/example \
  --header 'Authorization: Bearer <token>'

Returns the manifest for a materialized data export artifact owned by the authenticated user.

Authorizations

• userBearer
• userSessionCookie

Parameters

Path Parameters

artifactId

required

string

Responses

200

Successful JSON response.

Media type application/json

object

artifactId

string

requestId

string

format

string

downloadUrl

string

chunks

Array<object>

object

key

additional properties

key

additional properties

Example

{
  "artifactId": "artifact_123",
  "requestId": "export_123",
  "format": "json",
  "downloadUrl": "/api/user/data-export/artifacts/artifact_123/download?format=json",
  "chunks": []
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}