Saltar al contenido principal
GET
/
api
/
publicapi
/
v1
/
catalogs
/
{catalogId}
/
search
Devuelve los registros del catálogo filtrados por prefijo
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": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

Autorizaciones

​
Authorization
string
header
requerido

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

Parámetros de ruta

​
catalogId
string
requerido

ID de catálogo

Parámetros de consulta

​
prefix
string

Valor del prefijo. Longitud mínima: 2 caracteres.

Minimum string length: 2
​
Limit
integer<int32>

Número máximo de registros a devolver en la respuesta.

​
Offset
integer<int32>

Desplazamiento para la paginación. Especifica el número de registros que se deben omitir antes de empezar a recopilar el conjunto de resultados. Desplazamiento para la paginación. Especifica el número de registros que se deben omitir antes de iniciar la recopilación del conjunto de resultados.

Respuesta

Aceptar

Representa el resultado de una operación de búsqueda en el catálogo.

​
catalogInfo
object

Información adicional sobre el perfil de un conjunto de datos de tipo «Catalog»

​
records
object[] | null

Lista de registros de catálogo que coinciden con los criterios de búsqueda.