REST APIリファレンス

前へ次へ

bundleObjectLicense

このリソースを使用して、組織にインストールされたバンドルまたは組織で使用できるバンドルに関するライセンス情報を要求します。また、バンドルをインストールおよびアンインストールすることもできます。

組織に関連付けられたバンドルのライセンス情報を要求するには、次のURIにバンドルIDを使用します。

/api/v2/bundleObjectLicense/<bundleObjectId>

組織に関連付けられたすべてのバンドルのライセンス情報を要求するには、オプションのバンドルIDを省略します。

成功すると、要求されたバンドルのBundleObjectLicenseTypeが返されます。

すべてのバンドルのライセンス情報を要求すると、組織に関連付けられたすべてのバンドルのbundleObjectLicenseオブジェクトが返されます。

エラーが発生した場合にエラーオブジェクトを返します。

bundleObjectLicenseオブジェクトには次の属性が含まれます。

フィールド	タイプ	説明
bundleObjectId	String	バンドルのID。
orgId	String	組織ID。
updateOption	String	この属性は現在使用されていません。
licenseType	String	バンドルのタイプ。次のいずれかの値を返します。 Free トライアルサブスクリプション
endDate	Date/Time	ライセンスの有効期限日。無料の公開バンドルにはNULLを返します。
numberOfDaysToApply	Int	現在使用されていません。
numberOfMonthsToApply	Int	現在使用されていません。
beginDate	Date/Time	バンドルの公開日時。
bundleVersion	String	バンドルのバージョン番号。
createTime	Date/Time	バンドルの作成日時。
installed	Boolean	組織がバンドルをインストールしたかどうかを示します。インストール済みのバンドルにはTRUEを、使用可能なバンドルにはFALSEを返します。
active	Boolean	バンドルが使用可能かつアクティブであることを示します。TRUEを返します。
accessCode	String	ライセンス発行済みのバンドルをインストールする必要があります。非公開バンドルを共有する場合に使用されます。読み取り専用です。

組織でバンドルをインストールするには、次のURIを使用します。

/api/v2/bundleObjectLicense

このURIでは、bundleObjectLicenseオブジェクトの次の属性を使用します。

フィールド	タイプ	必須	説明
bundleObjectId	String	○	バンドルのID。

要求に成功した場合に成功の応答を返します。エラーが発生した場合にエラーオブジェクトを返します。

組織からバンドルをアンインストールするには、次のURIを使用します。

/api/v2/bundleObjectLicense?bundleObjectId=<bundleId>&updateOption=<updateOption>

次のbundleObjectLicense Delete URI属性を使用します。

フィールド	タイプ	必須	説明
bundleObjectId	String	○	バンドルのID。
updateOption	String		バンドル内のオブジェクトが使用されるとどうなるかを定義します。次のいずれかのオプションを使用します。 DELETE_EXISTING_OBJECTS。バンドルオブジェクトを使用するオブジェクトを削除します。 UPDATE_EXISTING_OBJECTS。バンドルオブジェクトを使用するオブジェクトを更新します。 EXCEPTION_IF_IS_USED。バンドルオブジェクトが使用され、アンインストールをキャンセルする場合にメッセージを返します。