You can use the REST API to get bundle details and manage bundles in your organization.
You can perform the following tasks using the REST API:
•Get bundle details and push a published private bundle to sub-organizations
•Get license information about bundles installed on or available to the organization
•Install and uninstall bundles
Bundle details
Use this resource to request the details for a specific bundle or the details for all bundles published by the organization or installed by the organization. You can also push a published private bundle to sub-organizations.
GET Request
To request the details of a particular bundle, you can include the bundle ID or the bundle name in the URI. Use one of the following URIs:
/api/v2/bundleObject/<id>
/api/v2/bundleObject/name/<name>
If you use the bundle name in the URI and the bundle name includes a space, replace the space with %20. For example:
/api/v2/bundleObject/name/first%20bundle
To request the details for all bundles published by the organization, use one of the following URIs:
When you request the details for a bundle, returns the bundleObject for the bundle.
When you request a list of published bundles, returns a bundleObject for each bundle that the organization published.
When you request a list of installed bundles, returns a bundleObject for each bundle that the organization installed.
Returns the error object if errors occurred.
The bundleObject includes the following attributes:
Field
Type
Description
id
String
Bundle ID.
orgId
String
Organization ID.
name
String
Bundle name.
description
String
Description.
createTime
Date/time
Time the bundle was created.
updateTime
Date/time
Time the bundle was updated.
createdBy
String
User who created the bundle.
updatedBy
String
User who last updated the bundle.
lastVersion
String
The current published version of the bundle.
revokeTime
Date/time
This attribute is not used at this time.
paid
Boolean
Whether the bundle was purchased. Returns true for paid, false for free.
copyable
Boolean
Determines whether users can download the contents of the bundle locally. Returns true or false.
accessType
String
Access type for the bundle. Returns the following codes in the BundleObjectAccessType object:
- PUBLIC. Available to all Informatica Intelligent Cloud Services organizations.
- SUBORGS. Available to sub-organizations of the publishing organization.
- ACCESS_LIST. Available to the organization IDs in the sharedWith attribute.
objects
Objects in the bundle. Includes information for each object in the bundleRefObject object.
objectTypeCode
String
Included in the bundleRefObject object.
The type of bundle. Includes the following values:
- 17. Mapping.
- 0L. Mapplet.
objectId
String
Included in the bundleRefObject object.
Object identified in the bundle.
objectName
String
Included in the bundleRefObject object.
Name of the object in the bundle.
objectUpdateTime
String
Included in the bundleRefObject object.
The date and time that the object in the bundle was last updated.
publishOrgId
String
ID of the organization that published the bundle.
publishOrgName
String
Name of the organization that published the bundle.
externalId
String
External ID for the bundle.
POST Request
As part of a parent organization, you can share a private bundle with sub-organizations.
You can push a published private bundle to install the bundle on all sub-organizations. Push a published private bundle when you want the objects in the bundle to be immediately available to all sub-organizations.
To push a bundle to a sub-organization, use the ID of the bundle object in the following URI:
/api/v2/bundleObject/push/<bundleId>
POST Response
Returns the success response if the request is successful. Returns the error object if errors occur.
Bundle licenses
Use this resource to request license information about bundles installed on or available to the organization.
GET Request
To request license information for a bundle associated with to the organization, use the bundle ID in the following URI:
/api/v2/bundleObjectLicense/<bundleObjectId>
To request license information for all bundles associated with the organization, omit the optional bundle ID.
GET Response
If successful, returns the BundleObjectLicenseType for the requested bundle.
If you request license information for all bundles, returns the bundleObjectLicense object for all bundles associated with the organization.
Returns the error object if errors occur.
The bundleObjectLicense object includes the following attributes:
Field
Type
Description
bundleObjectId
String
Bundle ID.
orgId
String
Organization ID.
updateOption
String
This attribute is not used at this time.
licenseType
String
Bundle type. Returns one of the following values:
- Free
- Trial
- Subscription
endDate
Date/time
Date the license expires. Returns NULL for free public bundles.
numberOfDaysToApply
Int
Not used at this time.
numberOfMonthsToApply
Int
Not used at this time.
beginDate
Date/time
Publish date for the bundle.
bundleVersion
String
Version number for the bundle.
createTime
Date/time
Creation date for the bundle.
installed
Boolean
Indicates if the organization installed the bundle. Returns TRUE for installed bundles and FALSE for available bundles.
active
Boolean
Indicates that the bundle is available and active. Returns TRUE.
accessCode
String
Required to install a licensed bundle. Used for sharing private bundles. Read only.
Installing and uninstalling bundles
Use this resource to install and uninstall bundles.
POST Request
To install a bundle on the organization, use the following URI:
/api/v2/bundleObjectLicense
With this URI, use the following attribute in a bundleObjectLicense object:
Field
Type
Required
Description
bundleObjectId
String
Yes
The ID of the bundle.
POST Response
Returns the success response if the request is successful. Returns the error object if errors occur.
DELETE Request
To uninstall a bundle from the organization, use the following URI: