filePlanDescriptor resource type

Namespace: microsoft.graph.security

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.

Represents a set of optional file plan descriptors to supplement a retention label and improve the manageability and organization of Microsoft 365 content.

You can add a descriptor by using the POST operation of the corresponding file plan descriptor template, and specifying data for the descriptor. For example, to include a filePlanCitation descriptor, use the create citationTemplate operation. Similarly, you can use the GET or DELETE operations on the template resource for the descriptor.

To list the descriptors that supplement a retention label, use the GET operation on that retentionLabel resource and apply $expand on the descriptors relationship.

For information on how retention labels and file plan descriptors work in the Microsoft Purview compliance portal, see Use file plan to create and manage retention labels.

Inherits from microsoft.graph.entity.

Methods

None.

Properties

Property	Type	Description
authority	microsoft.graph.security.filePlanAuthority	Represents the file plan descriptor of type authority applied to a particular retention label.
category	microsoft.graph.security.filePlanAppliedCategory	Represents the file plan descriptor of type category applied to a particular retention label.
citation	microsoft.graph.security.filePlanCitation	Represents the file plan descriptor of type citation applied to a particular retention label.
authority	microsoft.graph.security.filePlanAuthority	Represents the file plan descriptor of type authority applied to a particular retention label.
appliedCategory	microsoft.graph.security.filePlanAppliedCategory	Represents the file plan descriptor of type category applied to a particular retention label.
citation	microsoft.graph.security.filePlanCitation	Represents the file plan descriptor of type citation applied to a particular retention label.
department	microsoft.graph.security.filePlanDepartment	Represents the file plan descriptor of type department applied to a particular retention label.
filePlanReference	microsoft.graph.security.filePlanReference	Represents the file plan descriptor of type filePlanReference applied to a particular retention label.

Relationships

Relationship	Type	Description
authorityTemplate	microsoft.graph.security.authorityTemplate	Specifies the underlying authority that describes the type of content to be retained and its retention schedule.
categoryTemplate	microsoft.graph.security.categoryTemplate	Specifies a group of similar types of content in a particular department.
citationTemplate	microsoft.graph.security.citationTemplate	The specific rule or regulation created by a jurisdiction used to determine whether certain labels and content should be retained or deleted.
departmentTemplate	microsoft.graph.security.departmentTemplate	Specifies the department or business unit of an organization to which a label belongs.
filePlanReferenceTemplate	microsoft.graph.security.filePlanReferenceTemplate	Specifies a unique alpha-numeric identifier for an organization’s retention schedule.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.security.filePlanDescriptor",
  "id": "String (identifier)",
  "authority": {
    "@odata.type": "microsoft.graph.security.filePlanAuthority"
  },
  "category": {
    "@odata.type": "microsoft.graph.security.filePlanAppliedCategory"
  },
  "citation": {
    "@odata.type": "microsoft.graph.security.filePlanCitation"
  },
  "department": {
    "@odata.type": "microsoft.graph.security.filePlanDepartment"
  },
  "filePlanReference": {
    "@odata.type": "microsoft.graph.security.filePlanReference"
  }
}