API Guide for Cisco MXE 3500 Release 3.2 and 3.3

JobPackage XML

---

Revised: November 19, 2012

This chapter provides an overview of the jobPackage XML and includes the following sections:

• jobPackage XML Overview
• jobPackage Tags

jobPackage XML Overview

jobPackage XML allows for plan XML in various formats to be bundled with parameter XML so the two can be submitted as a single XML document. This is helpful in the REST API, which only allows for a single input XML document.

The jobPackage also allows a single job translation or submission to submit multiple jobs. Although the jobs run independently, they are submitted in one request sharing a common set of parameter XML.

jobPackage specifications may be nested as jobs within the jobPackage. This feature means transforms and customer planners can take advantage of the jobPackage capability to introduce new parameter XML for additional transforms and planners. Parameter XML within a jobPackage incrementally changes previous parameter XML as the job packages are nested.

Each sub-node of the jobList is treated as a separate job and undergoes the normal transformation process. Jobs listed in the jobList may use different plan XML formats. To be submitted, all of the jobs in the list must get translated into either job XML or jobPackage XML. If the job tag of the job XML or jobPackage has a name attribute, that name is returned with the jobSubmitStatus returned by the Submit request.

There is an attribute named canSubmit that is added to the jobPackage node once the document has all of its job list translated into jobs. This allows for the creation of XSL transforms and planners that can manipulate the jobPackage prior to it being submitted. Adding canSubmit='true' to a jobPackage disables the translation of the jobList.

jobPackage Tags

Example 6-1 jobPackage XML