04047c6ebe
# What this PR does - Add docs for `/resolution_notes` public api endpoint - Fix resolution notes order to show notes for the newest alert group on top ## Which issue(s) this PR fixes https://github.com/grafana/oncall/issues/222 ## Checklist - [x] Unit, integration, and e2e (if applicable) tests updated - [x] Documentation added (or `pr:no public docs` PR label added if not required) - [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not required)
144 lines
3.6 KiB
Markdown
144 lines
3.6 KiB
Markdown
---
|
|
canonical: https://grafana.com/docs/oncall/latest/oncall-api-reference/resolution_notes/
|
|
title: Resolution Notes HTTP API
|
|
weight: 900
|
|
---
|
|
|
|
# Create a resolution note
|
|
|
|
```shell
|
|
curl "{{API_URL}}/api/v1/resolution_notes/" \
|
|
--request POST \
|
|
--header "Authorization: meowmeowmeow" \
|
|
--header "Content-Type: application/json" \
|
|
--data '{
|
|
"alert_group_id": "I68T24C13IFW1",
|
|
"text": "Demo resolution note"
|
|
}'
|
|
```
|
|
|
|
The above command returns JSON structured in the following way:
|
|
|
|
```json
|
|
{
|
|
"id": "M4BTQUS3PRHYQ",
|
|
"alert_group_id": "I68T24C13IFW1",
|
|
"author": "U4DNY931HHJS5",
|
|
"source": "web",
|
|
"created_at": "2020-06-19T12:40:01.429805Z",
|
|
"text": "Demo resolution note"
|
|
}
|
|
```
|
|
|
|
| Parameter | Required | Description |
|
|
| --------------- | :------: | :--------------------- |
|
|
| `alert_group_id`| Yes | Alert group ID | |
|
|
| `text` | Yes | Resolution note text |
|
|
|
|
**HTTP request**
|
|
|
|
`POST {{API_URL}}/api/v1/resolution_notes/`
|
|
|
|
# Get a resolution note
|
|
|
|
```shell
|
|
curl "{{API_URL}}/api/v1/resolution_notes/M4BTQUS3PRHYQ/" \
|
|
--request GET \
|
|
--header "Authorization: meowmeowmeow" \
|
|
--header "Content-Type: application/json"
|
|
```
|
|
|
|
The above command returns JSON structured in the following way:
|
|
|
|
```json
|
|
{
|
|
"id": "M4BTQUS3PRHYQ",
|
|
"alert_group_id": "I68T24C13IFW1",
|
|
"author": "U4DNY931HHJS5",
|
|
"source": "web",
|
|
"created_at": "2020-06-19T12:40:01.429805Z",
|
|
"text": "Demo resolution note"
|
|
}
|
|
```
|
|
|
|
**HTTP request**
|
|
|
|
`GET {{API_URL}}/api/v1/resolution_notes/<RESOLUTION_NOTE_ID>/`
|
|
|
|
# List resolution notes
|
|
|
|
```shell
|
|
curl "{{API_URL}}/api/v1/resolution_notes/" \
|
|
--request GET \
|
|
--header "Authorization: meowmeowmeow" \
|
|
--header "Content-Type: application/json"
|
|
```
|
|
|
|
The above command returns JSON structured in the following way:
|
|
|
|
```json
|
|
{
|
|
"count": 1,
|
|
"next": null,
|
|
"previous": null,
|
|
"results": [
|
|
{
|
|
"id": "M4BTQUS3PRHYQ",
|
|
"alert_group_id": "I68T24C13IFW1",
|
|
"author": "U4DNY931HHJS5",
|
|
"source": "web",
|
|
"created_at": "2020-06-19T12:40:01.429805Z",
|
|
"text": "Demo resolution note"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
The following available filter parameter should be provided as a `GET` argument:
|
|
|
|
- `alert_group_id`
|
|
|
|
**HTTP request**
|
|
|
|
`GET {{API_URL}}/api/v1/resolution_notes/`
|
|
|
|
# Update a resolution note
|
|
|
|
```shell
|
|
curl "{{API_URL}}/api/v1/resolution_notes/M4BTQUS3PRHYQ/" \
|
|
--request PUT \
|
|
--header "Authorization: meowmeowmeow" \
|
|
--header "Content-Type: application/json" \
|
|
--data '{
|
|
"text": "Demo resolution note updated"
|
|
}'
|
|
```
|
|
|
|
The above command returns JSON structured in the following way:
|
|
|
|
```json
|
|
{
|
|
"id": "M4BTQUS3PRHYQ",
|
|
"alert_group_id": "I68T24C13IFW1",
|
|
"author": "U4DNY931HHJS5",
|
|
"source": "web",
|
|
"created_at": "2020-06-19T12:40:01.429805Z",
|
|
"text": "Demo resolution note updated"
|
|
}
|
|
```
|
|
|
|
**HTTP request**
|
|
|
|
`PUT {{API_URL}}/api/v1/resolution_notes/<RESOLUTION_NOTE_ID>/`
|
|
|
|
# Delete a resolution note
|
|
|
|
```shell
|
|
curl "{{API_URL}}/api/v1/resolution_notes/M4BTQUS3PRHYQ/" \
|
|
--request DELETE \
|
|
--header "Authorization: meowmeowmeow"
|
|
```
|
|
|
|
**HTTP request**
|
|
|
|
`DELETE {{API_URL}}/api/v1/resolution_notes/<RESOLUTION_NOTE_ID>/`
|