Sendet einen Auftrag an das System.
Syntax
IpsUser
IpsAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser
Eingabe (submitJobParam)
Name |
Typ |
Erforderlich |
Beschreibung |
---|---|---|---|
companyHandle | xsd:string | Ja | Handle des Unternehmens. |
userHandle | xsd:string | Nein | Behandeln Sie den Benutzer, der den Auftrag gesendet hat.
Hinweis: Das System sendet eine E-Mail an den von userHandle. Wenn userHandle nicht angegeben ist, erhält die Person, die den Auftrag gesendet hat, die E-Mails. |
jobName | xsd:string | Ja | Auftragsname. |
locale | xsd:string | Nein | Das Gebietsschema, das für Auftragsprotokolldetails und die E-Mail-Lokalisierung verwendet wird. Gebietsschemata werden als <language_code> und [<country_code>], wobei der Sprachcode ein aus zwei Buchstaben bestehender Code in Kleinbuchstaben ist, wie in ISO-639 angegeben, und der optionale Ländercode ein aus Großbuchstaben bestehender Code aus zwei Buchstaben gemäß ISO-3166 ist. Die Gebietsschema-Zeichenfolge für Englisch (USA) lautet beispielsweise: en-US. |
execTime | xsd:dateTime | Nein | Datum und Uhrzeit der Auftragsausführung. Hinweis: Geben Sie die Zeitzone mit der Anforderung an. Die Zeitzonen werden an die Zeitzone des Ziel-IPS-Servers angepasst. |
execSchedule | xsd:string | Nein | Legt fest, wann der Auftrag ausgeführt werden soll. Kann eine cron -Zeichenfolge, die den Auftrag wiederholt ausführt. Der Zeitplan ist immer relativ zur lokalen Zeitzone des Servers. Informationen zum benutzerdefinierten Zeitplanformat finden Sie in der IPS-Dokumentation . |
description | xsd:string | Nein | Auftragsbeschreibung |
exportJob | Typen:ExportJob | Nein | Exportieren Sie zuvor hochgeladene Dateien. Siehe ExportJob. |
imageServingPublishJob | Typen:ImageServingPublishJob | Nein | Details für einen Image Serving-Veröffentlichungsauftrag. |
imageRenderingPublishJob | Typen:ImageRenderingPublishJob | Nein | Details für einen Image Rendering-Veröffentlichungsauftrag. |
videoPublishJob | Typen:VideoPublishJob | Nein | Details für einen Video-Veröffentlichungsauftrag. Siehe VideoPublishJob. |
serverDirectoryPublishJob | Typen:ServerDirectoryPublishJob | Nein | Details für einen Veröffentlichungsauftrag für Serververzeichnisse. |
uploadDirectoryJob | Typen:UploadDirectoryJob | Nein | Details für einen Upload-Ordnerauftrag. |
uploadUrlsJob | Typen:UploadUrlsJob | Nein | Details für einen Upload-URL-Auftrag. |
optimizeImagesJob | Typen:OptimizeImagesJob | Nein |
|
ripPdfsJob | Typen:RipPdfsJob | Nein |
|
reprocessAssetsJob | Typen:ReprocessAssetsJob | Nein |
|
automatedSetGenerationJob | Typen:AutomatedSetGenerationJob | Nein | Verarbeiten Sie eine Asset-Liste mithilfe von automatisierten Set-Skripten in Sets. Siehe AutomatedSetGenerationJob. |
Ausgabe (submitJobReturn)
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
jobHandle | xsd:string |
Ja | Auftragshandle. |
Dieses Codebeispiel sendet einen Image Serving-Veröffentlichungsauftrag an IPS und gibt einen Auftrags-Handle zurück. Wählen Sie nur einen Auftragstyp in der Anforderung aus. weil userHandle
ausgelassen wurde, werden E-Mail-Benachrichtigungen an den Benutzer gesendet, der den Auftrag gesendet hat. Dieser Beispielauftrag wird sofort ausgeführt, weil execTime
und execSchedule
wurden weggelassen.
Anforderung
<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>
Antwort
<submitJobReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<jobHandle>47|My Test Job|</jobHandle>
</submitJobReturn>
Sie können höchstens eines der folgenden execTime
und execSchedule
. Wenn keines von beiden übergeben wird, wird der Auftrag sofort ausgeführt. Sie können nur eine der folgenden Optionen verwenden:
imageServingPublishJob
imageRenderingPublishJob
videoPublishJob
serverDirectoryPublishJob
uploadDirectoryJob
uploadUrlsJob