submitJob submitjob
ジョブをシステムに送信します。
構文
許可されているユーザータイプ section-eb7024277bec43c79e03f396205be16f
IpsUser
IpsAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser
パラメーター section-31a07dbccf964850883e817384499459
入力(submitJobParam)
ジョブを送信したユーザーへのハンドル。
メモ:userHandle で指定したユーザーにメールが送信 れます。 userHandle 指定されていない場合、ジョブを送信したユーザーがメールを受け取ります。
ジョブ ログの詳細および E メール ローカリゼーションに使用されるロケールです。
ロケールは <language_code> および [<country_code>] として指定します。言語コードは ISO-639 で指定される小文字の 2 文字コードで、オプションの国コードは ISO-3166 で指定される大文字の 2 文字コードです。 例えば、英語(米国)のロケール文字列は en-US になります。
ジョブを実行する日時。
メモ:リクエストのタイムゾーンを指定します。 タイムゾーンは、ターゲット IPS サーバーのタイムゾーンに合わせて調整されます。
ジョブを実行するタイミングを決定します。
ジョブを繰り返し実行する cron 文字列を指定できます。
スケジュールは、常にサーバーのローカルタイムゾーンを基準とした相対スケジュールになります。 カスタムスケジュール形式については、IPS ドキュメントを参照してください。
出力(submitJobReturn)
xsd:string
例 section-40ac77d14adf4588ba2575be6879b2d2
このコードサンプルでは、公開ジョブを提供する画像を 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>
説明 section-0f3078e503a249aeb6f3d662a51f036a
指定できる値は、execTime
と execSchedule
のいずれか 1 つだけです。 どちらも渡されない場合、ジョブは直ちに実行されます。 次のうちいずれか 1 つのみを使用できます。
imageServingPublishJob
imageRenderingPublishJob
videoPublishJob
serverDirectoryPublishJob
uploadDirectoryJob
uploadUrlsJob