Skip to main content
GET
Recuperar uma notificação de workspace

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

organization_id
string
obrigatório

Identificador da organização.

Required string length: 24
Pattern: ^[0-9a-f]{24}$
workspace_notification_id
string<uuid>
obrigatório

Identificador da notificação do workspace.

Required string length: 36
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Parâmetros de consulta

fields
string

Campos de resposta separados por vírgulas.

Maximum string length: 2048

Resposta

Notificação de workspace recuperada com sucesso.

id
string<uuid>
obrigatório

Identificador da notificação do workspace.

severity
enum<string> | null

Severidade da notificação.

Opções disponíveis:
informative,
maintenance,
issue
target
enum<string> | null

Destino da notificação.

Opções disponíveis:
workspaces,
sessions,
users
status
enum<string> | null

Estado da notificação.

Opções disponíveis:
pending,
generated,
closing,
manually_closed,
error,
expired
time_zone
string | null

Fuso horário da notificação.

start_date_utc
string<date-time> | null

Data e hora de início em UTC.

end_date_utc
string<date-time> | null

Data e hora de término em UTC.

message
string | null

Mensagem da notificação.

ask_for_acknowledgement
boolean | null

Indica se a acuse de recebimento é solicitado.

accepted_by_users
number | null

Número de usuários que aceitaram a notificação.

Indica se a notificação pisca.

disable_minimize
boolean | null

Indica se minimizar a notificação está desabilitado.

tooltip
string | null

Texto de ajuda da notificação.

Link associado à notificação.

organization_id
string | null

Identificador da organização associada.

Required string length: 24
Pattern: ^[0-9a-f]{24}$