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