PingCodeRESTAPI

创建一个空间

POST

https://open.pingcode.com/v1/wiki/spaces

最后修改时间：2024-01-02 08:11:29

责任人：未设置

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

name

string

必需

空间的名称（不超过32个字符）。

identifier

string

必需

空间的标识。在一个企业中这个标识是唯一的。产品的标识由大写英文字母/数字/下划线/连接线组成（不超过15个字符）。

scope_type

string

必需

空间可见范围。允许值分别表示企业可见、团队可见和用户可见。 Allowed values: organization, user_group, user

visibility

string

可选

空间可见性。允许值分别表示组织全部成员可见和仅空间成员可见。 Allowed values: public, private

description

string

空间的描述。

可选

members

array [object {2}]

空间成员的列表。

可选

string

必需

企业成员或团队的id。

type

string

必需

空间成员类型。允许值: user, user_group

user_group_id

string

可选

空间所属团队id。当scope_type为user_group时，该字段必填

示例

{
  "name": "组织空间",
  "identifier": "ORGA",
  "scope_type": "organization",
  "description": "组织空间所属整个组织",
  "members": [
    {
      "id": "{{user_id}}",
      "type": "user"
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open.pingcode.com/v1/wiki/spaces' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "组织空间",
    "identifier": "ORGA",
    "scope_type": "organization",
    "description": "组织空间所属整个组织",
    "members": [
        {
            "id": "{user_id}",
            "type": "user"
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

{}

页面关注人

部分更新一个空间