Fields - Update

참조

Service:: Work Item Tracking

API Version:: 7.1-preview.3

필드를 업데이트합니다.

PATCH https://dev.azure.com/{organization}/{project}/_apis/wit/fields/{fieldNameOrRefName}?api-version=7.1-preview.3

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
fieldNameOrRefName	path	True	string	업데이트할 필드의 이름/참조 이름
organization	path	True	string	Azure DevOps 조직의 이름입니다.
project	path		string	프로젝트 ID 또는 프로젝트 이름
api-version	query	True	string	사용할 API의 버전입니다. 이 버전의 api를 사용하려면 '7.1-preview.3'으로 설정해야 합니다.

요청 본문

Name	형식	Description
isDeleted	boolean	사용자가 필드를 복원할지 여부를 나타냅니다.
isLocked	boolean	사용자가 필드를 잠글지 여부를 나타냅니다.

응답

Name	형식	Description
200 OK	WorkItemField2	성공적인 작업

보안

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_write	작업 항목 및 쿼리를 읽고, 만들고, 업데이트하고, 보드 메타데이터를 업데이트하고, 읽기 영역 및 반복 경로를 다른 작업 항목 추적 관련 메타데이터를 추적하고, 쿼리를 실행하고, 서비스 후크를 통해 작업 항목 이벤트에 대한 알림을 받을 수 있는 기능을 부여합니다.

예제

Set field locked

Undelete a field

Set field locked

Sample Request

HTTP

PATCH https://dev.azure.com/{organization}/_apis/wit/fields/{fieldNameOrRefName}?api-version=7.1-preview.3

{
  "isLocked": true
}

Sample Response

Status code:: 200

persistent-Auth: true
lfs-Authenticate: NTLM
wwW-Authenticate: Negotiate oRswGaADCgEAoxIEEAEAAAAMDzOy0XQtlQAAAAA=

Response Body

{
  "name": "New Work Item Field3",
  "referenceName": "Custom.TestField",
  "description": "New work item field for testing",
  "type": "string",
  "usage": "workItem",
  "readOnly": false,
  "canSortBy": true,
  "isQueryable": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    {
      "referenceName": "SupportedOperations.NotEquals",
      "name": "<>"
    },
    {
      "referenceName": "SupportedOperations.GreaterThan",
      "name": ">"
    },
    {
      "referenceName": "SupportedOperations.LessThan",
      "name": "<"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEquals",
      "name": ">="
    },
    {
      "referenceName": "SupportedOperations.LessThanEquals",
      "name": "<="
    },
    {
      "referenceName": "SupportedOperations.Contains",
      "name": "Contains"
    },
    {
      "referenceName": "SupportedOperations.NotContains",
      "name": "Does Not Contain"
    },
    {
      "referenceName": "SupportedOperations.In",
      "name": "In"
    },
    {
      "name": "Not In"
    },
    {
      "referenceName": "SupportedOperations.InGroup",
      "name": "In Group"
    },
    {
      "referenceName": "SupportedOperations.NotInGroup",
      "name": "Not In Group"
    },
    {
      "referenceName": "SupportedOperations.Ever",
      "name": "Was Ever"
    },
    {
      "referenceName": "SupportedOperations.EqualsField",
      "name": "= [Field]"
    },
    {
      "referenceName": "SupportedOperations.NotEqualsField",
      "name": "<> [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanField",
      "name": "> [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanField",
      "name": "< [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEqualsField",
      "name": ">= [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanEqualsField",
      "name": "<= [Field]"
    }
  ],
  "isIdentity": false,
  "isPicklist": false,
  "isLocked": true,
  "isPicklistSuggested": false,
  "url": "http://localhost/DefaultCollection/_apis/wit/fields/Custom.TestField"
}

Undelete a field

Sample Request

HTTP

PATCH https://dev.azure.com/{organization}/_apis/wit/fields/{fieldNameOrRefName}?api-version=7.1-preview.3

{
  "isDeleted": false
}

Sample Response

Status code:: 200

persistent-Auth: true
lfs-Authenticate: NTLM
wwW-Authenticate: Negotiate oRswGaADCgEAoxIEEAEAAAAMDzOy0XQtlQAAAAA=

Response Body

