APIs Gestão de Envelopes
1. Conceito
Nesta página serão detalhadas as APIs da funcionalidade Gestão de Envelopes - Antiga, mais informações sobre a funcionalidade acesse a documentação.
2. Pré-requisitos
Os pré-requisitos para utilização das APIs estão descritos na documentação da Gestão de Envelopes.
Permissão exclusiva da API addEnvelopeResponsible:
| Nome | Permissão | Ação | Função |
|---|---|---|---|
| Adicionar responsável solidário ao envelope | res://senior.com.br/platform/ecm_ged/add_envelope_responsible
|
Editar | Permite que o usuário ADMIN do tenant possa executar a API addEnvelopeResponsible que inclui novas permissões ao envelope. |
3. APIs
3.1 API addEnvelopeResponsible – Adicionar responsável solidário a um envelope
Todo envelope permanece visível apenas para o seu criador, exceto quando grupos ou usuários são adicionados como responsáveis solidários.
No entanto, caso o criador do envelope encerre seu vínculo com a empresa sem ter incluído outros responsáveis, o administrador do tenant deverá ser acionado para adicionar, via API, grupos ou usuários como responsáveis solidários, conforme orientação da liderança.
URL
| Endpoint | POST https://platform.senior.com.br/bridge/1.0/rest/platform/ecm_ged/actions/addEnvelopeResponsible
|
|---|---|
| Header obrigatório | Content-Type: application/json
|
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
envelopeIds
|
Array | Sim | Lista de IDs dos envelopes que terão o responsável alterado. |
oldUserResponsible
|
String | Sim | Usuário responsável atual. |
newUserResponsible
|
String | Sim | Novo usuário responsável. |
Exemplo:
{
curl --location 'https://platform.senior.com.br/bridge/1.0/rest/platform/ecm_ged/actions/addEnvelopeResponsible' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}' \
--data-raw '{
"envelopeIds": ["UUID","UUID","UUID","UUID"],
"oldUserResponsible": "nome_usuario@senior.com.br",
"newUserResponsible": " nome_usuario2@senior.com.br" }'
}Respostas
| Código | Descrição |
|---|---|
| 200 | Responsável |
| 400 | Requisição inválida |
| 401 | Não autorizado |
| 403 | Acesso negado |
| 404 | Envelope não encontrado |
| 500 | Erro interno do servidor |
- O endpoint realiza a alteração do responsável de múltiplos envelopes em lote.
- É necessário informar um token Bearer válido no cabeçalho
Authorization. - Os IDs informados em
envelopeIdsdevem existir e estar acessíveis ao usuário autenticado. - O usuário informado em
oldUserResponsibledeve corresponder ao responsável atual dos envelopes.
English
Español
