Edit

Share via

WorkItemField2 interface

  • Reference
Package:
azure-devops-extension-api

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

Extends
WorkItemField

Properties

isLocked

Indicates whether this field is marked as locked for editing.

Inherited 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.
url

REST URL for the resource.
usage

The usage of the field.

Property Details

isLocked

Indicates whether this field is marked as locked for editing.

isLocked: boolean

Property Value

boolean

Inherited Property Details

canSortBy

Indicates whether the field is sortable in server queries.

canSortBy: boolean

Property Value

boolean

Inherited From WorkItemField.canSortBy

description

The description of the field.

description: string

Property Value

string

Inherited From WorkItemField.description

isDeleted

Indicates whether this field is deleted.

isDeleted: boolean

Property Value

boolean

Inherited From WorkItemField.isDeleted

isIdentity

Indicates whether this field is an identity field.

isIdentity: boolean

Property Value

boolean

Inherited From WorkItemField.isIdentity

isPicklist

Indicates whether this instance is picklist.

isPicklist: boolean

Property Value

boolean

Inherited From WorkItemField.isPicklist

isPicklistSuggested

Indicates whether this instance is a suggested picklist .

isPicklistSuggested: boolean

Property Value

boolean

Inherited From WorkItemField.isPicklistSuggested

isQueryable

Indicates whether the field can be queried in the server.

isQueryable: boolean

Property Value

boolean

Inherited From WorkItemField.isQueryable

name

The name of the field.

name: string

Property Value

string

Inherited From WorkItemField.name

picklistId

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

picklistId: string

Property Value

string

Inherited From WorkItemField.picklistId

readOnly

Indicates whether the field is [read only].

readOnly: boolean

Property Value

boolean

Inherited From WorkItemField.readOnly

referenceName

The reference name of the field.

referenceName: string

Property Value

string

Inherited From WorkItemField.referenceName

supportedOperations

The supported operations on this field.

supportedOperations: WorkItemFieldOperation[]

Property Value

WorkItemFieldOperation[]

Inherited From WorkItemField.supportedOperations

type

The type of the field.

type: FieldType

Property Value

FieldType

Inherited From WorkItemField.type

url

REST URL for the resource.

url: string

Property Value

string

Inherited From WorkItemField.url

usage

The usage of the field.

usage: FieldUsage

Property Value

FieldUsage

Inherited From WorkItemField.usage