Fields - Get

참조

Service:: Work Item Tracking

API Version:: 4.1

특정 필드에 대한 정보를 가져옵니다.

GET https://{instance}/{collection}/{project}/_apis/wit/fields/{fieldNameOrRefName}?api-version=4.1

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
collection	path	True	string	Team Foundation Server 컬렉션의 이름입니다.
fieldNameOrRefName	path	True	string	필드 단순 이름 또는 참조 이름
instance	path	True	string	TFS 서버 이름({server:port})
project	path		string	프로젝트 ID 또는 프로젝트 이름
api-version	query	True	string	사용할 API의 버전입니다. 이 버전의 api를 사용하려면 '4.1'로 설정해야 합니다.

응답

Name	형식	Description
200 OK	WorkItemField	성공한 작업

보안

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

Name	Description
vso.work	작업 항목, 쿼리, 보드, 영역 및 반복 경로 및 기타 작업 항목 추적 관련 메타데이터를 읽을 수 있는 기능을 부여합니다. 또한 서비스 후크를 통해 쿼리를 실행하고 작업 항목 이벤트에 대한 알림을 받을 수 있는 기능을 부여합니다.

예제

Sample Request

HTTP

GET https://{instance}/{collection}/_apis/wit/fields/{fieldNameOrRefName}?api-version=4.1

Sample Response

Status code:: 200

{
  "name": "Iteration Path",
  "referenceName": "System.IterationPath",
  "type": "treePath",
  "readOnly": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Under",
      "name": "Under"
    },
    {
      "referenceName": "SupportedOperations.NotUnder",
      "name": "Not Under"
    },
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    {
      "referenceName": "SupportedOperations.NotEquals",
      "name": "<>"
    },
    {
      "referenceName": "SupportedOperations.In",
      "name": "In"
    }
  ],
  "url": "https://fabrikam:8080/tfs/_apis/wit/fields/System.IterationPath"
}

정의

Name	Description
FieldType	필드의 형식입니다.
FieldUsage	필드의 사용법입니다.
ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
WorkItemField	작업 항목의 필드를 설명하고 해당 작업 항목 유형과 관련된 속성입니다.
WorkItemFieldOperation	작업 항목 필드 작업을 설명합니다.

FieldType

필드의 형식입니다.

Name	형식	Description
boolean	string	부울 필드 형식입니다.
dateTime	string	날짜/시간 필드 형식입니다.
double	string	이중 필드 형식입니다.
guid	string	Guid 필드 형식입니다.
history	string	기록 필드 형식입니다.
html	string	HTML(여러 줄) 필드 형식입니다.
identity	string	ID 필드 형식입니다.
integer	string	정수 필드 형식입니다.
picklistDouble	string	이중 선택 목록 필드 형식입니다.
picklistInteger	string	정수 선택 목록 필드 형식입니다.
picklistString	string	문자열 선택 목록 필드 형식입니다.
plainText	string	일반 텍스트 필드 형식입니다.
string	string	문자열 필드 형식입니다.
treePath	string	트리 경로 필드 형식입니다.

FieldUsage

필드의 사용법입니다.

Name	형식	Description
none	string	빈 사용량.
tree	string	트리 노드 필드 사용.
workItem	string	작업 항목 필드 사용량.
workItemLink	string	작업 항목 링크 필드 사용.
workItemTypeExtension	string	작업 항목 유형 확장 사용.

ReferenceLinks

REST 참조 링크의 컬렉션을 나타내는 클래스입니다.

Name	형식	Description
links	object	링크의 읽기 전용 보기입니다. 참조 링크는 읽기 전용이므로 읽기 전용으로만 노출하려고 합니다.

WorkItemField

작업 항목의 필드를 설명하고 해당 작업 항목 유형과 관련된 속성입니다.

Name	형식	Description
_links	ReferenceLinks	관련 REST 리소스에 대한 참조를 연결합니다.
description	string	필드에 대한 설명입니다.
isIdentity	boolean	이 필드가 ID 필드인지 여부를 나타냅니다.
isPicklist	boolean	이 instance 선택 목록인지 여부를 나타냅니다.
isPicklistSuggested	boolean	이 instance 제안된 선택 목록인지 여부를 나타냅니다.
name	string	필드의 이름입니다.
readOnly	boolean	필드가 [읽기 전용]인지 여부를 나타냅니다.
referenceName	string	필드의 참조 이름입니다.
supportedOperations	WorkItemFieldOperation[]	이 필드에서 지원되는 작업입니다.
type	FieldType	필드의 형식입니다.
url	string
usage	FieldUsage	필드의 사용법입니다.

WorkItemFieldOperation

작업 항목 필드 작업을 설명합니다.

Name	형식	Description
name	string	작업의 이름입니다.
referenceName	string	작업의 참조 이름입니다.