Delete collection
Deletes the specified collection.
Request
POST
http://<хост_on-premises>/rpc/deleteCollection
Headers
|
Name |
Description |
|
x-dl-api-version |
Type: string API version header. Const: Example: |
Body
application/json
{
"collectionId": "example"
}
|
Name |
Description |
|
collectionId |
Type: string ID of the collection to delete. Example: |
Responses
200 OK
Response
Body
application/json
{
"collections": [
{
"collectionId": "example",
"title": "example",
"description": "example",
"parentId": "example",
"tenantId": "example",
"createdBy": "example",
"createdAt": "example",
"updatedBy": "example",
"updatedAt": "example",
"meta": {}
}
]
}
|
Name |
Description |
|
collections |
Type: Collection[] Deleted collections. Example |
Collection
|
Name |
Description |
||
|
collectionId |
Type: string Unique identifier of the collection. Example: |
||
|
createdAt |
Type: string Creation timestamp. Example: |
||
|
createdBy |
Type: string ID of the user who created the collection. Example: |
||
|
description |
Type: string | null Description of the collection. Example: |
||
|
meta |
Type: object
Metadata associated with the collection. Example |
||
|
parentId |
Type: string | null ID of the parent collection. Example: |
||
|
tenantId |
Type: string ID of the DataLens tenant. Example: |
||
|
title |
Type: string Title of the collection. Example: |
||
|
updatedAt |
Type: string Last update timestamp. Example: |
||
|
updatedBy |
Type: string ID of the user who last updated the collection. Example: |
Example
{
"collectionId": "example",
"title": "example",
"description": "example",
"parentId": "example",
"tenantId": "example",
"createdBy": "example",
"createdAt": "example",
"updatedBy": "example",
"updatedAt": "example",
"meta": {}
}