リクエストの送信
OAMのパスワード管理REST APIを使用してリクエストを送信する場合は、次のガイドラインを使用します。
URLの構造
次のURL構造を使用してOAMパスワード管理のRESTリソースにアクセスします。
https://<subdomain>.<domain>.com:<port>/<resource-path>
説明:
-
<subdomain.domain>.com:<port>
は、OAMを実行しているホストおよびポートです。 -
<resource-path>
は、リソースを定義する相対パスです。
サポートされているメソッド
次の表にまとめているように、標準HTTPメソッド・リクエストを使用して、OAM Serviceに対して基本的なCRUD操作(作成、読取り、更新、削除)を実行できます。
HTTPメソッド | 説明 |
GET |
1つ以上の完全または部分リソースを取得します。 |
POST |
エンドポイントに応じて、新規リソースを作成するか、検索リクエストを作成します。 |
PUT |
既存の属性を指定した置換属性のセットで置換することでリソースを変更します(置換)。PUTを使用して新規リソースを作成する必要があります。 |
PATCH |
クライアントが指定した変更のセットでリソースを変更します(部分的な更新)。 |
DELETE |
リソースを削除します。 |
OPTIONS |
デフォルトのjerseyサポート。 |
HEAD |
デフォルトのjerseyサポート。 |
メディア・タイプ
OAM Service REST APIでは、次のメディア・タイプがサポートされています。
-
application/json
-
application/xml
サポートされているヘッダー
OAM Service REST APIでは、HTTPリクエストまたはレスポンスのヘッダー・セクションで渡される可能性のある次のヘッダーをサポートしています。
ヘッダー | 説明 | 例 |
Content-Type |
リクエストの本文のメディア・タイプ。POSTおよびPUTリクエストの場合、必須です。 |
Content-Type: application/json |
X-Response-Time |
リクエストの処理に要した時間(ミリ秒)。 |
X-Response-Time: 1000 |
|
レスポンスに使用可能なContent-Type |
|
Authorization |
HTTP認証の認証資格証明 |
|
Origin |
Cross Origin Resource Sharing (CORS)のリクエストの開始 |