Get package definition
GET {{baseUrl}}/api/packages/:packageId
Get definition of a package, including package status and its detail content.
Body
PARAM
Key | Datatype | Required | Description |
showContent
|
boolean | Show package content or not | |
fields
|
null | Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model. |
HEADERS
Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization token | |
X-MSTR-ProjectID
|
string | Project ID |
RESPONSES
status OK
{
"id": "QjdDQTkyRjA0QjlGQUU4RDk0MUMzRTlCN0UwQ0Q3NTQ6MUU5Q0ZDNzMzODRDRDAzMjhDNTAxRDlGM0YzNjQ1RTA=",
"status": "ready",
"settings": {
"updateSchema": [
"recal_table_logical_size",
"recal_table_keys_fact_entry_level"
],
"aclOnReplacingObjects": "use_existing",
"aclOnNewObjects": [
"keep_acl_as_source_object"
],
"defaultAction": "replace"
},
"content": [
{
"id": "8D679D5111D3E4981000E787EC6DE8A4",
"name": "Year",
"version": "24CEEC7044C6C7008EE0DF96565E9459",
"type": 12,
"owner": {
"id": "54F3D26011D2896560009A8E67019608"
},
"dateCreated": "2001-01-02T20:48:10.000+0000",
"dateModified": &q Curl curl -X GET 'baseUrl/api/packages/:packageId?showContent=true&fields=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' ENDPOINTS |