リクエストIDに基づいたリクエストの取得
get
/iam/governance/selfservice/api/v1/requests/{reqid}
指定されたリクエストIDのリクエストの詳細を返します。返される属性は、fieldsという名前の問合せパラメータの一部として指定できます。たとえば: 特定のリクエスト専用のリクエスト・タイプおよびステータス属性を取得するURIは、/requests/{reqid}?fields=reqType, reqStatusです。属性は、カンマ区切りリストで指定されます。
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
- reqid: string
リクエストID
問合せパラメータ
- fields(optional): string
結果に返される属性。RequestId属性は、戻りリストで必須です。カンマ区切り属性を受け入れます。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
成功
ヘッダー
- ResponseTime: string
リクエストの処理にかかった時間(ミリ秒)を取得します。
ネストされたスキーマ: UserRequest
型:
ソースを表示
object
- childRequests(optional): array childRequests
- id(optional): string
- links(optional): array links
- reqBeneficiaryList(optional): array reqBeneficiaryList
- reqCreatedOn(optional): string
- reqExpireOn(optional): string
- reqJustification(optional): string
- reqModifiedOnDate(optional): string
- reqStatus(optional): string
- reqTargetEntities(optional): array reqTargetEntities
- reqType(optional): string
- requester(optional): object Requester
- requestTaskDetails(optional): array requestTaskDetails
401レスポンス
未認可
404レスポンス
リクエスト・エンティティが見つからない
500レスポンス
内部サーバー・エラー
デフォルト・レスポンス
予期しないエラー
例
この例では、指定されたリクエストのすべての情報を取得します。ここで表示された情報は疑似システムに対するものであり、プロトタイプとして使用します。
cURLの例
curl -H "Content-Type: application/json" -X GET -u username:password https://pseudo.com/iam/governance/selfservice/api/v1/requests/12
GETレスポンス本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
{ "links": [ { "rel": "self", "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/12" } ], "id": "12", "reqStatus": "Request Completed", "requester": { "name": "requesterId", "value": "17", "link": { "rel": "self", "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17" } }, "reqCreatedOn": "2019-03-14T18:35:19Z", "reqExpireOn": "2019-03-14T18:54:57Z", "reqType": "Modify User Profile", "reqBeneficiaryList": [ { "links": [ { "rel": "self", "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17" } ], "id": "17" } ], "reqTargetEntities": [], "reqModifiedOnDate": "2019-03-14T18:54:57Z", "requestTaskDetails": [ { "title": "Default operational level approval for Request ID 12", "history": { "previousApprovers": [ { "stage": "defaultOperationalApproval.approvalTask.assignee", "status": "APPROVE", "approvers": "SYSTEM ADMINISTRATORS", "acquiredBy": "sysadmin", "stageIndex": "3", "updatedDate": "2019-03-14T18:54:56Z" } ], "currentApprovers": [ { "stage": "defaultOperationalApproval.approvalTask.assignee", "status": "COMPLETED", "approvers": "" } ], "futureApprovers": [] } } ], "childRequests": [] }