リソースの作成および更新
リソースは、POST または PUT HTTP 要求のいずれかを使用して作成されます。
apmdevops98jp
リソースは、POST または PUT HTTP 要求のいずれかを使用して作成されます。
- クライアントが生成されるリソースの ID を指定する必要がない場合、POST が使用されます。 API は、ID を作成し、クライアントに返します。
- PUT は、ID がクライアントにとって既知である場合に使用されます。
PUT または PATCH のいずれかを使用して、リソースを更新できます。
- PUT には提供されるエンティティの完全な表現が必要ですが、オプションのフィールドは省略できます。その場合、リソース サーバは既存の値を保持します。 Content-Type フィールドは、表現のインターネット メディア タイプを定義します。
- PATCH は、「パッチ」を既存のリソースに適用する要求としてリソース サーバによって解釈されます。 要求本文には、変更に必要なすべての情報を含める必要があります。
注:
一部のリソースが読み取り専用である場合に、すべてのリソースがこれらのメソッドをサポートするわけではありません。 安全でない要求(作成、更新、削除)を使用する前に、特定の API のドキュメントを参照してください。HTTP メソッド チート シート
以下の表は、どの HTTP 動詞をリソースの作成、更新(または削除)に使用するか決定するのに役立ちます。
アクション | HTTP メソッド | URL | 要求本文 |
ID を指定せずに新しいリソースを作成する | POST | コレクション URL を使用します。 例: http://host:port/apm/acc/agents | ペイロード内のリソースのすべての NULL 以外のプロパティが含まれます。 プロパティの省略は、許可された場合は値がデフォルトに設定され、プロパティがデフォルト値を持たない場合はエラーになります。 |
特定 ID で新しいリソースを作成する | PUT | URL に正確な ID を指定します。 例: http://host:port/apm/acc/agents/14 (ID 14 のエージェントを作成する場合)。 | ペイロード内のリソースのすべての NULL 以外のプロパティが含まれます。 プロパティの省略は、許可された場合は値がデフォルトに設定され、プロパティがデフォルト値を持たない場合はエラーになります。 |
新しいリソースでリソースを更新する(完全更新) | PUT | URL に正確な ID を指定します。 例: http://host:port/apm/acc/agents/14 (ID 14 のエージェントを作成する場合)。 | ペイロード内のリソースのすべての NULL 以外のプロパティが含まれます。 プロパティの省略は、許可された場合は値がデフォルトに設定され、プロパティがデフォルト値を持たない場合はエラーになります。 |
リソースを部分的に更新する | PATCH | URL に正確な ID を指定します。 例: http://host:port/apm/acc/agents/14 (ID 14 のエージェントを作成する場合)。 | 更新するプロパティのみが含まれます。 プロパティの省略は、サーバがリソースの現在の値を使用していることを意味します。 |
リソースを削除する | DELETE | URL に正確な ID を指定します。 例: http://host:port/apm/acc/agents/14 (ID 14 のエージェントを削除する場合)。 | 該当なし |
例
POST、PUT または PATCH メソッドの使用例については、特定の API 実装のドキュメントを参照してください。