Job Management API

/api/space/job-management/jobs/{id}/progress-update

The following operations are supported on this resource:

GET /api/space/job-management/jobs/{id}/progress-update (v1)


This API retrieves progress update information about a job specified by job ID. The API returns the information in a ProgressUpdate transfer object.

Access Control

The following capabilities are required to access this API:
"DefaultRead"


Example Usage

GET /api/space/job-management/jobs/{id}/progress-update


Parameters

NameTypeURI TypeDescriptionRequired
idintPathThe job ID for the job for which progress update information will be retrieved. Y

Content Types

  • Produces content types:
    application/vnd.net.juniper.space.job-management.progress-update+xml;version=1;q=0.01
    application/vnd.net.juniper.space.job-management.progress-update+json;version=1;q=0.01


  • Sample Output XML:
    <progress-update xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="parallel-progress">
       <job href="/api/space/job-management/jobs/524363"/>
       <taskId>524363</taskId>
       <jobName>Discover Network Elements-98304</jobName>
       <state>DONE</state>
       <status>FAILURE</status>
       <percentage>100.0</percentage>
       <data><![CDATA[Total requests: 1<br>Success count : 0<br>]]></data>
       <subTask xsi:type="percentage-complete">
         <state>DONE</state>
         <status>SUCCESS</status>
         <percentage>100.0</percentage>
       </subTask>
       <recurrence>
         <startTime>Thu, 17 Mar 2011 04:51:00 GMT</startTime>
         <endTime>Thu, 17 Mar 2011 05:29:00 GMT</endTime>
         <repeatInterval>1</repeatInterval>
         <unit>MINUTES</unit>
       </recurrence>
    </progress-update>


  • Sample Output JSON:
    {"progress-update":
       {"@type":"parallel-progress",
       "job":
         {"@href":"/api/space/job-management/jobs/524363"},
       "taskId":524363,
       "jobName":"Discover Network Elements-98304",
       "state":"DONE",
       "status":"FAILURE",
       "percentage":100,
       "data":"<![CDATA[Total requests: 1<br>Success count : 0<br>]]>",
       "subTask":
         {"@type":"percentage-complete",
         "state":"DONE",
         "status":"SUCCESS",
         "percentage":100},
       "recurrence":
         {"startTime":"Thu, 17 Mar 2011 04:51:00 GMT",
         "endTime":"Thu, 17 Mar 2011 05:29:00 GMT",
         "repeatInterval":1,
         "unit":"MINUTES"
    }}}