Deletes a current or scheduled job.
Syntax
IpsUser
IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser
Input (deleteJobParam)
Name | Type | Required | Description |
---|---|---|---|
companyHandle | xsd:string |
Yes | The handle to the company to which the job belongs. |
jobHandle | xsd:string |
Yes | The handle to the job to delete. |
Output
The IPS API does not return a response for this operation.
This code sample deletes a job that is running or is scheduled to run in IPS. It requires a job handle, which you must obtain from another operation.
Request
<deleteJobParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>47</companyHandle>
<jobHandle>47|My Test Job|</jobHandle>
</deleteJobParam>
Response
None.