submitJob submitjob

Envia um processo ao sistema.

Sintaxe

Tipos de usuário autorizados section-eb7024277bec43c79e03f396205be16f

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

Parâmetros section-31a07dbccf964850883e817384499459

Entrada (submitJobParam)

Nome
Tipo
Obrigatório
Descrição
companyHandle
xsd:string
Sim
Identificador da empresa.
userHandle
xsd:string
Não

Processe o usuário que enviou o job.

Observação: o sistema envia um email ao 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 do trabalho.
localidade
xsd:string
Não

A localidade usada para detalhes do log de trabalho e localização do email.

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

execTime
xsd:dateTime
Não

Data e hora de execução do job.

Observação: forneça o fuso horário com a solicitação. Os fusos horários são ajustados ao fuso horário do servidor IPS de destino.

execSchedule
xsd:string
Não

Determina quando executar a tarefa.

Pode ser um cron string que executa a tarefa de forma recorrente.

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

descrição
xsd:string
Não
Descrição do trabalho.
exportJob
tipos:ExportJob
Não

Exportar arquivos carregados anteriormente.

Consulte ExportJob.

imageServingPublishJob
tipos:ImageServingPublishJob
Não
Detalhes de um trabalho de publicação do servidor de imagens.
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 TrabalhoDePublicaçãoDeVídeo.

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
automatedSetGenerationJob
tipos:AutomatedSetGenerationJob
Não

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

Consulte AutomatedSetGenerationJob.

Saída (submitJobReturn)

Nome
Tipo
Obrigatório
Descrição
jobHandle
xsd:string
Sim
Identificador do trabalho.

Exemplos section-40ac77d14adf4588ba2575be6879b2d2

Esta amostra de código envia um trabalho de publicação de servidor de imagens para o IPS e retorna um identificador de trabalho. Escolha apenas um tipo de trabalho na solicitação. Porque userHandle for omitida, as notificações por email serão enviadas ao usuário que enviou o trabalho. Esse 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 section-0f3078e503a249aeb6f3d662a51f036a

É possível especificar no máximo um dos execTime e execSchedule. Se nenhum for aprovado, o job será executado imediatamente. Você pode usar apenas um dos seguintes:

  • imageServingPublishJob
  • imageRenderingPublishJob
  • videoPublishJob
  • serverDirectoryPublishJob
  • uploadDirectoryJob
  • uploadUrlsJob
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681