API Reference

Obter propriedades do tipo do documento (template)

Para que serve?

Serve para obter as propriedades do tipo do documento (template) da instância de processo.

Quando usar?

Esse serviço geralmente é utilizado para obter as propriedades do tipo do documento (template) de uma determinada atividade, como:

  • Obter as informações necessárias para realizar a inclusão de um arquivo na atividade;
  • Verificar os tipos de arquivos permitidos para o campo;
  • Verificar o tamanho máximo permitido para o arquivo antes da inclusão de um novo documento na atividade;

Essa consulta poderá ser executada em qualquer situação de um processo, ou seja, em andamento, finalizado ou cancelado.

Como usar?

Na chamada do serviço é preciso passar a identificação da instância do processo e da atividade em andamento (código da atividade e o ciclo), bem como o código do template.

Esse serviço pode ser executado a partir de um usuário responsável pela atividade em andamento ou que tenha permissão de pesquisa em atividades já executadas.

O retorno da execução desse serviço serão as propriedades do template e a listagem de campos específicos do template (metadados).

Para consultar todos os detalhes, utilize o link abaixo para acessar a documentação técnica.

Link da APIs

VersõesLinkRelease InicialRelease FinalStatus
v2Documentação Técnica5.50 RTM 1.06🟢

🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada