Show Menu
ARGOMENTI×

Elenco delle risorse

È possibile visualizzare un elenco di tutte Schema Registry le risorse di un determinato tipo (classi, mixin, schemi, tipi di dati o descrittori) all'interno di un contenitore eseguendo una singola richiesta di GET.
Quando si elencano le risorse, il risultato dei Schema Registry limiti è impostato su 300 elementi. Per restituire risorse oltre questo limite, è necessario utilizzare i parametri di paging. È inoltre consigliabile utilizzare i parametri di query per filtrare i risultati e ridurre il numero di risorse restituite.
Formato API
GET /{CONTAINER_ID}/{RESOURCE_TYPE}
GET /{CONTAINER_ID}/{RESOURCE_TYPE}?{QUERY_PARAMS}

Parametro
Descrizione
{CONTAINER_ID}
Il contenitore in cui si trovano le risorse ("global" o "tenant").
{RESOURCE_TYPE}
Il tipo di risorsa da recuperare dal Schema Library. I tipi validi sono classes , mixins , schemas , datatypes e descriptors .
{QUERY_PARAMS }
Parametri di query facoltativi per filtrare i risultati per. Per ulteriori informazioni, consulta la sezione sui parametri di query.
Richiesta
curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/global/classes&limit=2 \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Il formato della risposta dipende dall’intestazione Accetta inviata nella richiesta. Le seguenti intestazioni Accetta sono disponibili per elencare le risorse:
Accetta intestazione
Descrizione
application/vnd.adobe.xed-id+json
Restituisce un breve riepilogo di ciascuna risorsa. Intestazione consigliata per elencare le risorse. (Limite: 300)
application/vnd.adobe.xed+json
Restituisce lo schema JSON completo per ciascuna risorsa, con originale $ref e allOf incluso. (Limite: 300)
application/vnd.adobe.xdm-v2+json
Quando si utilizza l' /descriptors endpoint, questa intestazione Accetta deve essere utilizzata per utilizzare le funzionalità di paging.
Risposta
La richiesta precedente utilizzava l’intestazione application/vnd.adobe.xed-id+json Accetto, pertanto la risposta include solo gli attributi title , $id , meta:altId e version per ogni risorsa. La sostituzione full nell'intestazione Accetto restituisce tutti gli attributi di ogni risorsa. Selezionate l’intestazione Accetto appropriata in base alle informazioni richieste nella risposta.
{
  "results": [
    {
        "title": "XDM ExperienceEvent",
        "$id": "https://ns.adobe.com/xdm/context/experienceevent",
        "meta:altId": "_xdm.context.experienceevent",
        "version": "1"
    },
    {
        "title": "XDM Individual Profile",
        "$id": "https://ns.adobe.com/xdm/context/profile",
        "meta:altId": "_xdm.context.profile",
        "version": "1"
    }
  ]
}

Utilizzo dei parametri di query

Supporta Schema Registry l'utilizzo di parametri di query per visualizzare la pagina e filtrare i risultati quando vengono elencate le risorse.
Quando si combinano più parametri di query, questi devono essere separati da e commerciale ( & ).

Pagine

I parametri di query più comuni per il paging includono:
Parametro
Descrizione
start
Specificate dove devono iniziare i risultati elencati. Questo valore può essere ottenuto dall' _page.next attributo di una risposta a un elenco e utilizzato per accedere alla pagina successiva dei risultati. Se il _page.next valore è null, non è disponibile alcuna pagina aggiuntiva.
limit
Limita il numero di risorse restituite. Esempio: limit=5 restituirà un elenco di cinque risorse.
orderby
Ordinare i risultati in base a una proprietà specifica. Esempio: orderby=title ordinerà i risultati in ordine crescente (A-Z) in base al titolo. Se si aggiunge un titolo - prima del titolo ( orderby=-title ), gli elementi vengono ordinati per titolo in ordine decrescente (Z-A).

Filtro

Potete filtrare i risultati utilizzando il property parametro, utilizzato per applicare un operatore specifico a una determinata proprietà JSON all'interno delle risorse recuperate. Gli operatori supportati includono:
Operatore
Descrizione
Esempio
==
Filtra in base al fatto che la proprietà sia uguale al valore fornito.
property=title==test
!=
Filtra in base al fatto che la proprietà non sia uguale al valore fornito.
property=title!=test
<
Filtra in base al fatto che la proprietà sia minore del valore fornito.
property=version<5
>
Filtra in base al fatto che la proprietà sia maggiore del valore fornito.
property=version>5
<=
Filtra se la proprietà è minore o uguale al valore specificato.
property=version<=5
>=
Filtra in base al fatto che la proprietà sia maggiore o uguale al valore fornito.
property=version>=5
~
Filtra in base al fatto che la proprietà corrisponda o meno a un'espressione regolare specificata.
property=title~test$
(Nessuna)
Se si specifica solo il nome della proprietà, vengono restituite solo le voci in cui esiste la proprietà.
property=title
Potete usare il property parametro per filtrare i mixin in base alla classe compatibile. Ad esempio, property=meta:intendedToExtend==https://ns.adobe.com/xdm/context/profile restituisce solo i mixin compatibili con la XDM Individual Profile classe.