> ## 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. # Retourne les enregistrements du catalogue filtrés par préfixe ## OpenAPI ````yaml /fr/openapi.json get /api/publicapi/v1/catalogs/{catalogId}/search openapi: 3.0.4 info: description: 'Environnement : Production
Version du produit : 1.6.17' title: Vantage processing REST API version: '1.0' x-application-version: 1.6.17 servers: - description: Production – États-Unis url: https://vantage-us.abbyy.com - description: Production – Europe url: https://vantage-eu.abbyy.com - description: Production – Australie url: https://vantage-au.abbyy.com security: - OAuth2Security: - global.wildcard - openid - permissions paths: /api/publicapi/v1/catalogs/{catalogId}/search: get: tags: - Catalogs summary: Retourne les enregistrements du catalogue filtrés par préfixe operationId: SearchRecords parameters: - description: ID du catalogue in: path name: catalogId required: true schema: type: string - description: "Valeur du préfixe. Longueur minimale\_: 2\_caractères." in: query name: prefix schema: minLength: 2 type: string - description: Nombre maximal d’enregistrements à renvoyer dans la réponse. in: query name: Limit schema: description: Nombre maximal d’enregistrements à inclure dans la réponse. format: int32 type: integer - description: >- Décalage de pagination. Il indique le nombre d’enregistrements à ignorer avant de commencer à constituer le jeu de résultats. in: query name: Offset schema: description: >- Offset de pagination. Indique le nombre d’enregistrements à ignorer avant de commencer à constituer le jeu de résultats. 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: OK '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: Introuvable components: schemas: Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogSearchResult: additionalProperties: false description: Représente le résultat d’une opération de recherche dans le catalogue. properties: catalogInfo: $ref: >- #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogDataSet records: description: >- Liste des enregistrements de catalogue qui correspondent aux critères de recherche. 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: >- Informations complémentaires sur le profil de jeu de données de type « Catalog » properties: catalogType: $ref: >- #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogType columns: description: Colonnes utilisées dans le catalogue items: $ref: >- #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogDataSetColumn type: array description: description: Description du profil de jeu de données nullable: true type: string id: description: Identifiant du profil de jeu de données minLength: 1 type: string importFileName: description: Nom du fichier pour l’importation des données dans le catalogue nullable: true readOnly: true type: string lastRecordsUpdateTime: description: Horodatage de la dernière mise à jour des enregistrements nullable: true type: string locale: $ref: >- #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogLocale name: description: Nom du profil de jeu de données minLength: 1 type: string recordsCount: description: Nombre d’enregistrements dans le catalogue format: int32 type: integer usedInSkills: description: Liste des compétences ayant des correspondances dans le catalogue 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: >- Liste des valeurs de colonne. Le nom de la colonne est utilisé comme clé. nullable: true type: object externalId: minLength: 1 type: string required: - externalId type: object Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogType: description: Type du catalogue. enum: - Custom - IssuerCompany - ReceiverCompany - PurchaseOrders - PurchaseOrderItems type: string Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogDataSetColumn: additionalProperties: false description: Informations supplémentaires concernant une colonne de catalogue properties: isPredefined: description: '' type: boolean name: description: Nom de la colonne du catalogue minLength: 1 type: string notEmpty: description: '' type: boolean order: description: Position de la colonne dans la liste des colonnes du catalogue format: int32 type: integer parameterType: $ref: >- #/components/schemas/Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogParameterType title: description: Titre de colonne du catalogue 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: >- Paramètre régional utilisé pour interpréter les valeurs de la colonne de dates lors du remplissage du catalogue enum: - International - NorthAmerica type: string Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogSkillModel: additionalProperties: false description: Représente une compétence du catalogue, y compris son ID et sa version. properties: skillId: description: Id de la compétence nullable: true type: string version: description: Version de la compétence format: int32 type: integer type: object Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogParameterType: description: Type d’un Parameter de catalogue. enum: - Text - Double - Integer - Date type: string Abbyy.Vantage.PublicApi.Contract.Catalogs.Results.CatalogDataSetColumnType: description: Type de colonne de catalogue 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 ````