DokumentationDynamic Media Image Production System-API

submitJob submitjob

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Themen:

Erstellt für:

  • Entwickler
  • Admin

Sendet einen Auftrag an das System.

Syntax

Autorisierte Benutzertypen section-eb7024277bec43c79e03f396205be16f

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

Parameter section-31a07dbccf964850883e817384499459

Input (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 E-Mails an den durch userHandle angegebenen Benutzer. 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 " <Sprachcode>"und " [<Ländercode>]"angegeben, wobei der Sprachcode ein aus zwei Kleinbuchstaben bestehender Code gemäß ISO-639 ist und der optionale Ländercode ein aus zwei Buchstaben bestehender Code in Großbuchstaben ist, wie in ISO-3166 angegeben. 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 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 .

description
xsd:string
Nein
Auftragsbeschreibung
exportJob
types:ExportJob
Nein

Exportieren Sie zuvor hochgeladene Dateien.

Siehe ExportJob.

imageServingPublishJob
types:ImageServingPublishJob
Nein
Details für einen Image Serving-Veröffentlichungsauftrag.
imageRenderingPublishJob
types:ImageRenderingPublishJob
Nein
Details für einen Image Rendering-Veröffentlichungsauftrag.
videoPublishJob
types:VideoPublishJob
Nein

Details für einen Video-Veröffentlichungsauftrag.

Siehe VideoPublishJob.

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

Verarbeiten Sie eine Asset-Liste mithilfe von automatisierten Sets.

Siehe AutomatedSetGenerationJob.

Output (submitJobReturn)

Name
Typ
Erforderlich
Beschreibung
jobHandle
xsd:string
Ja
Auftragshandle.

Beispiele section-40ac77d14adf4588ba2575be6879b2d2

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. Da userHandle weggelassen wurde, werden E-Mail-Benachrichtigungen an den Benutzer gesendet, der den Auftrag gesendet hat. Dieser Beispielauftrag 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 maximal einen von execTime und execSchedule angeben. 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
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681