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
はい
ジョブ名:
ロケール
xsd:string
いいえ

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

ロケールは <language_code>および [<country_code>]で指定されます。言語コードは小文字の2文字コードで、オプションの国コードは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
いいえ

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

の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つを指定できます。 どちらも渡されない場合、ジョブは直ちに実行されます。 次のいずれかを使用できます。

  • imageServingPublishJob
  • imageRenderingPublishJob
  • videoPublishJob
  • serverDirectoryPublishJob
  • uploadDirectoryJob
  • uploadUrlsJob
recommendation-more-help
dynamic-media-developer-resources-help-aem-ips-api