POST | Criar anotação
  • 3 minutos de leitura
  • Tema escuro
    Tema claro
  • Pdf

POST | Criar anotação

  • Tema escuro
    Tema claro
  • Pdf

Resumo do artigo

Crie uma anotação no MySafe.

Requisição

POST api/mysafe/note

Info

Quando uma anotação é adicionada ao MySafe, ela é automaticamente associada ao seu criador, identificando-o como seu proprietário.

Parâmetros de requisição

Envie os parâmetros abaixo no body da requisição.

  • name - string - obrigatório - Nome atribuído à anotação.


  • note - string - obrigatório - O conteúdo da anotação, limitado a 900 caracteres.
Importante!

Anotações cujo conteúdo possui mais de 900 caracteres resultarão em erro.


  • tags - string - Palavras-chave associadas à anotação.


  • users_allowed - array de objetos - Dados dos usuários com acesso à anotação.


    →username - string - Nome do usuário com permissão de acesso à anotação.


    →can_edit - boolean - Permissão de edição.    Nota: se deixado vazio, usuários terão apenas permissão de visualização.
Atenção

Usuários com permissão can_edit = true podem inativar a anotação


  • groups_allowed - array de objetos - Dados dos grupos com permissão de acesso à anotação.


    →name - string - Nome do grupo com permissão de acesso à anotação.


    →can_edit - boolean - Permissão de edição.    Nota: se deixado vazio, membros do grupo terão apenas permissão de visualização.
Atenção

Membros de grupos com permissão can_edit = true podem inativar a anotação

Exemplo de requisição

POST {{url}}api/mysafe/note

{
    "name": "Staff meeting",
    "note": "Staff meetings are essential for maintaining clear communication and ensuring everyone is on the same page. These gatherings provide a platform to discuss ongoing projects, address any issues, and brainstorm new ideas. By fostering a collaborative environment, staff meetings encourage team members to share their insights and contribute to the organization's overall goals. Regularly scheduled meetings also help in building team morale and strengthening workplace relationships.",
    "tags": "meeting",
    "groups_allowed": [
        {
            "name": "TC team"
        }
    ]
}

Resposta

HTTP/1.1 201 CREATED 
{
    "code": 201,
    "response": {
        "status": 201,
        "message": "Note successfully registered",
        "error": false,
        "error_code": 0,
        "detail": "",
        "mensagem": "Note successfully registered",
        "erro": false,
        "cod_erro": 0
    },
    "note_entity": {
        "identifier": "8",
        "name": "Staff meeting",
        "tags": "meeting",
        "users_allowed": [],
        "groups_allowed": [
            {
                "name": "TC team",
                "can_edit": false
            }
        ],
        "shared_error": []
    }
}

Erros

400 - Bad Request.

Mensagem: "1001: Parameter 'name' was not informed!"

Possível causa: o parâmetro obrigatório name da anotação não foi informado.

Solução: informe o name da anotação e envie a requisição novamente.

Mensagem: "1001: Parameter 'note' was not informed!"

Possível causa: o parâmetro obrigatório note da anotação não foi informado.

Solução: informe o note da senha e envie a requisição novamente.

Mensagem: "1001: Parameter note limited to 900 characters"

Possível causa: o conteúdo enviado em note ultrapassou o limite de 900 caracteres.

Solução: diminua o conteúdo da anotação e envie a requisição novamente.
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 upstream 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: "The upstream server is timing out"

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.



Este artigo foi útil?