S3. Bundle Schedule API

The XDOC API provides three RESTful style service methods for Bundling:

  1. Container.BundleSchedule

    This method creates a new Bundle Package for a specified container and Bundle Profile.

    • The Bundle Workflow is kicked off (Bundle Generate and Bundle Deliver) and a PackageId is returned for the generated package.

    • The Bundle Package info and status is available via the Bundle Manager in the UI.

    • You may use Container.BundleStatus with the generated PackageId for API monitoring of the status. The workflow tasks are are also visible in the UI Workflow Monitor.

    • This method cannot be used with Bundle Profiles that have a delivery type of 'download'.


    For detailed info on parameters and sample XML response please see BundleSchedule on the HTTP Server Services Method Listing page.

  2. Container.BundleStatus

    This method returns a status indicator for a specified PackageId.

    Statuses include:

    • processing - bundling is still in process
    • success - the package was generated and delivered successfully
    • error - failure occured during package generation or delivery
    • cancelled - the bundling process was cancelled in the Bundle Manager UI
    • paused - the bundling process was paused in the Bundle UI


    For detailed info on parameters and sample XML response please see BundleStatus on the HTTP Server Services Method Listing page.

     

  3. Container.BundleStatusBatch

    This method returns a status indicator for a specified BatchName or BatchNbr.

    Statuses are the same as above for Container.BundleStatus.

    For detailed info on parameters and sample XML response please see BundleStatusBatch on the HTTP Server Services Method Listing page.


Note: These methods are only available in XDOC build 6111 or higher