You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/common-workflows/administration/migrations/create-and-import-migration-packages/manage-content-group-packages.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -89,6 +89,7 @@ Sample request of the project package:
89
89
{
90
90
"id": "54F3D26011D2896560009A8E67019608",
91
91
"name": "admin_group",
92
+
"level": "configuration_object",
92
93
"type": 77,
93
94
"action": "replace",
94
95
"includeDependents": true
@@ -139,6 +140,7 @@ Sample request of the project package:
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
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
+
312
392
## Delete project
313
393
314
394
<Availablesince="2021 Update 8" />
@@ -319,7 +399,9 @@ There are several use cases in which it is required to delete a project from an
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.
323
405
324
406
```json
325
407
{
@@ -331,6 +413,14 @@ The response code is either `202 Accepted` or `204 No Content`. The code depends
331
413
332
414
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.
333
415
416
+
<Availablesince="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:
0 commit comments