Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Background
This REST API meant to provide attachments from Objective or KRs. For this, user needs to attachment ID in API request.
API Details
This API will require valid authentication & will expect the user API token in the request.
Read Create User API token for more details
Below are the end points for this API based on which UpRaise app you are using
App name | Endpoint |
|---|---|
UpRaise for Employee Success | https://employee-success.upraise.io/rest/upraise/public/1.0/okr/attachment/{attachmentId} |
UpRaise People |
Request parameters
Response expected from this API endpoint is attachment ID.
Users without permission to view OKR won’t be able to download attachments. Appropriate error message will appear.
Response
Once the request is processed, the attachment file is downloaded as a response.
Error handling
HTTP Status code | Error Message |
|---|---|
403 (FORBIDDEN) | This user does not have permission to view OKRs. |
404 (NOT_FOUND) | Either the attachment was deleted or you don't have access to it. |
On this page | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Iframe | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|