Job Management API

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

The following operations are supported on this resource:

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


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

Access Control

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


Example Usage

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


Parameters

NameTypeURI TypeDescriptionRequired
idintPathThe job ID for the job whose information will be retrieved. Y

Content Types

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


  • Sample Output XML:
    <job uri="/api/space/job-management/jobs/524363">
       <id>524363</id>
       <name>Delete Script-524363</name>
       <percent>100.0</percent>
       <status>FAILURE</status>
       <jobType>Delete Script</jobType>
       <summary>Total requests: 1<br>Success count : 0<br></summary>
       <scheduledStartTime>Thu, 17 Mar 2011 05:29:00 GMT</scheduledStartTime>
       <user>super</user>
       <recurrence>Every 1 minute Starts: Thu, 17 Mar 2011 04:51:00 GMT Ends by: Thu, 17 Mar 2011 05:29:00 GMT</recurrence>
       <progress-update href="/api/space/job-management/jobs/524363/progress-update"/>
    </job>


  • Sample Output JSON:
    {"job":
       {"@uri":"/api/space/job-management/jobs/524363",
       "id":524363,
       "name":"Delete Script-524363",
       "percent":100,
       "status":"FAILURE",
       "jobType":"Delete Script",
       "summary":"Total requests: 1
    Success count : 0
    ",
       "scheduledStartTime":"Thu, 17 Mar 2011 05:29:00 GMT",
       "user":"super",
       "recurrence":"Every 1 minute Starts: Thu, 17 Mar 2011 04:51:00 GMT Ends by: Thu, 17 Mar 2011 05:29:00 GMT",
       "progress-update":
         {"@href":"/api/space/job-management/jobs/524363/progress-update"}
       }
    }



    For the current version of this API, refer to :
  • version 2