Interface WorkItemField

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

interface WorkItemField {
    _links?: any;
    canSortBy?: boolean;
    description?: string;
    isDeleted?: boolean;
    isIdentity?: boolean;
    isPicklist?: boolean;
    isPicklistSuggested?: boolean;
    isQueryable?: boolean;
    name?: string;
    picklistId?: string;
    readOnly?: boolean;
    referenceName?: string;
    supportedOperations?: WorkItemFieldOperation[];
    type?: FieldType;
    url?: string;
    usage?: FieldUsage;
}

Hierarchy (View Summary)

Properties

_links? canSortBy? description? isDeleted? isIdentity? isPicklist? isPicklistSuggested? isQueryable? name? picklistId? readOnly? referenceName? supportedOperations? type? url? usage?

Properties

Optional_links

_links?: any

Link references to related REST resources.

OptionalcanSortBy

canSortBy?: boolean

Indicates whether the field is sortable in server queries.

Optionaldescription

description?: string

The description of the field.

OptionalisDeleted

isDeleted?: boolean

Indicates whether this field is deleted.

OptionalisIdentity

isIdentity?: boolean

Indicates whether this field is an identity field.

OptionalisPicklist

isPicklist?: boolean

Indicates whether this instance is picklist.

OptionalisPicklistSuggested

isPicklistSuggested?: boolean

Indicates whether this instance is a suggested picklist .

OptionalisQueryable

isQueryable?: boolean

Indicates whether the field can be queried in the server.

Optionalname

name?: string

The name of the field.

OptionalpicklistId

picklistId?: string

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

OptionalreadOnly

readOnly?: boolean

Indicates whether the field is [read only].

OptionalreferenceName

referenceName?: string

The reference name of the field.

OptionalsupportedOperations

supportedOperations?: WorkItemFieldOperation[]

The supported operations on this field.

Optionaltype

type?: FieldType

The type of the field.

Optionalurl

url?: string

REST URL for the resource.

Optionalusage

usage?: FieldUsage

The usage of the field.

Settings

Member Visibility

On This Page

Properties