Skip to main content
Astra Automation
Hay disponible una nueva versión de este producto.
Se proporciona el idioma español mediante traducción automática para su comodidad. En caso de alguna inconsistencia, el inglés precede al español.

Listar las notificaciones no leídas de un usuario

PDF

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

Devuelve una matriz JSON de todos los recursos coincidentes de la colección. Si se especifican campos individuales en la solicitud, la matriz JSON de elementos contendrá los campos solicitados para cada recurso coincidente en el orden especificado.

Parámetros

Nombre Tipo En Obligatorio Descripción

account_id

cadena

ruta

Verdadero

ID del recurso de cuenta que lo contiene

  • ejemplo: {{.Account}}

user_id

cadena

ruta

Verdadero

ID del recurso de usuario contenedor

incluya

cadena

consulta

Falso

Indica qué campos deben devolverse al listar una colección.

Ejemplos de URL: "include=id", "include=id,name"

Ejemplos OpenAPI: "id"

  • ejemplo: notificationID,sequenceCount

límite

cadena

consulta

Falso

Indica el número máximo de recursos a devolver al listar una colección.

Ejemplos de URL: "limit=2"

Ejemplos OpenAPI: "2"

  • ejemplo: 2

filtro

cadena

consulta

Falso

Indica qué campos deben coincidir para devolver un recurso al listar una colección.

Los operadores admitidos son:

  • eq - Igualdad

  • lt/gt - menor que/mayor que

  • lte/gte - Menor o igual que/Mayor o igual que

Ejemplo de URL: "filter=field%20eq%20%27value%27"

Ejemplos OpenAPI: "field eq 'value'"

OrderBy

cadena

consulta

Falso

Indica el orden de clasificación de los recursos al listar una colección.

Ejemplos de URL: "orderBy=name", "orderBy=name%20desc"

Ejemplos OpenAPI: "name desc"

  • ejemplo: count%20desc

omitir

cadena

consulta

Falso

Indica el número de recursos que deben omitirse al listar una colección.

Ejemplos de URL: "skip=1"

Ejemplos OpenAPI: "1"

cuente

cadena

consulta

Falso

Indica si se debe devolver el número total de recursos en el objeto de metadatos.

Ejemplos de URL: "count=true"

Ejemplos de OpenAPI: "true"

  • ejemplo: true

continuar

consulta

Falso

Indica el token desde el que reanudar el listado.

Ejemplos de URL: "continue="

Ejemplos OpenAPI: ""</continue>

Respuesta

Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.
Nombre Tipo Obligatorio Descripción

artículos

array[Cualquiera de: "unreadNotification_1.0_get_response_body", array[]]

Verdadero

metadatos

"type_astra_metadata_list"

Verdadero
Ejemplo de respuesta 
{
  "type": "application/astra-unreadNotifications",
  "version": "1.0",
  "items": [
    [
      "4080cf5f-2261-4130-b8fb-8432e2e553e6",
      48923
    ],
    [
      "1b4e89f1-2e70-4a08-a015-e7064b0fb703",
      47345
    ]
  ],
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

Respuesta

Status: 401, Unauthorized
Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

estado

cadena

Verdadero

correlationID

cadena

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

Respuesta

Status: 400, Bad request
Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

estado

cadena

Verdadero

correlationID

cadena

Falso

invalidParams

matriz["invalidParams"]

Falso

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

Respuesta

Status: 403, Forbidden
Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

estado

cadena

Verdadero

correlationID

cadena

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

Error

Status: 404, Not found
Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

estado

cadena

Verdadero

correlationID

cadena

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

Definiciones

Ver definiciones

etiqueta_tipo_astra

Nombre Tipo Obligatorio Descripción

nombre

cadena

Verdadero

valor

cadena

Verdadero

tipo_astra_metadatos

Metadatos especificados por el cliente y el servicio asociados al recurso. Los valores definidos son:

  • Cumple con el esquema de metadatos Astra

Nombre Tipo Obligatorio Descripción

etiquetas

array["etiqueta_tipo_astra"]

Verdadero

CreationTimestamp

cadena

Verdadero

Modificación.Marca de hora

cadena

Verdadero

CreatedBy

cadena

Verdadero

modifiedBy

cadena

Falso

unreadNotification_1.0_get_response_body

Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

Tipo de medio del recurso. Los valores definidos son:

  • "application/astra-unreadNotification"

versión

cadena

Verdadero

Versión del recurso. Los valores definidos son:

  • "1,0"

id

cadena

Verdadero

Identificador único global del recurso. Los valores definidos son:

  • Cumple con el esquema UUIDv4

notificationID

cadena

Verdadero

Cadena JSON que contiene un ID de notificación que debe ser marcado como leído por el usuario que crea la marca. Los valores definidos son:

  • Cumple con el esquema del identificador Astra

sequenceCount

número

Verdadero

Número JSON que contiene un recuento de secuencias asociado a la notificación especificada por el notification ID.

gravedad

cadena

Verdadero

Cadena JSON que contiene uno de los siguientes valores que indican la gravedad del evento. Los valores definidos son:

  • "cleared" - Indica que un evento previamente reportado que describe una condición ya no está activo. Un evento con gravedad "cleared" utilizará el mismo resumen e ID de correlación para permitir su cotejo

  • "indeterminado" - Indica que no se puede determinar la gravedad

  • "informativo" - indica un cambio de estado que es esperado y normal (no definido en X.733)

  • "warning" - Indica la detección de un fallo potencial o inminente que afecta al servicio antes de que se produzcan efectos significativos

  • "crítico" - Indica que se ha producido una situación que afecta al servicio y se requiere una acción correctiva inmediata

metadatos

"tipo_astra_metadatos"

Verdadero

Metadatos especificados por el cliente y el servicio asociados al recurso. Los valores definidos son:

  • Cumple con el esquema de metadatos Astra

type_astra_metadata_list

Nombre Tipo Obligatorio Descripción

continuar

cadena

Falso

cuente

número

Falso

etiquetas

array["etiqueta_tipo_astra"]

Falso

CreationTimestamp

cadena

Falso

Modificación.Marca de hora

cadena

Falso

CreatedBy

cadena

Falso

modifiedBy

cadena

Falso

invalidParams

Nombre Tipo Obligatorio Descripción

nombre

cadena

Verdadero

Nombre del parámetro de consulta no válido

motivo

cadena

Verdadero

Razón por la que el parámetro de consulta no es válido