DocumentaciónAPI del sistema de producción de imágenes Dynamic Media

submitJob submitjob

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Temas:

Creado para:

  • Desarrollador
  • Administrador

Envía un trabajo al sistema.

Sintaxis

Tipos de usuarios autorizados section-eb7024277bec43c79e03f396205be16f

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

Parámetros section-31a07dbccf964850883e817384499459

Entrada (submitJobParam)

Nombre
Tipo
Obligatorio
Descripción
companyHandle
xsd:string
Sí
Manejo de la compañía.
userHandle
xsd:string
No

Identificador para el usuario que envió el trabajo.

Nota: El sistema enviará un correo electrónico al usuario especificado por userHandle. Si no se proporciona userHandle, la persona que envió el trabajo recibirá los mensajes de correo electrónico.

jobName
xsd:string
Sí
Nombre de trabajo.
configuración regional
xsd:string
No

La configuración regional utilizada para los detalles del registro de trabajos y la localización por 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úsculas según se especifica en la norma 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 la norma 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 para ejecutar el 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 ejecuta el trabajo de forma recurrente.

La programación siempre es relativa a la zona horaria 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 los archivos cargados anteriormente.

Ver ExportJob.

imageServingPublishJob
tipos:ImageServingPublishJob
No
Detalles de un trabajo de publicación para servicio de imágenes.
imageRenderingPublishJob
tipos:ImageRenderingPublishJob
No
Detalles de un trabajo de publicación de procesamiento de imágenes.
videoPublishJob
tipos:VideoPublishJob
No

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

Ver 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 carga de directorio.
uploadUrlsJob
tipos:UploadUrlsJob
No
Detalles de un trabajo de carga de URL.
optimizeImagesJob
tipos:OptimizeImagesJob
No
ripPdfsJob
tipos:RipPdfsJob
No
reprocessAssetsJob
tipos:ReprocessAssetsJob
No
automatedSetGenerationJob
tipos:AutomatedSetGenerationJob
No

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

Consulte AutomatedSetGenerationJob.

Salida (submitJobReturn)

Nombre
Tipo
Obligatorio
Descripción
jobHandle
xsd:string
Sí
Gestor del trabajo.

Ejemplos section-40ac77d14adf4588ba2575be6879b2d2

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

Solicitud

<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 section-0f3078e503a249aeb6f3d662a51f036a

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
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681