Get a specific project for authenticated user
GET {{baseUrl}}/api/projects/:name
Get a specific project that the authenticated user has access to. This endpoint returns the name, ID, description, alias, and status of the specified project; the project status corresponds to values from EnumDSSXMLProjectStatus. It also specifies whether this project is the platform analytics project, which contains a set of pre-defined reports that provide statistics for the IServer. You obtain the authorization token needed to execute the request using POST /auth/login; you pass the authorization token in the request header. You specifiy the name of the project in the path of the request.
Body
PARAM
| Key | Datatype | Required | Description |
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 |
RESPONSES
status
ENDPOINTS