submitJob

向系統提交作業。

語法

授權的使用者類型

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

參數

輸入(submitJobParam)

名稱

類型

必要

說明

companyHandle xsd:string

公司負責人。

userHandle xsd:string

處理提交作業的使用者。

注意:系統會傳送電子郵件給 userHandle所指定的使用者。 如果未提供 userHandle,則提交該作業的人員會收到電子郵件。

jobName xsd:string

工作名稱.

地區設定 xsd:string

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

地區設定指定為 <languagecode> [<countrycode>],其中語言代碼是ISO-639所指定的小寫、雙字母代碼,可選國家代碼是ISO-3166所指定的大寫、雙字母代碼。 例如,英文(美國)的地區字串為:美國。

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

ripPdfsJob 類型:RipPdfJob

reprocessAssetsJob 類型:ReprocessAssetsJob

automatedSetGenerationJob 類型: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

本頁內容