Work Item Types Field - Get
詳細な参照を含む作業項目の種類のフィールドを取得します。
GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitemtypes/{type}/fields/{field}?api-version=7.1-preview.3
GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitemtypes/{type}/fields/{field}?$expand={$expand}&api-version=7.1-preview.3
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
field
|
path | True |
string |
|
organization
|
path | True |
string |
Azure DevOps 組織の名前です。 |
project
|
path | True |
string |
プロジェクト ID またはプロジェクト名 |
type
|
path | True |
string |
作業項目の種類。 |
api-version
|
query | True |
string |
使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.3' に設定する必要があります。 |
$expand
|
query |
API 応答のレベルを展開します。 プロパティ: allowedvalues、default value、isRequired などを含めます。応答の一部として。なし: これらのプロパティをスキップします。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
成功した操作 |
セキュリティ
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Scopes
名前 | 説明 |
---|---|
vso.work | 作業項目、クエリ、ボード、領域とイテレーションのパス、およびその他の作業項目追跡関連のメタデータを読み取る機能を付与します。 また、クエリを実行したり、作業項目を検索したり、サービス フックを介して作業項目イベントに関する通知を受信したりすることもできます。 |
例
Get project scoped work item type field data |
Get project scoped work item type field data with expand option |
Get project scoped work item type field data
Sample Request
GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitemtypes/Bug/fields/System.IterationPath?api-version=7.1-preview.3
Sample Response
{
"helpText": "The iteration within which this bug will be fixed",
"alwaysRequired": false,
"defaultValue": null,
"referenceName": "System.IterationPath",
"name": "Iteration Path",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath"
}
Get project scoped work item type field data with expand option
Sample Request
GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitemtypes/Bug/fields/System.ChangedBy?$expand=All&api-version=7.1-preview.3
Sample Response
{
"alwaysRequired": false,
"defaultValue": null,
"allowedValues": [
{
"displayName": "Jamal Hartnett",
"id": "df828ec3-71d8-6e69-9afd-e736c5a32145",
"uniqueName": "fabrikamfiber4@hotmail.com",
"descriptor": "s2s.M2FjODRhZmItYWIwNC00ZWM0LWEyZWItOGEyYWJmNGJlNDQ3QDcyZjk4OGJmLTg2ZjEtNCFhZi05MWFiLTJkN2NkMDExZGI0Nw"
},
{
"displayName": "Norman Paulk",
"id": "df828ec3-71d8-6e69-9afd-e736c5b32145",
"uniqueName": "Fabrikamfiber16@hotmail.com",
"descriptor": "s2s.M2FjODRhZmIeYWIwNC00ZWM0LWEyZWItOGEyYWJmNGJlNDQ3QDcyZjk4OGJmLTg2ZjEtNDFhZi05MWFiLTJkN2NkMDExZGI0Nw"
},
{
"displayName": "Chuck Reinhart",
"id": "df828ec3-71d8-6e69-9afd-g736c5a32145",
"uniqueName": "fabrikamfiber3@hotmail.com",
"descriptor": "s2s.M2FjODRhZmItYWIwNC00SWG0LWEyZWItOGEyYWJmNGJlNDQ3QDcyZjk4OGJmLTg2ZjEtNDFhZi05MWFiLTJkN2NkMDExZGI0Nw"
}
],
"dependentFields": [],
"referenceName": "System.ChangedBy",
"name": "Changed By",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.ChangedBy"
}
定義
名前 | 説明 |
---|---|
Work |
作業項目のフィールドへの参照 |
Work |
API 応答のレベルを展開します。 プロパティ: allowedvalues、default value、isRequired などを含めます。応答の一部として。なし: これらのプロパティをスキップします。 |
Work |
詳細な参照を含む workItemype の Field インスタンス。 |
WorkItemFieldReference
作業項目のフィールドへの参照
名前 | 型 | 説明 |
---|---|---|
name |
string |
フィールドのフレンドリ名。 |
referenceName |
string |
フィールドの参照名。 |
url |
string |
リソースの REST URL。 |
WorkItemTypeFieldsExpandLevel
API 応答のレベルを展開します。 プロパティ: allowedvalues、default value、isRequired などを含めます。応答の一部として。なし: これらのプロパティをスキップします。
名前 | 型 | 説明 |
---|---|---|
all |
string |
フィールドの許可された値と依存フィールドが含まれます。 |
allowedValues |
string |
フィールドに使用できる値が含まれます。 |
dependentFields |
string |
フィールドの依存フィールドが含まれます。 |
none |
string |
フィールドの基本プロパティのみが含まれます。 |
WorkItemTypeFieldWithReferences
詳細な参照を含む workItemype の Field インスタンス。
名前 | 型 | 説明 |
---|---|---|
allowedValues |
object[] |
フィールドで使用できる値の一覧。 |
alwaysRequired |
boolean |
フィールド値が常に必要かどうかを示します。 |
defaultValue |
object |
フィールドの既定値を表します。 |
dependentFields |
依存フィールドの一覧。 |
|
helpText |
string |
フィールドのヘルプ テキストを取得します。 |
name |
string |
フィールドのフレンドリ名。 |
referenceName |
string |
フィールドの参照名。 |
url |
string |
リソースの REST URL。 |