Get all catalog items
get
/iam/governance/selfservice/api/v1/catalog
Returns the list of all catalog items published in the catalog. The catalog items can be of entity type application instance, entitlement and role. Specific type of catalog items can be filtered using the appropriate filter parameters.
Request
Supported Media Types
- application/json
Query Parameters
-
q(optional): string
Search filter to get the records. SCIM filter is accepted. There should not be any spaces for filter value. If you want to pass space in between filter value then replace it to "::". Supported search attributes in filter are ENTITY_TYPE/ENTITY_NAME/ENTITY_DISPLAY_NAME/USER_DEFINED_TAGS. Catalog accepts only one of the search filter from "ENTITY_NAME/ENTITY_DISPLAY_NAME/USER_DEFINED_FIELDS" at a time and search filter is applied as "BEGINS_WITH" implicitly. E.g: USER_DEFINED_TAGS sw User. Filter also supports "offset", "limit", "orderBy". e.g: offset=3&limit=5&orderBy=CATALOG_ID:descending. The ENTITY_TYPE filter can be combined with the any one of the remaining three filters. Possible values are ApplicationInstance/Role/Entitlement. If no ENTITY_TYPE is specified then all the catalog items will be returned. Only the requestable entities from the catalog will be returned. For example to get all the entitlements whose display name starts with "A" the filter will be "/catalog?q=ENTITY_TYPE eq Entitlements AND ENTITY_DISPLAY_NAME sw A"
Response
Supported Media Types
- application/json
200 Response
Successful
Headers
-
ResponseTime: string
Captures the time in milliseconds taken for processing the request.
401 Response
Unauthorized
404 Response
Resource not found
500 Response
Internal Server Error
Examples
This example demonstrates the ability to retrieve catalog information with filters being applied. The information shown here is against a pseudo system and serves as a prototype.
cURL Example
curl -H "Content-Type: application/json" -X GET -u username:password http://pseudo.com/iam/governance/selfservice/api/v1//catalog?q=ENTITY_TYPE eq Entitlement and ENTITY_NAME sw 24&offset=3&limit=5&orderBy=CATALOG_ID:descendingGET Response Body
Example of GET Response Body
The following example shows the contents of the response body in JSON format.
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/catalog?offset=1&limit=10"
},
{
"rel": "first",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/catalog?offset=1&limit=10"
},
{
"rel": "next",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/catalog?offset=11&limit=10"
}
],
"count": 10,
"hasMore": true,
"totalResult": -1,
"catalogs": [
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/catalog/1"
}
],
"id": 1,
"entityType": "Role",
"entityName": "Employee",
"entityDisplayName": "Employee Role"
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/catalog/2"
}
],
"id": 2,
"entityType": "ApplicationInstance",
"entityName": "SharedFileServer",
"entityDisplayName": "Shared File Server"
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/catalog/22"
}
],
"id": 22,
"entityType": "ApplicationInstance",
"entityName": "DBAT",
"entityDisplayName": "DBAT"
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/catalog/24"
}
],
"id": 24,
"entityType": "Role",
"entityName": "TestRole6",
"entityDisplayName": "TestRole6"
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/catalog/25"
}
],
"id": 25,
"entityType": "Role",
"entityName": "TestRole1",
"entityDisplayName": "TestRole-h"
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/catalog/26"
}
],
"id": 26,
"entityType": "Role",
"entityName": "TestRole2",
"entityDisplayName": "TestRole2"
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/catalog/27"
}
],
"id": 27,
"entityType": "Role",
"entityName": "TestRole3",
"entityDisplayName": "TestRole3"
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/catalog/28"
}
],
"id": 28,
"entityType": "Role",
"entityName": "TestRole4",
"entityDisplayName": "TestRole4"
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/catalog/29"
}
],
"id": 29,
"entityType": "Role",
"entityName": "TestRole5",
"entityDisplayName": "TestRole5"
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/catalog/115"
}
],
"id": 115,
"entityType": "ApplicationInstance",
"entityName": "EmployeeBadge016",
"entityDisplayName": "Employee Badge Disp_016"
}
]
}