REST Resources

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

The following operation is supported on this resource:

  • GET - Get job's progress
GET /jobs/{id}/progress-update Version 1

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

Sample Usage

GET /jobs/{id}/progress-update


  • Parameters:
    Name Type URI Type Description Required
    id int Path The job ID for the job for which progress update information will be retrieved. Y
  • 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"
         }
      }
    }

    • Access Control

    The following capabilities are required to access this API: DefaultRead