submitJob

向系统提交作业。

语法

授权用户类型

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

参数

输入(submitJobParam)

名称

类型

必需

说明

companyHandle xsd:string

公司负责人。

userHandle xsd:string

处理提交作业的用户。

注意:系统会向 userHandle指定的用户发送电子邮件。 如果未提供 userHandle,则提交工作的人员会收到电子邮件。

jobName xsd:string

作业名称.

locale xsd:string

用于作业日志详细信息和电子邮件本地化的区域设置。

区域设置指定为 <languagecode> [<countrycode>],其中语言代码是ISO-639指定的小写字母、双字母代码,而可选国家/地区代码是ISO-3166指定的大写双字母代码。 例如,英语(美国)的区域设置字符串将为:美国。

execTime xsd:dateTime

运行作业的日期和时间。

注意: 为时区提供请求。 时区将调整为目标IPS服务器的时区。

execSchedule xsd:string

确定运行作业的时间。

可以是运行定期作业的 cron字符串。

计划始终与服务器的本地时区相关。 有关自定义计划格式,请参阅IPS文档。

描述 xsd:string

作业描述。

exportJob types:ExportJob

导出以前上传的文件。

请参阅 ExportJob

imageServingPublishJob 类型:ImageServingPublishJob

提供发布作业的图像的详细信息。

imageRenderingPublishJob 类型:ImageRenderingPublishJob

有关图像渲染发布作业的详细信息。

videoPublishJob 类型:VideoPublishJob

视频发布作业的详细信息。

请参阅 VideoPublishJob

serverDirectoryPublishJob 类型:ServerDirectoryPublishJob

服务器目录发布作业的详细信息。

uploadDirectoryJob 类型:UploadDirectoryJob

上载目录作业的详细信息。

uploadUrlsJob 类型:UploadUrlsJob

上传URL作业的详细信息。

optimizeImagesJob 类型:OptimizeImagesJob

ripPdfsJob 类型:RipPdfsJob

reprocessAssetsJob 类型:ReprocessAssetsJob

automatedSetGenerationJob types:AutomatedSetGenerationJob

使用自动设置脚本将资产列表处理为多个集。

请参阅 AutomatedSetGenerationJob

输出(submitJobReturn)

名称 类型 必需 说明
*jobHandle* xsd:string 作业处理。

示例

此代码示例将提供发布作业的图像提交到IPS并返回作业句柄。 请求中只选择一种类型的作业。 由于userHandle被忽略,因此会向提交作业的用户发送电子邮件通知。 此示例作业会立即运行,因为忽略了execTimeexecSchedule

请求

<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>

响应

<submitJobReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <jobHandle>47|My Test Job|</jobHandle>
</submitJobReturn>

说明

您最多可以指定execTimeexecSchedule中的任一值。 如果两者均未传递,则作业会立即运行。 您只能使用以下任一项:

  • imageServingPublishJob
  • imageRenderingPublishJob
  • videoPublishJob
  • serverDirectoryPublishJob
  • uploadDirectoryJob
  • uploadUrlsJob

在此页面上