submitJob

最終更新日： 2022-03-08
  • 作成対象：
  • Developer
    Admin

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

構文

認証済みユーザータイプ

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

パラメータ

入力 (submitJobParam)

名前

種類

必須

説明

companyHandle xsd:string はい

会社の取り扱い。

userHandle xsd:string いいえ

ジョブを送信したユーザーに対するハンドル。

注意：システムは、 userHandle. If 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.

imageServingPublishJob types:ImageServingPublishJob いいえ

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

imageRenderingPublishJob types:ImageRenderingPublishJob いいえ

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

videoPublishJob タイプ：VideoPublishJob いいえ

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

詳しくは、 VideoPublishJob.

serverDirectoryPublishJob types:ServerDirectoryPublishJob いいえ

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

uploadDirectoryJob タイプ：UploadDirectoryJob いいえ

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

uploadUrlsJob タイプ：UploadUrlsJob いいえ

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

optimizeImagesJob types:OptimizeImagesJob いいえ

ripPdfsJob 型：RipPdfsJob いいえ

reprocessAssetsJob タイプ：ReprocessAssetsJob いいえ

automatedSetGenerationJob types:AutomatedSetGenerationJob いいえ

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

詳しくは、 AutomatedSetGenerationJob.

出力 (submitJobReturn)

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

例

このコードサンプルは、画像サービング公開ジョブを IPS に送信し、ジョブハンドルを返します。 リクエストでは 1 つのタイプのジョブのみを選択します。 理由： 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>

説明

最大 1 つの execTime および execSchedule. どちらも渡されない場合、ジョブは直ちに実行されます。 次のいずれかを使用できます。

  • imageServingPublishJob
  • imageRenderingPublishJob
  • videoPublishJob
  • serverDirectoryPublishJob
  • uploadDirectoryJob
  • uploadUrlsJob
前のページ
Next page

このページ