Search Catalog
Get All Catalog Items
Method: [GET]
API Endpoint
api/esearch/catalog
Query parameters
| Query Parameter | Data Type | Description | Example Value |
|---|---|---|---|
| Filter | Multi-Value | This will include the search catalog keyword, relevance filter, userlogin, userID, tags and collection | Keyword, relevanceFilter, userLogin, userID, tags |
| Offset | integer | The Offset query parameter is used to exclude from a response the first N items from the response. You can combine the Limit and the Offset parameters to request a particular set of items | 1 |
| Limit | integer | For pagination, the limit of entries to be returned. | 20 |
| count | integer | This allows you to specify the number of matches for the query. | 10 |
| sortby | string | This allows to specify the sorting variable for the response. The default is user display name. | displayName |
If you want to user the Filter query parameter, then you also need to mandatorily specify the userlogin and userID.
Example API End Point:
https://gke9.iamsath.com/api/esearch/catalog?filter=%7B%22keyword%22:%22%22,%22relevanceFilter%22:%5B%5D,%22userLogin%22:%22jerome%22,%22userId%22:%2263aec79793ccdf675cc4d018%22,%22tags%22:%5B%5D%7D&offset=1&limit=20&count=&sort_by=displayName
Get Catalog items using a Keyword
For searching catalog items using a keyword, you have to enter the keyword value in the Filter Query parameter of the API Endpoint. (As explained above).
Query Parameter Example:
{"keyword":"Marketing","relevanceFilter":[],"userLogin":"jerome","userId":"63aec79793ccdf675cc4d018","tags":[]}
Get Specific Catalog Items
If you want to Get a list of specific catalog items such as: Application or Entitlement etc, then you need to specify the Collection value in the in the Filter Query parameter of the API Endpoint.
Query Parameter Example:
{"keyword":"","relevanceFilter":[],"userLogin":"jerome","userId":"63aec79793ccdf675cc4d018","tags":[],"collection":"TargetSystem"}
- For Entitlement, specify collection as:
Entitlement - For Users, specify collection as :
User - For Roles, specify collection as:
Role - For Service Request, specify Collection as:
ServiceRequest
Get Specific Catalog Items using relevance filters
If you want to get specific catalog items such as: Application or Entitlement etc and you want to further filter the response using relevant filter, then you need to specify the Collection value and the relevanceFilter value in the Query parameter of the API Endpoint.
Query Parameter Example:
{"keyword":"","relevanceFilter":["recentlyAdded"],"userLogin":"jerome","userId":"63aec79793ccdf675cc4d018","tags":[],"collection":"TargetSystem"}
Get Specific Catalog Items using Tag filter
If you want to get specific catalog items such as: Application or Entitlement etc and you want to further filter the response using Tag filter, then you need to specify the Collection value and the tags value in the Query parameter of the API Endpoint.
Query Parameter Example:
{"keyword":"","relevanceFilter":["access"],"userLogin":"jerome","userId":"63aec79793ccdf675cc4d018","tags":["Finance","HR"],"collection":"TargetSystem"}