Oracle Identity Governance Self ServiceのREST API

プロビジョニング・タスクの更新

put

/iam/governance/selfservice/api/v1/provtasks/{taskid}

タスクIDに基づいてプロビジョニング・タスクを更新します。

リクエスト

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

application/json

パス・パラメータ

taskid: string

タスクID

プロビジョニング・タスクの入力

ルート・スキーマ: ProvisioningTaskRequestInstance

型: object

ソースを表示

fields(optional): array fields
requestId(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        }
    }
}

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

型: 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

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

ルート・スキーマ: ProvisioningTaskResponseInstance

型: object

ソースを表示

assignee(optional): string
id(optional): string
links(optional): array links
status(optional): string

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

ネストされたスキーマ: 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を使用してRESTリソースにPUTリクエストを発行して、プロビジョニング・タスクを更新する方法を示しています。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。cURLの詳細は、「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/provtasks/3009

PUTリクエスト本文の例

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

{
	"action": "reassign",
	"fields":
	[
		{
			"name": "assignee",
			"value": "23"
		},
		{
			"name": "type",
			"value": "user"
		}
	]
}

PUTレスポンス本文の例

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

{
    "links": [
        {
            "rel": "self",
            "href": "https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/3009"
        }
    ],
    "id": "3009",
    "status": "SUCCESS"
}

指定のプロビジョニング・タスクのノートの更新方法を示す例

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行して、IDで指定されたプロビジョニング・タスクのノートを更新する方法を示しています。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。

 curl -X PUT --verbose -k -1  -H "Content-Type: application/json" -H "X-Requested-By: provtask"  -u username:password  -d '{
       "action": "setNote",  
       "fields" : [
           {
                "name": "Process Instance.Task Details.Note",
                "value": "Updated value of Note-NB"
           }
        ]
  }'https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/6

PUTリクエスト本文の例

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

{
    "action": "setNote",  
       "fields" : [
           {
                "name": "Process Instance.Task Details.Note",
                "value": "Updated value of Note-NB"
           }
        ]
}

PUTレスポンス本文の例

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

{
    "links": [
        {
            "rel": "self",
            "href": "https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/6"
        }
    ],
    "id": "6",
    "status": "SUCCESS"
}

指定のプロビジョニング・タスクのレスポンスの更新方法を示す例

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行して、IDで指定されたプロビジョニング・タスクのレスポンスを更新する方法を示しています。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。

 curl -X PUT --verbose -k -1  -H "Content-Type: application/json" -H "X-Requested-By: provtask"  -u username:password  -d '{
       "action": "setResponse",  
       "fields" : [
           {
                "name": "Process Definition.Tasks.Responses.Response",     
				"value": "VALIDATION_FAILED"
           }
         ]
  }'https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/6

PUTリクエスト本文の例

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

{
     "action": "setResponse",  
       "fields" : [
           {
                "name": "Process Definition.Tasks.Responses.Response",     
				"value": "VALIDATION_FAILED"
           }
         ]
}

PUTレスポンス本文の例

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

{
    "links": [
        {
            "rel": "self",
            "href": "https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/6"
        }
    ],
    "id": "6",
    "status": "SUCCESS"
}

指定のプロビジョニング・タスクの再割当て方法を示す例

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行して、IDで指定されたプロビジョニング・タスクを再割り当てする方法を示しています。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。

 curl -X PUT --verbose -k -1  -H "Content-Type: application/json" -H "X-Requested-By: provtask"  -u username:password  -d '{
       "action": "reassign", 
       "fields" : [
         {
           "name": "type",
           "value": "user"
         },
         {
           "name": "assignee",
           "value": "1001"
         }
        ]
  }'https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/6

PUTリクエスト本文の例

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

{
     "action": "reassign", 
       "fields" : [
         {
           "name": "type",
           "value": "user"
         },
         {
           "name": "assignee",
           "value": "1"
         }
        ]
}

PUTレスポンス本文の例

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

{
    "links": [
        {
            "rel": "self",
            "href": "https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/6"
        },
        {
            "rel": "assignee",
            "href": "https://pseudo.com/iam/governance/selfservice/api/v1//users/1"
        }
    ],
    "id": "6",
    "status": "SUCCESS"
}

指定のプロビジョニング・タスクの再試行方法を示す例

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行して、IDで指定されたプロビジョニング・タスクを再試行する方法を示しています。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。

curl -X PUT --verbose -k -1  -H "Content-Type: application/json" -H "X-Requested-By: provtask"  -u username:password  -d '{
       "action": "retry"
  }'https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/6

PUTリクエスト本文の例

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

{
     "action": "retry"
}

PUTレスポンス本文の例

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

{
    "links": [
        {
            "rel": "self",
            "href": "https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/6"
        }
    ],
    "id": "6",
    "status": "SUCCESS"
}

先頭に戻る