Pular para o conteúdo principal
GET
/
api
/
publicapi
/
v1
/
catalogs
/
{catalogId}
/
search
Retorna os registros de catálogo filtrados por prefixo
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": {}
    }
  ]
}

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

catalogId
string
obrigatório

ID do catálogo

Parâmetros de consulta

prefix
string

Valor do prefixo. Tamanho mínimo: 2 caracteres.

Minimum string length: 2
Limit
integer<int32>

Número máximo de registros a serem retornados na resposta.

Offset
integer<int32>

Deslocamento para paginação. Define o número de registros a serem ignorados antes de iniciar a coleta do conjunto de resultados. Deslocamento para paginação. Especifica quantos registros serão ignorados antes de iniciar a coleta do conjunto de resultados.

Resposta

OK

Representa o resultado de uma operação de pesquisa em catálogo.

catalogInfo
object

Informações adicionais sobre o perfil de conjunto de dados do tipo 'Catalog'

records
object[] | null

Lista de registros de catálogo que atendem aos critérios de pesquisa.