Namespace: microsoft.graph.security
Create a new filePlanReferenceTemplate object.
This API is available in the following national cloud deployments.
Global service |
US Government L4 |
US Government L5 (DOD) |
China operated by 21Vianet |
✅ |
✅ |
✅ |
❌ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type |
Least privileged permissions |
Higher privileged permissions |
Delegated (work or school account) |
RecordsManagement.ReadWrite.All |
Not available. |
Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
Application |
RecordsManagement.ReadWrite.All |
Not available. |
HTTP request
POST /security/labels/filePlanReferences
Request body
In the request body, supply a JSON representation of the microsoft.graph.security.filePlanReferenceTemplate object.
You can specify the following properties when creating a filePlanReferenceTemplate.
Response
If successful, this method returns a 201 Created
response code and a microsoft.graph.security.filePlanReferenceTemplate object in the response body.
Examples
Request
Here's an example of a request.
POST https://graph.microsoft.com/v1.0/security/labels/filePlanReferences
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate",
"displayName": "FIN 01-02-001",
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models.Security;
var requestBody = new FilePlanReferenceTemplate
{
OdataType = "#microsoft.graph.security.filePlanReferenceTemplate",
DisplayName = "FIN 01-02-001",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Security.Labels.FilePlanReferences.PostAsync(requestBody);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
mgc security labels file-plan-references create --body '{\
"@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate",\
"displayName": "FIN 01-02-001",\
}\
'
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodelssecurity "github.com/microsoftgraph/msgraph-sdk-go/models/security"
//other-imports
)
requestBody := graphmodelssecurity.NewFilePlanReferenceTemplate()
displayName := "FIN 01-02-001"
requestBody.SetDisplayName(&displayName)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
filePlanReferences, err := graphClient.Security().Labels().FilePlanReferences().Post(context.Background(), requestBody, nil)
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.models.security.FilePlanReferenceTemplate filePlanReferenceTemplate = new com.microsoft.graph.models.security.FilePlanReferenceTemplate();
filePlanReferenceTemplate.setOdataType("#microsoft.graph.security.filePlanReferenceTemplate");
filePlanReferenceTemplate.setDisplayName("FIN 01-02-001");
com.microsoft.graph.models.security.FilePlanReferenceTemplate result = graphClient.security().labels().filePlanReferences().post(filePlanReferenceTemplate);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
const options = {
authProvider,
};
const client = Client.init(options);
const filePlanReferenceTemplate = {
'@odata.type': '#microsoft.graph.security.filePlanReferenceTemplate',
displayName: 'FIN 01-02-001',
};
await client.api('/security/labels/filePlanReferences')
.post(filePlanReferenceTemplate);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Security\FilePlanReferenceTemplate;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new FilePlanReferenceTemplate();
$requestBody->setOdataType('#microsoft.graph.security.filePlanReferenceTemplate');
$requestBody->setDisplayName('FIN 01-02-001');
$result = $graphServiceClient->security()->labels()->filePlanReferences()->post($requestBody)->wait();
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
Import-Module Microsoft.Graph.Security
$params = @{
"@odata.type" = "#microsoft.graph.security.filePlanReferenceTemplate"
displayName = "FIN 01-02-001"
}
New-MgSecurityLabelFilePlanReference -BodyParameter $params
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.security.file_plan_reference_template import FilePlanReferenceTemplate
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = FilePlanReferenceTemplate(
odata_type = "#microsoft.graph.security.filePlanReferenceTemplate",
display_name = "FIN 01-02-001",
)
result = await graph_client.security.labels.file_plan_references.post(request_body)
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
Response
Here's an example of the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate",
"id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c",
"displayName": "FIN 01-02-001",
"createdBy": {
"user": {
"id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
"displayName": "Admin"
}
},
"createdDateTime" : "2021-03-24T02:09:08Z"
}