submitJob submitjob

Unterbreitet einen Vorgang an das System.

Syntax

Autorisierte Benutzertypen section-eb7024277bec43c79e03f396205be16f

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

Parameter section-31a07dbccf964850883e817384499459

Eingabe (submitJobParam)

Name
Typ
Erforderlich
Beschreibung
companyHandle
xsd:string
Ja
Firmengriff.
userHandle
xsd:string
Nein

Handle an den Benutzer, der den Auftrag gesendet hat.

Hinweis: Das System sendet E-Mails an den Benutzer, der von userHandle angegeben wird. Wenn userHandle nicht angegeben wird, erhält die Person, die den Auftrag eingereicht hat, die E-Mails.

jobName
xsd:string
Ja
Vorgangsname.
Gebietsschema
xsd:string
Nein

Das Gebietsschema, das für Auftragsprotokolldetails und E-Mail-Lokalisierung verwendet wird.

Gebietsschemata werden als <language_code> und [<country_code>] angegeben, wobei der Sprach-Code ein Code mit zwei Kleinbuchstaben gemäß ISO-639 ist und der optionale Länder-Code ein Code mit zwei Großbuchstaben gemäß ISO-3166 ist. Die Gebietsschema-Zeichenfolge für Englisch (Vereinigte Staaten) wäre beispielsweise: en-US.

execTime
xsd:dateTime
Nein

Datum und Uhrzeit der Ausführung des Auftrags.

Hinweis: Geben Sie bei der Anfrage die Zeitzone an. Die Zeitzonen werden an die Zeitzone des Ziel-IPS-Servers angepasst.

execSchedule
xsd:string
Nein

Legt fest, wann der Auftrag ausgeführt wird.

Kann eine Cron-Zeichenfolge sein, 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 .

Beschreibung
xsd:string
Nein
Auftragsbeschreibung.
exportJob
:ExportJob
Nein

Exportieren Sie zuvor hochgeladene Dateien.

Siehe Exportvorgang.

imageServingPublishJob
:ImageServingPublishJob
Nein
Details für einen Image-Serving-Veröffentlichungsauftrag.
imageRenderingPublishJob
:ImageRenderingPublishJob
Nein
Details für einen Veröffentlichungsauftrag zum Rendern von Bildern.
videoPublishJob
:VideoPublishJob
Nein

Details für einen Videoveröffentlichungsauftrag.

Siehe VideoPublishJob.

serverDirectoryPublishJob
:ServerDirectoryPublishJob
Nein
Details für einen Veröffentlichungsauftrag für ein Serververzeichnis.
uploadDirectoryJob
:UploadDirectoryJob
Nein
Details für einen Upload-Verzeichnisauftrag.
uploadUrlsJob
:UploadUrlsJob
Nein
Details für einen URL-Upload-Auftrag.
optimizeImagesJob
:OptimizeImagesJob
Nein
ripPdfsJob
:RipPdfsJob
Nein
reprocessAssetsJob
:ReprocessAssetsJob
Nein
automatedSetGenerationJob
:AutomatedSetGenerationJob
Nein

Verarbeiten Sie eine Asset-Liste mithilfe automatisierter Set-Skripte in Sets.

Siehe AutomatedSetGenerationJob.

Ausgabe (submitJobReturn)

Name
Typ
Erforderlich
Beschreibung
jobHandle
xsd:string
Ja
Auftragsverarbeitung.

Beispiele section-40ac77d14adf4588ba2575be6879b2d2

Dieses Codebeispiel übermittelt einen Image Serving-Veröffentlichungsauftrag an IPS und gibt ein Auftrags-Handle zurück. Wählen Sie in der Anfrage nur einen Vorgangstyp aus. Da userHandle weggelassen wurde, werden E-Mail-Benachrichtigungen an den Benutzer gesendet, der den Auftrag gesendet hat. Dieser Beispielvorgang wird sofort ausgeführt, da execTime und execSchedule weggelassen wurden.

Anfrage

<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>

Anmerkungen section-0f3078e503a249aeb6f3d662a51f036a

Sie können höchstens eine der Optionen execTime und execSchedule angeben. Wenn keiner der Werte übergeben wird, wird der Auftrag sofort ausgeführt. Sie können nur eine der folgenden Optionen verwenden:

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