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	CreatePostRequest	PostInfo
update	UpdatePostRequest	PostInfo
send	PostRequest	Empty
delete	PostRequest	Empty
get	PostRequest	PostInfo
list	PostSearchQuery	PostsInfo
stat	PostStatQuery	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

Request Example

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

{
   "board_type": "NOTICE",
   "category": "developer",
   "title": "title",
   "contents": "This is contents.",
   "files": ["file-123456789012"],
   "options": {"is_popup": true},
   "writer": "user1",
   "resource_group": "DOMAIN",
}

Response Example

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

{
         "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"
}

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

Request Example

UpdatePostRequest

post_id (string) Required
title (string)
contents (string)
category (string)
files (string) Repeated
options (Struct)
writer (string)
workspaces (string) Repeated

{
     "post_id": "post-2118473ce15e",
     "title": "title2",
     "contents": "this is contents2.",
     "category": "developer",
     "options": {
         "is_popup": false,
         "is_pinned": true
     },
     "writer": "user1"
}

Response Example

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

{
         "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"
}

send #

Not Implemented

POST /board/v1/post/send

Request Example

PostRequest

post_id (string) Required

{
   "post_id": "post-2118473ce15e"
}

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

Request Example

PostRequest

post_id (string) Required

{
   "post_id": "post-2118473ce15e"
}

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

Request Example

PostRequest

post_id (string) Required

{
   "post_id": "post-2118473ce15e"
}

Response Example

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

{
         "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"
}

list #

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

POST /board/v1/post/list

Request Example

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)

{
   "query": {}
}

Response Example

PostsInfo

results (PostInfo) Repeated Required
total_count (int32) Required

{
     "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
}

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