submitJob submitjob

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

構文

許可されているユーザータイプ section-eb7024277bec43c79e03f396205be16f

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

パラメーター section-31a07dbccf964850883e817384499459

入力(submitJobParam)

名前
種類
必須
説明
companyHandle
xsd:string
はい
会社ハンドル。
userHandle
xsd:string
いいえ

ジョブを送信したユーザーへのハンドル。

メモ:userHandle で指定したユーザーにメールが送信 れます。 userHandle 指定されていない場合、ジョブを送信したユーザーがメールを受け取ります。

jobName
xsd:string
はい
ジョブ名。
locale
xsd:string
いいえ

ジョブ ログの詳細および E メール ローカリゼーションに使用されるロケールです。

ロケールは <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
タイプ:ImageServingPublishJob
いいえ
画像サービング公開ジョブの詳細。
imageRenderingPublishJob
タイプ:ImageRenderingPublishJob
いいえ
画像レンダリング公開ジョブの詳細。
videoPublishJob
タイプ:VideoPublishJob
いいえ

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

VideoPublishJob 参照してください。

serverDirectoryPublishJob
の種類:ServerDirectoryPublishJob
いいえ
サーバーディレクトリ公開ジョブの詳細。
uploadDirectoryJob
タイプ:UploadDirectoryJob
いいえ
ディレクトリのアップロードジョブの詳細。
uploadUrlsJob
タイプ:UploadUrlsJob
いいえ
アップロード URL ジョブの詳細。
optimizeImagesJob
タイプ:OptimizeImagesJob
いいえ
ripPdfsJob
の種類:RipPdfsJob
いいえ
reprocessAssetsJob
タイプ:ReprocessAssetsJob
いいえ
automatedSetGenerationJob
の種類:AutomatedSetGenerationJob
いいえ

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

AutomatedSetGenerationJob 参照してください。

出力(submitJobReturn)

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

section-40ac77d14adf4588ba2575be6879b2d2

このコードサンプルでは、公開ジョブを提供する画像を 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>

説明 section-0f3078e503a249aeb6f3d662a51f036a

指定できる値は、execTimeexecSchedule のいずれか 1 つだけです。 どちらも渡されない場合、ジョブは直ちに実行されます。 次のうちいずれか 1 つのみを使用できます。

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