/bundle
- Mount Point: /resource/rest/bundle
The following operations are supported on this resource:
Finds a bundle based on the specified bundle UUID, external ID, product UUID or Identifier and returns it as a XML documentrepresenting the bundle. One of the search methods listed above must be specified in order for this method to attempt to find a bundle.
Parameters
name |
description |
type |
default |
uuid |
An optional parameter to specify the UUID of the bundle to find. |
query |
|
externalId |
An optional parameter of the external ID of the bundle to find. |
query |
|
productUuid |
An optional parameter to specify the product UUID of the product containing the bundle to find. |
query |
|
productExternalId |
An optional parameter to specify the product external ID of the product containing the bundle to find. |
query |
|
identifierName |
An optional parameter to specify the name of the identifier. This refers to the value specified in the OCM_TYPE.NAMEfield. |
query |
|
identifierField |
A field to search in the identifier type. This parameter must be specified if searching for a bundle based on anIdentifier. This field value must match an identifier field being searched based on this module's schema. The idenfier field must also be a direct field of the identifier class beingsearched. No fields of an identifier's parent class can be used for searching. |
query |
|
identifierValue |
A value the Identifier Entity contains for a match. This parameter must be specified if searching for abundle based on an Identifier. |
query |
|
xsltId |
An optional parameter to specify the id of XSLT template. If specified, the XSLT code from the template will be applied tobundle XML document. |
query |
|
includePhysicalAsset |
A boolean parameter that is default to true. If it is set to true, the physicalasset XML will be injected into the bundle XML. If it is set to false, the release URL of physical asset will beinjected into the bundle XML. |
query |
|
Output Payload
element |
produceable content type(s) |
(custom) |
|
description |
An XML document containing the found Bundle conforming to this module's schema or a document that has been transformed by the XSTL applied to the bundleXML. If XSLT has been applied to the bundle XML, the resulting document may not match the module's schema. |
Exceptions
name |
description |
RESTWebserviceException |
If the not way to find the bundle is specified is empty, if the service to retrieve the bundle is notinitialized, or if the bundle cannot be found using the search criteria provided. The XML error message conforms to the REST web services error schema |