submitJob
Submits a job to the system.
Syntax
Authorized User Types
IpsUser
IpsAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser
Parameters
Input (submitJobParam)
Handle to the user who submitted the job.
Note: The system sends email to the user specified by userHandle. If userHandle is not provided, the person who submitted the job receives the emails.
The locale used for job log details and email localization.
Locales are specified as <language_code> and [<country_code>], where the language code is a lower-case, two- letter code as specified by ISO-639, and the optional country code is an upper-case, two-letter code as specified by ISO-3166. For example, the locale string for English (United States) would be: en-US.
Date and time to run the job.
Note: Provide the time zone with the request. Time zones are adjusted to the time zone of the target IPS server.
Determines when to run the job.
Can be a cron string that runs the job on a recurring basis.
The schedule is always relative to the server’s local time zone. See the IPS documentation for the custom schedule format.
Process an asset list into sets using Automated Set Scripts.
Output (submitJobReturn)
xsd:string
Examples
This code sample submits an image serving publish job to IPS and returns a job handle. Choose only one type of job in the request. Because userHandle
was omitted, email notifications are sent to the user who submitted the job. This sample job runs immediately because execTime
and execSchedule
were omitted.
Request
<submitJobParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>47</companyHandle>
<jobName>My Test Job</jobName>
<imageServingPublishJob>
<publishType>Full</publishType>
<emailSetting>Error</emailSetting>
</imageServingPublishJob>
</submitJobParam>
Response
<submitJobReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<jobHandle>47|My Test Job|</jobHandle>
</submitJobReturn>
Notes
You can specify at most one of execTime
and execSchedule
. If neither is passed, the job runs immediately. You can use only one of the following:
imageServingPublishJob
imageRenderingPublishJob
videoPublishJob
serverDirectoryPublishJob
uploadDirectoryJob
uploadUrlsJob