submitJob

ジョブをシステムに送信します。

構文

許可されたユーザーの種類

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

パラメータ

入力(submitJobParam)

名前

種類

必須

説明

companyHandle xsd:string はい

会社の担当。

userHandle xsd:string いいえ

ジョブを送信したユーザーに対する処理。

注意:システムは、 userHandleで指定されたユーザーに電子メールを送信します。 userHandleを指定しない場合、ジョブを送信した人が電子メールを受け取ります。

jobName xsd:string はい

ジョブ名.

locale xsd:string いいえ

ジョブログの詳細と電子メールのローカライゼーションに使用されるロケール。

ロケールは <language_code>および [<country_code>]と指定します。ここで、言語コードはISO-639で指定された小文字2文字のコードで、オプションの国コードはISO-3166で指定された大文字2文字のコードです。 例えば、英語(米国)のロケール文字列は次のようになります。en-US.

execTime xsd:dateTime いいえ

ジョブを実行する日時。

注意: リクエストのタイムゾーンを指定します。 タイムゾーンは、ターゲットIPSサーバーのタイムゾーンに合わせて調整されます。

execSchedule xsd:string いいえ

ジョブを実行するタイミングを決定します。

繰り返しジョブを実行する cron文字列を指定できます。

スケジュールは、常にサーバーのローカルタイムゾーンに対して相対的に指定します。 カスタムスケジュール形式については、 IPSのドキュメントを参照してください。

説明 xsd:string いいえ

ジョブの説明。

exportJob タイプ:ExportJob[たいぷ:ExportJob] いいえ

以前にアップロードしたファイルを書き出す。

ExportJobを参照してください。

imageServingPublishJob 型:ImageServingPublishJob[がた:ImageServingPublishJob] いいえ

画像サービング公開ジョブの詳細。

imageRenderingPublishJob タイプ:ImageRenderingPublishJob いいえ

画像レンダリング公開ジョブの詳細。

videoPublishJob タイプ:VideoPublishJob いいえ

ビデオ公開ジョブの詳細。

VideoPublishJobを参照してください。

serverDirectoryPublishJob タイプ:ServerDirectoryPublishJob いいえ

サーバーディレクトリの公開ジョブの詳細。

uploadDirectoryJob タイプ:UploadDirectoryJob いいえ

アップロードディレクトリジョブの詳細。

uploadUrlsJob 型:UploadUrlsJob[がた:UploadUrlsJob] いいえ

アップロードURLジョブの詳細。

optimizeImagesJob タイプ:OptimizeImagesJob[たいぷ:OptimizeImagesJob] いいえ

ripPdfsJob タイプ:RipPdfsJob[たいぷ:RipPdfsJob] いいえ

reprocessAssetsJob タイプ:ReprocessAssetsJob[たいぷ:ReprocessAssetsJob] いいえ

automatedSetGenerationJob 型:AutomatedSetGenerationJob[がた:AutomatedSetGenerationJob] いいえ

自動セットスクリプトを使用して、アセットリストをセットに処理します。

AutomatedSetGenerationJobを参照してください。

出力(submitJobReturn)

名前 種類 必須 説明
*jobHandle* xsd:string はい ジョブハンドル。

このコードサンプルは、画像サービングの公開ジョブをIPSに送信し、ジョブハンドルを返します。 リクエストでは、1つのタイプのジョブのみを選択します。 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のうち、最大1つを指定できます。 どちらも渡されない場合、ジョブは直ちに実行されます。 次のいずれか1つのみを使用できます。

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

このページ