Interface ProcessWorkItemTypeField

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

interface ProcessWorkItemTypeField {
    allowedValues?: any[];
    allowGroups?: boolean;
    customization?: CustomizationType;
    defaultValue?: any;
    description?: string;
    isLocked?: boolean;
    name?: string;
    readOnly?: boolean;
    referenceName?: string;
    required?: boolean;
    type?: FieldType;
    url?: string;
}

Properties

allowedValues? allowGroups? customization? defaultValue? description? isLocked? name? readOnly? referenceName? required? type? url?

Properties

OptionalallowedValues

allowedValues?: any[]

The list of field allowed values.

OptionalallowGroups

allowGroups?: boolean

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

Optionalcustomization

customization?: CustomizationType

Indicates the type of customization on this work item.

OptionaldefaultValue

defaultValue?: any

The default value of the field.

Optionaldescription

description?: string

Description of the field.

OptionalisLocked

isLocked?: boolean

Information about field definition being locked for editing

Optionalname

name?: string

Name of the field.

OptionalreadOnly

readOnly?: boolean

If true the field cannot be edited.

OptionalreferenceName

referenceName?: string

Reference name of the field.

Optionalrequired

required?: boolean

If true the field cannot be empty.

Optionaltype

type?: FieldType

Type of the field.

Optionalurl

url?: string

Resource URL of the field.

Settings

Member Visibility

On This Page

Properties