submitJob

Envia uma tarefa ao sistema.

Sintaxe

Tipos de usuário autorizados

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

Parâmetros

Entrada (submitJobParam)

Nome

Tipo

Obrigatório

Descrição

companyHandle xsd:string Sim

Alça da empresa.

userHandle xsd:string Não

Manipule o usuário que enviou o trabalho.

Observação: O sistema envia emails para o usuário especificado por userHandle. Se userHandle não for fornecido, a pessoa que submeteu o trabalho receberá os emails.

jobName xsd:string Sim

Nome do trabalho.

locale xsd:string Não

A localidade usada para detalhes do registro de tarefas e localização de email.

As localidades são especificadas como <language_code> e [<country_code>], onde o código de idioma é um código de duas letras em minúsculas, conforme especificado pela ISO-639, e o código de país opcional é um código de duas letras em maiúsculas, conforme especificado pela ISO-3166. Por exemplo, a string de localidade para inglês (Estados Unidos) seria: en-US.

execTime xsd:dateTime Não

Data e hora para executar a tarefa.

Observação: Forneça o fuso horário com a solicitação. Os fusos horários são ajustados para o fuso horário do servidor IPS de públicos alvos.

execSchedule xsd:string Não

Determina quando executar a tarefa.

Pode ser uma string cron que executa o trabalho de forma recorrente.

O agendamento é sempre relativo ao fuso horário local do servidor. Consulte a documentação IPS para obter o formato de agendamento personalizado.

descrição xsd:string Não

Descrição do trabalho.

exportJob tipos:ExportJob Não

Exporte arquivos carregados anteriormente.

Consulte ExportJob.

imageServingPublishJob tipos:ImageServingPublishJob Não

Detalhes de uma tarefa de publicação de serviço de imagem.

imageRenderingPublishJob tipos:ImageRenderingPublishJob Não

Detalhes de um trabalho de publicação de renderização de imagem.

videoPublishJob tipos:VideoPublishJob Não

Detalhes de um trabalho de publicação de vídeo.

Consulte VideoPublishJob.

serverDirectoryPublishJob tipos:ServerDirectoryPublishJob Não

Detalhes de um trabalho de publicação de diretório de servidor.

uploadDirectoryJob tipos:UploadDirectoryJob Não

Detalhes de um trabalho de diretório de upload.

uploadUrlsJob tipos:UploadUrlsJob Não

Detalhes de um trabalho de URL de upload.

otimizeImagesJob tipos:OtimizeImagesJob Não

ripPdfsJob tipos:RipPdfsJob Não

reprocessAssetsJob tipos:ReprocessAssetsJob Não

autoSetGenerationJob tipos:AutomatedSetGenerationJob Não

Processar uma lista de ativo em conjuntos usando o Conjunto Automatizado de Scripts.

Consulte AutomatedSetGenerationJob.

Saída (submitJobReturn)

Nome Tipo Obrigatório Descrição
*jobHandle* xsd:string Sim Trabalho.

Exemplos

Esta amostra de código envia um trabalho de publicação de serviço de imagem para o IPS e retorna um identificador de trabalho. Escolha apenas um tipo de tarefa na solicitação. Como userHandle foi omitido, notificações por email são enviadas ao usuário que enviou o trabalho. Este trabalho de amostra é executado imediatamente porque execTime e execSchedule foram omitidos.

Solicitação

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

Resposta

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

Notas

Você pode especificar no máximo um de execTime e execSchedule. Se nenhum dos dois for aprovado, o trabalho será executado imediatamente. Você pode usar apenas uma das seguintes opções:

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

Nesta página