educationClass の更新

名前空間: microsoft.graph

educationClass オブジェクトのプロパティを更新します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	❌	❌	❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類	最小特権アクセス許可	より高い特権のアクセス許可
委任 (職場または学校のアカウント)	サポートされていません。	サポートされていません。
委任 (個人用 Microsoft アカウント)	サポートされていません。	サポートされていません。
アプリケーション	EduRoster.ReadWrite.All	注意事項なし。

HTTP 要求

PATCH /education/classes/{id}

要求ヘッダー

ヘッダー	値
Authorization	ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type	application/json

要求本文

要求本文で、更新する関連フィールドの値を指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。 最適なパフォーマンスを得るために、変更されていない既存の値を含めないでください。

プロパティ	種類	説明
displayName	String	クラスの名前。
mailNickname	String	すべてのメンバーに電子メールを送信する際のメール名 (この機能が有効な場合)。
説明	String	クラスの説明。
createdBy	identitySet	クラスを作成したエンティティ。
classCode	String	クラスを識別するために学校が使用するクラス コード。
externalId	String	同期システムからのクラスの ID。
externalSource	educationExternalSource	このクラスの作成方法。 使用可能な値: sis、 manual
externalSourceDetail	String	このリソースが生成された外部ソースの名前。
grade	String	クラスの成績レベル。
term	educationTerm	このクラスの学期。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で更新された educationClass オブジェクトを返します。

例

要求

次の例は要求を示しています。

HTTP

PATCH https://graph.microsoft.com/v1.0/education/classes/{class-id}
Content-type: application/json

{
  "description": "History - World History 1",
  "displayName": "World History Level 1",
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new EducationClass
{
	Description = "History - World History 1",
	DisplayName = "World History Level 1",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Education.Classes["{educationClass-id}"].PatchAsync(requestBody);

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

CLI

mgc education classes patch --education-class-id {educationClass-id} --body '{\
  "description": "History - World History 1",\
  "displayName": "World History Level 1",\
}\
'

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Go

// 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"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewEducationClass()
description := "History - World History 1"
requestBody.SetDescription(&description) 
displayName := "World History Level 1"
requestBody.SetDisplayName(&displayName) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
classes, err := graphClient.Education().Classes().ByEducationClassId("educationClass-id").Patch(context.Background(), requestBody, nil)

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

EducationClass educationClass = new EducationClass();
educationClass.setDescription("History - World History 1");
educationClass.setDisplayName("World History Level 1");
EducationClass result = graphClient.education().classes().byEducationClassId("{educationClass-id}").patch(educationClass);

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const educationClass = {
  description: 'History - World History 1',
  displayName: 'World History Level 1',
};

await client.api('/education/classes/{class-id}')
	.update(educationClass);

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\EducationClass;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new EducationClass();
$requestBody->setDescription('History - World History 1');
$requestBody->setDisplayName('World History Level 1');

$result = $graphServiceClient->education()->classes()->byEducationClassId('educationClass-id')->patch($requestBody)->wait();

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

PowerShell

Import-Module Microsoft.Graph.Education

$params = @{
	description = "History - World History 1"
	displayName = "World History Level 1"
}

Update-MgEducationClass -EducationClassId $educationClassId -BodyParameter $params

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Python

from msgraph import GraphServiceClient
from msgraph.generated.models.education_class import EducationClass

graph_client = GraphServiceClient(credentials, scopes)

request_body = EducationClass(
	description = "History - World History 1",
	display_name = "World History Level 1",
)

result = await graph_client.education.classes.by_education_class_id('educationClass-id').patch(request_body)

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.educationClass",
  "id": "64ef8ce5-8ce5-64ef-e58c-ef64e58cef64",
  "displayName": "String",
  "mailNickname": "String",
  "description": "String",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "classCode": "String",
  "externalName": "String",
  "externalId": "String",
  "externalSource": "String",
  "externalSourceDetail": "String",
  "grade": "String",
  "term": {
    "@odata.type": "microsoft.graph.educationTerm"
  }
}