search
The API for Konnect Portal Search.
List Portal Entities via Search
Returns paginated search results from the specified entities with the given search parameters.
Query Parameters
Determines how to filter search results
Accepted values are versions and versions.documents. Use commas to separate multiple values.
Example:versions,versions.documents
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Path Parameters
Determines which entity sets to search
Allowed values:product-catalog
Response
application/json
Response
Search Results
SearchResults
returns the pagination information
Show Child Parameters
The paginated results that matched the search query
Show Child Parameters
SearchResults
objectreturns the pagination information
Show Child Parameters
The paginated results that matched the search query
Show Child Parameters
ProductCatalogIndexSource
objectContains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
the name of the product
Example:Nice Product
a description of the product
Example:A nice product for customers to read about and consume
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Number of product documents available.
Example:5
Number of product versions.
Example:2
Last created version.
Show Child Parameters
Public labels store information about an entity that can be used for filtering a list of objects.
Public labels are intended to store PUBLIC metadata.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"category":"finance"}
SearchIndicesParameters
stringAllowed values:product-catalog