作成 API の呼び出し

作成 API には、POST HTTP 要求を使用してアクセスします。作成 API は、データベースに新規のリソース項目を挿入します。

REST 作成要求は、指定されるリソースの Name に応じて、以下のタイプの API を使用します。

manageName (および Operation=Create)
manageNameHierarchy (および Operation=Create)
createName
createNameHierarchy

例えば、オーダーの作成要求は createOrder を使用し、組織の作成要求は manageOrganizationHierarchy を使用します。リソースと API の完全なリストを表示するには、REST Javadoc ファイルを参照してください。

要求の形式

作成 API を呼び出すには、次の HTTP 要求の形式を使用します。

POST https://host:port/contextRoot/restapi/Name

Name は、作成するリソースのタイプです。

次の例では、オーダーについての作成要求を示します。

POST https://host:port/contextRoot/restapi/order

作成または変更

「manage」API を使用して、単一の作成または変更の要求で、既存のリソースならばそれを更新し、まだ存在しないリソースならばそれを作成することができます。 REST を使用して作成または変更するには、 PATCH をリソース・コレクションの 名前 に送信し、リソースを記述する文書を要求本体に渡します。

PATCH https://host:port/contextRoot/restapi/Name

作成または変更の機能は、「manage」API を使用するリソース・タイプとのみ互換性があります。例えば、アイテムは manageItem を使用し、組織は manageOrganizationHierarchy を使用するので、PATCH を使用してアイテムと組織の作成または変更を行うことができます。リソース・タイプが「manage」API を使用するかどうかを知るには、Javadoc ファイルを参照してください。