ジャンプ先

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

証明タスクの更新。

put

/iam/governance/selfservice/api/v1/certifications/{certid}/tasks/{taskid}

タスクIDで指定された証明タスクを更新します。タスクに対して実行できる更新は、タスクの再割当て、タスクの完了、タスクの失効、タスクのプロキシの作成およびタスクのリセットです。

リクエスト

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

• application/json

パス・パラメータ

• certid: string
  証明ID
• taskid: string
  タスクID

本文()

ルート・スキーマ: PutCertificationsTasksByTaskIdRequest

型: object

ソースを表示

• action(optional): string
• fields(optional): array fields

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

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

型: array

ソースを表示

• 配列: オブジェクト PutCertificationsTasksByTaskIdRequestField

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

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

型: object

ソースを表示

• field(optional): string

{
    "properties":{
        "field":{
            "type":"string"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

成功

ヘッダー

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

本文()

ルート・スキーマ: PutCertificationsTasksByTaskIdResponse

型: object

ソースを表示

• action(optional): string
• fields(optional): array fields
• id(optional): string
• links(optional): array links
• status(optional): string

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

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

型: array

ソースを表示

• 配列: オブジェクト PutCertificationsTasksByTaskIdResponseField

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

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

型: array

ソースを表示

• 配列: オブジェクト LinkDataInstances

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

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

型: object

ソースを表示

• field(optional): string

{
    "properties":{
        "field":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

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

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

401レスポンス

未認可

404レスポンス

リクエスト・エンティティが見つからない

500レスポンス

内部サーバー・エラー

先頭に戻る

例

次の例では、証明タスクを更新します。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。

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/certifications/21/tasks/e1d5e5dd-5f9e-4747
-bd5f-e00dc0b99d58

PUTリクエスト本文の例

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

{
   "action" : "suspend"
}

レスポンス本文の例

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

{
    "links": [
        {
            "rel": "self",
            "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/certifications/21/tasks/e
1d5e5dd-5f9e-4747-bd5f-e00dc0b99d58/"
        }
    ],
    "id": "e1d5e5dd-5f9e-4747-bd5f-e00dc0b99d58",
    "action": "suspend",
    "status": "SUCCESS",
    "fields": [
        {
            "name": "state",
            "value": "SUSPENDED"
        },
        {
            "name": "assignees",
            "value": [
                "Ajay Arora"
            ]
        }
    ]
}

先頭に戻る