> ## 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.

# Devuelve los registros del catálogo filtrados por prefijo



## OpenAPI

````yaml /es/openapi.json get /api/publicapi/v1/catalogs/{catalogId}/search
openapi: 3.0.4
info:
  description: 'Entorno: Producción<br>Versión del producto: 1.6.17'
  title: Vantage processing REST API
  version: '1.0'
  x-application-version: 1.6.17
servers:
  - description: Producción (Estados Unidos)
    url: https://vantage-us.abbyy.com
  - description: Producción (Europa)
    url: https://vantage-eu.abbyy.com
  - description: Producción (Australia)
    url: https://vantage-au.abbyy.com
security:
  - OAuth2Security:
      - global.wildcard
      - openid
      - permissions
paths:
  /api/publicapi/v1/catalogs/{catalogId}/search:
    get:
      tags:
        - Catalogs
      summary: Devuelve los registros del catálogo filtrados por prefijo
      operationId: SearchRecords
      parameters:
        - description: ID de catálogo
          in: path
          name: catalogId
          required: true
          schema:
            type: string
        - description: 'Valor del prefijo. Longitud mínima: 2 caracteres.'
          in: query
          name: prefix
          schema:
            minLength: 2
            type: string
        - description: Número máximo de registros a devolver en la respuesta.
          in: query
          name: Limit
          schema:
            description: Número máximo de registros a devolver en la respuesta.
            format: int32
            type: integer
        - description: >-
            Desplazamiento para la paginación. Especifica el número de registros
            que se deben omitir antes de empezar a recopilar el conjunto de
            resultados.
          in: query
          name: Offset
          schema:
            description: >-
              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.
            format: int32
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogSearchResult
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogSearchResult
            text/plain:
              schema:
                $ref: >-
                  #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogSearchResult
          description: Aceptar
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
          description: No se encontró
components:
  schemas:
    Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogSearchResult:
      additionalProperties: false
      description: Representa el resultado de una operación de búsqueda en el catálogo.
      properties:
        catalogInfo:
          $ref: >-
            #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogDataSet
        records:
          description: >-
            Lista de registros de catálogo que coinciden con los criterios de
            búsqueda.
          items:
            $ref: >-
              #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogRecordData
          nullable: true
          type: array
      type: object
    Microsoft.AspNetCore.Mvc.ProblemDetails:
      additionalProperties: {}
      properties:
        detail:
          nullable: true
          type: string
        instance:
          nullable: true
          type: string
        status:
          nullable: true
          type: string
        title:
          nullable: true
          type: string
        type:
          nullable: true
          type: string
      type: object
    Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogDataSet:
      additionalProperties: false
      description: >-
        Información adicional sobre el perfil de un conjunto de datos de tipo
        «Catalog»
      properties:
        catalogType:
          $ref: >-
            #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogType
        columns:
          description: Columnas usadas en el catálogo
          items:
            $ref: >-
              #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogDataSetColumn
          type: array
        description:
          description: Descripción del perfil del conjunto de datos
          nullable: true
          type: string
        id:
          description: ID del perfil del conjunto de datos
          minLength: 1
          type: string
        importFileName:
          description: Nombre del archivo para importar datos al catálogo
          nullable: true
          readOnly: true
          type: string
        lastRecordsUpdateTime:
          description: Hora de la última actualización de registros
          nullable: true
          type: string
        locale:
          $ref: >-
            #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogLocale
        name:
          description: Nombre del perfil del conjunto de datos
          minLength: 1
          type: string
        recordsCount:
          description: Número de registros en el catálogo
          format: int32
          type: integer
        usedInSkills:
          description: Lista de skills que tienen mapeos en el catálogo
          items:
            $ref: >-
              #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogSkillModel
          nullable: true
          type: array
      required:
        - columns
        - id
        - name
      type: object
    Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogRecordData:
      additionalProperties: false
      properties:
        columnValues:
          additionalProperties:
            nullable: true
            type: string
          description: >-
            Lista de valores de columnas. El nombre de cada columna se utiliza
            como clave.
          nullable: true
          type: object
        externalId:
          minLength: 1
          type: string
      required:
        - externalId
      type: object
    Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogType:
      description: Tipo de catálogo.
      enum:
        - Custom
        - IssuerCompany
        - ReceiverCompany
        - PurchaseOrders
        - PurchaseOrderItems
      type: string
    Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogDataSetColumn:
      additionalProperties: false
      description: Información adicional sobre una columna de catálogo
      properties:
        isPredefined:
          description: ''
          type: boolean
        name:
          description: Nombre de la columna del catálogo
          minLength: 1
          type: string
        notEmpty:
          description: ''
          type: boolean
        order:
          description: Posición de la columna en la lista de columnas del catálogo
          format: int32
          type: integer
        parameterType:
          $ref: >-
            #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogParameterType
        title:
          description: Título de la columna del catálogo
          nullable: true
          type: string
        type:
          $ref: >-
            #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogDataSetColumnType
      required:
        - name
        - notEmpty
        - type
      type: object
    Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogLocale:
      description: >-
        Configuración regional usada para interpretar los valores de las
        columnas de fecha al completar el catálogo
      enum:
        - International
        - NorthAmerica
      type: string
    Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogSkillModel:
      additionalProperties: false
      description: Representa una skill del catálogo, con su ID y su versión.
      properties:
        skillId:
          description: ID de skill
          nullable: true
          type: string
        version:
          description: Versión de la skill
          format: int32
          type: integer
      type: object
    Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogParameterType:
      description: Tipo de Parameter de catálogo.
      enum:
        - Text
        - Double
        - Integer
        - Date
      type: string
    Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogDataSetColumnType:
      description: Tipo de columna de catálogo
      enum:
        - Text
        - Number
        - Alphanumeric
      type: string
  securitySchemes:
    OAuth2Security:
      flows:
        authorizationCode:
          authorizationUrl: https://vantage-preview.abbyy.com/auth2/connect/authorize
          scopes:
            global.wildcard: Global wildcard
            openid: User Id
            permissions: User permissions
          tokenUrl: https://vantage-preview.abbyy.com/auth2/connect/token
      type: oauth2

````