- 2 minutos de leitura
- Imprimir
- Tema escuroTema claro
- Pdf
GET | Listar todas as anotações
- 2 minutos de leitura
- Imprimir
- Tema escuroTema claro
- Pdf
Acesse informações de anotações armazenadas no MySafe.
Requisição
GET
api/mysafe/note
Parâmetros de consulta
Envie os parâmetros abaixo como query na URL.
tag
- string - Filtra as anotações por tags.name
- string - Filtra as anotações pelo nome.
Exemplos de requisição
GET
{{url}}api/mysafe/note
- Lista todas as anotações.
GET
{{url}}api/mysafe/note?tag=secret
- Lista a(s) anotação(ões) registrada(s) com a tag
= secret
.
GET
{{url}}api/mysafe/note?name=secret note
- Lista a(s) anotação(ões) registrada(s) com name
= secret note
.
Resposta
HTTP/1.1 200 OK
{
"code": 200,
"response": {
"status": 200,
"message": "",
"error": false,
"error_code": 0,
"detail": "",
"mensagem": "",
"erro": false,
"cod_erro": 0
},
"note_on_list": [
{
"identifier": "1",
"name": "My note",
"tags": "",
"need_justify": "0",
"need_approval": "0",
"can_view": true,
"can_write": true
},
{
"identifier": "2",
"name": "Secret note",
"tags": "secret",
"need_justify": "0",
"need_approval": "0",
"can_view": true,
"can_write": true
},
{
"identifier": "6",
"name": "Staff meeting decisions",
"tags": "meeting",
"need_justify": "0",
"need_approval": "0",
"can_view": true,
"can_write": true
},
{
"identifier": "9",
"name": "TC Meeting",
"tags": "API, MySafe, TC",
"need_justify": "0",
"need_approval": "0",
"can_view": true,
"can_write": true
}
]
}
Campos do corpo da resposta
notes_on_list
- array de objetos - Dados das anotações armazenadas.identifier
- int - Código único de identificação da anotação.name
- string - Nome da anotação.tags
- string - Palavras-chave associadas à anotação.can_view
- string - Permissão de visualização da anotação.can_write
- string - Permissão de edição da anotação.Erros
500 - Internal Server Error.
Mensagem: "Unexpected error."
Possível causa: o erro está no servidor senhasegura.
Solução: contate o time de suporte para mais informações.
No route matched with those values.
Mensagem: "No route matched with those values."
Possíveis causas: falha na autenticação da sua aplicação com o servidor senhasegura ou URL incorreta.
Solução: verifique os parâmetros de autenticação como Access Token URL
, Client ID
e Client Secret
e solicite um novo token de acesso ou verifique e corrija a URL.
An invalid response was received from the upstream server .
Mensagem: "An invalid response was received from the a seupstream server
Possível causa: o servidor upstream pode estar demorando muito para responder, levando a um erro de timeout que é interpretado como uma resposta inválida pelo servidor proxy/gateway.
Solução: verifique a conectividade entre a origem da requisição e o servidor senhasegura.
The upstream server is timing out.
Mensagem: "An invalid response was received from the upstream server"
Possível causa: o tempo da requisição se esgotou.
Solução: verifique a conectividade entre a origem da requisição e o servidor senhasegura.