提交作業

向系統提交作業。

語法

授權用戶類型

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

參數

輸入(submitJobParam)

名稱

類型

必要

說明

公司句柄 xsd:string 是

公司負責。

userHandle xsd：字串 否

向提交作業的用戶處理。

注：系統將電子郵件發送給由 userHandle。 如果 userHandle 未提供，提交該作業的人將收到電子郵件。

作業名稱 xsd：字串 是

工作名稱.

地區設定 xsd：字串 否

用於作業日誌詳細資訊和電子郵件本地化的區域設定。

區域設定指定為 <language_code> 和 [<country_code>]，其中，語言代碼是ISO-639指定的小寫雙字母代碼，可選國家代碼是ISO-3166指定的大寫雙字母代碼。 例如，英語（美國）的區域設定字串為：美國。

執行時間 xsd:dateTime 否

運行作業的日期和時間。

注：向時區提供請求。 將時區調整為目標IPS伺服器的時區。

執行計畫 xsd：字串 否

確定何時運行作業。

可以是 克隆 定期運行作業的字串。

計畫始終與伺服器的本地時區相關。 請參閱IPS文檔瞭解自定義計畫格式。

描述 xsd：字串 否

作業描述。

導出作業 類型：ExportJob 否

導出以前上載的檔案。

請參閱 導出作業。

imageServingPublishJob 類型：ImageServingPublishJob 否

提供發佈作業的映像的詳細資訊。

imageRenderingPublishJob 類型：ImageRenderingPublishJob 否

影像呈現發佈作業的詳細資訊。

videoPublishJob 類型：VideoPublishJob 否

視頻發佈作業的詳細資訊。

請參閱 視頻發佈工作。

伺服器目錄發佈作業 類型：ServerDirectoryPublishJob 否

伺服器目錄發佈作業的詳細資訊。

uploadDirectory作業 類型：UploadDirectoryJob 否

上載目錄作業的詳細資訊。

上載Urls作業 類型：UploadUrlsJob 否

上載URL作業的詳細資訊。

優化ImagesJob 類型：OptimizeImagesJob 否

ripPdf作業 類型：RipPdfsJob 否

reprocessAssetsJob 類型：ReprocessAssetsJob 否

automatedSetGenerationJob 類型：AutomatedSetGenerationJob 否

使用自動設定指令碼將資產清單處理為集。

請參閱 AutomatedSetGenerationJob。

輸出(submitJobReturn)

名稱 類型 必要 說明
作業句柄 xsd:string 是 作業處理。

範例

此代碼示例將提供發佈作業的映像提交到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>

附註

您最多可以指定 execTime 和 execSchedule。 如果兩者都未通過，則作業將立即運行。 您只能使用以下選項之一：

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

本頁內容