Get subscription list
Returns a list of subscriptions.
Request
POST
https://api.datalens.tech/rpc/getSubscriptions
Headers
|
Name |
Description |
|
x-dl-api-version |
Type: string API version header. Const: Example: |
Body
application/json
{
"search": "example",
"status": "active",
"collectionId": "example",
"workbookId": "example",
"contentEntryId": "example",
"triggerEntryId": "example",
"createdBy": "example",
"sortBy": "createdAt",
"order": "asc",
"limit": 0.5,
"pageToken": "example",
"recipient": {
"subjectId": "example",
"subjectType": "userAccount"
}
}
|
Name |
Description |
|
collectionId |
Type: string Example: |
|
contentEntryId |
Type: string Example: |
|
createdBy |
Type: string Example: |
|
limit |
Type: number |
|
order |
Type: string Enum: |
|
pageToken |
Type: string Example: |
|
recipient |
Type: SubscriptionRecipient Example |
|
search |
Type: string Example: |
|
sortBy |
Type: string Enum: |
|
status |
Type: string Enum: |
|
triggerEntryId |
Type: string Example: |
|
workbookId |
Type: string Example: |
SubscriptionRecipient
|
Name |
Description |
|
subjectId |
Type: string ID of the recipient user account. Example: |
|
subjectType |
Type: string Recipient subject type. Only user accounts are supported. Const: Example: |
Example
{
"subjectId": "example",
"subjectType": "userAccount"
}
Responses
200 OK
Response
Body
application/json
{
"subscriptions": [
{
"title": "example",
"description": "example",
"content": {
"type": "example",
"entryId": "example",
"options": {}
},
"trigger": {
"type": "example",
"entryId": "example",
"options": {}
},
"artifact": {
"type": "example",
"options": {}
},
"recipients": [
{
"subjectId": "example",
"subjectType": "userAccount"
}
],
"selfSubscribeEnabled": true,
"status": "active",
"tenantId": "example",
"workbookId": "example",
"meta": {},
"subscriptionId": "example",
"createdAt": "example",
"updatedAt": "example",
"suspendedAt": "example",
"createdBy": "example",
"updatedBy": "example"
}
],
"nextPageToken": "example"
}
|
Name |
Description |
|
subscriptions |
Type: Subscription[] Example |
|
nextPageToken |
Type: string | null Example: |
Subscription
|
Name |
Description |
||||||||
|
artifact |
Type: object
Example |
||||||||
|
content |
Type: object
Example |
||||||||
|
createdAt |
Type: string Example: |
||||||||
|
createdBy |
Type: string Example: |
||||||||
|
meta |
Type: object
Example |
||||||||
|
recipients |
Type: SubscriptionRecipient[] Example |
||||||||
|
selfSubscribeEnabled |
Type: boolean |
||||||||
|
status |
Type: string Enum: |
||||||||
|
subscriptionId |
Type: string Example: |
||||||||
|
suspendedAt |
Type: string | null Example: |
||||||||
|
tenantId |
Type: string Example: |
||||||||
|
title |
Type: string Example: |
||||||||
|
trigger |
Type: object
Example |
||||||||
|
updatedAt |
Type: string Example: |
||||||||
|
updatedBy |
Type: string Example: |
||||||||
|
workbookId |
Type: string Example: |
||||||||
|
description |
Type: string | null Example: |
Example
{
"title": "example",
"description": "example",
"content": {
"type": "example",
"entryId": "example",
"options": {}
},
"trigger": {
"type": "example",
"entryId": "example",
"options": {}
},
"artifact": {
"type": "example",
"options": {}
},
"recipients": [
{
"subjectId": "example",
"subjectType": "userAccount"
}
],
"selfSubscribeEnabled": true,
"status": "active",
"tenantId": "example",
"workbookId": "example",
"meta": {},
"subscriptionId": "example",
"createdAt": "example",
"updatedAt": "example",
"suspendedAt": "example",
"createdBy": "example",
"updatedBy": "example"
}