CustomFieldCreationInformation class
Contains the properties that can be set when creating a CustomField.
Syntax
CSOM
class CustomFieldCreationInformation
JSOM
PS.CustomFieldCreationInformation
REST Interface
Supported.
PS.CustomFieldCreationInformation
http://contoso.sharepoint.com/sites/pwa/api/ProjectServer/CustomFields/Add
POST Example (not all fields may be required)
body = {
'parameters': {
'Description':'value',
'EntityTypeId':'value',
'FieldType':'value',
'Formula':'value',
'Id':'value',
'IsEditableInVisibility':'value',
'IsMultilineText':'value',
'IsRequired':'value',
'IsWorkflowControlled':'value',
'LookupAllowMultiSelect':'value',
'LookupDefaultValue':'value',
'LookupTableId':'value',
'Name':'value'
}
Members
✓ - Read Support ✓ʷ - Write Support
Properties
Name | .NET | JSOM | REST | Type | Description |
---|---|---|---|---|---|
Description | ✓ʷ | ✓ʷ | ✓ʷ | String | Gets or sets the description of the custom field. |
EntityType | ✓ʷ | ✓ʷ | EntityType | Gets or sets the type of entity (project, task, or resource) for the custom field. | |
EntityTypeId | ✓ʷ | Guid | Gets or sets the type of entity type id(project, task, or resource) for the custom field. | ||
FieldType | ✓ʷ | ✓ʷ | ✓ʷ | CustomFieldType | Gets or sets the type of the custom field. |
Formula | ✓ʷ | ✓ʷ | ✓ʷ | String | Gets or sets the formula that calculates the value of a custom field. |
Id | ✓ʷ | ✓ʷ | ✓ʷ | Guid | Gets or sets the GUID of the custom field. |
IsEditableInVisibility | ✓ʷ | ✓ʷ | ✓ʷ | Boolean | Gets or sets a Boolean value that indicates whether the custom field value can be edited in project site Visibility mode. |
IsMultilineText | ✓ʷ | ✓ʷ | ✓ʷ | Boolean | Gets or sets a Boolean value that indicates whether a text custom field can contain multiple lines. |
IsRequired | ✓ʷ | ✓ʷ | ✓ʷ | Boolean | Gets or sets a Boolean value that indicates whether a value for the custom field is required when the entity (project, resource, or task) is created. |
IsWorkflowControlled | ✓ʷ | ✓ʷ | ✓ʷ | Boolean | Gets or sets a Boolean value that indicates whether the custom field value is controlled by a workflow. |
LookupAllowMultiSelect | ✓ʷ | ✓ʷ | ✓ʷ | Boolean | Gets or sets a Boolean value that indicate whether multiple lookup table values can be set for this custom field |
LookupDefaultValue | ✓ʷ | ✓ʷ | ✓ʷ | Guid | Gets or sets the GUID of the default lookup table value. |
LookupTable | ✓ʷ | ✓ʷ | LookupTable | Gets or sets the LookupTable object for a text custom field. | |
LookupTableId | ✓ʷ | Guid | Gets or sets the LookupTable Id for a text custom field. | ||
Name | ✓ʷ | ✓ʷ | ✓ʷ | String | Gets or sets the name of the custom field. |