Mettre à jour educationClass

Espace de noms: microsoft.graph

Mettez à jour les propriétés d’un objet educationClass .

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	❌	❌	❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	Non prise en charge.	Non prise en charge.
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	EduRoster.ReadWrite.All	Non disponible.

Requête HTTP

PATCH /education/classes/{id}

En-têtes de demande

En-tête	Valeur
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type	application/json

Corps de la demande

Dans le corps de la demande, fournissez les valeurs pour les champs appropriés qui doivent être mis à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conserveront leurs valeurs précédentes ou seront recalculées en fonction des modifications apportées à d’autres valeurs des propriétés. Pour de meilleures performances, n’incluez pas de valeurs existantes qui n’ont pas été modifiées.

Propriété	Type	Description
displayName	String	Nom du cours.
mailNickname	String	Nom du courrier pour l’envoi d’e-mails à tous les membres, si cette option est activée.
description	String	Description du cours.
createdBy	identitySet	Entité qui a créé le cours.
classCode	String	Code du cours utilisé par l’établissement scolaire pour identifier le cours.
externalId	String	ID du cours depuis le système de synchronisation.
externalSource	educationExternalSource	Comment ce cours a été créé. Les valeurs possibles sont : sis, manual
externalSourceDetail	Chaîne	Nom de la source externe à partir de laquelle ces ressources ont été générées.
grade	Chaîne	Niveau de note de la classe.
term	educationTerm	Trimestre pour ce cours.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et un objet educationClass mis à jour dans le corps de la réponse.

Exemple

Demande

L’exemple suivant illustre une demande.

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);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc education classes patch --education-class-id {educationClass-id} --body '{\
  "description": "History - World History 1",\
  "displayName": "World History Level 1",\
}\
'

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


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

classes, err := graphClient.Education().Classes().ByEducationClassId("educationClass-id").Patch(context.Background(), requestBody, nil)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (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);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (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);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (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();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PowerShell

Import-Module Microsoft.Graph.Education

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

Update-MgEducationClass -EducationClassId $educationClassId -BodyParameter $params

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (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)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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"
  }
}