Vai al contenuto principale
GET
/
api
/
publicapi
/
v1
/
catalogs
/
{catalogId}
/
search
Restituisce i record del catalogo filtrati in base al prefisso
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": {}
    }
  ]
}

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

ID catalogo

Parametri della query

prefix
string

Valore del prefisso. Lunghezza minima: 2 caratteri.

Minimum string length: 2
Limit
integer<int32>

Numero massimo di record da restituire nella risposta. Numero massimo di record da includere nella risposta.

Offset
integer<int32>

Offset per la paginazione. Specifica il numero di record da ignorare prima di iniziare a raccogliere l'insieme di risultati. Offset per la paginazione. Specifica il numero di record da saltare prima di iniziare a recuperare i risultati.

Risposta

OK

Rappresenta il risultato di un'operazione di ricerca nel catalogo.

catalogInfo
object

Informazioni aggiuntive sul profilo di data set di tipo "Catalog"

records
object[] | null

Elenco dei record di catalogo che soddisfano i criteri di ricerca.