Jump to

• Request
• Response
• Examples

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: string
  Unique Catalog Id for Catalog item

Query Parameters

• fields(optional): 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"

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful

Headers

• ResponseTime: string
  Captures the time in milliseconds taken for processing the request.

Body ()

Root Schema : GetCatalogByCatalogIdResponse

Type: object

Show Source

• approverRoleDisplayName(optional): string
• approverUserDisplayName(optional): string
• approverUserLogin(optional): string
• auditObjectives(optional): string
• category(optional): string
• certifierRoleDisplayName(optional): string
• certifierUserDisplayName(optional): string
• certifierUserLogin(optional): string
• entityDescription(optional): string
• entityDisplayName(optional): string
• entityKey(optional): string
• entityName(optional): string
• entityType(optional): string
• fulFillMentRoleDisplayName(optional): string
• fulFillMentUserDisplayName(optional): string
• fulFillMentUserLogin(optional): string
• id(optional): integer
• isAuditable(optional): string
• isCertifiable(optional): string
• itemRisk(optional): string
• links(optional): array links
• tags(optional): string
• updateDate(optional): string
• userDefinedTags(optional): string

{
    "properties":{
        "id":{
            "type":"integer"
        },
        "entityType":{
            "type":"string"
        },
        "entityKey":{
            "type":"string"
        },
        "entityName":{
            "type":"string"
        },
        "entityDisplayName":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "entityDescription":{
            "type":"string"
        },
        "auditObjectives":{
            "type":"string"
        },
        "approverRoleDisplayName":{
            "type":"string"
        },
        "approverUserDisplayName":{
            "type":"string"
        },
        "approverUserLogin":{
            "type":"string"
        },
        "certifierUserDisplayName":{
            "type":"string"
        },
        "certifierUserLogin":{
            "type":"string"
        },
        "certifierRoleDisplayName":{
            "type":"string"
        },
        "fulFillMentRoleDisplayName":{
            "type":"string"
        },
        "fulFillMentUserDisplayName":{
            "type":"string"
        },
        "fulFillMentUserLogin":{
            "type":"string"
        },
        "itemRisk":{
            "type":"string"
        },
        "tags":{
            "type":"string"
        },
        "updateDate":{
            "type":"string"
        },
        "userDefinedTags":{
            "type":"string"
        },
        "isCertifiable":{
            "type":"string"
        },
        "isAuditable":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

Nested Schema : LinkDataInstances

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Default Response

Unexpected error

Back to Top

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"
}

Back to Top