submitJob

Envía un trabajo al sistema.

Sintaxis

Tipos de usuarios autorizados

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

Parámetros

Entrada (submitJobParam)

Nombre

Tipo

Obligatorio

Descripción

companyHandle xsd:string

Identificador de la empresa.

userHandle xsd:string No

Gestionar al usuario que ha enviado el trabajo.

Nota: El sistema envía un correo electrónico al usuario especificado por userHandle. Si no se proporciona userHandle , la persona que envió el trabajo recibe los correos electrónicos.

jobName xsd:string

Nombre de trabajo.

locale xsd:string No

La configuración regional utilizada para los detalles del registro de trabajos y la localización del correo electrónico.

Las configuraciones regionales se especifican como <language_code> y [<country_code>], donde el código de idioma es un código de dos letras en minúscula, según se especifica en ISO-639, y el código de país opcional es un código de dos letras en mayúsculas según se especifica en ISO-3166. Por ejemplo, la cadena de configuración regional para inglés (Estados Unidos) sería: en-US.

execTime xsd:dateTime No

Fecha y hora de ejecución del trabajo.

Nota: Proporcione la zona horaria con la solicitud. Las zonas horarias se ajustan a la zona horaria del servidor IPS de destino.

execSchedule xsd:string No

Determina cuándo ejecutar el trabajo.

Puede ser una cadena cron que ejecute el trabajo de forma recurrente.

La programación siempre es relativa al huso horario local del servidor. Consulte la documentación de IPS para ver el formato de programación personalizado.

descripción xsd:string No

Descripción del trabajo.

exportJob tipos:ExportJob No

Exportar archivos cargados anteriormente.

Consulte ExportJob.

imageServingPublishJob tipos:ImageServingPublishJob No

Detalles de un trabajo de publicación de servicio de imágenes.

imageRenderingPublishJob tipos:ImageRenderingPublishJob No

Detalles de un trabajo de publicación de renderización de imágenes.

videoPublishJob tipos:VideoPublishJob No

Detalles de un trabajo de publicación de vídeo.

Consulte VideoPublishJob.

serverDirectoryPublishJob tipos:ServerDirectoryPublishJob No

Detalles de un trabajo de publicación de directorio de servidor.

uploadDirectoryJob tipos:UploadDirectoryJob No

Detalles de un trabajo de directorio de carga.

uploadUrlsJob tipos:UploadUrlsJob No

Detalles de un trabajo de URL de carga.

optimizeImagesJob tipos:OptimizeImagesJob No

ripPdfsJob tipos:RipPdfsJob No

reprocessAssetsJob tipos:ReprocessAssetsJob No

automaticSetGenerationJob tipos:AutomatedSetGenerationJob No

Procese una lista de recursos en conjuntos mediante Scripts de conjunto automatizados.

Consulte AutomatedSetGenerationJob.

Salida (submitJobReturn)

Nombre Tipo Obligatorio Descripción
*jobHandle* xsd:string Identificador de trabajo.

Ejemplos

Este ejemplo de código envía un trabajo de publicación de servidor de imágenes a IPS y devuelve un identificador de trabajo. Elija solo un tipo de trabajo en la solicitud. Como se ha omitido userHandle, las notificaciones por correo electrónico se envían al usuario que ha enviado el trabajo. Este trabajo de ejemplo se ejecuta inmediatamente porque se omitieron execTime y execSchedule.

Solicitar

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

Respuesta

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

Notas

Puede especificar como máximo uno de execTime y execSchedule. Si no se pasa ninguno, el trabajo se ejecuta inmediatamente. Solo puede utilizar una de las siguientes opciones:

  • imageServingPublishJob
  • imageRenderingPublishJob
  • videoPublishJob
  • serverDirectoryPublishJob
  • uploadDirectoryJob
  • uploadUrlsJob

En esta página