/api/space/job-management/cancel-jobs

The following operation is supported on this resource:

  • POST - Cancel job api for bulk jobs
POST /cancel-jobs Version 3

Cancel job api for bulk jobs.

Sample Usage

POST /cancel-jobs


  • Sample Input XML:
    <cancel-jobs-request>
         <jobs>
               <job href="/api/space/job-management/jobs/{id}"/>
         </jobs>
    </cancel-jobs-request>

  • Sample Output XML:
    <jobs total="Integer" uri="/api/space/job-management/jobs">
         <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>
               <schedule-string>String</schedule-string>
               <retry-group-id>Integer</retry-group-id>
               <previous-retry-id>Integer</previous-retry-id>
               <retry-supported>Boolean</retry-supported>
               <domain-id>Integer</domain-id>
               <domain-name>String</domain-name>
         </job>
    </jobs>

  • Sample Input JSON:
    {
       "cancel-jobs-request" : {
         "jobs" : {
           "job" : {
             "@href" : "/api/space/job-management/jobs/{id}"
           }
         }
       }
    }

  • Sample Output JSON:
    {
       "jobs" : {
         "@total" : "Integer" ,
         "@uri" : "/api/space/job-management/jobs" ,
         "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" ,
           "schedule-string" : "String" ,
           "retry-group-id" : "Integer" ,
           "previous-retry-id" : "Integer" ,
           "retry-supported" : "Boolean" ,
           "domain-id" : "Integer" ,
           "domain-name" : "String"
         }
       }
    }

  • Access Control

    The following capabilities are required to access this API: CancelAnyJob