跳转到内容
云词

项目

查询或修改项目

查询项目

GET /teams/{teamName}/projects

路径参数

  • Name
    teamName
    Type
    string
    Description

    团队标识

Terminal window
curl --request GET \
    --url https://api.yundict.com/teams/{teamName}/projects \
    --header "X-Api-Token: {token}" \
{
  "data": [
    {
      "name": "ProjectA"
    },
    {
      "name": "ProjectB"
    }
  ]
}

创建项目

POST /teams/{team_name}/projects

路径参数

  • Name
    teamName
    Type
    string
    Description

    团队标识

必选参数

  • Name
    name
    Type
    string
    Description
    项目标识
  • Name
    displayName
    Type
    string
    Description
    项目名称

可选参数

  • Name
    description
    Type
    string
    Description
    项目描述
  • Name
    baseLanguageISO
    Type
    string
    Description
    项目基础语种
  • Name
    languagesISO
    Type
    array
    Description
    项目语种列表
Terminal window
curl --request POST \
    --url https://api.yundict.com/teams/{teamName}/projects \
    --header "X-Api-Token: {token}" \
    --header "X-Api-Token: {token}" \
    --header 'Content-Type: application/json' \
    --data '
{
  "name": "my-project"
  "displayName": "My Project"
}
'
{
  "success": true
}

修改项目

PATCH /teams/{teamName}/projects/{projectName}

路径参数

  • Name
    teamName
    Type
    string
    Description
    团队标识，在团队设置页中可以查看
  • Name
    projectName
    Type
    string
    Description
    项目标识，在项目设置页中可以查看

可选参数

  • Name
    name
    Type
    string
    Description
    项目标识，可更新为新的值
  • Name
    displayName
    Type
    string
    Description
    项目名称
  • Name
    description
    Type
    string
    Description
    项目描述
  • Name
    baseLanguageISO
    Type
    string
    Description
    项目基础语种
  • Name
    languagesISO
    Type
    array
    Description
    项目语种列表
Terminal window
curl --request PATCH \
    --url https://api.yundict.com/teams/{teamName}/projects/{projectName} \
    --header "X-Api-Token: {token}" \
    --header "X-Api-Token: {token}" \
    --header 'Content-Type: application/json' \
    --data '
{
  "name": "my-team"
  "displayName": "My Team"
}
'
{
  "data": [
    {
      "name": "ProjectA"
    },
    {
      "name": "ProjectB"
    }
  ]
}

删除项目

DELETE /teams/{team_name}/projects/{project_name}

路径参数

  • Name
    teamName
    Type
    string
    Description

    团队唯一标识符

  • Name
    projectName
    Type
    string
    Description

    项目唯一标识符

Terminal window
curl --request DELETE \
     --url https://api.yundict.com/teams/{teamName}/{project_name} \
     --header 'X-Api-Token: {token}'
{
  "success": true
}