S3. Bundle Schedule API
Here’s a quick summary of what the XDOC API offers for Bundle Scheduling:
Key Methods
-
Container.BundleSchedule- Creates a new Bundle Package for a given container and Bundle Profile.
- Starts the Bundle Workflow (Generate + Deliver).
- Returns a PackageId for tracking.
- Status can be monitored via:
- API:
Container.BundleStatus - UI: Bundle Manager & Workflow Monitor.
- API:
- Important: Cannot be used with Bundle Profiles having delivery type =
download. - For detailed info on parameters and sample XML response please see BundleSchedule on the HTTP Server Services Method Listing page.
-
Container.BundleStatus- Checks status for a given PackageId.
- Possible statuses:
processing– still bundlingsuccess– generated & deliverederror– failure during generation/deliverycancelled– stopped via UIpaused– paused via UI
-
Container.BundleStatusBatch- Similar to
BundleStatusbut for BatchName or BatchNbr. - Forr detailed info on parameters and sample XML response please see BundleStatus on the HTTP Server Services Method Listing page.
- Similar to
-
Project.BundleProfileList- Lists available Bundle Profiles for a given ProjectId.
- For detailed info on parameters and sample XML response please see BundleProfileList on the HTTP Server Services Method Listing page.
Notes
- These methods are available only in XDOC build 6111 or higher.
- For parameters & sample XML responses, refer to the HTTP Server Services Method Listing page.