customFieldDefinition resource type (planner)

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

A custom field defined on a plan, used to capture structured, plan-specific data on tasks. Choice options for single-choice and multiple-choice fields are contained under choiceOptions; values are set per task via customFieldValue.

Inherits from plannerDelta.

Methods

Method	Return type	Description
List	customFieldDefinition collection	Get a list of the customFieldDefinition objects and their properties.
Create	customFieldDefinition	Create a new customFieldDefinition object.
Get	customFieldDefinition	Read the properties and relationships of customFieldDefinition object.
Update	customFieldDefinition	Update the properties of a customFieldDefinition object.
Delete	None	Delete a customFieldDefinition object.
List choiceOptions	customChoiceOption collection	Get a list of the customChoiceOption objects and their properties.
Create customChoiceOption	customChoiceOption	Create a new customChoiceOption object.

Properties

Property	Type	Description
archivalInfo	plannerArchivalInfo	Information about whether the entity is archived, and when it was archived.
createdBy	identitySet	Identity of the user (or application) who created the entity. Read-only.
createdDateTime	DateTimeOffset	Date and time the entity was created. The value is represented in ISO 8601 format and is always in UTC time. Read-only.
deletedBy	identitySet	Identity of the user who deleted the custom field definition, if it was deleted.
deletedDateTime	DateTimeOffset	Date and time the custom field definition was deleted, if applicable.
displayName	String	Name of the custom field.
id	String	The unique identifier of the entity. Read-only. Inherited from entity
lastModifiedBy	identitySet	Identity of the user (or application) who last modified the entity. Read-only.
lastModifiedDateTime	DateTimeOffset	Date and time the entity was last modified. The value is represented in ISO 8601 format and is always in UTC time. Read-only.
planId	String	ID of the plan the custom field is defined on. Required, and immutable after creation.
rollupType	customFieldRollupType	How values of this custom field are rolled up across tasks. The possible values are: noRollup, max, min, sum, average, unknownFutureValue.
valueType	customFieldValueType	Data type of the custom field's values.. The possible values are: text, date, utcDateTime, number, decimal, flag, singleChoiceText, multipleChoiceText, unknownFutureValue.

Relationships

Relationship	Type	Description
choiceOptions	customChoiceOption collection	The collection of selectable choice options for a single-choice or multiple-choice custom field. Read-only. Nullable.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.customFieldDefinition",
  "id": "String (identifier)",
  "planId": "String",
  "displayName": "String",
  "valueType": "String",
  "rollupType": "String",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "createdDateTime": "String (timestamp)",
  "lastModifiedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "lastModifiedDateTime": "String (timestamp)",
  "deletedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "deletedDateTime": "String (timestamp)",
  "archivalInfo": {
    "@odata.type": "microsoft.graph.plannerArchivalInfo"
  }
}