Restituisce informazioni dettagliate sul catalogo

Restituisce informazioni dettagliate sulla struttura del catalogo, ad esempio l’insieme di colonne obbligatorie

GET /api/publicapi/v1/catalogs/{catalogId}

Restituisce informazioni dettagliate sul catalogo

cURL

curl --request GET \
  --url https://vantage-us.abbyy.com/api/publicapi/v1/catalogs/{catalogId} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "name": "<string>",
  "columns": [
    {
      "name": "<string>",
      "type": "Text",
      "notEmpty": true
    }
  ],
  "rowCount": 123
}

Autorizzazioni

Authorization · string · header · obbligatorio

The access token received from the authorization server in the OAuth 2.0 flow.

Parametri del percorso

catalogId · string · obbligatorio

Identificativo del catalogo. Puoi trovarlo nell’elenco di tutti i cataloghi.

Risposta

200

text/plain

Le informazioni sul catalogo sono state restituite correttamente

id · string · obbligatorio

Identificatore univoco del catalogo

Minimum string length: 1

name · string · obbligatorio

Nome del catalogo

Minimum string length: 1

columns · object[] · obbligatorio

Colonne del catalogo

Show child attributes

rowCount · integer<int32> · obbligatorio

Numero totale di righe del catalogo