# Note

> **Package : spaceone.api.monitoring.v1**

## Note

{% hint style="info" %}
**Note Methods:**
{% endhint %}

| NO | Method                | Request Type                            | Response Type                                                                                                      | Description |
| -- | --------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ----------- |
| 1  | [**create**](#create) | [CreateNoteRequest](#createnoterequest) | [NoteInfo](#noteinfo)                                                                                              |             |
| 2  | [**update**](#update) | [UpdateNoteRequest](#updatenoterequest) | [NoteInfo](#noteinfo)                                                                                              |             |
| 3  | [**delete**](#delete) | [NoteRequest](#noterequest)             | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto)   |             |
| 4  | [**get**](#get)       | [GetNoteRequest](#getnoterequest)       | [NoteInfo](#noteinfo)                                                                                              |             |
| 5  | [**list**](#list)     | [NoteQuery](#notequery)                 | [NotesInfo](#notesinfo)                                                                                            |             |
| 6  | [**stat**](#stat)     | [NoteStatQuery](#notestatquery)         | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |             |

### create

> **POST** /monitoring/v1/notes

| Type     | Message                                 |
| -------- | --------------------------------------- |
| Request  | [CreateNoteRequest](#createnoterequest) |
| Response | [NoteInfo](#noteinfo)                   |

### update

> **PUT** /monitoring/v1/note/{note\_id}

| Type     | Message                                 |
| -------- | --------------------------------------- |
| Request  | [UpdateNoteRequest](#updatenoterequest) |
| Response | [NoteInfo](#noteinfo)                   |

### delete

> **DELETE** /monitoring/v1/note/{note\_id}

| Type     | Message                                                                                                          |
| -------- | ---------------------------------------------------------------------------------------------------------------- |
| Request  | [NoteRequest](#noterequest)                                                                                      |
| Response | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto) |

### get

> **GET** /monitoring/v1/note/{note\_id}

| Type     | Message                           |
| -------- | --------------------------------- |
| Request  | [GetNoteRequest](#getnoterequest) |
| Response | [NoteInfo](#noteinfo)             |

### list

> **GET** /monitoring/v1/notes
>
> **POST** /monitoring/v1/notes/search

| Type     | Message                 |
| -------- | ----------------------- |
| Request  | [NoteQuery](#notequery) |
| Response | [NotesInfo](#notesinfo) |

### stat

> **POST** /monitoring/v1/notes/stat

| Type     | Message                                                                                                            |
| -------- | ------------------------------------------------------------------------------------------------------------------ |
| Request  | [NoteStatQuery](#notestatquery)                                                                                    |
| Response | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |

## Message

### CreateNoteRequest

| No | Field      | Type   | Required | Description |
| -- | ---------- | ------ | :------: | ----------- |
| 1  | alert\_id  | string |     ✅    |             |
| 2  | note       | string |     ✅    |             |
| 3  | domain\_id | string |     ✅    |             |

### GetNoteRequest

| No | Field      | Type           | Required | Description |
| -- | ---------- | -------------- | :------: | ----------- |
| 1  | note\_id   | string         |     ✅    |             |
| 2  | domain\_id | string         |     ✅    |             |
| 3  | only       | list of string |     ❌    |             |

### NoteInfo

| No | Field       | Type   | Description |
| -- | ----------- | ------ | ----------- |
| 1  | note\_id    | string |             |
| 2  | alert\_id   | string |             |
| 3  | note        | string |             |
| 4  | created\_by | string |             |
| 5  | project\_id | string |             |
| 6  | domain\_id  | string |             |
| 7  | created\_at | string |             |

### NoteQuery

| No | Field       | Type                                                                                               | Required | Description |
| -- | ----------- | -------------------------------------------------------------------------------------------------- | :------: | ----------- |
| 1  | query       | [spaceone.api.core.v1.Query](https://spaceone-dev.gitbook.io/api-reference/common-v1/search-query) |     ❌    |             |
| 2  | note\_id    | string                                                                                             |     ❌    |             |
| 3  | alert\_id   | string                                                                                             |     ❌    |             |
| 4  | created\_by | string                                                                                             |     ❌    |             |
| 5  | project\_id | string                                                                                             |     ❌    |             |
| 6  | domain\_id  | string                                                                                             |     ❌    |             |

### NoteRequest

| No | Field      | Type   | Required | Description |
| -- | ---------- | ------ | :------: | ----------- |
| 1  | note\_id   | string |     ✅    |             |
| 2  | domain\_id | string |     ✅    |             |

### NoteStatQuery

| No | Field      | Type                                                                                                             | Required | Description |
| -- | ---------- | ---------------------------------------------------------------------------------------------------------------- | :------: | ----------- |
| 1  | query      | [spaceone.api.core.v1.StatisticsQuery](https://spaceone-dev.gitbook.io/api-reference/common-v1/statistics-query) |     ✅    |             |
| 2  | domain\_id | string                                                                                                           |     ✅    |             |

### NotesInfo

| No | Field        | Type                                                                                            | Description |
| -- | ------------ | ----------------------------------------------------------------------------------------------- | ----------- |
| 1  | results      | [list of NoteInfo](#noteinfo)                                                                   |             |
| 2  | total\_count | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) |             |

### UpdateNoteRequest

| No | Field      | Type   | Required | Description |
| -- | ---------- | ------ | :------: | ----------- |
| 1  | note\_id   | string |     ✅    |             |
| 2  | note       | string |     ❌    |             |
| 3  | domain\_id | string |     ✅    |             |
