Skip to main content
Astra Automation
Uma versão mais recente deste produto está disponível.
O português é fornecido por meio de tradução automática para sua conveniência. O inglês precede o português em caso de inconsistências.

Recuperar uma notificação não lida

PDFs

GET /accounts/{account_id}/core/v1/users/{user_id}/unreadNotifications/{unreadNotification_id}

Retorna o recurso da API de Notificação Não Lida armazenado no corpo da resposta JSON.

Parâmetros

Nome Tipo Em Obrigatório Descrição

id_da_conta

string

caminho

Verdadeiro

ID do recurso de conta que o contém

  • exemplo: {{.Account}}

ID do usuário

string

caminho

Verdadeiro

ID do recurso de usuário que o contém

ID da notificação não lida

string

caminho

Verdadeiro

ID da coleção unreadNotification a ser listada

Resposta

Status: 200, Returns the stored Unread Notification API resource in the JSON response body.
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

Tipo de mídia do recurso. Os valores definidos são:

  • "aplicação/astra-unreadNotification"

versão

string

Verdadeiro

Versão do recurso. Os valores definidos são:

  • "1,0"

id

string

Verdadeiro

Identificador globalmente único do recurso. Os valores definidos são:

  • Em conformidade com o esquema UUIDv4

ID da notificação

string

Verdadeiro

String JSON contendo um ID de notificação que deve ser marcado como lido pelo usuário que criou a marcação. Os valores definidos são:

  • Conforme o esquema de identificador Astra

sequenceCount

número

Verdadeiro

Número JSON contendo uma contagem sequencial associada à notificação especificada pelo ID da notificação.

gravidade

string

Verdadeiro

String JSON contendo um dos seguintes valores que indicam a gravidade do evento. Os valores definidos são:

  • "cleared" - Indica que um evento relatado anteriormente, que descrevia uma condição, não está mais ativo. Um evento com a gravidade "cleared" usará o mesmo resumo e ID de correlação para permitir que ele seja correspondido.

  • "Indeterminado" - Indica que a gravidade não pode ser determinada

  • "Informativo" - Indica uma mudança de estado que é esperada e normal (não definida em X.733)

  • "warning" - Indica a detecção de uma falha potencial ou iminente que afete o serviço antes que quaisquer efeitos significativos sejam sentidos

  • "Crítico" - Indica que ocorreu uma condição que afeta o serviço e que é necessária uma ação corretiva imediata

metadados

"tipo_metadados_astra"

Verdadeiro

Metadados especificados pelo cliente e pelo serviço associados ao recurso. Os valores definidos são:

  • Conforme o esquema de metadados Astra
Exemplo de resposta 
{
  "type": "application/astra-unreadNotification",
  "version": "1.0",
  "id": "10df997b-629e-50f8-bc5f-a18b9a4ac5f6",
  "notificationID": "4080cf5f-2261-4130-b8fb-8432e2e553e6",
  "sequenceCount": 48923,
  "severity": "warning",
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

Resposta

Status: 401, Unauthorized
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso
Exemplo de resposta 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Resposta

Status: 400, Bad request
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso

invalidParams

array["invalidParams"]

Falso

Lista de parâmetros de consulta inválidos
Exemplo de resposta 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Resposta

Status: 403, Forbidden
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso
Exemplo de resposta 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Erro

Status: 404, Not found
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso
Exemplo de resposta de erro 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

Definições

Ver definições

tipo_astra_label

Nome Tipo Obrigatório Descrição

nome

string

Verdadeiro

valor

string

Verdadeiro

tipo_metadados_astra

Metadados especificados pelo cliente e pelo serviço associados ao recurso. Os valores definidos são:

  • Conforme o esquema de metadados Astra

Nome Tipo Obrigatório Descrição

etiquetas

array["tipo_astra_label"]

Verdadeiro

CriaçãoTimestamp

string

Verdadeiro

Alteração do Timestamp

string

Verdadeiro

CreatedBy

string

Verdadeiro

modifiedBy

string

Falso

invalidParams

Nome Tipo Obrigatório Descrição

nome

string

Verdadeiro

Nome do parâmetro de consulta inválido

razão

string

Verdadeiro

Motivo pelo qual o parâmetro de consulta é inválido