Статья создана

Update subscription

Updates the specified subscription.

Request

POST

https://api.datalens.tech/rpc/updateSubscription

Headers

Name

Description

x-dl-api-version

Type: string

API version header.

Const: 3

Example: 3

Body

application/json

{
  "title": "example",
  "description": "example",
  "content": {
    "type": "dash",
    "entryId": "example",
    "options": {
      "states": [
        {}
      ],
      "aiSummary": {
        "enabled": true,
        "prompt": "example"
      }
    }
  },
  "trigger": {
    "type": "cron",
    "entryId": "example",
    "options": {
      "expression": "example",
      "timezone": "example"
    }
  },
  "artifact": {
    "type": "png",
    "options": {
      "size": [
        null
      ],
      "fullPage": true
    }
  },
  "recipients": [
    {
      "subjectId": "example",
      "subjectType": "userAccount"
    }
  ],
  "selfSubscribeEnabled": true,
  "status": "active",
  "tenantId": "example",
  "workbookId": "example",
  "meta": {},
  "subscriptionId": "7lieexzx4kxs0"
}

Name

Description

artifact

One of 2 types

Type: object

options

Type: object

fullPage	Type: boolean
size	Type: array \| null Example `[ null ]`

Example

{
  "size": [
    null
  ],
  "fullPage": true
}

type

Type: string

Const: png

Example: example

Example

{
  "type": "png",
  "options": {
    "size": [
      null
    ],
    "fullPage": true
  }
}

Type: object

options

Type: object

Example

{}

type

Type: string

Const: pdf

Example: example

Example

{
  "type": "pdf",
  "options": {}
}

Example

{
  "type": "png",
  "options": {
    "size": [
      null
    ],
    "fullPage": true
  }
}

content

One of 2 types

Type: object

entryId

Type: string

Example: example

options

Type: object

states

Type: object[]

state

Type: string

Example: example

tab

Type: string

Example: example

parameters

Type: object

[additional]

Type: unknown

Example: null

Example

{}

stateTitle

Type: string | null

Example: example

Min items: 1

Max items: 10

Example

[
  {
    "tab": "example",
    "state": "example",
    "stateTitle": "example",
    "parameters": {}
  }
]

aiSummary

Type: object | null

Example

{
  "enabled": true,
  "prompt": "example"
}

Example

{
  "states": [
    {
      "tab": "example",
      "state": "example",
      "stateTitle": "example",
      "parameters": {}
    }
  ],
  "aiSummary": {
    "enabled": true,
    "prompt": "example"
  }
}

type

Type: string

Const: dash

Example: example

Example

{
  "type": "dash",
  "entryId": "example",
  "options": {
    "states": [
      {
        "tab": "example",
        "state": "example",
        "stateTitle": "example",
        "parameters": {}
      }
    ],
    "aiSummary": {
      "enabled": true,
      "prompt": "example"
    }
  }
}

Type: object

entryId

Type: string

Example: example

options

Type: object

states

Type: object[]

parameters

Type: object

[additional]

Type: unknown

Example: null

Example

{}

stateTitle

Type: string | null

Example: example

Min items: 1

Max items: 10

Example

[
  {
    "stateTitle": "example",
    "parameters": {}
  }
]

Example

{
  "states": [
    {
      "stateTitle": "example",
      "parameters": {}
    }
  ]
}

type

Type: string

Const: report

Example: example

Example

{
  "type": "report",
  "entryId": "example",
  "options": {
    "states": [
      {
        "stateTitle": "example",
        "parameters": {}
      }
    ]
  }
}

Example

{
  "type": "dash",
  "entryId": "example",
  "options": {
    "states": [
      {
        "tab": "example",
        "state": "example",
        "stateTitle": "example",
        "parameters": {}
      }
    ],
    "aiSummary": {
      "enabled": true,
      "prompt": "example"
    }
  }
}

recipients

Type: SubscriptionRecipient[]

Example

[
  {
    "subjectId": "example",
    "subjectType": "userAccount"
  }
]

selfSubscribeEnabled

Type: boolean

status

Type: string

Enum: active, stopped

subscriptionId

Type: string

Min length: 1

Pattern: ^[a-zA-Z0-9._:-]+$

Example: 7lieexzx4kxs0

tenantId

Type: string

Example: example

title

Type: string

Example: example

trigger

One of 2 types

Type: object

options

Type: object

expression

Type: string

Min length: 1

Example: example

timezone

Type: string

Example: example

Example

{
  "expression": "example",
  "timezone": "example"
}

type

Type: string

Const: cron

Example: example

entryId

Type: string | null

Example: example

Example

{
  "type": "cron",
  "entryId": "example",
  "options": {
    "expression": "example",
    "timezone": "example"
  }
}

Type: object

entryId

Type: string

Min length: 1

Example: example

options

Type: object

query

Type: string

Min length: 1

Max length: 100000

Example: example

timezone

Type: string

Example: example

Example

{
  "query": "example",
  "timezone": "example"
}

type

Type: string

Const: sql

Example: example

Example

{
  "type": "sql",
  "entryId": "example",
  "options": {
    "query": "example",
    "timezone": "example"
  }
}

Example

{
  "type": "cron",
  "entryId": "example",
  "options": {
    "expression": "example",
    "timezone": "example"
  }
}

workbookId

Type: string

Example: example

description

Type: string | null

Example: example

meta

Type: object

[additional]

Type: string

Example: example

Example

{}

SubscriptionRecipient

Name

Description

subjectId

Type: string

ID of the recipient user account.

Example: example

subjectType

Type: string

Recipient subject type. Only user accounts are supported.

Const: userAccount

Example: example

Example

{
  "subjectId": "example",
  "subjectType": "userAccount"
}

Responses

200 OK

Response

Body

application/json

{
  "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"
}

Name

Description

artifact

Type: object

options

Type: object

[additional]

Type: unknown

Example: null

Example

{}

type

Type: string

Example: example

Example

{
  "type": "example",
  "options": {}
}

content

Type: object

entryId

Type: string

Example: example

options

Type: object

[additional]

Type: unknown

Example: null

Example

{}

type

Type: string

Example: example

Example

{
  "type": "example",
  "entryId": "example",
  "options": {}
}

createdAt

Type: string

Example: example

createdBy

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

recipients

Type: SubscriptionRecipient[]

Example

[
  {
    "subjectId": "example",
    "subjectType": "userAccount"
  }
]

selfSubscribeEnabled

Type: boolean

status

Type: string

Enum: active, stopped, suspended

subscriptionId

Type: string

Example: example

suspendedAt

Type: string | null

Example: example

tenantId

Type: string

Example: example

title

Type: string

Example: example

trigger

Type: object

entryId

Type: string | null

Example: example

options

Type: object

[additional]

Type: unknown

Example: null

Example

{}

type

Type: string

Example: example

Example

{
  "type": "example",
  "entryId": "example",
  "options": {}
}

updatedAt

Type: string

Example: example

updatedBy

Type: string

Example: example

workbookId

Type: string

Example: example

description

Type: string | null

Example: example

Update subscription

RequestRequest

HeadersHeaders

BodyBody

SubscriptionRecipientSubscriptionRecipient

ResponsesResponses

200 OK200 OK

BodyBody

Была ли статья полезна?

Request

Headers

Body

SubscriptionRecipient

Responses

200 OK

Body