submitJob submitjob

Hiermee wordt een taak naar het systeem verzonden.

Syntaxis

Geautoriseerde gebruikerstypen section-eb7024277bec43c79e03f396205be16f

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

Parameters section-31a07dbccf964850883e817384499459

Input (submitJobParam)

Naam
Type
Vereist
Beschrijving
companyHandle
xsd:tekenreeks
Ja
Bedrijfshandgreep.
userHandle
xsd:tekenreeks
Nee

Handgreep naar de gebruiker die de taak heeft verzonden.

Opmerking: Het systeem verzendt e-mail naar de gebruiker die door wordt gespecificeerd userHandle. Indien userHandle niet wordt verstrekt, ontvangt de persoon die de baan indiende de e-mail.

jobName
xsd:tekenreeks
Ja
Taaknaam.
landinstelling
xsd:tekenreeks
Nee

De landinstelling die wordt gebruikt voor loggegevens van taken en e-maillokalisatie.

Landinstellingen worden opgegeven als <language_code> en [<country_code>], waarbij de taalcode een code van twee kleine letters is, zoals gespecificeerd in ISO-639, en de optionele landcode een code van twee letters in hoofdletters is, zoals gespecificeerd in ISO-3166. De landinstelling voor Engels (Verenigde Staten) zou bijvoorbeeld als volgt zijn: en-US.

execTime
xsd:dateTime
Nee

Datum en tijd waarop de taak moet worden uitgevoerd.

Opmerking: Geef de tijdzone het verzoek. De streken van de tijd worden aangepast aan de tijdzone van de doelIPS server.

execSchedule
xsd:tekenreeks
Nee

Hiermee bepaalt u wanneer de taak moet worden uitgevoerd.

Kan een kraan tekenreeks die de taak op terugkerende basis uitvoert.

Het programma is altijd relatief ten opzichte van de lokale tijdzone van de server. Zie de IPS documentatie voor het formaat van het douaneschema.

beschrijving
xsd:tekenreeks
Nee
Taakbeschrijving.
exportJob
typen:ExportJob
Nee

Eerder geüploade bestanden exporteren.

Zie ExportJob.

imageServingPublishJob
typen:ImageServingPublishJob
Nee
Details voor een afbeelding die publicatietaak aanbiedt.
imageRenderingPublishJob
typen:ImageRenderingPublishJob
Nee
Details voor een publicatietaak voor het renderen van afbeeldingen.
videoPublishJob
typen:VideoPublishJob
Nee

Details voor een video-publicatietaak.

Zie VideoPublishJob.

serverDirectoryPublishJob
types:ServerDirectoryPublishJob
Nee
Details voor de publicatietaak van een serverdirectory.
uploadDirectoryJob
typen:UploadDirectoryJob
Nee
Details voor een uploadmaptaak.
uploadUrlsJob
types:UploadUrlsJob
Nee
Details voor een URL-uploadtaak.
optimizeImagesJob
typen:OptimizeImagesJob
Nee
ripPdfsJob
types:RipPDFSJob
Nee
reprocessAssetsJob
types:ReprocessAssetsJob
Nee
automatedSetGenerationJob
types:AutomatedSetGenerationJob
Nee

Verwerk een elementenlijst in sets met behulp van Geautomatiseerde setscripts.

Zie AutomatedSetGenerationJob.

Uitvoer (submitJobReturn)

Naam
Type
Vereist
Beschrijving
jobHandle
xsd:string
Ja
Taakgreep.

Voorbeelden section-40ac77d14adf4588ba2575be6879b2d2

Dit codevoorbeeld legt een beeld serend publiceerbaan aan IPS voor en keert een baanhandvat terug. Kies slechts één type taak in de aanvraag. Omdat userHandle is weggelaten, worden e-mailmeldingen verzonden naar de gebruiker die de taak heeft verzonden. Deze voorbeeldtaak wordt onmiddellijk uitgevoerd omdat execTime en execSchedule zijn weggelaten.

Verzoek

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

Antwoord

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

Notities section-0f3078e503a249aeb6f3d662a51f036a

U kunt maximaal één van execTime en execSchedule. Als geen van beide is geslaagd, wordt de taak onmiddellijk uitgevoerd. U kunt slechts één van het volgende gebruiken:

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