# Post

A Post is a message published on a Board. It also provides notifications to Projects affected by the Post.

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

\
\


## Post

**Post Methods:**

| Method                                                                                                       | Request                                                                                                                        | Response                                                                                                       |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------- |
| [**create**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#create) | [CreatePostRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#createpostrequest) | [PostInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#postinfo)   |
| [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#update) | [UpdatePostRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#updatepostrequest) | [PostInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#postinfo)   |
| [**send**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#send)     | [PostRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#postrequest)             | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#empty)         |
| [**delete**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#delete) | [PostRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#postrequest)             | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#empty)         |
| [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#get)       | [PostRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#postrequest)             | [PostInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#postinfo)   |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#list)     | [PostSearchQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#postsearchquery)     | [PostsInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#postsinfo) |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#stat)     | [PostStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#poststatquery)         | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/board/v1/Post/README.md#struct)       |

\


### create

Creates a new Post under a specific Board. You must specify the `board_id`, `title`, and `contents`. The parameter `category` is not required but can be set in the scope of `categories` specified in the parent Board. You can make the new Post pinned or pop up by adjusting the parameters.

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

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

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

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

* **board\_type** (string) `Required`
* **title** (string) `Required`
* **contents** (string) `Required`
* **resource\_group** (ResourceGroup) `Required`
* **category** (string)
* **files** (string) `Repeated`
* **options** (Struct)
* **writer** (string)
* **workspaces** (string) `Repeated`

\{{< highlight json >\}} { "board\_type": "NOTICE", "category": "developer", "title": "title", "contents": "This is contents.", "files": \["file-123456789012"], "options": {"is\_popup": true}, "writer": "user1", "resource\_group": "DOMAIN", } \{{< /highlight >\}} \{{< /tab >\}}

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

[PostInfo](#POSTINFO)

* **board\_type** (string) `Required`
* **post\_id** (string) `Required`
* **category** (string) `Required`
* **title** (string) `Required`
* **contents** (string) `Required`
* **options** (Struct) `Required`
* **view\_count** (int32) `Required`
* **writer** (string) `Required`
* **files** (ListValue) `Required`
* **resource\_group** (ResourceGroup) `Required`
* **domain\_id** (string) `Required`
* **workspaces** (string) `Repeated` `Required`
* **user\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

\{{< highlight json >\}} { "board\_type": "NOTICE", "post\_id": "post-123456789012", "category": "developer", "title": "title", "contents": "This is contents.", "options": { "is\_pinned": false, "is\_popup": true }, "view\_count": 0, "writer": "user1", "resource\_group": "DOMAIN", "domain\_id": "domain-123456789012", "user\_id": "user1@email.com", "created\_at": "2022-01-01T01:06:23.732Z", "updated\_at": "2022-01-01T01:06:23.732Z" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### update

Updates a specific Post. You can make changes in Post settings, except `board_id`, `post_id`, and `domain_id`.

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

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

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

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

* **post\_id** (string) `Required`
* **title** (string)
* **contents** (string)
* **category** (string)
* **files** (string) `Repeated`
* **options** (Struct)
* **writer** (string)
* **workspaces** (string) `Repeated`

\{{< highlight json >\}} { "post\_id": "post-2118473ce15e", "title": "title2", "contents": "this is contents2.", "category": "developer", "options": { "is\_popup": false, "is\_pinned": true }, "writer": "user1" } \{{< /highlight >\}} \{{< /tab >\}}

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

[PostInfo](#POSTINFO)

* **board\_type** (string) `Required`
* **post\_id** (string) `Required`
* **category** (string) `Required`
* **title** (string) `Required`
* **contents** (string) `Required`
* **options** (Struct) `Required`
* **view\_count** (int32) `Required`
* **writer** (string) `Required`
* **files** (ListValue) `Required`
* **resource\_group** (ResourceGroup) `Required`
* **domain\_id** (string) `Required`
* **workspaces** (string) `Repeated` `Required`
* **user\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

\{{< highlight json >\}} { "board\_type": "NOTICE", "post\_id": "post-123456789012", "category": "developer", "title": "title", "contents": "This is contents.", "options": { "is\_pinned": false, "is\_popup": true }, "view\_count": 0, "writer": "user1", "resource\_group": "DOMAIN", "domain\_id": "domain-123456789012", "user\_id": "user1@email.com", "created\_at": "2022-01-01T01:06:23.732Z", "updated\_at": "2022-01-01T01:06:23.732Z" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### send

Not Implemented

> **POST** /board/v1/post/send

\{{< tabs " send " >\}}

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

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

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

\{{< highlight json >\}} { "post\_id": "post-2118473ce15e" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### delete

Deletes a specific Post. You must specify the `post_id` of the Post to delete, and the `board_id` of the Board where the child Post to delete belongs.

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

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

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

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

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

\{{< highlight json >\}} { "post\_id": "post-2118473ce15e" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### get

Gets a specific Post. You must specify the `post_id` of the Post to get, and the `board_id` of the Board where the child Post to get belongs. Prints detailed information about the Post.

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

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

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

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

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

\{{< highlight json >\}} { "post\_id": "post-2118473ce15e" } \{{< /highlight >\}} \{{< /tab >\}}

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

[PostInfo](#POSTINFO)

* **board\_type** (string) `Required`
* **post\_id** (string) `Required`
* **category** (string) `Required`
* **title** (string) `Required`
* **contents** (string) `Required`
* **options** (Struct) `Required`
* **view\_count** (int32) `Required`
* **writer** (string) `Required`
* **files** (ListValue) `Required`
* **resource\_group** (ResourceGroup) `Required`
* **domain\_id** (string) `Required`
* **workspaces** (string) `Repeated` `Required`
* **user\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

\{{< highlight json >\}} { "board\_type": "NOTICE", "post\_id": "post-123456789012", "category": "developer", "title": "title", "contents": "This is contents.", "options": { "is\_pinned": false, "is\_popup": true }, "view\_count": 0, "writer": "user1", "resource\_group": "DOMAIN", "domain\_id": "domain-123456789012", "user\_id": "user1@email.com", "created\_at": "2022-01-01T01:06:23.732Z", "updated\_at": "2022-01-01T01:06:23.732Z" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### list

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

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

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

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

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

* **query** (Query)
* **board\_type** (string)
* **post\_id** (string)
* **category** (string)
* **writer** (string)
* **is\_pinned** (bool)
* **is\_popup** (bool)
* **domain\_id** (string)
* **workspace\_id** (string)

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

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

[PostsInfo](#POSTSINFO)

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

\{{< highlight json >\}} { "results": \[ { "board\_id": "board-b9aa34e65c60", "post\_id": "post-2118473ce15e", "category": "spaceone", "title": "title2", "contents": "this is contents2.", "options": { "is\_popup": false, "is\_pinned": true }, "view\_count": 3, "writer": "seolmin2", "files": \["file-123456789012"], "resource\_group": "DOMAIN", "domain\_id": "domain-58010aa2e451", "user\_id": "user1@email.com", "created\_at": "2022-06-13T01:06:23.732Z", "updated\_at": "2022-06-13T01:06:23.732Z" }, { "board\_id": "board-b9aa34e65c60", "post\_id": "post-532ae1191233", "category": "flower", "title": "작업공지", "contents": "This is description", "options": { "is\_pinned": true, "is\_popup": true }, "writer": "권설민", "files": \["file-123456789022"], "resource\_group": "DOMAIN", "user\_id": "supervisor", "created\_at": "2022-06-10T07:01:44.384Z", "updated\_at": "2022-06-10T07:01:44.384Z" } ], "total\_count": 2 } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### stat

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

\
\


## Message

### CreatePostRequest

* **board\_type** (string) `Required`
* **title** (string) `Required`
* **contents** (string) `Required`
* **resource\_group** (ResourceGroup) `Required`
* **category** (string)
* **files** (string) `Repeated`
* **options** (Struct)
* **writer** (string)
*   **workspaces** (string) `Repeated`

    \


### PostInfo

* **board\_type** (string) `Required`
* **post\_id** (string) `Required`
* **category** (string) `Required`
* **title** (string) `Required`
* **contents** (string) `Required`
* **options** (Struct) `Required`
* **view\_count** (int32) `Required`
* **writer** (string) `Required`
* **files** (ListValue) `Required`
* **resource\_group** (ResourceGroup) `Required`
* **domain\_id** (string) `Required`
* **workspaces** (string) `Repeated` `Required`
* **user\_id** (string) `Required`
* **created\_at** (string) `Required`
*   **updated\_at** (string) `Required`

    \


### PostRequest

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

    \


### PostSearchQuery

* **query** (Query)
* **board\_type** (string)
* **post\_id** (string)
* **category** (string)
* **writer** (string)
* **is\_pinned** (bool)
* **is\_popup** (bool)
* **domain\_id** (string)
*   **workspace\_id** (string)

    \


### PostStatQuery

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

    \


### PostsInfo

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

    \


### UpdatePostRequest

* **post\_id** (string) `Required`
* **title** (string)
* **contents** (string)
* **category** (string)
* **files** (string) `Repeated`
* **options** (Struct)
* **writer** (string)
*   **workspaces** (string) `Repeated`

    \
