WorkItemField interface
Describes a field on a work item and it's properties specific to that work item type.
- Extends
can |
Indicates whether the field is sortable in server queries. |
description | The description of the field. |
is |
Indicates whether this field is deleted. |
is |
Indicates whether this field is an identity field. |
is |
Indicates whether this instance is picklist. |
is |
Indicates whether this instance is a suggested picklist . |
is |
Indicates whether the field can be queried in the server. |
name | The name of the field. |
picklist |
If this field is picklist, the identifier of the picklist associated, otherwise null |
read |
Indicates whether the field is [read only]. |
reference |
The reference name of the field. |
supported |
The supported operations on this field. |
type | The type of the field. |
usage | The usage of the field. |
url | REST URL for the resource. |
Indicates whether the field is sortable in server queries.
canSortBy: boolean
Property Value
boolean
The description of the field.
description: string
Property Value
string
Indicates whether this field is deleted.
isDeleted: boolean
Property Value
boolean
Indicates whether this field is an identity field.
isIdentity: boolean
Property Value
boolean
Indicates whether this instance is picklist.
isPicklist: boolean
Property Value
boolean
Indicates whether this instance is a suggested picklist .
isPicklistSuggested: boolean
Property Value
boolean
Indicates whether the field can be queried in the server.
isQueryable: boolean
Property Value
boolean
The name of the field.
name: string
Property Value
string
If this field is picklist, the identifier of the picklist associated, otherwise null
picklistId: string
Property Value
string
Indicates whether the field is [read only].
readOnly: boolean
Property Value
boolean
The reference name of the field.
referenceName: string
Property Value
string
The supported operations on this field.
supportedOperations: WorkItemFieldOperation[]
Property Value
REST URL for the resource.
url: string
Property Value
string
Inherited From WorkItemTrackingResource.url