ジャンプ先

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

特定のタスクに関連付けられた個々の明細項目の更新。

put

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

taskidに関連付けられた明細項目IDで指定された明細項目を更新します。明細項目に対して実行できる更新アクションは、要求、失効、棄権、完了、サインオフ、コメントの編集、ステータスのリセットです。

リクエスト

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

• application/json

パス・パラメータ

• certid: string
  証明ID
• lineitemid: string
  明細項目ID
• taskid: string
  タスクID

本文()

LineItemで実行されるアクション

ルート・スキーマ: SingleLineItemRequestPayLoad

型: object

ソースを表示

• lineItem(optional): object LineItemRequestPayLoad
• lineItemDetails(optional): array lineItemDetails

{
    "properties":{
        "lineItem":{
            "$ref":"#/definitions/LineItemRequestPayLoad"
        },
        "lineItemDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LineItemDetailRequestPayLoad"
            }
        }
    }
}

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

型: object

ソースを表示

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

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

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

型: array

ソースを表示

• [0]: object LineItemDetailRequestPayLoad

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

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

型: array

ソースを表示

• [0]: object PutCertificationsTasksByTaskIdResponseField

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

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

型: object

ソースを表示

• field(optional): string

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

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

型: object

ソースを表示

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

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

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

型: array

ソースを表示

• [0]: object PutCertificationsTasksByTaskIdResponseField

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

成功

ヘッダー

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

本文()

ルート・スキーマ: SingleLineItemResponsePayLoad

型: object

ソースを表示

• lineItem(optional): object LineItemResponsePayLoad
• lineItemDetails(optional): array lineItemDetails
• links(optional): array links
• status(optional): string

{
    "properties":{
        "status":{
            "type":"string"
        },
        "lineItem":{
            "$ref":"#/definitions/LineItemResponsePayLoad"
        },
        "lineItemDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LineItemDetailResponsePayLoad"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

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

型: object

ソースを表示

• action(optional): string
• lineItemId(optional): string
• status(optional): string

{
    "properties":{
        "action":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "lineItemId":{
            "type":"string"
        }
    }
}

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

型: array

ソースを表示

• [0]: object LineItemDetailResponsePayLoad

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

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

型: array

ソースを表示

• [0]: object LinkDataInstances

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

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

型: object

ソースを表示

• action(optional): string
• entityId(optional): string
• entityType(optional): string
• status(optional): string

{
    "properties":{
        "entityId":{
            "type":"string"
        },
        "entityType":{
            "type":"string"
        },
        "action":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

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

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

401レスポンス

未認可

404レスポンス

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

500レスポンス

内部サーバー・エラー

デフォルト・レスポンス

予期しないエラー

先頭に戻る

例

この例では、証明タスクに関連付けられた単一の明細項目を更新する機能を示します。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。

cURLの例

curl  -H "Content-Type: application/json"  -X PUT  -u username:password  -d @put.json https://pseudo.com/iam/governance/selfservice/api/v1/certifications/184/tasks/fefc3f4d-d7d3-4fb9-a9bf-80652cdfdbcd/lineitems/957"

PUTリクエスト本文の例

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

{
  "action": "ResetStatus",
  "fields": [
    {
      "name": "comment",
      "value": "test ResetStatus"
    }
  ]
}

PUTレスポンス本文の例

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

{
  "links": [
    {
      "rel": "self",
      "href": "http://pseudo.com/iam/governance/selfservice/api/v1/certifications/184/tasks/fefc3f4d-d7d3-4fb9-a9bf-80652cdfdbcd/lineitems/957"
    }
  ],
  "action": "ResetStatus",
  "status": "success"
}

先頭に戻る