Show Menu
TOPICS×

executeJob

Runs a specific job.
Syntax

Authorized User Types

  • IpsUser
  • IpsAdmin
  • TrialSiteAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser

Parameters

Input (executeJobParam)
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 run.
Output (executeJobReturn)
The IPS API does not return a response for this operation.

Examples

This code sample runs a job that is scheduled to run in IPS.
Request
<executeJobParam xmlns="http://www.scene7.com/IpsApi/xsd">
   <companyHandle>47</companyHandle>
   <jobHandle>47|My Test Job|</jobHandle>
</executeJobParam>

Response
None.