Read advanced property of a project
GET {{baseUrl}}/api/model/projects/:projectId?showAdvancedProperties=true
This API gets the definition of a specified project and the list of its advanced properties.
The information field describes the common object information such as the object ID, creation time, version ID, etc.
showAdvancedProperties=true query parameter is mandatory for the API to return the list of advanced properties. The project ID in the header is required to return the project's definition in metadata. The changeset ID is required to return the project's definition within a specific changeset, otherwise it's optional. To execute the request, either the project ID or changeset ID needs to be provided. If both are provided, only the changeset ID is used. A changeset ID can be obtained using the changeset creation API. An authorization token is required to execute the request and can be obtained using Authentication endpoints.
Body
PARAM
| Key | Datatype | Required | Description |
showAdvancedProperties
|
boolean | Specify whether to retrieve the values of the advanced properties. The advanced properties are presented in the following groups: * "vldbProperties": A list of properties as determined by the common infrastructure. If omitted or `false` the API will return information field only. If `true`, all applicable advanced properties are returned. |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization Token | |
X-MSTR-ProjectID
|
string | Project ID | |
X-MSTR-MS-Changeset
|
string | Changeset ID | |
Accept
|
string |
RESPONSES
ENDPOINTS