customFieldDefinition resource type

Namespace: microsoft.graph.security.caseManagement

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.

Abstract base type describing a single tenant-defined custom field — one entry in the blank-form schema of a caseTypeConfiguration. Each custom field is a concrete subtype, identified by @odata.type, that marks the field kind.

This is an abstract type and can't be instantiated directly. Collections of custom-field definitions contain instances of the following derived types:

• stringCustomFieldDefinition
• numberCustomFieldDefinition
• dateTimeCustomFieldDefinition
• optionsCustomFieldDefinition

Custom-field definitions are reached by containment navigation from a case type configuration at /security/caseManagement/caseTypeConfigurations/{caseTypeConfigurationId}/customFields, so each field is individually addressable. The collection is read-only.

Methods

Method	Return type	Description
List	microsoft.graph.security.caseManagement.customFieldDefinition collection	Get a list of the customFieldDefinition objects for a case type.
Get	microsoft.graph.security.caseManagement.customFieldDefinition	Read the properties of a customFieldDefinition object.

Properties

Property	Type	Description
description	String	The field description. Supports $filter and $orderby.
displayName	String	The field label shown on the case form. Supports $filter and $orderby.
id	String	The unique identifier of the custom field. Read-only. Supports $filter and $orderby.
isDisabled	Boolean	true if the field is disabled; otherwise, false. Supports $filter and $orderby.
isRequired	Boolean	true if a value is required for this field; otherwise, false. Supports $filter and $orderby.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.security.caseManagement.customFieldDefinition",
  "id": "String (identifier)",
  "displayName": "String",
  "description": "String",
  "isRequired": "Boolean",
  "isDisabled": "Boolean"
}