# Board

A Board is a bulletin-board-type resource for posting notices and announcements in Cloudforet.

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

\
\


## Board

**Board Methods:**

| Method                                                                                                                         | Request                                                                                                                                         | Response                                                                                                          |
| ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| [**create**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#create)                  | [CreateBoardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#createboardrequest)               | [BoardInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#boardinfo)   |
| [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#update)                  | [UpdateBoardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#updateboardrequest)               | [BoardInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#boardinfo)   |
| [**set\_categories**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#set_categories) | [SetBoardCategoriesRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#setboardcategoriesrequest) | [BoardInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#boardinfo)   |
| [**delete**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#delete)                  | [BoardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#boardrequest)                           | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#empty)           |
| [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#get)                        | [BoardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#boardrequest)                           | [BoardInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#boardinfo)   |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#list)                      | [BoardQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#boardquery)                               | [BoardsInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#boardsinfo) |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#stat)                      | [BoardStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#boardstatquery)                       | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#struct)         |

\


### create

Creates a new Board with SYSTEM permission. The `name` of the board is only required. You can add one or more `categories` representing the Board's attributes.

> **POST** /board/v1/board/create

\{{< tabs " create " >\}}

\{{< tab "Request Example" >\}}

[CreateBoardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#createboardrequest)

* **name** (string) `Required`
* **categories** (string) `Repeated`
* **tags** (Struct)

\{{< highlight json >\}} { "name": "notice", "categories": \["admin", "developer", "devops"], "tags": {"a": "b"} } \{{< /highlight >\}} \{{< /tab >\}}

\{{< tab "Response Example" >\}}

[BoardInfo](#BOARDINFO)

* **board\_id** (string) `Required`
* **name** (string) `Required`
* **categories** (string) `Repeated` `Required`
* **tags** (Struct) `Required`
* **created\_at** (string) `Required`

\{{< highlight json >\}} { "board\_id": "board-123456789012", "name": "notice", "categories": \[ "admin", "developer", "devops" ], "tags": { "a": "b" }, "created\_at": "2022-01-01T06:47:27.759Z" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### update

Updates a specific Board with SYSTEM permission. You can make changes in Board settings, including `name` and `tags`.

> **POST** /board/v1/board/update

\{{< tabs " update " >\}}

\{{< tab "Request Example" >\}}

[UpdateBoardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#updateboardrequest)

* **board\_id** (string) `Required`
* **name** (string)
* **tags** (Struct)

\{{< highlight json >\}} { "board\_id": "board-123456789012", "name": "system notice", "tags": {"b": "c"} } \{{< /highlight >\}} \{{< /tab >\}}

\{{< tab "Response Example" >\}}

[BoardInfo](#BOARDINFO)

* **board\_id** (string) `Required`
* **name** (string) `Required`
* **categories** (string) `Repeated` `Required`
* **tags** (Struct) `Required`
* **created\_at** (string) `Required`

\{{< highlight json >\}} { "board\_id": "board-123456789012", "name": "notice", "categories": \[ "admin", "developer", "devops" ], "tags": { "a": "b" }, "created\_at": "2022-01-01T06:47:27.759Z" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### set\_categories

Adds or changes `categories` of a specific Board with SYSTEM permission. A change in `categories` of a Board does not affect the `category` of the child Posts.

> **POST** /board/v1/board/set-categories

\{{< tabs " set\_categories " >\}}

\{{< tab "Request Example" >\}}

[SetBoardCategoriesRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#setboardcategoriesrequest)

* **board\_id** (string) `Required`
* **categories** (string) `Repeated`

\{{< highlight json >\}} { "board\_id": "board-123456789012", "categories": \["Developer", "SRE", "Devops"] } \{{< /highlight >\}} \{{< /tab >\}}

\{{< tab "Response Example" >\}}

[BoardInfo](#BOARDINFO)

* **board\_id** (string) `Required`
* **name** (string) `Required`
* **categories** (string) `Repeated` `Required`
* **tags** (Struct) `Required`
* **created\_at** (string) `Required`

\{{< highlight json >\}} { "board\_id": "board-123456789012", "name": "notice", "categories": \[ "admin", "developer", "devops" ], "tags": { "a": "b" }, "created\_at": "2022-01-01T06:47:27.759Z" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### delete

Deletes a specific Board with `SYSTEM` permission. You can delete a Board regardless of the presence of Posts created under the Board.

> **POST** /board/v1/board/delete

\{{< tabs " delete " >\}}

\{{< tab "Request Example" >\}}

[BoardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#boardrequest)

* **board\_id** (string) `Required`

\{{< highlight json >\}} { "board\_id": "board-123456789012" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### get

Gets a specific Board. You must specify the `board_id` of the Board to get. Prints detailed information about the Board, including `name`, `categories`.

> **POST** /board/v1/board/get

\{{< tabs " get " >\}}

\{{< tab "Request Example" >\}}

[BoardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#boardrequest)

* **board\_id** (string) `Required`

\{{< highlight json >\}} { "board\_id": "board-123456789012" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< tab "Response Example" >\}}

[BoardInfo](#BOARDINFO)

* **board\_id** (string) `Required`
* **name** (string) `Required`
* **categories** (string) `Repeated` `Required`
* **tags** (Struct) `Required`
* **created\_at** (string) `Required`

\{{< highlight json >\}} { "board\_id": "board-123456789012", "name": "notice", "categories": \[ "admin", "developer", "devops" ], "tags": { "a": "b" }, "created\_at": "2022-01-01T06:47:27.759Z" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### list

Gets a list of all Boards. You can use a query to get a filtered list of Boards.

> **POST** /board/v1/board/list

\{{< tabs " list " >\}}

\{{< tab "Request Example" >\}}

[BoardQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Board/README.md#boardquery)

* **query** (Query)
* **board\_id** (string)
* **name** (string)

\{{< highlight json >\}} { "query": {} } \{{< /highlight >\}} \{{< /tab >\}}

\{{< tab "Response Example" >\}}

[BoardsInfo](#BOARDSINFO)

* **results** (BoardInfo) `Repeated` `Required`
* **total\_count** (int32) `Required`

\{{< highlight json >\}} { "results": \[ { "board\_id": "board-123456789012", "name": "dev-notice", "categories": \[ "flower", "school", "spaceone" ], "tags": { "b": "c" }, "created\_at": "2022-01-01T05:16:08.549Z" }, { "board\_id": "board-987654321098", "name": "notice", "tags": { "a": "b" }, "created\_at": "2022-01-01T05:24:19.758Z" } ], "total\_count": 2 } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### stat

> **POST** /board/v1/board/stat

\
\


## Message

### BoardInfo

* **board\_id** (string) `Required`
* **name** (string) `Required`
* **categories** (string) `Repeated` `Required`
* **tags** (Struct) `Required`
*   **created\_at** (string) `Required`

    \


### BoardQuery

* **query** (Query)
* **board\_id** (string)
*   **name** (string)

    \


### BoardRequest

*   **board\_id** (string) `Required`

    \


### BoardStatQuery

*   **query** (StatisticsQuery) `Required`

    \


### BoardsInfo

* **results** (BoardInfo) `Repeated` `Required`
*   **total\_count** (int32) `Required`

    \


### CreateBoardRequest

* **name** (string) `Required`
* **categories** (string) `Repeated`
*   **tags** (Struct)

    \


### SetBoardCategoriesRequest

* **board\_id** (string) `Required`
*   **categories** (string) `Repeated`

    \


### UpdateBoardRequest

* **board\_id** (string) `Required`
* **name** (string)
*   **tags** (Struct)

    \
