Skip to content

Commit 7e9a793

Browse files
author
zhe
committed
Update
1 parent 8749f2d commit 7e9a793

File tree

9 files changed

+1366
-15
lines changed

9 files changed

+1366
-15
lines changed

docs/common-workflows/administration/migrations/create-and-import-migration-packages/manage-content-group-packages.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ Sample request of the project package:
8989
{
9090
"id": "54F3D26011D2896560009A8E67019608",
9191
"name": "admin_group",
92+
"level": "configuration_object",
9293
"type": 77,
9394
"action": "replace",
9495
"includeDependents": true
@@ -139,6 +140,7 @@ Sample request of the project package:
139140
{
140141
"id": "54F3D26011D2896560009A8E67019608",
141142
"name": "admin_group",
143+
"level": "configuration_object",
142144
"type": 77,
143145
"action": "replace",
144146
"includeDependents": true

docs/common-workflows/administration/monitors/project-administration.md

Lines changed: 91 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,6 +309,86 @@ In the example above, the project status of `"MicroStrategy Tutorial"` was chang
309309
}
310310
```
311311

312+
## Update status for a specific project on all cluster nodes
313+
314+
<Available since="Strategy ONE (June 2025)" />
315+
316+
Endpoint: [PATCH /api/monitors/projects/status](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Monitors/updateProjectStatusOnAllNodes)
317+
318+
There are several use cases in which it is required to load or unload a project on an environment. A dedicated endpoint `PATCH /api/monitors/projects/status` is implemented to address these use cases. The endpoint call requires to provide the identifier or the name of the project in the query parameters and `X-MSTR-AuthToken` in the header.
319+
320+
If a project ID is passed in the query parameter, we will use the project by ID. Otherwise, a project name must be passed and the project with specific name ignoring cases will be used.
321+
322+
This API will accept the request and start processing to execute based on the request submitted. By default, the API will wait for server session to expire before unloading a project. You can provide a `deleteSessions` query parameter in the case of unloading project to close all active sessions immediately.
323+
324+
- Request parameters:
325+
326+
- `X-MSTR- AuthToken`: Authorization Token
327+
- `projectId`: Project Id
328+
- `projectName`: Project name
329+
- `deleteSessions`: Whether to close all active sessions when unloading project
330+
331+
- Request body:
332+
333+
```json
334+
{
335+
"status": "loaded" // Valid values are: loaded, unloaded, request_idle, exec_idle, partial_idle, wh_exec_idle, full_idle
336+
}
337+
```
338+
339+
- Curl:
340+
341+
```bash
342+
curl -X PATCH " https:// demo.microstrategy.com/MicroStrategyLibrary/api/monitors/projects/status?projectId=B7CA92F04B9FAE8D941C3E9B7E0CD754" -H "accept: application/json" -H "X-MSTR-AuthToken: jal5uua4uo6gfag1vivmadag17" -H "Content-Type: application/json" -d "{\\"status\\":\\"unloaded\\"}"
343+
```
344+
345+
- Response code: 202 (Accepted)
346+
347+
## Get status for a specific project on all cluster nodes
348+
349+
<Available since="Strategy ONE (June 2025)" />
350+
351+
Endpoint: [GET /api/monitors/projects/status](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Monitors/getProjectStatusOnAllNodes)
352+
353+
This endpoint queries the status of a project on each node, especially after you load or unload a project with the `PATCH /api/monitors/projects/status` API. The endpoint call requires to provide the identifier or the name of the project in the query parameters and `X-MSTR-AuthToken` in the header.
354+
355+
If a project ID is passed in the query parameter, we will use the project by ID. Otherwise, a project name must be passed and the project with specific name ignoring cases will be used.
356+
357+
You can expect the following statuses of the project to be returned with respect to the nodes: unloaded, loaded, exec_idle, request_idle, full_idle, wh_exec_idle, partial_idle, unloaded_pending, loaded_pending.
358+
359+
- Request parameters:
360+
361+
- `X-MSTR- AuthToken`: Authorization Token
362+
- `projectId`: Project Id
363+
- `projectName`: Project name
364+
365+
- Curl:
366+
367+
```bash
368+
curl -X GET "https://demo.microstrategy.com/MicroStrategyLibrary/api/monitors/projects/status?projectId=B7CA92F04B9FAE8D941C3E9B7E0CD754" -H "accept: application/json" -H "X-MSTR-AuthToken: s664q0cqjergslaj4vfpnneb3m"
369+
```
370+
371+
- Response body:
372+
373+
```json
374+
{
375+
"nodes": [
376+
{
377+
"serverName": "env-160560laio1use1",
378+
"serverPort": 34952,
379+
"status": "running"
380+
},
381+
{
382+
"serverName": "env-160560laio2use1",
383+
"serverPort": 34952,
384+
"status": "unloaded"
385+
}
386+
]
387+
}
388+
```
389+
390+
- Response code: 200 (Success: OK)
391+
312392
## Delete project
313393

314394
<Available since="2021 Update 8" />
@@ -319,7 +399,9 @@ There are several use cases in which it is required to delete a project from an
319399
curl -X 'DELETE' 'https://demo.microstrategy.com/MicroStrategyLibrary/api/projects/A435ED1A4CF916B9A0A0729F9C93C9B9' -H 'accept: */*' -H 'X-MSTR-AuthToken: tp43crmdrkf54avoo9jbgj4a3q'
320400
```
321401

322-
The response code is either `202 Accepted` or `204 No Content`. The code depends on the deletion execution status. If the endpoint manages to delete the project in a given timeout, it sends `204` code. If the deletion takes longer than the timeout, the endpoint sends `202` code. The status of the operation can be checked using `GET /api/monitors/iServer/nodes` endpoint. If the deletion is successful, the endpoint stops reporting the project. The endpoint will delete a project only if the project has unloaded status on every node. If the project is not unloaded a following error will be provided to a client.
402+
The response code is either `202 Accepted` or `204 No Content`. The code depends on the deletion execution status. If the endpoint manages to delete the project in a given timeout, it sends `204` code. If the deletion takes longer than the timeout, the endpoint sends `202` code. The status of the operation can be checked using `GET /api/monitors/iServer/nodes` endpoint. If the deletion is successful, the endpoint stops reporting the project.
403+
404+
By default, the endpoint will delete a project only if the project has unloaded status on every node. If the project is not unloaded a following error will be provided to a client.
323405

324406
```json
325407
{
@@ -331,6 +413,14 @@ The response code is either `202 Accepted` or `204 No Content`. The code depends
331413

332414
The project status can be changed using the `PATCH /api/monitors/iServer/nodes/{nodeName}/projects/{projectId}` endpoint. The client can delete the project if it is administrator or owner of the project.
333415

416+
<Available since="Strategy ONE (June 2025)" />
417+
418+
You can provide a `deleteSessions` query parameter which will help to automatically close all active sessions across all the clustered nodes and then delete the project. The exemplary call is listed below:
419+
420+
```bash
421+
curl -X 'DELETE' \ 'https://demo.microstrategy.com/MicroStrategyLibrary/api/projects/B7CA92F04B9FAE8D941C3E9B7E0CD754?deleteSessions=true' \ -H 'accept: */*' \ -H 'X-MSTR-AuthToken: tp43crmdrkf54avoo9jbgj4a3q'
422+
```
423+
334424
## Log out
335425

336426
Endpoint: [POST /api/auth/logout](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogout)

0 commit comments

Comments
 (0)