PATCH https://graph.microsoft.com/beta/external/connections/contosohr/schema
Content-type: application/json
{
"baseType": "microsoft.graph.externalItem",
"properties": [
{
"name": "ticketTitle",
"type": "string",
"isSearchable": "true",
"isRetrievable": "true",
"labels": [
"title"
]
},
{
"name": "priority",
"type": "string",
"isQueryable": "true",
"isRetrievable": "true",
"isSearchable": "false"
},
{
"name": "assignee",
"type": "string",
"isRetrievable": "true"
}
]
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models.ExternalConnectors;
var requestBody = new Schema
{
BaseType = "microsoft.graph.externalItem",
Properties = new List<Property>
{
new Property
{
Name = "ticketTitle",
Type = PropertyType.String,
IsSearchable = true,
IsRetrievable = true,
Labels = new List<Label?>
{
Label.Title,
},
},
new Property
{
Name = "priority",
Type = PropertyType.String,
IsQueryable = true,
IsRetrievable = true,
IsSearchable = false,
},
new Property
{
Name = "assignee",
Type = PropertyType.String,
IsRetrievable = true,
},
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.External.Connections["{externalConnection-id}"].Schema.PatchAsync(requestBody);
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta external connections schema patch --external-connection-id {externalConnection-id} --body '{\
"baseType": "microsoft.graph.externalItem",\
"properties": [\
{\
"name": "ticketTitle",\
"type": "string",\
"isSearchable": "true",\
"isRetrievable": "true",\
"labels": [\
"title"\
]\
},\
{\
"name": "priority",\
"type": "string",\
"isQueryable": "true",\
"isRetrievable": "true",\
"isSearchable": "false"\
},\
{\
"name": "assignee",\
"type": "string",\
"isRetrievable": "true"\
}\
]\
}\
'
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodelsexternalconnectors "github.com/microsoftgraph/msgraph-beta-sdk-go/models/externalconnectors"
//other-imports
)
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)
requestBody := graphmodelsexternalconnectors.NewSchema()
baseType := "microsoft.graph.externalItem"
requestBody.SetBaseType(&baseType)
property := graphmodelsexternalconnectors.NewProperty()
name := "ticketTitle"
property.SetName(&name)
type := graphmodels.STRING_PROPERTYTYPE
property.SetType(&type)
isSearchable := true
property.SetIsSearchable(&isSearchable)
isRetrievable := true
property.SetIsRetrievable(&isRetrievable)
labels := []graphmodelsexternalconnectors.Labelable {
label := graphmodels.TITLE_LABEL
property.SetLabel(&label)
}
property.SetLabels(labels)
property1 := graphmodelsexternalconnectors.NewProperty()
name := "priority"
property1.SetName(&name)
type := graphmodels.STRING_PROPERTYTYPE
property1.SetType(&type)
isQueryable := true
property1.SetIsQueryable(&isQueryable)
isRetrievable := true
property1.SetIsRetrievable(&isRetrievable)
isSearchable := false
property1.SetIsSearchable(&isSearchable)
property2 := graphmodelsexternalconnectors.NewProperty()
name := "assignee"
property2.SetName(&name)
type := graphmodels.STRING_PROPERTYTYPE
property2.SetType(&type)
isRetrievable := true
property2.SetIsRetrievable(&isRetrievable)
properties := []graphmodelsexternalconnectors.Propertyable {
property,
property1,
property2,
}
requestBody.SetProperties(properties)
schema, err := graphClient.External().Connections().ByExternalConnectionId("externalConnection-id").Schema().Patch(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.models.externalconnectors.Schema schema = new com.microsoft.graph.beta.models.externalconnectors.Schema();
schema.setBaseType("microsoft.graph.externalItem");
LinkedList<com.microsoft.graph.beta.models.externalconnectors.Property> properties = new LinkedList<com.microsoft.graph.beta.models.externalconnectors.Property>();
com.microsoft.graph.beta.models.externalconnectors.Property property = new com.microsoft.graph.beta.models.externalconnectors.Property();
property.setName("ticketTitle");
property.setType(com.microsoft.graph.beta.models.externalconnectors.PropertyType.String);
property.setIsSearchable(true);
property.setIsRetrievable(true);
LinkedList<com.microsoft.graph.beta.models.externalconnectors.com.microsoft.graph.beta.models.externalconnectors.Label> labels = new LinkedList<com.microsoft.graph.beta.models.externalconnectors.com.microsoft.graph.beta.models.externalconnectors.Label>();
labels.add(com.microsoft.graph.beta.models.externalconnectors.Label.Title);
property.setLabels(labels);
properties.add(property);
com.microsoft.graph.beta.models.externalconnectors.Property property1 = new com.microsoft.graph.beta.models.externalconnectors.Property();
property1.setName("priority");
property1.setType(com.microsoft.graph.beta.models.externalconnectors.PropertyType.String);
property1.setIsQueryable(true);
property1.setIsRetrievable(true);
property1.setIsSearchable(false);
properties.add(property1);
com.microsoft.graph.beta.models.externalconnectors.Property property2 = new com.microsoft.graph.beta.models.externalconnectors.Property();
property2.setName("assignee");
property2.setType(com.microsoft.graph.beta.models.externalconnectors.PropertyType.String);
property2.setIsRetrievable(true);
properties.add(property2);
schema.setProperties(properties);
com.microsoft.graph.models.externalconnectors.Schema result = graphClient.external().connections().byExternalConnectionId("{externalConnection-id}").schema().patch(schema);
const options = {
authProvider,
};
const client = Client.init(options);
const schema = {
baseType: 'microsoft.graph.externalItem',
properties: [
{
name: 'ticketTitle',
type: 'string',
isSearchable: 'true',
isRetrievable: 'true',
labels: [
'title'
]
},
{
name: 'priority',
type: 'string',
isQueryable: 'true',
isRetrievable: 'true',
isSearchable: 'false'
},
{
name: 'assignee',
type: 'string',
isRetrievable: 'true'
}
]
};
await client.api('/external/connections/contosohr/schema')
.version('beta')
.update(schema);
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Schema;
use Microsoft\Graph\Generated\Models\Property;
use Microsoft\Graph\Generated\Models\Label;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new Schema();
$requestBody->setBaseType('microsoft.graph.externalItem');
$propertiesProperty1 = new Property();
$propertiesProperty1->setName('ticketTitle');
$propertiesProperty1->setType(new PropertyType('string'));
$propertiesProperty1->setIsSearchable(true);
$propertiesProperty1->setIsRetrievable(true);
$propertiesProperty1->setLabels([new Label('title'), ]);
$propertiesArray []= $propertiesProperty1;
$propertiesProperty2 = new Property();
$propertiesProperty2->setName('priority');
$propertiesProperty2->setType(new PropertyType('string'));
$propertiesProperty2->setIsQueryable(true);
$propertiesProperty2->setIsRetrievable(true);
$propertiesProperty2->setIsSearchable(false);
$propertiesArray []= $propertiesProperty2;
$propertiesProperty3 = new Property();
$propertiesProperty3->setName('assignee');
$propertiesProperty3->setType(new PropertyType('string'));
$propertiesProperty3->setIsRetrievable(true);
$propertiesArray []= $propertiesProperty3;
$requestBody->setProperties($propertiesArray);
$result = $graphServiceClient->external()->connections()->byExternalConnectionId('externalConnection-id')->schema()->patch($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Search
$params = @{
baseType = "microsoft.graph.externalItem"
properties = @(
@{
name = "ticketTitle"
type = "string"
isSearchable = "true"
isRetrievable = "true"
labels = @(
"title"
)
}
@{
name = "priority"
type = "string"
isQueryable = "true"
isRetrievable = "true"
isSearchable = "false"
}
@{
name = "assignee"
type = "string"
isRetrievable = "true"
}
)
}
Update-MgBetaExternalConnectionSchema -ExternalConnectionId $externalConnectionId -BodyParameter $params
from msgraph import GraphServiceClient
from msgraph.generated.models.schema import Schema
from msgraph.generated.models.property import Property
from msgraph.generated.models.label import Label
graph_client = GraphServiceClient(credentials, scopes)
request_body = Schema(
base_type = "microsoft.graph.externalItem",
properties = [
Property_(
name = "ticketTitle",
type = PropertyType.String,
is_searchable = True,
is_retrievable = True,
labels = [
Label.Title,
],
),
Property_(
name = "priority",
type = PropertyType.String,
is_queryable = True,
is_retrievable = True,
is_searchable = False,
),
Property_(
name = "assignee",
type = PropertyType.String,
is_retrievable = True,
),
],
)
result = await graph_client.external.connections.by_external_connection_id('externalConnection-id').schema.patch(request_body)