ProcessWorkItemTypeField interface

Package:

azure-devops-extension-api

Class that describes a field in a work item type and its properties.

Properties

allowedValues	The list of field allowed values.
allowGroups	Allow setting field value to a group identity. Only applies to identity fields.
customization	Indicates the type of customization on this work item.
defaultValue	The default value of the field.
description	Description of the field.
isLocked	Information about field definition being locked for editing
name	Name of the field.
readOnly	If true the field cannot be edited.
referenceName	Reference name of the field.
required	If true the field cannot be empty.
type	Type of the field.
url	Resource URL of the field.

Property Details

allowedValues

The list of field allowed values.

allowedValues: any[]

Property Value

any[]

allowGroups

Allow setting field value to a group identity. Only applies to identity fields.

allowGroups: boolean

Property Value

boolean

customization

Indicates the type of customization on this work item.

customization: CustomizationType

Property Value

CustomizationType

defaultValue

The default value of the field.

defaultValue: any

Property Value

any

description

Description of the field.

description: string

Property Value

string

isLocked

Information about field definition being locked for editing

isLocked: boolean

Property Value

boolean

name

Name of the field.

name: string

Property Value

string

readOnly

If true the field cannot be edited.

readOnly: boolean

Property Value

boolean

referenceName

Reference name of the field.

referenceName: string

Property Value

string

required

If true the field cannot be empty.

required: boolean

Property Value

boolean

type

Type of the field.

type: FieldType

Property Value

FieldType

url

Resource URL of the field.

url: string

Property Value

string