Envoie une tâche au système.
Syntaxe
IpsUser
IpsAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser
Entrée (submitJobParam)
Nom |
Type |
Obligatoire |
Description |
---|---|---|---|
companyHandle | xsd:string | Oui | Poignée de la société. |
userHandle | xsd:string | Non | Gérer l’utilisateur qui a envoyé la tâche.
Remarque : Le système envoie un courrier électronique à l’utilisateur spécifié par userHandle. If userHandle n’est pas fourni, la personne qui a envoyé la tâche reçoit les courriers électroniques. |
jobName | xsd:string | Oui | Nom de la tâche. |
locale | xsd:string | Non | Paramètre régional utilisé pour les détails du journal des tâches et la localisation des emails. Les paramètres régionaux sont spécifiés comme suit : <language_code> et [<country_code>], où le code de langue est un code à deux lettres en minuscules, comme spécifié par la norme ISO-639, et le code de pays facultatif est un code à deux lettres en majuscules, comme spécifié par la norme ISO-3166. Par exemple, la chaîne du paramètre régional pour l’anglais (États-Unis) serait : en-US. |
execTime | xsd:dateTime | Non | Date et heure d’exécution de la tâche. Remarque : Indiquez le fuseau horaire avec la requête. Les fuseaux horaires sont ajustés au fuseau horaire du serveur IPS cible. |
execSchedule | xsd:string | Non | Détermine le moment d’exécution de la tâche. Peut être cron chaîne qui exécute la tâche de manière récurrente. Le planning est toujours relatif au fuseau horaire local du serveur. Consultez la documentation IPS pour connaître le format de planification personnalisé. |
description | xsd:string | Non | Description de la tâche. |
exportJob | types:ExportJob | Non | Exportez les fichiers précédemment téléchargés. Voir ExportJob. |
imageServingPublishJob | types:ImageServingPublishJob | Non | Détails d’une tâche de publication de diffusion d’image. |
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’une tâche de publication de répertoire de serveur. |
uploadDirectoryJob | types:UploadDirectoryJob | Non | Détails d’une tâche de téléchargement de répertoire. |
uploadUrlsJob | types:UploadUrlsJob | Non | Détails d’une tâche de téléchargement d’URL. |
optimizeImagesJob | types:OptimizeImagesJob | Non |
|
ripPdfsJob | types:RipPdfsJob | Non |
|
reprocessAssetsJob | types:ReprocessAssetsJob | Non |
|
AutomatedSetGenerationJob | types:AutomatedSetGenerationJob | Non | Traitez une liste de ressources en ensembles à l’aide de scripts de visionneuse automatisés. |
Sortie (submitJobReturn)
Nom | Type | Obligatoire | Description |
---|---|---|---|
jobHandle | xsd:string |
Oui | Poignée de tâche. |
Cet exemple de code envoie une tâche de publication de diffusion d’image à IPS et renvoie un gestionnaire de tâche. Sélectionnez un seul type de tâche dans la requête. Parce que userHandle
a été omis, des notifications électroniques sont envoyées à l’utilisateur qui a envoyé la tâche. Cet exemple de tâche s’exécute immédiatement car execTime
et execSchedule
ont été omis.
Request
<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>
Vous pouvez spécifier au plus l’une des 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