DokumentationDynamic Media Image Production System API

submitJob submitjob

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Ämnen:

Skapat för:

  • Utvecklare
  • Administratör

Skickar ett jobb till systemet.

Syntax

Auktoriserade användartyper section-eb7024277bec43c79e03f396205be16f

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

Parametrar section-31a07dbccf964850883e817384499459

Indata (submitJobParam)

Namn
Typ
Obligatoriskt
Beskrivning
companyHandle
xsd:string
Ja
Företagshandtag.
userHandle
xsd:string
Nej

Hantera till användaren som skickade jobbet.

Obs! Systemet skickar e-post till användaren som anges av userHandle. Om userHandle inte anges får personen som skickade jobbet e-postmeddelandena.

jobName
xsd:string
Ja
Jobbnamn.
locale
xsd:string
Nej

Språkinställningen som används för jobbloggsinformation och e-postlokalisering.

Språk anges som <språkkod> och [<landskod>], där språkkoden är en gemen, tvåbokstavskod enligt ISO-639, och den valfria landskoden är en versal, tvåbokstavskod enligt ISO-3166. Den nationella strängen för engelska (USA) skulle till exempel vara: en-US.

execTime
xsd:dateTime
Nej

Datum och tid då jobbet ska köras.

Obs! Ange tidszonen med begäran. Tidszoner justeras till tidzonen för mål-IPS-servern.

execSchedule
xsd:string
Nej

Anger när jobbet ska köras.

Kan vara en cron-sträng som kör jobbet med återkommande intervall.

Schemat är alltid relativt serverns lokala tidszon. I IPS-dokumentationen finns information om det anpassade schemaformatet.

description
xsd:string
Nej
Jobbbeskrivning.
exportJob
typer:ExportJob
Nej

Exportera tidigare överförda filer.

Se ExportJob.

imageServingPublishJob
typer:ImageServingPublishJob
Nej
Information om en bild som visar publiceringsjobb.
imageRenderingPublishJob
typer:ImageRenderingPublishJob
Nej
Information om ett publiceringsjobb för bildåtergivning.
videoPublishJob
typer:VideoPublishJob
Nej

Information om ett videopubliceringsjobb.

Se VideoPublishJob.

serverDirectoryPublishJob
typer:ServerDirectoryPublishJob
Nej
Information om ett serverkatalogpubliceringsjobb.
uploadDirectoryJob
typer:UploadDirectoryJob
Nej
Information om ett uppladdningskatalogjobb.
uploadUrlsJob
typer:UploadUrlsJob
Nej
Information om ett URL-överföringsjobb.
optimizeImagesJob
typer:OptimizeImagesJob
Nej
ripPdfsJob
typer:RipPdfsJob
Nej
reprocessAssetsJob
typer:ReprocessAssetsJob
Nej
automatiseradSetGenerationJob
typer:AutomatedSetGenerationJob
Nej

Bearbeta en resurslista i uppsättningar med hjälp av automatiska uppsättningsskript.

Se AutomatedSetGenerationJob.

Utdata (submitJobReturn)

Namn
Typ
Obligatoriskt
Beskrivning
jobHandle
xsd:string
Ja
Jobbreferens.

Exempel section-40ac77d14adf4588ba2575be6879b2d2

Det här kodexemplet skickar en bild som visar publiceringsjobb till IPS och returnerar en jobbreferens. Välj bara en typ av jobb i förfrågan. Eftersom userHandle utelämnades skickas e-postmeddelanden till användaren som skickade jobbet. Det här exempeljobbet körs omedelbart eftersom execTime och execSchedule utelämnades.

Begäran

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

Svar

<submitJobReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <jobHandle>47|My Test Job|</jobHandle>
</submitJobReturn>

Anteckningar section-0f3078e503a249aeb6f3d662a51f036a

Du kan ange högst ett av execTime och execSchedule. Om inget av det godkänns körs jobbet omedelbart. Du kan bara använda något av följande:

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