Job Management API

/api/space/job-management/jobs (v1)

The following operations are supported on this resource:

GET /api/space/job-management/jobs (v1)


This API retrieves all the jobs based on a passed URI context and supports the paging, filtering, and sorting of data. The API returns the information in a Jobs transfer object.

Note: The use of 'contains' and 'starts-with' operators for filtering on 'state' and 'status' fields is not supported.

.

Access Control

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


Example Usage

GET /api/space/job-management/jobs

Content Types

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


  • Sample Output XML:
    <jobs size="2" uri="/api/space/job-management/jobs">
     <job key="131072" uri="/api/space/job-management/jobs/131072" href="/api/space/job-management/jobs/131072">
      <name>Discover Network Elements-131072</name>
      <state>DONE</state>
      <status>SUCCESS</status>
      <recurring>false</recurring>
      <user>super</user>
     </job>
     <job key="425990" uri="/api/space/job-management/jobs/425990">
      <name>Resync Network Elements-425990</name>
      <state>DONE</state>
      <status>SUCCESS</status>
      <recurring>false</recurring>
      <user>newUser</user>
     </job>
    </jobs>


  • Sample Output JSON:
    {"jobs":
     {"@size":"2","@uri":"/api/space/job-management/jobs",
     "job":
      [{"@key":"131072",
      "@uri":"/api/space/job-management/jobs/131072",
      "@href":"/api/space/job-management/jobs/131072",
      "name":"Discover Network Elements-131072",
      "state":"DONE",
      "status":"SUCCESS",
      "recurring":false,
      "user":"super"},
      {"@key":"425990",
      "@uri":"/api/space/job-management/jobs/425990",
      "name":"Resync Network Elements-425990",
      "state":"DONE",
      "status":"SUCCESS",
      "recurring":false,
      "user":"newUser"}]
    }}



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