Zum Hauptinhalt springen
GET
/
api
/
publicapi
/
v1
/
catalogs
/
{catalogId}
/
search
Gibt Katalogeinträge zurück, die anhand eines Präfixes gefiltert werden
curl --request GET \
  --url https://vantage-us.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/search \
  --header 'Authorization: Bearer <token>'
{
  "catalogInfo": {
    "id": "<string>",
    "name": "<string>",
    "columns": [
      {
        "name": "<string>",
        "type": "Text",
        "notEmpty": true,
        "title": "<string>",
        "parameterType": "Text",
        "order": 123,
        "isPredefined": true
      }
    ],
    "catalogType": "Custom",
    "description": "<string>",
    "importFileName": "<string>",
    "locale": "International",
    "recordsCount": 123,
    "usedInSkills": [
      {
        "skillId": "<string>",
        "version": 123
      }
    ],
    "lastRecordsUpdateTime": "<string>"
  },
  "records": [
    {
      "externalId": "<string>",
      "columnValues": {}
    }
  ]
}

Autorisierungen

Authorization
string
header
erforderlich

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

Pfadparameter

catalogId
string
erforderlich

Katalog-ID

Abfrageparameter

prefix
string

Präfixwert. Mindestlänge: 2 Zeichen.

Minimum string length: 2
Limit
integer<int32>

Maximale Anzahl von Datensätzen, die in der Antwort zurückgegeben werden sollen. Maximale Anzahl der Datensätze, die in der Antwort zurückgegeben werden.

Offset
integer<int32>

Offset für die Paginierung. Gibt an, wie viele Einträge übersprungen werden, bevor mit dem Abrufen der Ergebnismenge begonnen wird. Offset für die Paginierung. Gibt die Anzahl der Datensätze an, die übersprungen werden, bevor mit dem Erfassen der Ergebnismenge begonnen wird.

Antwort

OK

Repräsentiert das Ergebnis einer Katalogsuche.

catalogInfo
object

Zusätzliche Informationen zum Datensatzprofil des Typs „Catalog“

records
object[] | null

Liste der Katalogeinträge, die den Suchkriterien entsprechen.