カタログIDに基づいたカタログ項目の詳細の取得
get
/iam/governance/selfservice/api/v1/catalog/{catalogid}
カタログIDに基づいてカタログ項目の詳細を返します。レスポンス・ペイロードは、カタログに関連付けられたすべての情報を取得します。証明者、リスク、承認者、ユーザー定義のタグなどの詳細が返されます。
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
- catalogid: string
カタログ項目に一意のカタログID
問合せパラメータ
- fields(optional): string
返される属性は、fields問合せパラメータを指定して制御できます。属性名のカンマ区切りリストは属性問合せパラメータに渡されます。たとえば、カタログ名、タイプ、証明の詳細などを取得するには、URIは"/catalog/{catalogid}?fields=entityType, entityName,isCertifiable"となります
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
成功
ヘッダー
- ResponseTime: string
リクエストの処理にかかった時間(ミリ秒)を取得します。
ルート・スキーマ: GetCatalogByCatalogIdResponse
型:
ソースを表示
object- 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
401レスポンス
未認可
404レスポンス
リクエスト・エンティティが見つからない
500レスポンス
内部サーバー・エラー
デフォルト・レスポンス
予期しないエラー
例
この例では、指定されたカテゴリ・エントリの詳細を取得します。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。
cURLの例
curl -H "Content-Type: application/json" -X GET -u username:password https://pseudo.com/iam/governance/selfservice/api/v1/catalog/2
GETレスポンス本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
{
"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"
}