发现项目结构
本页介绍如何查询所有信息以了解项目的配置。
项目信息
获取可用项目列表
GET /v3/projects 端点将返回可供用户访问的项目引用列表。
响应示例：
[
{
"id": 1,
"name": "Intland Software's Scrum Template",
"type": "ProjectReference"
},
...
]
{
"id": 1,
"name": "Intland Software's Scrum Template",
"type": "ProjectReference"
},
...
]
获取有关特定项目的详细信息
GET /v3/projects/{projectId} 将返回项目的详细信息。
响应示例：
{
"id": 1,
"name": "Intland Software's Scrum Template",
"description": "Agile-Scrum Project Template",
"descriptionFormat": "Wiki",
"version": 1,
"keyName": "ASCRUMT",
"closed": false,
"deleted": false,
"template": true,
"createdAt": "2020-08-04T10:52:45.639",
"createdBy": {
"id": 1,
"name": "bond",
"type": "UserReference"
}
}
"id": 1,
"name": "Intland Software's Scrum Template",
"description": "Agile-Scrum Project Template",
"descriptionFormat": "Wiki",
"version": 1,
"keyName": "ASCRUMT",
"closed": false,
"deleted": false,
"template": true,
"createdAt": "2020-08-04T10:52:45.639",
"createdBy": {
"id": 1,
"name": "bond",
"type": "UserReference"
}
}
按给定条件搜索项目
POST /v3/projects/search 将返回符合特定条件的所有项目。
如果使用项目部署功能，这可能非常有用，因为项目 ID 可能会在此类部署期间发生变更。
请求正文示例：
{
"keyName": "ASCRUMT"
}
"keyName": "ASCRUMT"
}
响应示例：
{
"page": 1,
"pageSize": 1,
"total": 1,
"projects": [
{
"id": 25,
"name": "Intland Software's Scrum Template",
"description": "Agile-Scrum Project Template",
"descriptionFormat": "Wiki",
"version": 1,
"keyName": "ASCRUMT",
"closed": false,
"deleted": false,
"template": true,
"createdAt": "2020-08-04T10:52:45.639",
"createdBy": {
"id": 1,
"name": "bond",
"type": "UserReference"
}
}
]
}
"page": 1,
"pageSize": 1,
"total": 1,
"projects": [
{
"id": 25,
"name": "Intland Software's Scrum Template",
"description": "Agile-Scrum Project Template",
"descriptionFormat": "Wiki",
"version": 1,
"keyName": "ASCRUMT",
"closed": false,
"deleted": false,
"template": true,
"createdAt": "2020-08-04T10:52:45.639",
"createdBy": {
"id": 1,
"name": "bond",
"type": "UserReference"
}
}
]
}
跟踪器信息
获取特定项目中的跟踪器列表
GET /v3/projects/{projectId}/trackers 将返回特定项目包含的跟踪器引用列表。
响应示例：
[
{
"id": 4304,
"name": "Releases",
"type": "TrackerReference"
},
{
"id": 4305,
"name": "User Stories",
"type": "TrackerReference"
},
{
"id": 4306,
"name": "Epics",
"type": "TrackerReference"
},
...
]
{
"id": 4304,
"name": "Releases",
"type": "TrackerReference"
},
{
"id": 4305,
"name": "User Stories",
"type": "TrackerReference"
},
{
"id": 4306,
"name": "Epics",
"type": "TrackerReference"
},
...
]
获取有关特定跟踪器的详细信息
GET /v3/trackers/{trackerId} 将返回有关特定跟踪器的详细信息。
响应示例：
{
"id": 4304,
"name": "Releases",
"descriptionFormat": "PlainText",
"keyName": "RELEASE",
"version": 1,
"createdAt": "2020-08-04T10:53:47.281",
"createdBy": {
"id": 1,
"name": "bond",
"type": "UserReference"
},
"type": {
"id": 103,
"name": "Release",
"type": "TrackerTypeReference"
},
"deleted": false,
"hidden": false,
"usingWorkflow": true,
"onlyWorkflowCanCreateNewReferringItem": false,
"usingQuickTransitions": false,
"defaultShowAncestorItems": false,
"defaultShowDescendantItems": false,
"project": {
"id": 25,
"name": "Intland Software's Scrum Template",
"type": "ProjectReference"
},
"availableAsTemplate": false
}
"id": 4304,
"name": "Releases",
"descriptionFormat": "PlainText",
"keyName": "RELEASE",
"version": 1,
"createdAt": "2020-08-04T10:53:47.281",
"createdBy": {
"id": 1,
"name": "bond",
"type": "UserReference"
},
"type": {
"id": 103,
"name": "Release",
"type": "TrackerTypeReference"
},
"deleted": false,
"hidden": false,
"usingWorkflow": true,
"onlyWorkflowCanCreateNewReferringItem": false,
"usingQuickTransitions": false,
"defaultShowAncestorItems": false,
"defaultShowDescendantItems": false,
"project": {
"id": 25,
"name": "Intland Software's Scrum Template",
"type": "ProjectReference"
},
"availableAsTemplate": false
}
搜索特定跟踪器类型
首先，需要使用 GET /v3/trackers/types 端点找出系统中定义的跟踪器类型。
响应示例：
[
{
"id": 1,
"name": "Issue",
"type": "TrackerTypeReference"
},
{
"id": 2,
"name": "Bug",
"type": "TrackerTypeReference"
},
{
"id": 3,
"name": "Change Request",
"type": "TrackerTypeReference"
},
...
{
"id": 103,
"name": "Release",
"type": "TrackerTypeReference"
},
...
]
{
"id": 1,
"name": "Issue",
"type": "TrackerTypeReference"
},
{
"id": 2,
"name": "Bug",
"type": "TrackerTypeReference"
},
{
"id": 3,
"name": "Change Request",
"type": "TrackerTypeReference"
},
...
{
"id": 103,
"name": "Release",
"type": "TrackerTypeReference"
},
...
]
使用正确的 TrackerTypeReference 可调用 POST /v3/projects/{projectId}/trackers/search 端点，以仅检索特定类型的跟踪器：
请求正文示例：
{
"types": [
{
"id": 2,
"name": "Bug",
"type": "TrackerTypeReference"
}
]
}
"types": [
{
"id": 2,
"name": "Bug",
"type": "TrackerTypeReference"
}
]
}
响应示例：
{
"page": 1,
"pageSize": 1,
"total": 1,
"trackers": [
{
"id": 4307,
"name": "Bugs",
"description": "Errors, flaws, faults in the software product",
"descriptionFormat": "Wiki",
"keyName": "BUG",
"version": 1,
"createdAt": "2020-08-04T10:53:47.281",
"createdBy": {
"id": 1,
"name": "bond",
"type": "UserReference"
},
"type": {
"id": 2,
"name": "Bug",
"type": "TrackerTypeReference"
},
"deleted": false,
"hidden": false,
"usingWorkflow": true,
"onlyWorkflowCanCreateNewReferringItem": false,
"usingQuickTransitions": false,
"defaultShowAncestorItems": false,
"defaultShowDescendantItems": false,
"project": {
"id": 25,
"name": "Intland Software's Scrum Template",
"type": "ProjectReference"
},
"availableAsTemplate": false
}
]
}
"page": 1,
"pageSize": 1,
"total": 1,
"trackers": [
{
"id": 4307,
"name": "Bugs",
"description": "Errors, flaws, faults in the software product",
"descriptionFormat": "Wiki",
"keyName": "BUG",
"version": 1,
"createdAt": "2020-08-04T10:53:47.281",
"createdBy": {
"id": 1,
"name": "bond",
"type": "UserReference"
},
"type": {
"id": 2,
"name": "Bug",
"type": "TrackerTypeReference"
},
"deleted": false,
"hidden": false,
"usingWorkflow": true,
"onlyWorkflowCanCreateNewReferringItem": false,
"usingQuickTransitions": false,
"defaultShowAncestorItems": false,
"defaultShowDescendantItems": false,
"project": {
"id": 25,
"name": "Intland Software's Scrum Template",
"type": "ProjectReference"
},
"availableAsTemplate": false
}
]
}
跟踪器字段信息
获取跟踪器字段
GET /v3/trackers/{trackerId}/fields 端点将返回跟踪器中的已配置字段引用。
响应示例：
[
{
"id": 0,
"name": "ID",
"type": "FieldReference",
"trackerId": 4307
},
{
"id": 1,
"name": "Tracker",
"type": "FieldReference",
"trackerId": 4307
},
{
"id": 2,
"name": "Priority",
"type": "FieldReference",
"trackerId": 4307
},
{
"id": 3,
"name": "Name",
"type": "FieldReference",
"trackerId": 4307
},
...
]
{
"id": 0,
"name": "ID",
"type": "FieldReference",
"trackerId": 4307
},
{
"id": 1,
"name": "Tracker",
"type": "FieldReference",
"trackerId": 4307
},
{
"id": 2,
"name": "Priority",
"type": "FieldReference",
"trackerId": 4307
},
{
"id": 3,
"name": "Name",
"type": "FieldReference",
"trackerId": 4307
},
...
]
获取有关特定跟踪器字段的详细信息
GET /v3/trackers/{trackerId}/fields/{fieldId} 将返回有关特定字段的详细信息。
响应示例：
{
"id": 14,
"name": "Severity",
"description": "VoCA (Voice of Customer Audit)",
"type": "OptionChoiceField",
"hidden": false,
"valueModel": "ChoiceFieldValue<ChoiceOptionReference>",
"mandatoryInStatuses": [
{
"id": 0,
"name": "Unset",
"type": "ChoiceOptionReference"
},
{
"id": 3,
"name": "New / Unassigned",
"type": "ChoiceOptionReference"
},
{
"id": 5,
"name": "In Verification",
"type": "ChoiceOptionReference"
},
{
"id": 7,
"name": "Closed",
"type": "ChoiceOptionReference"
},
{
"id": 8,
"name": "Open In Domain",
"type": "ChoiceOptionReference"
}
],
"multipleValues": false,
"options": [
{
"id": 0,
"name": "Unset",
"type": "ChoiceOptionReference"
},
{
"id": 1,
"name": "VoCA Prio 1",
"type": "ChoiceOptionReference"
},
{
"id": 2,
"name": "VoCA Prio 2",
"type": "ChoiceOptionReference"
},
{
"id": 7,
"name": "Not Applicable",
"type": "ChoiceOptionReference"
}
],
"trackerItemField": "severities",
"referenceType": "ChoiceOptionReference"
},
"id": 14,
"name": "Severity",
"description": "VoCA (Voice of Customer Audit)",
"type": "OptionChoiceField",
"hidden": false,
"valueModel": "ChoiceFieldValue<ChoiceOptionReference>",
"mandatoryInStatuses": [
{
"id": 0,
"name": "Unset",
"type": "ChoiceOptionReference"
},
{
"id": 3,
"name": "New / Unassigned",
"type": "ChoiceOptionReference"
},
{
"id": 5,
"name": "In Verification",
"type": "ChoiceOptionReference"
},
{
"id": 7,
"name": "Closed",
"type": "ChoiceOptionReference"
},
{
"id": 8,
"name": "Open In Domain",
"type": "ChoiceOptionReference"
}
],
"multipleValues": false,
"options": [
{
"id": 0,
"name": "Unset",
"type": "ChoiceOptionReference"
},
{
"id": 1,
"name": "VoCA Prio 1",
"type": "ChoiceOptionReference"
},
{
"id": 2,
"name": "VoCA Prio 2",
"type": "ChoiceOptionReference"
},
{
"id": 7,
"name": "Not Applicable",
"type": "ChoiceOptionReference"
}
],
"trackerItemField": "severities",
"referenceType": "ChoiceOptionReference"
},
id
字段的 ID。例如，此项可用于标识要修改值的字段。
name
字段的名称。
description
字段的说明。
type
。hidden
指示字段是否处于隐藏状态。
valueModel
在修改值时需要提供的模型名称。
mandatoryInStatuses
需要在跟踪器项中设置字段值的“状况”选项列表。
multipleValues
指示选择字段是否允许多个值。
options
选择选项字段的选项列表。
trackerItemField
如果该字段是内置字段 (表示该字段是所有跟踪器的公用字段)，则此特性指示 TrackerItem 模型中可设置该字段的位置。
referenceType
对于选择字段，此特性指示这些字段可接受的引用类型。
例如：
• 选择选项字段的 ChoiceOptionReference。
• 跟踪器项引用字段的 TrackerItemReference。
获取跟踪器字段的权限设置
GET /v3/trackers/{trackerId}/fields/{fieldId}/permissions 将返回特定字段的状况/角色/权限矩阵。
用户界面表示：
响应示例：
[
{
"status": {
"id": 0,
"name": "Unset",
"type": "ChoiceOptionReference"
},
"permissions": [
{
"role": {
"id": 1,
"name": "Project Admin",
"type": "RoleReference"
},
"field": null,
"project": null,
"accessLevel": "READ"
},
{
"role": {
"id": 2,
"name": "Developer",
"type": "RoleReference"
},
"field": null,
"project": null,
"accessLevel": "READ"
},
...
]
},
{
"status": {
"id": 1,
"name": "New",
"type": "ChoiceOptionReference"
},
"permissions": [
{
"role": {
"id": 1,
"name": "Project Admin",
"type": "RoleReference"
},
"field": null,
"project": null,
"accessLevel": "WRITE"
},
{
"role": {
"id": 2,
"name": "Developer",
"type": "RoleReference"
},
"field": null,
"project": null,
"accessLevel": "WRITE"
},
...
},
{
"status": {
"id": 2,
"name": "Verified",
"type": "ChoiceOptionReference"
},
"permissions": [ ... ]
},
{
"status": {
"id": 3,
"name": "In progress",
"type": "ChoiceOptionReference"
},
"permissions": [ ... ]
},
...
]
{
"status": {
"id": 0,
"name": "Unset",
"type": "ChoiceOptionReference"
},
"permissions": [
{
"role": {
"id": 1,
"name": "Project Admin",
"type": "RoleReference"
},
"field": null,
"project": null,
"accessLevel": "READ"
},
{
"role": {
"id": 2,
"name": "Developer",
"type": "RoleReference"
},
"field": null,
"project": null,
"accessLevel": "READ"
},
...
]
},
{
"status": {
"id": 1,
"name": "New",
"type": "ChoiceOptionReference"
},
"permissions": [
{
"role": {
"id": 1,
"name": "Project Admin",
"type": "RoleReference"
},
"field": null,
"project": null,
"accessLevel": "WRITE"
},
{
"role": {
"id": 2,
"name": "Developer",
"type": "RoleReference"
},
"field": null,
"project": null,
"accessLevel": "WRITE"
},
...
},
{
"status": {
"id": 2,
"name": "Verified",
"type": "ChoiceOptionReference"
},
"permissions": [ ... ]
},
{
"status": {
"id": 3,
"name": "In progress",
"type": "ChoiceOptionReference"
},
"permissions": [ ... ]
},
...
]