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_notification	SendNotificationRequest	google.protobuf.Empty
delete	PostRequest	google.protobuf.Empty
get	GetPostRequest	PostInfo
list	PostQuery	PostsInfo
stat	PostStatQuery	google.protobuf.Struct

create

POST /board/v1/board/{board_id}/posts

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.

Type	Message
Request	CreatePostRequest
Response	PostInfo

Request Example

{
    "board_id": "board-123456789012",
    "category": "developer",
    "title": "title",
    "contents": "This is contents.",
    "options": {
        "is_popup": true
    },
    "writer": "user1",
    "domain_id": "domain-123456789012"
}

Response Example

{
    "board_id": "board-123456789012",
    "post_id": "post-123456789012",
    "category": "developer",
    "title": "title",
    "contents": "This is contents.",
    "options": {
        "is_pinned": false,
        "is_popup": true
    },
    "view_count": 0,
    "writer": "user1",
    "scope": "DOMAIN",
    "domain_id": "domain-123456789012",
    "user_id": "[e-mail]",
    "created_at": "2022-01-01T01:06:23.732Z",
    "updated_at": "2022-01-01T01:06:23.732Z"
}

update

PUT /board/v1/board/{board_id}/post/{post_id}

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

Type	Message
Request	UpdatePostRequest
Response	PostInfo

Request Example

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

Response Example

{
    "board_id": "board-123456789012",
    "post_id": "post-123456789012",
    "category": "developer",
    "title": "title2",
    "contents": "this is contents2.",
    "options": {
        "is_popup": false,
        "is_pinned": true
    },
    "view_count": 1,
    "writer": "user1",
    "scope": "DOMAIN",
    "domain_id": "domain-123456789012",
    "user_id": "[e-mail]",
    "created_at": "2022-06-13T01:06:23.732Z",
    "updated_at": "2022-06-13T01:06:23.732Z"
}

send_notification

POST /board/v1/board/{board_id}/post/{post_id}/send-notification

Not Implemented

Type	Message
Request	SendNotificationRequest
Response	google.protobuf.Empty

delete

DELETE /board/v1/board/{board_id}/post/{post_id}

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.

Type	Message
Request	PostRequest
Response	google.protobuf.Empty

Request Example

{
    "board_id": "board-b9aa34e65c60",
    "post_id": "post-2118473ce15e",
    "domain_id": "domain-123456789012"
}

get

GET /board/v1/board/{board_id}/post/{post_id}

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.

Type	Message
Request	GetPostRequest
Response	PostInfo

Request Example

{
    "board_id": "board-b9aa34e65c60",
    "post_id": "post-2118473ce15e",
    "domain_id": "domain-58010aa2e451"
}

Response Example

{
    "board_id": "board-b9aa34e65c60",
    "post_id": "post-2118473ce15e",
    "category": "flower",
    "title": "title",
    "contents": "this is contents.",
    "options": {
        "is_pinned": false,
        "is_popup": true
    },
    "view_count": 2,
    "writer": "seolmin",
    "scope": "DOMAIN",
    "domain_id": "domain-58010aa2e451",
    "user_id": "supervisor",
    "created_at": "2022-06-13T01:06:23.732Z",
    "updated_at": "2022-06-13T01:06:23.732Z"
}

list

GET /board/v1/board/{board_id}/posts

POST /board/v1/board/{board_id}/posts/search

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

Type	Message
Request	PostQuery
Response	PostsInfo

Request Example

{
    "board_id": "board-b9aa34e65c60",
    "query": {}
}

Response Example

{
    "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",
            "scope": "DOMAIN",
            "domain_id": "domain-58010aa2e451",
            "user_id": "[e-mail]",
            "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": "\uc791\uc5c5\uacf5\uc9c0",
            "contents": "This is description",
            "options": {
                "is_pinned": true,
                "is_popup": true
            },
            "writer": "\uad8c\uc124\ubbfc",
            "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/board/{board_id}/posts/stat

Type	Message
Request	PostStatQuery
Response	google.protobuf.Struct

Message

CreatePostRequest

Field	Type	Required	Description
board_id	string	✔
category	string	✘
title	string	✔
contents	string	✔
options	google.protobuf.Struct	✘
writer	string	✘
domain_id	string	✘

GetPostRequest

Field	Type	Required	Description
board_id	string	✔
post_id	string	✔
only	list of string	✘
domain_id	string	✘

PostInfo

Field	Type	Description
board_id	string
post_id	string
category	string
title	string
contents	string
options	google.protobuf.Struct
view_count	int32
writer	string
scope	SYSTEM DOMAIN
domain_id	string
user_id	string
user_domain_id	string
created_at	string
updated_at	string

PostQuery

Field	Type	Required	Description
board_id	string	✔
post_id	string	✘
category	string	✘
writer	string	✘
user_id	string	✘
user_domain_id	string	✘
domain_id	string	✘
query	spaceone.api.core.v1.Query	✘

PostRequest

Field	Type	Required	Description
board_id	string	✔
post_id	string	✔
domain_id	string	✘

PostStatQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.StatisticsQuery	✔
domain_id	string	✔

PostsInfo

Field	Type	Description
results	list of PostInfo
total_count	int32

SendNotificationRequest

Field	Type	Required	Description
board_id	string	✔
post_id	string	✔
domain_id	string	✘

UpdatePostRequest

Field	Type	Required	Description
board_id	string	✔
post_id	string	✔
category	string	✘
title	string	✘
contents	string	✘
options	google.protobuf.Struct	✘
writer	string	✘
domain_id	string	✘