バンドル
REST APIを使用して、バンドルの詳細を取得し、組織内のバンドルを管理できます。
REST APIを使用して次のタスクを実行できます。
- •バンドルの詳細の取得、およびパブリッシュされたプライベートバンドルのサブ組織へのプッシュ
- •組織にインストールされているバンドルまたは組織で使用可能なバンドルに関するライセンス情報の取得
- •バンドルのインストールとアンインストール
バンドルの詳細
このリソースを使用して、特定のバンドルの詳細や、組織によってパブリッシュされたまたはインストールされたすべてのバンドルの詳細を要求します。また、パブリッシュされた非公開バンドルをサブ組織にプッシュすることもできます。
GET要求
特定のバンドルの詳細を要求するには、URIにバンドルIDまたはバンドル名を含めることができます。次のいずれかのURIを使用します。
/api/v2/bundleObject/<id>
/api/v2/bundleObject/name/<name>
URIにバンドル名を使用し、バンドル名にスペースが含まれる場合は、スペースを%20で置き換えます。以下に例を示します。
/api/v2/bundleObject/name/first%20bundle
組織によってパブリッシュされたすべてのバンドルの詳細を要求するには、次のいずれかのURIを使用します。
/api/v2/bundleObject/?published=true
/api/v2/bundleObject/?published=true&installed=false
組織によってインストールされたすべてのバンドルの詳細を要求するには、次のいずれかのURIを使用します。
/api/v2/bundleObject/?installed=true
/api/v2/bundleObject/?published=false&installed=true
GET応答
バンドルの詳細を要求すると、バンドルのbundleObjectを返します。
パブリッシュされたバンドルのリストを要求すると、組織がパブリッシュした各バンドルのbundleObjectを返します。
インストールされたバンドルのリストを要求すると、組織がインストールした各バンドルのbundleObjectを返します。
エラーが発生した場合にエラーオブジェクトを返します。
bundleObjectには次の属性が含まれます。
フィールド | タイプ | 説明 |
|---|
id | String | バンドルのID。 |
orgId | String | 組織ID |
name | String | バンドル名。 |
description | String | 説明。 |
createTime | Date/Time | バンドルが作成された時刻。 |
updateTime | Date/Time | バンドルが更新された時刻。 |
createdBy | String | バンドルを作成したユーザー。 |
updatedBy | String | バンドルを最後に更新したユーザー。 |
lastVersion | String | 現在パブリッシュされているバンドルのバージョン。 |
revokeTime | Date/Time | この属性は現在使用されていません。 |
paid | Boolean | バンドルが購入されたかどうかを示します。有料の場合はtrue、無料の場合はfalseを返します。 |
copyable | Boolean | ユーザーがバンドルのコンテンツをローカルにダウンロードできるかどうかを決定します。trueまたはfalseを返します。 |
accessType | String | バンドルのアクセスタイプ。BundleObjectAccessTypeオブジェクトの次のコードを返します。 - - PUBLICすべてのInformatica Intelligent Cloud Services組織で使用可能。
- - SUBORGS。パブリッシュする組織のサブ組織で使用可能。
- - ACCESS_LIST。sharedWith属性の組織IDに使用可能。
|
objects | | バンドル内のオブジェクト。bundleRefObjectオブジェクト内の各オブジェクトに関する情報が含まれます。 |
objectTypeCode | String | bundleRefObjectオブジェクトに含まれています。 バンドルのタイプ。次の値が含まれます。 |
objectId | String | bundleRefObjectオブジェクトに含まれています。 バンドルで特定されるオブジェクト。 |
objectName | String | bundleRefObjectオブジェクトに含まれています。 バンドルのオブジェクト名。 |
objectUpdateTime | String | bundleRefObjectオブジェクトに含まれています。 バンドル内のオブジェクトの最終更新日時。 |
publishOrgId | String | バンドルをパブリッシュした組織のID。 |
publishOrgName | String | バンドルをパブリッシュした組織の名前。 |
externalId | String | バンドルの外部ID。 |
POST要求
親組織の一部として、サブ組織と非公開バンドルを共有できます。
パブリッシュされた非公開バンドルをプッシュすると、すべてのサブ組織にバンドルがインストールされます。バンドル内のオブジェクトをすべてのサブ組織ですぐに使用できるようにする場合は、パブリッシュされた非公開バンドルをプッシュします。
バンドルをサブ組織にプッシュするには、次のURIにバンドルオブジェクトのIDを使用します。
/api/v2/bundleObject/push/<bundleId>
POST応答
要求に成功した場合に成功の応答を返します。エラーが発生した場合にエラーオブジェクトを返します。
バンドルライセンス
このリソースを使用して、組織にインストールされたバンドルまたは組織で使用できるバンドルに関するライセンス情報を要求します。
GET要求
組織に関連付けられたバンドルのライセンス情報を要求するには、次のURIにバンドルIDを使用します。
/api/v2/bundleObjectLicense/<bundleObjectId>
組織に関連付けられたすべてのバンドルのライセンス情報を要求するには、オプションのバンドルIDを省略します。
GET応答
成功すると、要求されたバンドルのBundleObjectLicenseTypeが返されます。
すべてのバンドルのライセンス情報を要求すると、組織に関連付けられたすべてのバンドルのbundleObjectLicenseオブジェクトが返されます。
エラーが発生した場合にエラーオブジェクトを返します。
bundleObjectLicenseオブジェクトには次の属性が含まれます。
フィールド | タイプ | 説明 |
|---|
bundleObjectId | String | バンドルのID。 |
orgId | String | 組織ID。 |
updateOption | String | この属性は現在使用されていません。 |
licenseType | String | バンドルのタイプ。次のいずれかの値を返します。 |
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 | ライセンス発行済みのバンドルをインストールする必要があります。非公開バンドルを共有する場合に使用されます。読み取り専用です。 |
バンドルのインストールとアンインストール
このリソースを使用して、バンドルをインストールおよびアンインストールします。
POST要求
組織でバンドルをインストールするには、次のURIを使用します。
/api/v2/bundleObjectLicense
このURIでは、bundleObjectLicenseオブジェクトの次の属性を使用します。
フィールド | タイプ | 必須 | 説明 |
|---|
bundleObjectId | String | ○ | バンドルのID。 |
POST応答
要求に成功した場合に成功の応答を返します。エラーが発生した場合にエラーオブジェクトを返します。
DELETE要求
組織からバンドルをアンインストールするには、次の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。バンドルオブジェクトが使用され、アンインストールをキャンセルする場合にメッセージを返します。
|
DELETE応答
要求に成功した場合に成功の応答を返します。エラーが発生した場合にエラーオブジェクトを返します。