WorkItemField interface

Package:

azure-devops-extension-api

Describes a field on a work item and it's properties specific to that work item type.

Extends

WorkItemTrackingResource

Properties

canSortBy	Indicates whether the field is sortable in server queries.
description	The description of the field.
isDeleted	Indicates whether this field is deleted.
isIdentity	Indicates whether this field is an identity field.
isPicklist	Indicates whether this instance is picklist.
isPicklistSuggested	Indicates whether this instance is a suggested picklist .
isQueryable	Indicates whether the field can be queried in the server.
name	The name of the field.
picklistId	If this field is picklist, the identifier of the picklist associated, otherwise null
readOnly	Indicates whether the field is [read only].
referenceName	The reference name of the field.
supportedOperations	The supported operations on this field.
type	The type of the field.
usage	The usage of the field.

Inherited Properties

url	REST URL for the resource.

Property Details

canSortBy

Indicates whether the field is sortable in server queries.

canSortBy: boolean

Property Value

boolean

description

The description of the field.

description: string

Property Value

string

isDeleted

Indicates whether this field is deleted.

isDeleted: boolean

Property Value

boolean

isIdentity

Indicates whether this field is an identity field.

isIdentity: boolean

Property Value

boolean

isPicklist

Indicates whether this instance is picklist.

isPicklist: boolean

Property Value

boolean

isPicklistSuggested

Indicates whether this instance is a suggested picklist .

isPicklistSuggested: boolean

Property Value

boolean

isQueryable

Indicates whether the field can be queried in the server.

isQueryable: boolean

Property Value

boolean

name

The name of the field.

name: string

Property Value

string

picklistId

If this field is picklist, the identifier of the picklist associated, otherwise null

picklistId: string

Property Value

string

readOnly

Indicates whether the field is [read only].

readOnly: boolean

Property Value

boolean

referenceName

The reference name of the field.

referenceName: string

Property Value

string

supportedOperations

The supported operations on this field.

supportedOperations: WorkItemFieldOperation[]

Property Value

WorkItemFieldOperation[]

type

The type of the field.

type: FieldType

Property Value

FieldType

usage

The usage of the field.

usage: FieldUsage

Property Value

FieldUsage

Inherited Property Details

url

REST URL for the resource.

url: string

Property Value

string

Inherited From WorkItemTrackingResource.url