submitJob

Envia uma tarefa para o 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

Manuseio da empresa.

userHandle xsd:string Não

Manipule o usuário que enviou o trabalho.

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

jobName xsd:string Sim

Nome da tarefa.

locale xsd:string Não

A localidade usada para detalhes do log 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 sequência de caracteres da 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 destino.

execSchedule xsd:string Não

Determina quando executar a tarefa.

Pode ser uma sequência cron que executa o trabalho de forma recorrente.

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

descrição xsd:string Não

Descrição da tarefa.

exportJob tipos:ExportJob Não

Exportar arquivos carregados anteriormente.

Consulte ExportJob.

imageServingPublishJob tipos:ImageServingPublishJob Não

Detalhes de um trabalho de publicação de fornecimento 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 do diretório do 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 upload de URL.

otimizeImagesJob tipos:OtimizeImagesJob Não

ripPdfsJob tipos:RipPdfsJob Não

reprocessAssetsJob tipos:ReprocessAssetsJob Não

automaticSetGenerationJob tipos:AutomatedSetGenerationJob Não

Processar uma lista de ativos em conjuntos usando Scripts de conjunto automatizado.

Consulte AutomatedSetGenerationJob.

Saída (submitJobReturn)

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

Exemplos

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

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, a tarefa será executada imediatamente. Você pode usar somente um dos seguintes:

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

Nesta página