Endpoints Tags
Endpoints de Tags
Importante
Não esqueça de enviar o tokenAPI e cryptKey em sua requisição.
Ex.: https://secure.d4sign.com.br/api/v1/safes?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}
Listar as TAGs do documento
GET
/tags/{UUID-DOCUMENTO}
GET
/tags/{UUID-DOCUMENTO}Este método listará todas as TAGs do documento
O resultado será de 500 usuários por páginas
Utilize o parametro PG na URL para paginar o resultado. Ex.:
https://secure.d4sign.com.br/api/v1/users/list?tokenAPI={SEU-TOKEN}&cryptKey={crypt-key}&pg=2O primeiro bloco do resultado exibirá o total de páginas disponÃveis
{
"Content-Type": "application/json"
}
{
"uuid_arquivo": "uuid-do-documento",
"TAGs": "teste1, teste2, teste4",
}
Adicionar TAGs no documento
POST
/tags/{UUID-DOCUMENTO}/add
POST
/tags/{UUID-DOCUMENTO}/addEste método irá adicionar uma TAG em seu documento
{
"Content-Type": "application/json"
}
{
"tag":"minha tag"
}
{
"message": "TAGs added sucessfully",
"TAGs": "minha tag"
}
Parâmetro | Descrição |
---|---|
tag (obrigatório) | TAG que será cadastrada no documento |
Remover TAGs do documento
POST
/tags/{UUID-DOCUMENTO}/remove
POST
/tags/{UUID-DOCUMENTO}/removeEste método irá remover uma TAG em seu documento
{
"Content-Type": "application/json"
}
{
"tag":"minha tag"
}
{
"message": "TAGs removed sucessfully",
"TAGs": "minha tag"
}
Parâmetro | Descrição |
---|---|
tag (obrigatório) | TAG que será removida do documento |
Remover TODAS as TAGs do documento
POST
/tags/{UUID-DOCUMENTO}/erase
POST
/tags/{UUID-DOCUMENTO}/eraseEste método irá remover TODAS as TAG em seu documento
{
"Content-Type": "application/json"
}
{
"message": "All TAGs removed sucessfully"
}
Adicionar TAG URGENTE ao documento
POST
/tags/{UUID-DOCUMENTO}/addurgent
POST
/tags/{UUID-DOCUMENTO}/addurgentEste método irá adicionar a TAG URGENTE em seu documento.
{
"Content-Type": "application/json"
}
{
"message": "TAGs Urgent added sucessfully",
"TAGS": "Urgente"
}
Lembrando que para conseguir fazer essa requisição, você precisa ser dono do cofre ou ter permissão de Administrador ou padrão, caso o cofre seja compartilhado.
Remover TAG URGENTE do documento
POST
/tags/{UUID-DOCUMENTO}/addremoveurgent
POST
/tags/{UUID-DOCUMENTO}/addremoveurgentEste método irá remover a TAG URGENTE em seu documento.
{
"Content-Type": "application/json"
}
{
"message": "Urgent TAG removed sucessfully",
"TAGs": "TAG"
}
Lembrando que para conseguir fazer essa requisição, você precisa ser dono do cofre ou ter permissão de Administrador ou padrão, caso o cofre seja compartilhado.
Updated 10 months ago