OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
openproject/docs/api/apiv3/paths/notification.yml

36 lines
1.0 KiB

# /api/v3/notifications/{id}
---
get:
summary: Get the notification
operationId: view_notification
tags:
- Notifications
description: Returns the notification identified by the notification id.
parameters:
- name: id
in: path
description: notification id
example: '1'
required: true
schema:
type: integer
responses:
'200':
content:
application/hal+json:
schema:
$ref: '../components/schemas/notification_model.yml'
description: OK
'404':
content:
application/hal+json:
schema:
$ref: '../components/schemas/error_response.yml'
example:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The requested resource could not be found.
description: |-
Returned if the notification does not exist or if the user does not have permission to view it.
**Required permission** being recipient of the notification