Gets detailed information about the catalog

Gets detailed information about the catalog structure, e.g. required column set

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

Gets detailed information about the catalog

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>",
      "notEmpty": true
    }
  ],
  "rowCount": 123
}

Authorizations

Authorization · string · header · required

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

Path Parameters

catalogId · string · required

Catalog identifier. You can find it in the list of all catalogs.

Response

200

text/plain

Catalog info is successfully returned

id · string · required

Unique identifier of the catalog

Minimum string length: 1

name · string · required

Name of the catalog

Minimum string length: 1

columns · object[] · required

Columns of the catalog

Show child attributes

rowCount · integer<int32> · required

Total number of rows in the catalog