Get Details of Catalog Item Based on Catalog ID
get
/iam/governance/selfservice/api/v1/catalog/{catalogid}
Returns details of catalog item based on the catalog ID. The response payload gets all the information associated with the catalog. The details of certifier, risk, approver, user defined tags etc. are returned.
Request
Supported Media Types
- application/json
Path Parameters
-
catalogid(required): string
Unique Catalog Id for Catalog item
Query Parameters
-
fields: string
The attributes that are to be returned can be controlled by specifying the fields query parameter. A Comma-separated list of the attribute names is to be passed to the attributes query parameter. For example to get the catalog name, type, certification details etc the URI is "/catalog/{catalogid}?fields=entityType, entityName,isCertifiable"
Response
Supported Media Types
- application/json
200 Response
Successful
Headers
-
ResponseTime: string
Captures the time in milliseconds taken for processing the request.
Root Schema : GetCatalogByCatalogIdResponse
Type:
Show Source
object-
approverRoleDisplayName:
string
-
approverUserDisplayName:
string
-
approverUserLogin:
string
-
auditObjectives:
string
-
category:
string
-
certifierRoleDisplayName:
string
-
certifierUserDisplayName:
string
-
certifierUserLogin:
string
-
entityDescription:
string
-
entityDisplayName:
string
-
entityKey:
string
-
entityName:
string
-
entityType:
string
-
fulFillMentRoleDisplayName:
string
-
fulFillMentUserDisplayName:
string
-
fulFillMentUserLogin:
string
-
id:
integer
-
isAuditable:
string
-
isCertifiable:
string
-
itemRisk:
string
-
links:
array links
-
tags:
string
-
updateDate:
string
-
userDefinedTags:
string
401 Response
Unauthorized
404 Response
Requested entity not found
500 Response
Internal Server Error
Default Response
Unexpected error
Examples
This example retrieves the details for a given catalog entry. 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 https://pseudo.com/iam/governance/selfservice/api/v1/catalog/2
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/2"
}
],
"id": 2,
"entityType": "Role",
"entityKey": "7",
"entityName": "Fraud Analyst",
"entityDisplayName": "Fraud Analyst",
"category": "Role",
"auditObjectives": "ao",
"approverRoleDisplayName": "AP Expense Approver",
"approverUserDisplayName": "Robert Klein",
"approverUserLogin": "RKLEIN",
"certifierUserDisplayName": "Junki Long",
"certifierUserLogin": "JLONG",
"certifierRoleDisplayName": "AP Merchandise Vendor Approver",
"fulFillMentRoleDisplayName": "Administrators",
"fulFillMentUserDisplayName": "Howard Smith",
"fulFillMentUserLogin": "HSMITH",
"itemRisk": "3",
"tags": "udtag Fraud Analyst Fraud Analyst Default",
"updateDate": "2019-04-01T16:59:41Z",
"userDefinedTags": "udtag",
"isCertifiable": "true",
"isAuditable": "true"
}