View Catalog Metadata
The user can view the business context for a catalog item with the URI /catalog/{catalogid}/metadata GET.
cURL Example
curl -H "Content-Type: application/json" -X GET -u username:password https://pseudo.com/iam/governance/selfservice/api/v1/catalog/15/metadata
GET Response Body
{
"links": [
{
"rel": "self",
"href": "https://pseudo.com/iam/governance/selfservice/api/v1/catalog/15/metadata"
}
],
"catalogMetadatas": [
{
"metadataValue": "15",
"metadataDefinitionId": "1",
"metadataDefinitionDBColumnName": "CATALOG_ID",
"metadataDefinitionDisplayName": "CATALOG PRIMARY KEY",
"metadataDefinitionDescription": "ITS A CATALOG PRIMARY KEY",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "false"
},
{
"metadataValue": "ApplicationInstance",
"metadataDefinitionId": "2",
"metadataDefinitionDBColumnName": "ENTITY_TYPE",
"metadataDefinitionDisplayName": "Type",
"metadataDefinitionDescription": "This is to identify if the type is Role, ENtitlement and App Instance",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "true",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "true"
},
{
"metadataValue": "1",
"metadataDefinitionId": "3",
"metadataDefinitionDBColumnName": "ENTITY_KEY",
"metadataDefinitionDisplayName": "OIM Entity Key",
"metadataDefinitionDescription": "This is Primary key of Role, Entitlement and App Instance",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "true"
},
{
"metadataDefinitionId": "4",
"metadataDefinitionDBColumnName": "PARENT_ENTITY_TYPE",
"metadataDefinitionDisplayName": "OIM Parent Entity Type",
"metadataDefinitionDescription": "This is to identify what is the type of the parent of another catalog items whether its Role, Entitlement and App Instance",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "false"
},
{
"metadataDefinitionId": "5",
"metadataDefinitionDBColumnName": "PARENT_ENTITY_KEY",
"metadataDefinitionDisplayName": "Parent Entity key",
"metadataDefinitionDescription": "If catalog parent is present what is the parent entity key",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "false"
},
{
"metadataValue": "Vision Employees Domain Disp",
"metadataDefinitionId": "6",
"metadataDefinitionDBColumnName": "ENTITY_DISPLAY_NAME",
"metadataDefinitionDisplayName": "Display Name",
"metadataDefinitionDescription": "Display name of the underlying entity",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "true",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "true"
},
{
"metadataValue": "VisionEmployeesDomain",
"metadataDefinitionId": "7",
"metadataDefinitionDBColumnName": "ENTITY_NAME",
"metadataDefinitionDisplayName": "OIM Entity Name",
"metadataDefinitionDescription": "Name of underlying entity",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "true"
},
{
"metadataValue": "Vision Employees Domain Desc",
"metadataDefinitionId": "8",
"metadataDefinitionDBColumnName": "ENTITY_DESCRIPTION",
"metadataDefinitionDisplayName": "OIM Entity Description",
"metadataDefinitionDescription": "Description of underlying entity",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "true"
},
{
"metadataValue": "1",
"metadataDefinitionId": "9",
"metadataDefinitionDBColumnName": "IS_REQUESTABLE",
"metadataDefinitionDisplayName": "Is requestable",
"metadataDefinitionDescription": "If the Entity is requestable or not",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "false"
},
{
"metadataValue": "0",
"metadataDefinitionId": "10",
"metadataDefinitionDBColumnName": "IS_DELETED",
"metadataDefinitionDisplayName": "Delete Catalog Item",
"metadataDefinitionDescription": "If the item in catalog is soft deleted or not.",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "false"
},
{
"metadataDefinitionId": "11",
"metadataDefinitionDBColumnName": "USER_DEFINED_TAGS",
"metadataDefinitionDisplayName": "User Defined Tags",
"metadataDefinitionDescription": "Contains the arbitrary tags.",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "false"
},
{
"metadataValue": " VisionEmployeesDomain DOBBased Vision Employees Domain Disp Vision Employees Domain Resource AD User ",
"metadataDefinitionId": "12",
"metadataDefinitionDBColumnName": "TAGS",
"metadataDefinitionDisplayName": "Tags",
"metadataDefinitionDescription": "Tags on which search will be performed",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "false"
},
{
"metadataValue": "ApplicationInstance",
"metadataDefinitionId": "13",
"metadataDefinitionDBColumnName": "CATEGORY",
"metadataDefinitionDisplayName": "Category",
"metadataDefinitionDescription": "Category on which user can peform refinement",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "true"
},
{
"metadataValue": "SOX Compliance",
"metadataDefinitionId": "14",
"metadataDefinitionDBColumnName": "AUDIT_OBJECTIVE",
"metadataDefinitionDisplayName": "Audit Objective",
"metadataDefinitionDescription": "Its a MVA saved as comma separated",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "true"
},
{
"metadataValue": "7",
"metadataDefinitionId": "15",
"metadataDefinitionDBColumnName": "APPROVER_USER",
"metadataDefinitionDisplayName": "Approver User",
"metadataDefinitionDescription": "User approver ID of the catalog item",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "false"
},
{
"metadataDefinitionId": "16",
"metadataDefinitionDBColumnName": "APPROVER_ROLE",
"metadataDefinitionDisplayName": "Approver Role",
"metadataDefinitionDescription": "Role approver ID of the catalog item",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "false"
},
{
"metadataDefinitionId": "17",
"metadataDefinitionDBColumnName": "FULFILLMENT_USER",
"metadataDefinitionDisplayName": "Fulfillment User",
"metadataDefinitionDescription": "Fulfillment User ID of the catalog item",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "false"
},
{
"metadataDefinitionId": "18",
"metadataDefinitionDBColumnName": "FULFILLMENT_ROLE",
"metadataDefinitionDisplayName": "Fulfillment Role",
"metadataDefinitionDescription": "Fulfillment Role ID of the catalog item",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "false"
},
{
"metadataValue": "7",
"metadataDefinitionId": "19",
"metadataDefinitionDBColumnName": "CERTIFIER_USER",
"metadataDefinitionDisplayName": "Certifier User",
"metadataDefinitionDescription": "Certfier User ID of the catalog item",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "true"
},
{
"metadataDefinitionId": "20",
"metadataDefinitionDBColumnName": "CERTIFIER_ROLE",
"metadataDefinitionDisplayName": "Certifier Role",
"metadataDefinitionDescription": "Certfier Role ID of the catalog item",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "false"
},
{
"metadataValue": "5",
"metadataDefinitionId": "21",
"metadataDefinitionDBColumnName": "ITEM_RISK",
"metadataDefinitionDisplayName": "Item Risk",
"metadataDefinitionDescription": "Item Risk score of the catalog item",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "true"
},
{
"metadataValue": "1",
"metadataDefinitionId": "22",
"metadataDefinitionDBColumnName": "CERTIFIABLE",
"metadataDefinitionDisplayName": "Certifiable",
"metadataDefinitionDescription": "Indicate if the catalog item is Certifiable.",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "false"
},
{
"metadataValue": "2019-06-13 14:12:55",
"metadataDefinitionId": "23",
"metadataDefinitionDBColumnName": "RISK_UPDATE_DATE",
"metadataDefinitionDisplayName": "Risk update Date",
"metadataDefinitionDescription": "Risk update date of the catalog item",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "true"
},
{
"metadataValue": "1",
"metadataDefinitionId": "24",
"metadataDefinitionDBColumnName": "IS_AUDITABLE",
"metadataDefinitionDisplayName": "Is Auditable",
"metadataDefinitionDescription": "This field will be used during SOD",
"metadataDefinitionSearchable": "false",
"metadataDefinitionSortable": "false",
"metadataDefinitionUdf": "false",
"metadataDefinitionCertifiable": "false"
}
]
}