POST | Create note
- 2 minutes to read
- Print
- DarkLight
- PDF
POST | Create note
- 2 minutes to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Create a note in MySafe.
Request
POST api/mysafe/note
Info
When a note is added to MySafe, it's automatically associated with its creator, identifying them as the owner.
Request parameters
Send the parameters below in the request body.
name- string - required - Name assigned to the note.
note- string - required - The content of the note, limited to 900 characters.
Important!
Notes whose content exceeds 900 characters will result in error.
tags- string - Keywords associated with the note.
users_allowed- array of objects - Data of users allowed to access the note.
username - string - Name of the user allowed to access the note.can_edit - boolean - Edit permission.Attention
Users with can_edit = true permission can deactivate the note.
groups_allowed- array of objects - Data of groups allowed to access the note.
name - string - Name of the group allowed to access the note.can_edit - boolean - Edit permission.Attention
Group members with can_edit = true permission can deactivate the note.
Example request
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"
}
]
}
Response
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": []
}
}
Errors
400 - Bad Request
Message: "1001: Parameter 'name' was not informed!"
Possible cause: the required parameter name of the note was not informed.
name of the note and resend the request.Message: "1001: Parameter 'note' was not informed!"
Possible cause: the required parameter note was not informed.
note and resend the request.Message: "1001: Parameter note limited to 900 characters"
Possible cause: the content sent in note exceeded the limit of 900 characters.
500 - Internal Server Error
Message: "Unexpected error."
Possible cause: the error is on the senhasegura server.
Solution: contact the support team for more information.
No route matched with those values.
Message: "No route matched with those values."
Possible causes: failure in your application's authentication with the senhasegura server or incorrect URL.
Solution: check the authentication parameters such as Access Token URL, Client ID, and Client Secret and request a new access token or check and correct the URL.
An invalid response was received from the upstream server.
Message: "An invalid response was received from the upstream server."
Possible cause: the upstream server may be taking too long to respond, leading to a timeout error interpreted as an invalid response by the proxy/gateway server.
Solution: check the connectivity between the request origin and the senhasegura server.
The upstream server is timing out.
Message: "The upstream server is timing out."
Possible cause: the request timed out.
Solution: check the connectivity between the request origin and the senhasegura server.
Was this article helpful?
