Get Job Plan Web Service

This web service returns a single job plan by its ID, as a typed document: the plan's pipelines come back as XML or JSON structure rather than as the escaped XML string that the planData field of the listJobPlans response carries. Use it to read one plan without retrieving them all.

The plan is returned only if the calling user is entitled to see it, which means the plan is owned by that user, owned by one of their groups, or marked "Public [all users]" - the same plans the Job Plans page shows them. A plan that does not exist and a plan the caller is not entitled to see both return 404 NOT FOUND, so the response cannot be used to discover which IDs exist.

The representation is the same one the single-plan export and the system backup produce. It does not repeat the plan's own ID, since the caller supplies it in the URL, and it omits the pipelines' cron scheduling fields.

A non-numeric ID returns 400 BAD REQUEST.

Example request

GET http://localhost:8090/MidVision/ws/deployment/jobPlan/9 HTTP/1.1
Accept-Encoding: gzip,deflate
Accept: application/xml
Authorization: ********************
Host: localhost:8090
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Example Response

<JobPlan>
   <description>Execution of SCRIPS_DEMO_40 targets.</description>
   <executionPolicy>Individual</executionPolicy>
   <name>ScriptsDemo40</name>
   <securityName>mvadmin</securityName>
   <Pipeline>
      <PipelineStep>
         <OrchestrationJob>
            <projectName>SCRIPT_DEMO_40</projectName>
            <version>SCRIPT_DEMO_40-0.0.1</version>
            <continueOnFailure>false</continueOnFailure>
            <targetName>localhost_win.dev.Blue-Circle</targetName>
            <envType live="false" name="Development"/>
         </OrchestrationJob>
      </PipelineStep>
   </Pipeline>
   <Pipeline>
      <PipelineStep>
         <OrchestrationJob>
            <projectName>SCRIPT_DEMO_40</projectName>
            <version>SCRIPT_DEMO_40-0.0.1</version>
            <continueOnFailure>false</continueOnFailure>
            <targetName>localhost_win.dev.Red-Square</targetName>
            <envType live="false" name="Development"/>
         </OrchestrationJob>
      </PipelineStep>
   </Pipeline>
</JobPlan>

Pass Accept: application/json for the same document as JSON.