Invia un processo al sistema.
Sintassi
IpsUser
IpsAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser
Input (submitJobParam)
Nome |
Tipo |
Obbligatorio |
Descrizione |
---|---|---|---|
companyHandle | xsd:string | Sì | Tratta l'azienda. |
userHandle | xsd:string | No | Gestisci l'utente che ha inviato il processo.
Nota: Il sistema invia un’e-mail all’utente specificato da userHandle. Se userHandle non viene fornito, la persona che ha inviato il lavoro riceve le e-mail. |
jobName | xsd:string | Sì | Nome processo. |
locale | xsd:string | No | Impostazioni internazionali utilizzate per i dettagli del registro di lavoro e la localizzazione delle e-mail. Le impostazioni internazionali sono specificate come <language_code> e [<country_code>], se il codice della lingua è un codice a due lettere minuscolo, come specificato dalla norma ISO-639, e se il codice del paese opzionale è un codice a due lettere maiuscolo come specificato dalla norma ISO-3166. Ad esempio, la stringa locale per Inglese (Stati Uniti) è la seguente: en-US. |
execTime | xsd:dateTime | No | Data e ora di esecuzione del processo. Nota: Fornisci il fuso orario con la richiesta. I fusi orari vengono regolati in base al fuso orario del server IPS di destinazione. |
execSchedule | xsd:string | No | Determina quando eseguire il processo. Può essere cron stringa che esegue il processo su base ricorrente. La pianificazione è sempre relativa al fuso orario locale del server. Consulta la documentazione IPS per il formato di pianificazione personalizzato. |
descrizione | xsd:string | No | Descrizione del processo. |
exportJob | tipi:ExportJob | No | Esporta i file caricati in precedenza. Vedi ExportJob. |
imageServingPublishJob | tipi:ImageServingPublishJob | No | Dettagli per un processo di pubblicazione di image serving. |
imageRenderingPublishJob | tipi:ImageRenderingPublishJob | No | Dettagli per un processo di pubblicazione di rendering delle immagini. |
videoPublishJob | tipi:VideoPublishJob | No | Dettagli per un processo di pubblicazione video. Vedi VideoPublishJob. |
serverDirectoryPublishJob | tipi:ServerDirectoryPublishJob | No | Dettagli per un processo di pubblicazione della directory del server. |
uploadDirectoryJob | tipi:UploadDirectoryJob | No | Dettagli per un processo della directory di caricamento. |
uploadUrlsJob | tipi:UploadUrlsJob | No | Dettagli per un processo URL di caricamento. |
optimizeImagesJob | tipi:OptimizeImagesJob | No |
|
ripPdfsJob | tipi:RipPdfsJob | No |
|
reprocessAssetsJob | tipi:ReprocessAssetsJob | No |
|
automatedSetGenerationJob | tipi:AutomatedSetGenerationJob | No | Elabora un elenco di risorse in set utilizzando gli script di set automatizzati. |
Output (submitJobReturn)
Nome | Tipo | Obbligatorio | Descrizione |
---|---|---|---|
jobHandle | xsd:string |
Sì | Maniglia di lavoro. |
Questo esempio di codice invia un processo di pubblicazione a IPS e restituisce un handle di processo. Scegliere un solo tipo di processo nella richiesta. Perché userHandle
è stato omesso, le notifiche e-mail vengono inviate all'utente che ha inviato il processo. Questo processo di esempio viene eseguito immediatamente perché execTime
e execSchedule
sono stati omessi.
Request Contents (Richiesta contenuto)
<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>
Risposta
<submitJobReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<jobHandle>47|My Test Job|</jobHandle>
</submitJobReturn>
Puoi specificare al massimo uno dei seguenti execTime
e execSchedule
. Se non viene passato nessuno dei due, il processo viene eseguito immediatamente. Puoi utilizzare solo uno dei seguenti elementi:
imageServingPublishJob
imageRenderingPublishJob
videoPublishJob
serverDirectoryPublishJob
uploadDirectoryJob
uploadUrlsJob