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	CreateBoardRequest	BoardInfo
update	UpdateBoardRequest	BoardInfo
set_categories	SetBoardCategoriesRequest	BoardInfo
delete	BoardRequest	google.protobuf.Empty
get	GetBoardRequest	BoardInfo
list	BoardQuery	BoardsInfo
stat	BoardStatQuery	google.protobuf.Struct

create

POST /board/v1/boards

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.

Type	Message
Request	CreateBoardRequest
Response	BoardInfo

Request Example

{
    "name": "notice",
    "categories": [
        "admin",
        "developer",
        "devops"
    ],
    "tags": {
        "a": "b"
    }
}

Response Example

{
    "board_id": "board-123456789012",
    "name": "notice",
    "categories": [
        "admin",
        "developer",
        "devops"
    ],
    "tags": {
        "a": "b"
    },
    "created_at": "2022-01-01T06:47:27.759Z"
}

update

PUT /board/v1/board/{board_id}

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

Type	Message
Request	UpdateBoardRequest
Response	BoardInfo

Request Example

{
    "board_id": "board-123456789012",
    "name": "system notice",
    "tags": {
        "b": "c"
    }
}

Response Example

{
    "board_id": "board-123456789012",
    "name": "system notice",
    "categories": [
        "admin",
        "developer",
        "devops"
    ],
    "tags": {
        "b": "c"
    },
    "created_at": "2022-01-01T06:47:27.759Z"
}

set_categories

PUT /board/v1/board/{board_id}/set-categories

Type	Message
Request	SetBoardCategoriesRequest
Response	BoardInfo

delete

DELETE /board/v1/board/{board_id}

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

Type	Message
Request	BoardRequest
Response	google.protobuf.Empty

Request Example

{
    "board_id": "board-123456789012"
}

get

GET /board/v1/board/{board_id}

Type	Message
Request	GetBoardRequest
Response	BoardInfo

list

GET /board/v1/boards

POST /board/v1/boards/search

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

Type	Message
Request	BoardQuery
Response	BoardsInfo

Request Example

>{"query": {}}

Response Example

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

stat

POST /board/v1/boards/stat

Type	Message
Request	BoardStatQuery
Response	google.protobuf.Struct

Message

BoardInfo

Field	Type	Description
board_id	string
name	string
categories	list of string
tags	google.protobuf.Struct
created_at	string

BoardQuery

Field	Type	Required	Description
board_id	string	✘
name	string	✘
query	spaceone.api.core.v1.Query	✘

BoardRequest

Field	Type	Required	Description
board_id	string	✔

BoardStatQuery

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

BoardsInfo

Field	Type	Description
results	list of BoardInfo
total_count	int32

CreateBoardRequest

Field	Type	Required	Description
name	string	✔
categories	list of string	✘
tags	google.protobuf.Struct	✘

GetBoardRequest

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

SetBoardCategoriesRequest

Field	Type	Required	Description
board_id	string	✔
categories	list of string	✘

UpdateBoardRequest

Field	Type	Required	Description
board_id	string	✔
name	string	✘
tags	google.protobuf.Struct	✘