服務存取點與授權資訊
|
產品 |
資源 |
要求的權限 |
|
專案協作 |
專案 |
讀寫 |
請求文法
Region版
POST https://{domain}/oapi/v1/projex/projects要求標頭
|
參數 |
類型 |
是否必填 |
描述 |
樣本值 |
|
x-yunxiao-token |
string |
是 |
個人存取權杖。 |
pt-0fh3****0fbG_35af****0484 |
請求參數
|
參數 |
類型 |
位置 |
是否必填 |
描述 |
樣本值 |
| - |
object |
body |
否 |
||
|
customCode |
string |
body |
是 |
專案編號，四到六位大寫字母，組織下唯一。 |
CCDD |
|
customFieldValues |
object |
body |
否 |
格式為:{"fieldId":"value"}，多值 value 用逗號隔開，例如：{"fieldId": "value1,value2"}。例如：{"priority":"888853d622cc8eae793e085e27"}。fieldId 的可選值為"擷取專案模板"介面返回的欄位 type 值為 CustomField 的欄位，value 為希望更新的值。 |
{ |
|
description |
string |
body |
否 |
描述。 |
test |
|
name |
string |
body |
是 |
專案名稱。 |
project-test |
|
operatorId |
string |
body |
否 |
操作者的 userId，個人 token 時該參數無效。 |
user-xxx |
|
scope |
string |
body |
是 |
公開性, public or private，可能的值：[public, private]。 |
public |
|
templateId |
string |
body |
是 |
模板 id，可以通過擷取專案模版列表介面擷取。 |
template-test |
請求樣本
Region版
curl -X 'POST' \
'https://{domain}/oapi/v1/projex/projects' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
--data '
{
"customCode": "CCDD",
"customFieldValues": {
"priority": "888853d622cc8eae793e085e27"
},
"description": "test",
"name": "project-test",
"operatorId": "user-xxx",
"scope": "public",
"templateId": "template-test"
}'返回參數
|
參數 |
類型 |
描述 |
樣本值 |
| - |
object |
||
|
id |
string |
id。 |
1111 |
返回樣本
{
"id": "1111"
}錯誤碼
訪問錯誤碼中心查看 API 相關錯誤碼。