Elenca le notifiche non lette per un utente
GET /accounts/{account_id}/core/v1/users/{user_id}/unreadNotifications
Restituisce un array JSON di tutte le risorse corrispondenti nella raccolta. Se nella richiesta vengono specificati singoli campi, l'array JSON degli elementi conterrà i campi richiesti per ciascuna risorsa corrispondente nell'ordine specificato.
Parametri
| Nome | Tipo | In | Obbligatorio | Descrizione |
|---|---|---|---|---|
ID account |
stringa |
percorso |
Vero |
ID della risorsa account contenitore
|
ID utente |
stringa |
percorso |
Vero |
ID della risorsa utente contenente |
includi |
stringa |
query |
Falso |
Indica quali campi devono essere restituiti durante l'elenco di una raccolta. Esempi di URL: "include=id", "include=id,name" Esempi OpenAPI: "id"
|
limite |
stringa |
query |
Falso |
Indica il numero massimo di risorse da restituire quando si elenca una raccolta. Esempi di URL: "limit=2" Esempi OpenAPI: "2"
|
filtro |
stringa |
query |
Falso |
Indica quali campi devono essere confrontati per restituire una risorsa durante l'elenco di una collezione. Gli operatori supportati sono:
Esempio di URL: "filter=field%20eq%20%27value%27" Esempi OpenAPI: "field eq 'value'" |
OrderBy |
stringa |
query |
Falso |
Indica l'ordine di visualizzazione delle risorse durante l'elenco di una collezione. Esempi di URL: "orderBy=name", "orderBy=name%20desc" Esempi OpenAPI: "name desc"
|
saltare |
stringa |
query |
Falso |
Indica il numero di risorse da saltare durante l'elenco di una raccolta. Esempi di URL: "skip=1" Esempi OpenAPI: "1" |
conta |
stringa |
query |
Falso |
Indica se il numero totale di risorse deve essere restituito nell'oggetto metadata. Esempi di URL: "count=true" Esempi OpenAPI: "true"
|
continuare |
query |
Falso |
Indica il token da cui riprendere l'elenco. Esempi di URL: "continue= Esempi OpenAPI: " |
Risposta
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.
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
elementi |
array[Qualsiasi tra: "unreadNotification_1.0_get_response_body", array[]] |
Vero |
|
metadati |
Vero |
Risposta tipo
{
"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"
}
}
Risposta
Status: 401, Unauthorized
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Risposta
Status: 400, Bad request
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
|
invalidParams |
vettore["invalidParams"] |
Falso |
Elenco dei parametri di query non validi |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Risposta
Status: 403, Forbidden
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
Errore
Status: 404, Not found
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
Esempio di risposta di errore
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
Definizioni
Vedi definizioni
etichetta tipo_astra
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
nome |
stringa |
Vero |
|
valore |
stringa |
Vero |
type_astra_metadati
Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:
-
Conforme allo schema di metadati Astra
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
etichette |
vettore["etichetta tipo_astra"] |
Vero |
|
CreationTimestamp |
stringa |
Vero |
|
ModificationTimestamp |
stringa |
Vero |
|
CreatedBy |
stringa |
Vero |
|
modifiedBy |
stringa |
Falso |
unreadNotification_1.0_get_response_body
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
Tipo di media della risorsa. I valori definiti sono:
|
versione |
stringa |
Vero |
Versione della risorsa. I valori definiti sono:
|
id |
stringa |
Vero |
Identificatore univoco globale della risorsa. I valori definiti sono:
|
ID notifica |
stringa |
Vero |
Stringa JSON contenente un ID di notifica che deve essere contrassegnato come letto dall'utente che crea il contrassegno. I valori definiti sono:
|
sequenceCount |
numero |
Vero |
Numero JSON contenente un conteggio sequenziale associato alla notifica specificata dall'ID della notifica. |
gravità |
stringa |
Vero |
Stringa JSON contenente uno dei seguenti valori che indicano la gravità dell'evento. I valori definiti sono:
|
metadati |
Vero |
Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:
|
elenco_metadati_tipo_astra
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
continuare |
stringa |
Falso |
|
conta |
numero |
Falso |
|
etichette |
vettore["etichetta tipo_astra"] |
Falso |
|
CreationTimestamp |
stringa |
Falso |
|
ModificationTimestamp |
stringa |
Falso |
|
CreatedBy |
stringa |
Falso |
|
modifiedBy |
stringa |
Falso |
invalidParams
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
nome |
stringa |
Vero |
Nome del parametro di query non valido |
motivo |
stringa |
Vero |
Motivo per cui il parametro di query non è valido |