Communities
A collaborative platform to connect and grow with like-minded Informaticans across the globe
Product Communities
Connect and collaborate with Informatica experts and champions
Discussions
Have a question? Start a Discussion and get immediate answers you are looking for
User Groups
Customer-organized groups that meet online and in-person. Join today to network, share ideas, and get tips on how to get the most out of Informatica
Get Started
Community Guidelines
Knowledge Center
Troubleshooting documents, product guides, how to videos, best practices, and more
Knowledge Base
One-stop self-service portal for solutions, FAQs, Whitepapers, How Tos, Videos, and more
Support TV
Video channel for step-by-step instructions to use our products, best practices, troubleshooting tips, and much more
Documentation
Information library of the latest product documents
Velocity (Best Practices)
Best practices and use cases from the Implementation team
Learn
Rich resources to help you leverage full capabilities of our products
Trainings
Role-based training programs for the best ROI
Certifications
Get certified on Informatica products. Free, Foundation, or Professional
Product Learning Paths
Free and unlimited modules based on your expertise level and journey
Resources
Library of content to help you leverage the best of Informatica products
Tech Tuesdays Webinars
Most popular webinars on product architecture, best practices, and more
Product Availability Matrix
Product Availability Matrix statements of Informatica products
SupportFlash
Monthly support newsletter
Support Documents
Informatica Support Guide and Statements, Quick Start Guides, and Cloud Product Description Schedule
Product Lifecycle
End of Life statements of Informatica products
Ideas
Events
Change Request Tracking
Marketplace
English
  • Informatica Data Quality 10.5
  • All Products

Table of Contents

Search

  1. Preface
  2. Introduction to Business Glossary API
  3. HTTP Methods
  4. API Reference

API Guide

API Guide

Back Next

GET /glossary/api/v4/suggest

GET /glossary/api/v4/suggest

Use this URI to suggest several possible search queries based on the user's query. Requires a valid JSESSIONID cookie as part of this request. Results are filtered based on the user's permissions.

Parameters

The following table describes the query parameters for the GET /glossary/api/v4/suggest URI request:
Parameter
Description
query
Required. Search query string.

Returns

The number of search results and an ordered list of matched business terms. Results are limited to published terms that the user has the permission to access.

Return Values

The following table describes the return value for the GET /glossary/api/v4/suggest URI request:
Return Value
Description
suggestion
Lists possible search queries based on the search string that the user enters.

Responses

The following responses can occur for the GET /glossary/api/v4/suggest URI request:
HTTP Return Code: 200
Suggestion for a search string. For example: 
{
  "processingTime": "10",
  "suggestion": [
    "Customer Name",
    "Custom Cars"
  ]
}
HTTP Return Code: 400
Response to a missing request parameter. For example: 
{ 	"errorCode": "BG1003", 
	"message": "Invalid request, missing either parameter {0} or its value."
}
HTTP Return Code: 401
Session expired.
HTTP Return Code: 403
Response to a search query that is not valid. For example: 
{
  "errorCode": "BGREST_1211",
  "message": "[SearchServiceClient_00013] The search string is not valid. You cannot start a search string with wildcard characters * or ?."
}
HTTP Return Code: 404
This API method will never return an error.
HTTP Return Code: 500
Response to an internal search error. For example: 
{
  "errorCode": "BGREST_1211",
  "message": "No Search Service is associated with Model Repository Service ['MRS_BG']. To perform a search, create a Search Service, associate it with the Model Repository Service, and ensure that it is enabled."
}
0 COMMENTS
We’d like to hear from you!