Bundle Administration Service
{ urn:soa.com:/uri/products/admin/bundleservice/wsdl/1.0 } BundlesService
API used to manage system bundles.
POSTInstall Bundle
Install a bundle from a specified location.
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
location
query
string
location
form
string
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
Success
installStatus
installStatus {
resolutionReport {
resourceInfo {
nameValuePair {
resourceRequirements {
link {
installed( int )
total( int )
report( resolutionReport )
links( Collection of link )
id( string )
message( string )
status( string )
}
resolutionReport {
addedResources( Collection of resourceInfo )
unsatisfiedRequirements( Collection of resourceRequirements )
optionalResources( Collection of resourceInfo )
links( Collection of link )
id( string )
requiredResources( Collection of resourceInfo )
status( string )
}
resourceInfo {
bundleUrl( string )
presentationName( string )
size( string )
provides( Collection of string )
symbolicName( string )
description( string )
id( string )
version( string )
properties( Collection of nameValuePair )
repositoryUrl( string )
requires( Collection of string )
}
nameValuePair {
name( string )
value( string )
}
resourceRequirements {
requirements( Collection of string )
resource( string )
}
link {
rel( string )
href( string )
title( string )
type( string )
}
GETGet Bundles
Get all bundles that match a given filter.
Parameters
Name
Type
Description
Model
filter
query
The filter to match bundles against. If null, all bundles will be retrieved. The filter will be matched against the bundles manifest.
string
brief
query
Boolean indicating if brief information should be returned for each bundle.
boolean
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
Success
bundleSet
bundleSet {
bundleInfo {
bundleDescriptor {
serviceInfo {
nameValuePair {
exportedBundlePackage {
importedBundlePackage {
link {
bundles( Collection of bundleInfo )
links( Collection of link )
}
bundleInfo {
importingBundles( Collection of bundleDescriptor )
servicesProvided( Collection of serviceInfo )
manifest( Collection of nameValuePair )
startLevel( int )
exportedPackages( Collection of exportedBundlePackage )
lifecycle( string )
servicesInUse( Collection of serviceInfo )
importedPackages( Collection of importedBundlePackage )
symbolicName( string )
location( string )
links( Collection of link )
id( long )
state( string )
lastModified( string )
bundle( boolean )
properties( Collection of nameValuePair )
}
bundleDescriptor {
symbolicName( string )
location( string )
id( long )
}
serviceInfo {
bundleId( long )
bundleName( string )
properties( Collection of nameValuePair )
}
nameValuePair {
name( string )
value( string )
}
exportedBundlePackage {
name( string )
bootDelegated( boolean )
version( string )
}
importedBundlePackage {
name( string )
exportingBundle( bundleDescriptor )
bootDelegated( boolean )
optional( boolean )
version( string )
}
link {
rel( string )
href( string )
title( string )
type( string )
}
POSTInstall Bundle
Install a bundle from a specified location.
Parameters
Accepts application/json
Name
Type
Description
Model
body
entity
bundleSpec
bundleSpec {
password( string )
location( string )
convert( boolean, required )
username( string )
}
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
Success
installStatus
installStatus {
resolutionReport {
resourceInfo {
nameValuePair {
resourceRequirements {
link {
installed( int )
total( int )
report( resolutionReport )
links( Collection of link )
id( string )
message( string )
status( string )
}
resolutionReport {
addedResources( Collection of resourceInfo )
unsatisfiedRequirements( Collection of resourceRequirements )
optionalResources( Collection of resourceInfo )
links( Collection of link )
id( string )
requiredResources( Collection of resourceInfo )
status( string )
}
resourceInfo {
bundleUrl( string )
presentationName( string )
size( string )
provides( Collection of string )
symbolicName( string )
description( string )
id( string )
version( string )
properties( Collection of nameValuePair )
repositoryUrl( string )
requires( Collection of string )
}
nameValuePair {
name( string )
value( string )
}
resourceRequirements {
requirements( Collection of string )
resource( string )
}
link {
rel( string )
href( string )
title( string )
type( string )
}
PUT/{id}Update Bundle
Update a bundle.
Parameters
Accepts application/json application/xml text/xml
Name
Type
Description
Model
id
path
long
body
entity
bundleInfo
bundleInfo {
bundleDescriptor {
serviceInfo {
nameValuePair {
exportedBundlePackage {
importedBundlePackage {
link {
importingBundles( Collection of bundleDescriptor )
servicesProvided( Collection of serviceInfo )
manifest( Collection of nameValuePair )
startLevel( int, required )
exportedPackages( Collection of exportedBundlePackage )
lifecycle( string )
servicesInUse( Collection of serviceInfo )
importedPackages( Collection of importedBundlePackage )
symbolicName( string )
location( string )
links( Collection of link )
id( long, required )
state( string )
lastModified( string )
bundle( boolean, required )
properties( Collection of nameValuePair )
}
bundleDescriptor {
symbolicName( string )
location( string )
id( long, required )
}
serviceInfo {
bundleId( long, required )
bundleName( string )
properties( Collection of nameValuePair )
}
nameValuePair {
name( string )
value( string )
}
exportedBundlePackage {
name( string )
bootDelegated( boolean, required )
version( string )
}
importedBundlePackage {
name( string )
exportingBundle( bundleDescriptor )
bootDelegated( boolean, required )
optional( boolean, required )
version( string )
}
link {
rel( string )
href( string )
title( string )
type( string )
}
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
Success
bundleInfo
bundleInfo {
bundleDescriptor {
serviceInfo {
nameValuePair {
exportedBundlePackage {
importedBundlePackage {
link {
importingBundles( Collection of bundleDescriptor )
servicesProvided( Collection of serviceInfo )
manifest( Collection of nameValuePair )
startLevel( int )
exportedPackages( Collection of exportedBundlePackage )
lifecycle( string )
servicesInUse( Collection of serviceInfo )
importedPackages( Collection of importedBundlePackage )
symbolicName( string )
location( string )
links( Collection of link )
id( long )
state( string )
lastModified( string )
bundle( boolean )
properties( Collection of nameValuePair )
}
bundleDescriptor {
symbolicName( string )
location( string )
id( long )
}
serviceInfo {
bundleId( long )
bundleName( string )
properties( Collection of nameValuePair )
}
nameValuePair {
name( string )
value( string )
}
exportedBundlePackage {
name( string )
bootDelegated( boolean )
version( string )
}
importedBundlePackage {
name( string )
exportingBundle( bundleDescriptor )
bootDelegated( boolean )
optional( boolean )
version( string )
}
link {
rel( string )
href( string )
title( string )
type( string )
}
GET/{id}Get Bundle Information
Get detailed information for a bundle.
Parameters
Name
Type
Description
Model
id
path
long
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
Success
bundleInfo
bundleInfo {
bundleDescriptor {
serviceInfo {
nameValuePair {
exportedBundlePackage {
importedBundlePackage {
link {
importingBundles( Collection of bundleDescriptor )
servicesProvided( Collection of serviceInfo )
manifest( Collection of nameValuePair )
startLevel( int )
exportedPackages( Collection of exportedBundlePackage )
lifecycle( string )
servicesInUse( Collection of serviceInfo )
importedPackages( Collection of importedBundlePackage )
symbolicName( string )
location( string )
links( Collection of link )
id( long )
state( string )
lastModified( string )
bundle( boolean )
properties( Collection of nameValuePair )
}
bundleDescriptor {
symbolicName( string )
location( string )
id( long )
}
serviceInfo {
bundleId( long )
bundleName( string )
properties( Collection of nameValuePair )
}
nameValuePair {
name( string )
value( string )
}
exportedBundlePackage {
name( string )
bootDelegated( boolean )
version( string )
}
importedBundlePackage {
name( string )
exportingBundle( bundleDescriptor )
bootDelegated( boolean )
optional( boolean )
version( string )
}
link {
rel( string )
href( string )
title( string )
type( string )
}
DELETE/{id}Uninstall Bundle
Uninstall a bundle.
Parameters
Name
Type
Description
Model
id
path
long
GET/install/{id}Get Install Information
Get detailed information on an ongoing installation job.
Parameters
Name
Type
Description
Model
id
path
string
Reponse
Produces application/jsonapplication/xmltext/xml
Status Code
Reason
Model
200
Success
installStatus
installStatus {
resolutionReport {
resourceInfo {
nameValuePair {
resourceRequirements {
link {
installed( int )
total( int )
report( resolutionReport )
links( Collection of link )
id( string )
message( string )
status( string )
}
resolutionReport {
addedResources( Collection of resourceInfo )
unsatisfiedRequirements( Collection of resourceRequirements )
optionalResources( Collection of resourceInfo )
links( Collection of link )
id( string )
requiredResources( Collection of resourceInfo )
status( string )
}
resourceInfo {
bundleUrl( string )
presentationName( string )
size( string )
provides( Collection of string )
symbolicName( string )
description( string )
id( string )
version( string )
properties( Collection of nameValuePair )
repositoryUrl( string )
requires( Collection of string )
}
nameValuePair {
name( string )
value( string )
}
resourceRequirements {
requirements( Collection of string )
resource( string )
}
link {
rel( string )
href( string )
title( string )
type( string )
}
POST/{id}/updateUpdate Bundle
Update a bundle.
Parameters
Name
Type
Description
Model
id
path
long
Reponse
Status Code
Reason
Model
200
Success
bundleInfo
bundleInfo {
bundleDescriptor {
serviceInfo {
nameValuePair {
exportedBundlePackage {
importedBundlePackage {
link {
importingBundles( Collection of bundleDescriptor )
servicesProvided( Collection of serviceInfo )
manifest( Collection of nameValuePair )
startLevel( int )
exportedPackages( Collection of exportedBundlePackage )
lifecycle( string )
servicesInUse( Collection of serviceInfo )
importedPackages( Collection of importedBundlePackage )
symbolicName( string )
location( string )
links( Collection of link )
id( long )
state( string )
lastModified( string )
bundle( boolean )
properties( Collection of nameValuePair )
}
bundleDescriptor {
symbolicName( string )
location( string )
id( long )
}
serviceInfo {
bundleId( long )
bundleName( string )
properties( Collection of nameValuePair )
}
nameValuePair {
name( string )
value( string )
}
exportedBundlePackage {
name( string )
bootDelegated( boolean )
version( string )
}
importedBundlePackage {
name( string )
exportingBundle( bundleDescriptor )
bootDelegated( boolean )
optional( boolean )
version( string )
}
link {
rel( string )
href( string )
title( string )
type( string )
}
POST/{id}/startStart Bundle
Start a bundle.
Parameters
Name
Type
Description
Model
id
path
long
Reponse
Status Code
Reason
Model
200
Success
bundleInfo
bundleInfo {
bundleDescriptor {
serviceInfo {
nameValuePair {
exportedBundlePackage {
importedBundlePackage {
link {
importingBundles( Collection of bundleDescriptor )
servicesProvided( Collection of serviceInfo )
manifest( Collection of nameValuePair )
startLevel( int )
exportedPackages( Collection of exportedBundlePackage )
lifecycle( string )
servicesInUse( Collection of serviceInfo )
importedPackages( Collection of importedBundlePackage )
symbolicName( string )
location( string )
links( Collection of link )
id( long )
state( string )
lastModified( string )
bundle( boolean )
properties( Collection of nameValuePair )
}
bundleDescriptor {
symbolicName( string )
location( string )
id( long )
}
serviceInfo {
bundleId( long )
bundleName( string )
properties( Collection of nameValuePair )
}
nameValuePair {
name( string )
value( string )
}
exportedBundlePackage {
name( string )
bootDelegated( boolean )
version( string )
}
importedBundlePackage {
name( string )
exportingBundle( bundleDescriptor )
bootDelegated( boolean )
optional( boolean )
version( string )
}
link {
rel( string )
href( string )
title( string )
type( string )
}
POST/{id}/stopStop Bundle
Stop a bundle.
Parameters
Name
Type
Description
Model
id
path
long
Reponse
Status Code
Reason
Model
200
Success
bundleInfo
bundleInfo {
bundleDescriptor {
serviceInfo {
nameValuePair {
exportedBundlePackage {
importedBundlePackage {
link {
importingBundles( Collection of bundleDescriptor )
servicesProvided( Collection of serviceInfo )
manifest( Collection of nameValuePair )
startLevel( int )
exportedPackages( Collection of exportedBundlePackage )
lifecycle( string )
servicesInUse( Collection of serviceInfo )
importedPackages( Collection of importedBundlePackage )
symbolicName( string )
location( string )
links( Collection of link )
id( long )
state( string )
lastModified( string )
bundle( boolean )
properties( Collection of nameValuePair )
}
bundleDescriptor {
symbolicName( string )
location( string )
id( long )
}
serviceInfo {
bundleId( long )
bundleName( string )
properties( Collection of nameValuePair )
}
nameValuePair {
name( string )
value( string )
}
exportedBundlePackage {
name( string )
bootDelegated( boolean )
version( string )
}
importedBundlePackage {
name( string )
exportingBundle( bundleDescriptor )
bootDelegated( boolean )
optional( boolean )
version( string )
}
link {
rel( string )
href( string )
title( string )
type( string )
}
