Objetivo
Estes endpoints têm como objetivo realizar o download de pastas criadas no ECM. O processo é executado em duas etapas: o primeiro endpoint é responsável pela geração do arquivo, enquanto o segundo permite efetuar o download do arquivo gerado.
URL
Gerar o arquivo – /rest/ecm-new/IntegrationDocument/generate-archive-download
Realizar o download do arquivo gerado – /rest/ecm-new/IntegrationDocument/{jobId}
Parâmetros
folderId – Este parâmetro será utilizado para realizar a requisição do endpoint de gerar o arquivo, deve ser preenchido com o ID da pasta desejada, podendo ser encontrado através do endpoint “/rest/ecm-new/IntegrationDocument” que irá listar todos os documentos e pastas publicados no tenant do usuário, com as informações detalhadas de cada um, sendo um deles o “folderId”.
jobId – Este parâmetro será retornado como resposta do endpoint de gerar o arquivo, e será utilizado para preencher o campo do endpoint para realizar o download do arquivo gerado, através dele, o sistema irá identificar o arquivo que foi gerado para download.
Retornos
Cada um dos endpoints terá um retorno, aquele que irá gerar o arquivo para download, irá retornar o “JobId” e através dele será possível a realização do download da pasta.
O texto do campo “Value” corresponde ao “jobId”
JobId – Identificador do arquivo que foi gerado através do folderId inserido na requisição.
O segundo endpoint, irá retornar um status, de acordo com o progresso em que o arquivo que está sendo gerado se encontra, podendo ser “Processing”, “Ready”, “Error” ou “Expired”.
PROCESSING – Indica que o arquivo ainda está sendo gerado.
READY – Indica que o arquivo já está pronto para ser feito o download, junto do status, será exibido um link para poder realizar o download da pasta.
ERROR – Indica que houve um erro no processamento do arquivo e não foi possível gerar o link para download.
EXPIRED – Indica que o arquivo que está tentando ser baixado já expirou e não pode ser gerado o link para download.