ジャンプ先

• リクエスト
• レスポンス
• 例

リクエストの更新

put

/iam/governance/selfservice/api/v1/requests

ペイロードで指定されたリクエストを更新します。各リクエストのリクエストIDは、各リクエストで更新する属性とともにペイロードに指定する必要があります。リクエスト・データを更新したり、リクエスト・ステータスを更新できます。指定されたアクション属性のタイプに基づいて、SOAまたはOIMアクションが実行されます。ここで、アクションとして使用できるのは、APPROVE、RELEASE、RESUME、REASSIGN、REJECT、ESCALATE、SUSPEND、WITHDRAW、CLAIM、SAVE、CREATESUBTASK、SKIPASSIGNMENT、CLOSEです。オプションで各リクエストにTaskIdを指定すると、操作を特定のタスクに対してのみ実行できます。taskIdを指定しない場合、リスト内の最初のタスクがリクエストされた操作に対して選択されます。

リクエスト

サポートされているメディア・タイプ

• application/json

本文()

リクエストを更新するための更新属性のリスト

ルート・スキーマ: BulkReqUpdateRequest

型: object

ソースを表示

• requests(optional): array requests

{
    "properties":{
        "requests":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReqUpdateRequestEntity"
            }
        }
    }
}

ネストされたスキーマ: requests

型: array

ソースを表示

• 配列: オブジェクト ReqUpdateRequestEntity

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

ネストされたスキーマ: ReqUpdateRequestEntity

型: object

ソースを表示

• action(optional): string
• actionComment(optional): string
• assignees(optional): array assignees
• id(optional): string
• reqTargetEntities(optional): array reqTargetEntities
• requestId(optional): string
• taskId(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "action":{
            "type":"string"
        },
        "actionComment":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "taskId":{
            "type":"string"
        },
        "assignees":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PendingApprovalsAssigneeNames"
            }
        },
        "reqTargetEntities":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reqTargetEntityRequestPayload"
            }
        }
    }
}

ネストされたスキーマ: assignees

型: array

ソースを表示

• 配列: オブジェクト PendingApprovalsAssigneeNames

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

ネストされたスキーマ: reqTargetEntities

型: array

ソースを表示

• 配列: オブジェクト reqTargetEntityRequestPayload

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

ネストされたスキーマ: PendingApprovalsAssigneeNames

型: object

ソースを表示

• name(optional): string
• type(optional): string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: reqTargetEntityRequestPayload

型: object

ソースを表示

• appFormData(optional): array appFormData
• catalogId(optional): string
• entityId(optional): string
• entityName(optional): string
• entityType(optional): string
• parentAccountId(optional): integer
• parentAccountName(optional): string

{
    "properties":{
        "entityName":{
            "type":"string"
        },
        "entityId":{
            "type":"string"
        },
        "catalogId":{
            "type":"string"
        },
        "entityType":{
            "type":"string"
        },
        "parentAccountId":{
            "type":"integer"
        },
        "parentAccountName":{
            "type":"string"
        },
        "appFormData":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        }
    }
}

ネストされたスキーマ: appFormData

型: array

ソースを表示

• 配列: オブジェクト Fields

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

ネストされたスキーマ: Fields

型: object

ソースを表示

• name(optional): string
• value(optional): string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

成功

ヘッダー

• ResponseTime: string
  リクエストの処理にかかった時間(ミリ秒)を取得します。

本文()

ルート・スキーマ: BulkReqUpdateResponse

型: object

ソースを表示

• requests(optional): array requests

{
    "properties":{
        "requests":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReqUpdateResponseEntity"
            }
        }
    }
}

ネストされたスキーマ: requests

型: array

ソースを表示

• 配列: オブジェクト ReqUpdateResponseEntity

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

ネストされたスキーマ: ReqUpdateResponseEntity

型: object

ソースを表示

• id(optional): string
• links(optional): array links
• reason(optional): string
• requestId(optional): string
• status(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

ネストされたスキーマ: links

型: array

ソースを表示

• 配列: オブジェクト LinkDataInstances

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

ネストされたスキーマ: LinkDataInstances

型: object

ソースを表示

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

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

401レスポンス

未認可

403レスポンス

禁止

404レスポンス

リソースが見つからない

500レスポンス

内部サーバー・エラー

先頭に戻る

例

この例では、保留中リクエストを承認する機能を示します。

cURLの例

curl  -H "Content-Type: application/json"  -H "X-Requested-By: <anyvalue>"  -X PUT  -u username:password  -d @put.json https://pseudo.com/iam/governance/selfservice/api/v1/requests

PUTリクエスト本文の例

次の例に、JSON形式のリクエスト本文のコンテンツを示します。

{
    "requests": [
        {
            "id": "1003",
            "actionComment": "rest sysadmin approved",
            "action": "approve"
        },
        {
            "id": "23",
            "actionComment": "rest sysadmin reject",
            "action": "reject"
        }
    ]
}

PUTレスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
    "links": [
        {
            "rel": "self",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests"
        }
    ],
    "requests": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/1003"
                }
            ],
            "id": "1003",
            "status": "SUCCESS"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/23"
                }
            ],
            "id": "23",
            "status": "SUCCESS"
        }
    ]
}

先頭に戻る