submitJob submitjob

Soumet un traitement au système.

Syntaxe

Types d’utilisateurs autorisés section-eb7024277bec43c79e03f396205be16f

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

Paramètres section-31a07dbccf964850883e817384499459

Input (submitJobParam)

Nom
Type
Obligatoire
Description
companyHandle
xsd:string
Oui
Identifiant de la société.
userHandle
xsd:string
Non

Gérer vers l’utilisateur qui a envoyé le traitement.

Remarque : le système envoie un e-mail à l’utilisateur spécifié par userHandle. Si userHandle n’est pas fourni, la personne qui a envoyé le traitement reçoit les e-mails.

jobName
xsd:string
Oui
Nom du traitement.
paramètres régionaux
xsd:string
Non

Paramètres régionaux utilisés pour les détails du log de traitement et la localisation des e-mails.

Les paramètres régionaux sont spécifiés <language_code> et [<country_code>], où le code de langue est un code à deux lettres en minuscules spécifié par la norme ISO-639 et le code de pays facultatif est un code à deux lettres en majuscules spécifié par la norme ISO-3166. Par exemple, la chaîne de paramètres régionaux pour l’anglais (États-Unis) serait : en-US.

execTime
xsd:dateTime
Non

Date et heure d’exécution du traitement.

Remarque : indiquez le fuseau horaire de la requête. Les fuseaux horaires sont adaptés au fuseau horaire du serveur IPS cible.

execSchedule
xsd:string
Non

Détermine quand exécuter la tâche.

Il peut s’agir d’une chaîne cron qui exécute la tâche de manière récurrente.

La planification est toujours relative au fuseau horaire local du serveur. Voir la documentation IPS pour le format de planning personnalisé.

description
xsd:string
Non
Description du traitement.
exportJob
types:ExportJob
Non

Exportez les fichiers précédemment chargés.

Voir ExportJob.

imageServingPublishJob
types :ImageServingPublishJob
Non
Détails d’une image diffusant la tâche de publication.
imageRenderingPublishJob
types :ImageRenderingPublishJob
Non
Détails d’une tâche de publication de rendu d’image.
videoPublishJob
types :VideoPublishJob
Non

Détails d’une tâche de publication vidéo.

Voir VideoPublishJob.

serverDirectoryPublishJob
types:ServerDirectoryPublishJob
Non
Détails d’un traitement de publication de répertoire serveur.
uploadDirectoryJob
de sous-réseau :UploadDirectoryJob
Non
Détails d’une tâche de répertoire de chargement.
uploadUrlsJob
de sous-réseau :UploadUrlsJob
Non
Détails d’une tâche d’URL de chargement.
optimizerImagesJob
types de :OptimizeImagesJob
Non
ripPdfsJob
Types de : RipPdfsJob
Non
reprocessAssetsJob
de sous-dossiers :ReprocessAssetsJob
Non
automatedSetGenerationJob
de sous-réseau :AutomatedSetGenerationJob
Non

Traitez une liste de ressources en visionneuses à l’aide de scripts de visionneuse automatisée.

Voir AutomatedSetGenerationJob.

Output (submitJobReturn)

Nom
Type
Obligatoire
Description
jobHandle
xsd:string
Oui
Traitement du traitement.

Exemples section-40ac77d14adf4588ba2575be6879b2d2

Cet exemple de code envoie une image diffusant la tâche de publication à IPS et renvoie un descripteur de tâche. Sélectionnez un seul type de traitement dans la requête. Comme userHandle a été omis, des notifications par e-mail sont envoyées à l’utilisateur qui a envoyé le traitement. Cet exemple de tâche s’exécute immédiatement, car execTime et execSchedule ont été omis.

Requête

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

Réponse

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

Remarques section-0f3078e503a249aeb6f3d662a51f036a

Vous pouvez spécifier au maximum l’une des options execTime et execSchedule. Si aucun des deux n’est transmis, la tâche s’exécute immédiatement. Vous ne pouvez utiliser que l’une des méthodes suivantes :

  • imageServingPublishJob
  • imageRenderingPublishJob
  • videoPublishJob
  • serverDirectoryPublishJob
  • uploadDirectoryJob
  • uploadUrlsJob
recommendation-more-help
dynamic-media-developer-resources-help-aem-ips-api