Export representation of a catalog (e.g., catalog JSON)
GET/v1/catalogs/:catalogId/export
Export representation of a catalog (e.g., catalog JSON)
Request
Path Parameters
Header Parameters
The exported representation format to be returned. Currently, only application/json is supported.
Responses
- 200
- 400
- 401
- 404
- 500
The JSON for a catalog.
- application/json
- Schema
- Example (from schema)
Schema
Array [
- MOD1
- MOD2
- MOD3
- MOD4
- MOD5
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
properties
object
aggregate-prediction
object
required
annotations
object
annotation
object[]
required
oneOf
Possible values: [version]
Possible values: [engineId]
Possible values: [versionTag]
Possible values: [publishDate]
attributes
object
attribute-key
object[]
required
keyed-attribute
object[]
required
dimensions
object
dimension
object[]
required
datasets
object
dataset
object[]
required
calculated-members
object
calculated-member
object[]
required
cubes
object
cube
object[]
required
perspectives
object
perspective
object[]
required
{
"name": "string",
"version": "string",
"properties": {
"aggregate-prediction": {},
"aggressive_aggregate_promotion": true,
"caption": "string",
"visible": true
},
"annotations": {
"annotation": [
{},
{},
{},
{},
{}
]
},
"attributes": {
"attribute-key": [
{}
],
"keyed-attribute": [
{}
]
},
"dimensions": {
"dimension": [
{}
]
},
"datasets": {
"dataset": [
{}
]
},
"calculated-members": {
"calculated-member": [
{}
]
},
"cubes": {
"cube": [
{}
]
},
"perspectives": {
"perspective": [
{}
]
}
}
Invalid request (e.g., invalid or missing parameters/headers).
Unauthorized. This error will occur if calling user does not have access to the API.
Resource not found (e.g., catalog with provided ID does not exist).
A server error occurred. Check the logs for more details.