{
  "name": "New Work Item Field3",
  "referenceName": "Custom.TestField",
  "description": "New work item field for testing",
  "type": "string",
  "usage": "workItem",
  "readOnly": false,
  "canSortBy": true,
  "isQueryable": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    {
      "referenceName": "SupportedOperations.NotEquals",
      "name": "<>"
    },
    {
      "referenceName": "SupportedOperations.GreaterThan",
      "name": ">"
    },
    {
      "referenceName": "SupportedOperations.LessThan",
      "name": "<"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEquals",
      "name": ">="
    },
    {
      "referenceName": "SupportedOperations.LessThanEquals",
      "name": "<="
    },
    {
      "referenceName": "SupportedOperations.Contains",
      "name": "Contains"
    },
    {
      "referenceName": "SupportedOperations.NotContains",
      "name": "Does Not Contain"
    },
    {
      "referenceName": "SupportedOperations.In",
      "name": "In"
    },
    {
      "name": "Not In"
    },
    {
      "referenceName": "SupportedOperations.InGroup",
      "name": "In Group"
    },
    {
      "referenceName": "SupportedOperations.NotInGroup",
      "name": "Not In Group"
    },
    {
      "referenceName": "SupportedOperations.Ever",
      "name": "Was Ever"
    },
    {
      "referenceName": "SupportedOperations.EqualsField",
      "name": "= [Field]"
    },
    {
      "referenceName": "SupportedOperations.NotEqualsField",
      "name": "<> [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanField",
      "name": "> [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanField",
      "name": "< [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEqualsField",
      "name": ">= [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanEqualsField",
      "name": "<= [Field]"
    }
  ],
  "isIdentity": false,
  "isPicklist": false,
  "isPicklistSuggested": false,
  "url": "http://localhost/DefaultCollection/_apis/wit/fields/Custom.TestField"
}

정의

Name	Description
FieldType	필드의 형식입니다.
FieldUpdate	작업 항목 필드에 대한 업데이트 요청을 설명합니다.
FieldUsage	필드의 사용법입니다.
ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
WorkItemField2	작업 항목의 필드와 해당 작업 항목 유형과 관련된 속성에 대해 설명합니다.
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	이중 선택 목록 필드 형식입니다. REST API에서 이중 선택 목록 필드를 만들 때는 "Double" FieldType을 사용합니다.
picklistInteger	string	정수 선택 목록 필드 형식입니다. REST API에서 정수 선택 목록 필드를 만들 때는 "Integer" FieldType을 사용합니다.
picklistString	string	문자열 선택 목록 필드 형식입니다. REST API에서 문자열 선택 목록 필드를 만들 때 "String" FieldType을 사용합니다.
plainText	string	일반 텍스트 필드 형식입니다.
string	string	문자열 필드 형식입니다.
treePath	string	Treepath 필드 형식입니다.

FieldUpdate

작업 항목 필드에 대한 업데이트 요청을 설명합니다.

Name	형식	Description
isDeleted	boolean	사용자가 필드를 복원할지 여부를 나타냅니다.
isLocked	boolean	사용자가 필드를 잠글지 여부를 나타냅니다.

FieldUsage

필드의 사용법입니다.

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

ReferenceLinks

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

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

WorkItemField2

작업 항목의 필드와 해당 작업 항목 유형과 관련된 속성에 대해 설명합니다.

Name	형식	Description
_links	ReferenceLinks	관련 REST 리소스에 대한 참조를 연결합니다.
canSortBy	boolean	서버 쿼리에서 필드를 정렬할 수 있는지 여부를 나타냅니다.
description	string	필드에 대한 설명입니다.
isDeleted	boolean	이 필드가 삭제되었는지 여부를 나타냅니다.
isIdentity	boolean	이 필드가 ID 필드인지 여부를 나타냅니다.
isLocked	boolean	이 필드가 편집을 위해 잠긴 것으로 표시되는지 여부를 나타냅니다.
isPicklist	boolean	이 instance 선택 목록인지 여부를 나타냅니다.
isPicklistSuggested	boolean	이 instance 제안된 선택 목록인지 여부를 나타냅니다.
isQueryable	boolean	서버에서 필드를 쿼리할 수 있는지 여부를 나타냅니다.
name	string	필드의 이름입니다.
picklistId	string	이 필드가 선택 목록인 경우 연결된 선택 목록의 식별자이고, 그렇지 않으면 null입니다.
readOnly	boolean	필드가 [읽기 전용]인지 여부를 나타냅니다.
referenceName	string	필드의 참조 이름입니다.
supportedOperations	WorkItemFieldOperation[]	이 필드에서 지원되는 작업입니다.
type	FieldType	필드의 형식입니다.
url	string
usage	FieldUsage	필드의 사용법입니다.

WorkItemFieldOperation

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

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

Fields - Update

URI 매개 변수

요청 본문

응답

보안

oauth2

Scopes

예제

Set field locked

Sample Request

Sample Response

Undelete a field

Sample Request

Sample Response

정의

FieldType

FieldUpdate

FieldUsage

ReferenceLinks

WorkItemField2

WorkItemFieldOperation

피드백

추가 리소스