Verify アプリケーション・プログラミング・インターフェース (API)

Verify アプリケーション・プログラミング・インターフェース(API)にアクセスし、社内アプリケーションの開発に活用することができます。

IBM® Verify ドキュメントハブサポート 詳細については、APIドキュメントを参照してください。

IBM 研修 「 IBM 」トレーニングでAPIに関する動画 Verify をご覧ください。

HTTP メソッド

各 API リソースは、指定された Uniform Resource Identifier (URI) によって識別され、以下の標準 HTTP メソッドを使用してアクセスされます。 HTTP メソッドは、オブジェクトへの意図したアクションを示します。
表 1. HTTP 手法
HTTP メソッド 説明
GET 指定された URL でリソースまたは関係を取得します。
  • リソース URL に対するリクエスト(<resource-noun>)は、検索およびページングの制約に従って、すべてのインスタンスを取得します(検索のセクションを参照)。
  • リソースIDレベルでのリクエスト(<resource-noun>/<resource-id>)は、個別のリソースを返します。
  • リレーションシップ名レベルでのクエリ (<relationship>) は、検索およびページングの制約に従って、すべてのリレーションシップインスタンスを取得します。
  • デフォルトの応答状況コードは 200 です。
  • 照会パラメーター ("count" に最大値 1000 を指定するなど) を追加すると、結果のページ編集をカスタマイズできます。
  • リレーションシップIDレベルでのリクエスト (<relationship>/<relationship-id>) は、個々のリレーションシップインスタンスを返します。
POST 指定された URL でリソースまたは関係を作成します。
  • リソース URL に対するリクエスト(<resource-noun>)により、そのリソースが作成されます。
  • リレーションシップIDレベルでのリクエスト(<relationship>)により、新しいリレーションシップが作成されます。
  • 一括ロード作成に使用できます。
PUT 指定された URL でリソースまたは関係を更新します。
  • リソース URL に対するリクエスト(<resource-noun>)は、そのリソースを更新します。
  • リレーションシップIDレベルでのリクエスト (<relationship>) は、新しいリレーションシップを更新します。 一部の関係は変更できないため、場合によっては、不正な要求とみなされることがあります。
  • 読み取り専用情報 (リソース ID や関係 ID など) を変更する要求は、不正な要求とみなされます。
PATCH

リソースの部分的更新に使用されます。

  • リソースタイプ ` URL ` レベルでのリクエスト(<resource-noun> 指定されたリソースに対して、リクエストで指定されたプロパティの変更分のみを更新します)。
  • PATCH のコンテンツ・タイプは application/json-patch+json です。
  • メイン ID (一次キーにマップされる固有の ID またはプロパティー) を使用して削除操作が指定された場合、オブジェクト全体が削除されます。
DELETE 指定された URL でリソースまたは関係を削除します。
注: 一括削除を行う場合は、PATCH を使用してください。