submitjob submitjob

將工作提交至系統。

語法

授權的使用者型別 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已省略,所以會傳送電子郵件通知給送出工作的使用者。 此範例工作會立即執行,因為省略了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>

附註 section-0f3078e503a249aeb6f3d662a51f036a

您最多可以指定execTimeexecSchedule其中之一。 如果兩者皆未傳遞,工作就會立即執行。 您只能使用下列其中一項:

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