REST Resources
/api/space/job-management/jobs/{id}
The following operations are supported on this resource:
GET /jobs/{id} | Version 3 |
Get a single job.
Sample Usage
GET /jobs/{id}
- Parameters:
Name Type URI Type Description Required job-instance-id Integer Path Job Instance ID Y
- Accept Headers:
application/vnd.net.juniper.space.job-management.job+xml;version=3
application/vnd.net.juniper.space.job-management.job+json;version=3
<job href="/api/space/job-management/jobs/{id}" uri="/api/space/job-management/jobs/{id}">
<id>Integer</id>
<name>String</name>
<percent-complete>Double</percent-complete>
<mo-state>String</mo-state>
<job-state>SCHEDULED</job-state>
<job-status>UNDETERMINED</job-status>
<job-type>String</job-type>
<job-params-summary><![CDATA[String]]></job-params-summary>
<job-parameter-data><![CDATA[String]]></job-parameter-data>
<summary><![CDATA[String]]></summary>
<scheduled-start-time>String</scheduled-start-time>
<start-time>String</start-time>
<end-time>String</end-time>
<owner>String</owner>
<repeat-cron>String</repeat-cron>
<schedule-string>String</schedule-string>
<retry-group-id>Integer</retry-group-id>
<retry-group href="/api/space/job-management/jobs/{id}" uri="/api/space/job-management/jobs/{id}">
<id>Integer</id>
<name>String</name>
</retry-group>
<previous-retry-id>Integer</previous-retry-id>
<previous-retry href="/api/space/job-management/jobs/{id}" uri="/api/space/job-management/jobs/{id}">
<id>Integer</id>
<name>String</name>
</previous-retry>
<detail-link>
<name>String</name>
</detail-link>
<retry-supported>Boolean</retry-supported>
<retry-job-link>
<content-type>String</content-type>
</retry-job-link>
<supports-recurrence>Boolean</supports-recurrence>
<domain-id>Integer</domain-id>
<domain-name>String</domain-name>
<domain href="/api/space/domain-management/domains/{domainId}"/>
<cancel href="/api/space/job-management/jobs/{id}/cancel"/>
<progress-update href="/api/space/job-management/jobs/{id}/progress-update"/>
<reschedule-job href="/api/space/job-management/jobs/{id}/reschedule-job"/>
</job>
{
"job" : {
"@href" : "/api/space/job-management/jobs/{id}" ,
"@uri" : "/api/space/job-management/jobs/{id}" ,
"id" : "Integer" ,
"name" : "String" ,
"percent-complete" : "Double" ,
"mo-state" : "String" ,
"job-state" : "SCHEDULED" ,
"job-status" : "UNDETERMINED" ,
"job-type" : "String" ,
"job-params-summary" : "String" ,
"job-parameter-data" : "String" ,
"summary" : "String" ,
"scheduled-start-time" : "String" ,
"start-time" : "String" ,
"end-time" : "String" ,
"owner" : "String" ,
"repeat-cron" : "String" ,
"schedule-string" : "String" ,
"retry-group-id" : "Integer" ,
"retry-group" : {
"@href" : "/api/space/job-management/jobs/{id}" ,
"@uri" : "/api/space/job-management/jobs/{id}" ,
"id" : "Integer" ,
"name" : "String"
} ,
"previous-retry-id" : "Integer" ,
"previous-retry" : {
"@href" : "/api/space/job-management/jobs/{id}" ,
"@uri" : "/api/space/job-management/jobs/{id}" ,
"id" : "Integer" ,
"name" : "String"
} ,
"detail-link" : {
"name" : "String"
} ,
"retry-supported" : "Boolean" ,
"retry-job-link" : {
"content-type" : "String"
} ,
"supports-recurrence" : "Boolean" ,
"domain-id" : "Integer" ,
"domain-name" : "String" ,
"domain" : {
"@href" : "/api/space/domain-management/domains/{domainId}"
} ,
"cancel" : {
"@href" : "/api/space/job-management/jobs/{id}/cancel"
} ,
"progress-update" : {
"@href" : "/api/space/job-management/jobs/{id}/progress-update"
} ,
"reschedule-job" : {
"@href" : "/api/space/job-management/jobs/{id}/reschedule-job"
}
}
}
Access Control
The following capabilities are required to access this API: DefaultRead
Data Notification
This API supports data notification.
For the deprecated versions of this API, refer to :
version 1
PUT /jobs/{id} | Version 3 |
Change owner field for a job.
Sample Usage
PUT /jobs/{id}
- Parameters:
Name Type URI Type Description Required id Integer Path ID Y
- Content-Type Headers:
application/vnd.net.juniper.space.job-management.job+xml;version=3;charset=UTF-8
application/vnd.net.juniper.space.job-management.job+json;version=3;charset=UTF-8 - Accept Headers:
application/vnd.net.juniper.space.job-management.job+xml;version=3
application/vnd.net.juniper.space.job-management.job+json;version=3
<job>
<mo-state>String</mo-state>
<owner>String</owner>
</job>
<job href="/api/space/job-management/jobs/{id}" uri="/api/space/job-management/jobs/{id}">
<id>Integer</id>
<name>String</name>
<percent-complete>Double</percent-complete>
<mo-state>String</mo-state>
<job-state>SCHEDULED</job-state>
<job-status>UNDETERMINED</job-status>
<job-type>String</job-type>
<job-params-summary><![CDATA[String]]></job-params-summary>
<job-parameter-data><![CDATA[String]]></job-parameter-data>
<summary><![CDATA[String]]></summary>
<scheduled-start-time>String</scheduled-start-time>
<start-time>String</start-time>
<end-time>String</end-time>
<owner>String</owner>
<repeat-cron>String</repeat-cron>
<schedule-string>String</schedule-string>
<retry-group-id>Integer</retry-group-id>
<retry-group href="/api/space/job-management/jobs/{id}" uri="/api/space/job-management/jobs/{id}">
<id>Integer</id>
<name>String</name>
</retry-group>
<previous-retry-id>Integer</previous-retry-id>
<previous-retry href="/api/space/job-management/jobs/{id}" uri="/api/space/job-management/jobs/{id}">
<id>Integer</id>
<name>String</name>
</previous-retry>
<detail-link>
<name>String</name>
</detail-link>
<retry-supported>Boolean</retry-supported>
<retry-job-link>
<content-type>String</content-type>
</retry-job-link>
<supports-recurrence>Boolean</supports-recurrence>
<domain-id>Integer</domain-id>
<domain-name>String</domain-name>
</job>
{
"job" : {
"mo-state" : "String" ,
"owner" : "String"
}
}
{
"job" : {
"@href" : "/api/space/job-management/jobs/{id}" ,
"@uri" : "/api/space/job-management/jobs/{id}" ,
"id" : "Integer" ,
"name" : "String" ,
"percent-complete" : "Double" ,
"mo-state" : "String" ,
"job-state" : "SCHEDULED" ,
"job-status" : "UNDETERMINED" ,
"job-type" : "String" ,
"job-params-summary" : "String" ,
"job-parameter-data" : "String" ,
"summary" : "String" ,
"scheduled-start-time" : "String" ,
"start-time" : "String" ,
"end-time" : "String" ,
"owner" : "String" ,
"repeat-cron" : "String" ,
"schedule-string" : "String" ,
"retry-group-id" : "Integer" ,
"retry-group" : {
"@href" : "/api/space/job-management/jobs/{id}" ,
"@uri" : "/api/space/job-management/jobs/{id}" ,
"id" : "Integer" ,
"name" : "String"
} ,
"previous-retry-id" : "Integer" ,
"previous-retry" : {
"@href" : "/api/space/job-management/jobs/{id}" ,
"@uri" : "/api/space/job-management/jobs/{id}" ,
"id" : "Integer" ,
"name" : "String"
} ,
"detail-link" : {
"name" : "String"
} ,
"retry-supported" : "Boolean" ,
"retry-job-link" : {
"content-type" : "String"
} ,
"supports-recurrence" : "Boolean" ,
"domain-id" : "Integer" ,
"domain-name" : "String"
}
}
Access Control
The following capabilities are required to access this API: ReassignJob
PATCH /jobs/{id} | Version 3 |
Change owner field for a job.
Sample Usage
PATCH /jobs/{id}
- Parameters:
Name Type URI Type Description Required id Integer Path ID Y
- Content-Type Headers:
application/vnd.net.juniper.space.job-management.job_patch+xml;version=3;charset=UTF-8 - Accept Headers:
application/vnd.net.juniper.space.job-management.job+xml;version=3
application/vnd.net.juniper.space.job-management.job+json;version=3
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<diff>
<!--What you see below are just samples of patch operations that may be performed on this DTO.-->
<!--For more information about patch document format please look at http://http://www.rfc-editor.org/rfc/rfc5261.txt-->
<replace sel="job/mo-state">
<mo-state>String</mo-state>
</replace>
<replace sel="job/owner">
<owner>String</owner>
</replace>
</diff>
<job href="/api/space/job-management/jobs/{id}" uri="/api/space/job-management/jobs/{id}">
<id>Integer</id>
<name>String</name>
<percent-complete>Double</percent-complete>
<mo-state>String</mo-state>
<job-state>SCHEDULED</job-state>
<job-status>UNDETERMINED</job-status>
<job-type>String</job-type>
<job-params-summary><![CDATA[String]]></job-params-summary>
<job-parameter-data><![CDATA[String]]></job-parameter-data>
<summary><![CDATA[String]]></summary>
<scheduled-start-time>String</scheduled-start-time>
<start-time>String</start-time>
<end-time>String</end-time>
<owner>String</owner>
<repeat-cron>String</repeat-cron>
<schedule-string>String</schedule-string>
<retry-group-id>Integer</retry-group-id>
<retry-group href="/api/space/job-management/jobs/{id}" uri="/api/space/job-management/jobs/{id}">
<id>Integer</id>
<name>String</name>
</retry-group>
<previous-retry-id>Integer</previous-retry-id>
<previous-retry href="/api/space/job-management/jobs/{id}" uri="/api/space/job-management/jobs/{id}">
<id>Integer</id>
<name>String</name>
</previous-retry>
<detail-link>
<name>String</name>
</detail-link>
<retry-supported>Boolean</retry-supported>
<retry-job-link>
<content-type>String</content-type>
</retry-job-link>
<supports-recurrence>Boolean</supports-recurrence>
<domain-id>Integer</domain-id>
<domain-name>String</domain-name>
<domain href="/api/space/domain-management/domains/{domainId}"/>
<cancel href="/api/space/job-management/jobs/{id}/cancel"/>
<progress-update href="/api/space/job-management/jobs/{id}/progress-update"/>
<reschedule-job href="/api/space/job-management/jobs/{id}/reschedule-job"/>
</job>
{
"job" : {
"@href" : "/api/space/job-management/jobs/{id}" ,
"@uri" : "/api/space/job-management/jobs/{id}" ,
"id" : "Integer" ,
"name" : "String" ,
"percent-complete" : "Double" ,
"mo-state" : "String" ,
"job-state" : "SCHEDULED" ,
"job-status" : "UNDETERMINED" ,
"job-type" : "String" ,
"job-params-summary" : "String" ,
"job-parameter-data" : "String" ,
"summary" : "String" ,
"scheduled-start-time" : "String" ,
"start-time" : "String" ,
"end-time" : "String" ,
"owner" : "String" ,
"repeat-cron" : "String" ,
"schedule-string" : "String" ,
"retry-group-id" : "Integer" ,
"retry-group" : {
"@href" : "/api/space/job-management/jobs/{id}" ,
"@uri" : "/api/space/job-management/jobs/{id}" ,
"id" : "Integer" ,
"name" : "String"
} ,
"previous-retry-id" : "Integer" ,
"previous-retry" : {
"@href" : "/api/space/job-management/jobs/{id}" ,
"@uri" : "/api/space/job-management/jobs/{id}" ,
"id" : "Integer" ,
"name" : "String"
} ,
"detail-link" : {
"name" : "String"
} ,
"retry-supported" : "Boolean" ,
"retry-job-link" : {
"content-type" : "String"
} ,
"supports-recurrence" : "Boolean" ,
"domain-id" : "Integer" ,
"domain-name" : "String" ,
"domain" : {
"@href" : "/api/space/domain-management/domains/{domainId}"
} ,
"cancel" : {
"@href" : "/api/space/job-management/jobs/{id}/cancel"
} ,
"progress-update" : {
"@href" : "/api/space/job-management/jobs/{id}/progress-update"
} ,
"reschedule-job" : {
"@href" : "/api/space/job-management/jobs/{id}/reschedule-job"
}
}
}
Access Control
The following capabilities are required to access this API: DefaultRead
(Deprecated) |
Version 1 |
This API is used to cancel a job specified by job ID. Only root jobs can be cancelled. A job can be cancelled only if it is scheduled to run in the future and has not yet started. Running or completed jobs cannot be canceled.
Sample Usage
DELETE /jobs/{id}
- Parameters:
Name Type URI Type Description Required id int Path The job ID of the job to be cancelled. Y
Access Control
The following capabilities are required to access this API: DefaultRead