citationTemplate 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 the specific rule or regulation created by a jurisdiction used to determine whether certain labels and content should be retained or deleted. This resource supports CRUD operations to apply and manage the filePlanCitation descriptor for a retentionLabel. The citation file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content.
Inherits from microsoft.graph.security.filePlanDescriptorTemplate.
Methods
| Method | Return type | Description |
|---|---|---|
| List | microsoft.graph.security.citationTemplate collection | Get a list of the microsoft.graph.security.citationTemplate objects and their properties. |
| Create | microsoft.graph.security.citationTemplate | Create a new microsoft.graph.security.citationTemplate object. |
| Get | microsoft.graph.security.citationTemplate | Read the properties and relationships of a microsoft.graph.security.citationTemplate object. |
| Delete | None | Delete a microsoft.graph.security.citationTemplate object. |
Properties
| Property | Type | Description |
|---|---|---|
| citationJurisdiction | String | Represents the jurisdiction or agency that published the citation. |
| citationUrl | String | Represents the URL to the published citation. |
| createdBy | microsoft.graph.identitySet | Represents the user who created the citation descriptor. Inherited from microsoft.graph.security.filePlanDescriptorTemplate. Read-only. |
| createdDateTime | DateTimeOffset | Represents the date and time in which the citation descriptor is created. Inherited from microsoft.graph.security.filePlanDescriptorTemplate. Read-only. |
| displayName | String | Unique string that defines a citation name. Inherited from microsoft.graph.security.filePlanDescriptorTemplate. |
| id | String | Unique ID of the citation. Inherited from microsoft.graph.entity. Read-only. |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.security.citationTemplate",
"id": "String (identifier)",
"displayName": "String",
"createdBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"createdDateTime": "String (timestamp)",
"citationUrl": "String",
"citationJurisdiction": "String"
}