文档Dynamic Media Image Production System API

提交作业 submitjob

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • undefined
  • undefined

将作业提交到系统。

语法

授权用户类型 section-eb7024277bec43c79e03f396205be16f

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

参数 section-31a07dbccf964850883e817384499459

输入(submitJobParam)

名称
类型
必需
说明
companyHandle
xsd：string
是
公司句柄。
用户句柄
xsd：string
否

处理提交作业的用户。

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

作业名称
xsd：string
是
作业名称。
区域设置
xsd：string
否

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

区域设置指定为 <language_code>和 [<country_code>]，其中语言代码是由ISO-639指定的小写形式的双字母代码，而可选的国家/地区代码是由ISO-3166指定的大写形式的双字母代码。 例如，英语（美国）的区域设置字符串将为： en-US。

execTime
xsd：dateTime
否

运行作业的日期和时间。

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

execSchedule
xsd：string
否

确定运行作业的时间。

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

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

描述
xsd：string
否
作业描述。
exportJob
类型：ExportJob
否

导出以前上载的文件。

请参阅 ExportJob。

imageServingPublishJob
类型：ImageServingPublishJob
否
图像服务发布作业的详细信息。
imageRenderingPublishJob
类型：ImageRenderingPublishJob
否
图像渲染发布作业的详细信息。
videoPublishJob
类型：VideoPublishJob
否

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

查看 VideoPublishJob。

serverDirectoryPublishJob
类型：ServerDirectoryPublishJob
否
服务器目录发布作业的详细信息。
uploadDirectoryJob
类型：UploadDirectoryJob
否
上载目录作业的详细信息。
uploadUrlsJob
类型：UploadUrlsJob
否
上载URL作业的详细信息。
optimizeImagesJob
类型：OptimizeImagesJob
否
ripPdf作业
类型：RipPdfJob
否
reprocessAssetsJob
类型：ReprocessAssetsJob
否
automatedSetGenerationJob
类型：AutomatedSetGenerationJob
否

使用自动化集脚本将资产列表处理为集。

查看 AutomatedSetGenerationJob。

输出(submitJobReturn)

名称
类型
必需
说明
jobHandle
xsd:string
是
作业句柄。

示例 section-40ac77d14adf4588ba2575be6879b2d2

此代码示例将图像服务发布作业提交给IPS并返回作业句柄。 在请求中仅选择一种类型的作业。 由于userHandle被忽略，因此会向提交作业的用户发送电子邮件通知。 此示例作业立即运行，因为省略了execTime和execSchedule。

请求

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

说明 section-0f3078e503a249aeb6f3d662a51f036a

您最多可以指定execTime和execSchedule之一。 如果两者均未传递，则作业将立即运行。 您只能使用以下选项之一：

  • imageServingPublishJob
  • imageRenderingPublishJob
  • videoPublishJob
  • serverDirectoryPublishJob
  • uploadDirectoryJob
  • uploadUrlsJob
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681