Obtenir un fichier agreementFile

Article
10/30/2023

Espace de noms: microsoft.graph

Récupérez les détails d’un fichier de contrat, y compris les informations de langue et de version. Le fichier par défaut peut avoir plusieurs versions, chacune avec sa propre langue, qui peuvent être récupérées en spécifiant l’en-tête Accept-Language .

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)	Agreement.Read.All	Agreement.ReadWrite.All
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	Non prise en charge.	Non prise en charge.

Requête HTTP

GET /agreements/{agreementsId}/file

Paramètres facultatifs de la requête

Cette méthode ne prend pas en charge les paramètres de requête OData pour vous aider à personnaliser la réponse. Pour des informations générales, consultez paramètres de la requête OData.

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Accept-Language	Paramètres régionaux ISO 639-1 valides. Facultatif.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et une collection d’objets agreementFile dans le corps de la réponse.

Exemples

Exemple 1 : Obtenir le fichier de contrat par défaut

Demande

GET https://graph.microsoft.com/v1.0/identityGovernance/termsOfUse/agreements/94410bbf-3d3e-4683-8149-f034e55c39dd/file


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

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.IdentityGovernance.TermsOfUse.Agreements["{agreement-id}"].File.GetAsync();



mgc identity-governance terms-of-use agreements file get --agreement-id {agreement-id}



// 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"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
file, err := graphClient.IdentityGovernance().TermsOfUse().Agreements().ByAgreementId("agreement-id").File().Get(context.Background(), nil)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

AgreementFile result = graphClient.identityGovernance().termsOfUse().agreements().byAgreementId("{agreement-id}").file().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let agreementFile = await client.api('/identityGovernance/termsOfUse/agreements/94410bbf-3d3e-4683-8149-f034e55c39dd/file')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


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


$result = $graphServiceClient->identityGovernance()->termsOfUse()->agreements()->byAgreementId('agreement-id')->file()->get()->wait();


Import-Module Microsoft.Graph.Identity.Governance

Get-MgIdentityGovernanceTermsOfUseAgreementFile -AgreementId $agreementId


from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


result = await graph_client.identity_governance.terms_of_use.agreements.by_agreement_id('agreement-id').file.get()

Réponse

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identityGovernance/termsOfUse/agreements('94410bbf-3d3e-4683-8149-f034e55c39dd')/file/$entity",
    "@odata.type": "#microsoft.graph.agreementFileLocalization",
    "id": "08033369-8972-42a3-8533-90bbd2757a01",
    "fileName": "TOU.pdf",
    "displayName": "Contoso ToU for guest users",
    "language": "en",
    "isDefault": true,
    "isMajorVersion": false,
    "createdDateTime": "2022-03-04T13:14:13.9361722Z",
    "fileData": null
}

Exemple 2 : Obtenir le fichier de contrat pour une langue spécifique

Demande

L’exemple suivant montre comment obtenir le fichier d’accord pour la fr-FR langue. S’il n’existe aucun fichier de contrat de ce type, le fichier d’accord par défaut est retourné.

GET https://graph.microsoft.com/v1.0/agreements/94410bbf-3d3e-4683-8149-f034e55c39dd/file
Accept-Language: fr-FR


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

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Agreements["{agreement-id}"].File.GetAsync((requestConfiguration) =>
{
	requestConfiguration.Headers.Add("Accept-Language", "fr-FR");
});



mgc agreements file get --agreement-id {agreement-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  abstractions "github.com/microsoft/kiota-abstractions-go"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphagreements "github.com/microsoftgraph/msgraph-sdk-go/agreements"
	  //other-imports
)

headers := abstractions.NewRequestHeaders()
headers.Add("Accept-Language", "fr-FR")

configuration := &graphagreements.AgreementItemFileRequestBuilderGetRequestConfiguration{
	Headers: headers,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
file, err := graphClient.Agreements().ByAgreementId("agreement-id").File().Get(context.Background(), configuration)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

AgreementFile result = graphClient.agreements().byAgreementId("{agreement-id}").file().get(requestConfiguration -> {
	requestConfiguration.headers.add("Accept-Language", "fr-FR");
});


const options = {
	authProvider,
};

const client = Client.init(options);

let agreementFile = await client.api('/agreements/94410bbf-3d3e-4683-8149-f034e55c39dd/file')
	.header('Accept-Language','fr-FR')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Agreements\Item\File\FileRequestBuilderGetRequestConfiguration;


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

$requestConfiguration = new FileRequestBuilderGetRequestConfiguration();
$headers = [
		'Accept-Language' => 'fr-FR',
	];
$requestConfiguration->headers = $headers;


$result = $graphServiceClient->agreements()->byAgreementId('agreement-id')->file()->get($requestConfiguration)->wait();


Import-Module Microsoft.Graph.Identity.Governance

Get-MgAgreementFile -AgreementId $agreementId


from msgraph import GraphServiceClient
from msgraph.generated.agreements.item.file.file_request_builder import FileRequestBuilder

graph_client = GraphServiceClient(credentials, scopes)


request_configuration = FileRequestBuilder.FileRequestBuilderGetRequestConfiguration()
request_configuration.headers.add("Accept-Language", "fr-FR")


result = await graph_client.agreements.by_agreement_id('agreement-id').file.get(request_configuration = request_configuration)

Réponse

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#agreements('94410bbf-3d3e-4683-8149-f034e55c39dd')/file/$entity",
    "@odata.type": "#microsoft.graph.agreementFileLocalization",
    "id": "90d1723c-52c1-40e3-a51a-da99a82c0327",
    "fileName": "Contoso ToU for guest users (French)",
    "displayName": "Contoso ToU for guest users (French)",
    "language": "fr-FR",
    "isDefault": false,
    "isMajorVersion": false,
    "createdDateTime": "2022-03-04T14:38:22.8292386Z",
    "fileData": null
}

Share via

Obtenir un fichier agreementFile

Autorisations

Requête HTTP

Paramètres facultatifs de la requête

En-têtes de demande

Corps de la demande

Réponse

Exemples

Exemple 1 : Obtenir le fichier de contrat par défaut

Demande

Réponse

Exemple 2 : Obtenir le fichier de contrat pour une langue spécifique

Demande

Réponse

Commentaires

Commentaires

Ressources supplémentaires