Criar agreementFileLocalization

Namespace: microsoft.graph

Crie um novo arquivo de contrato localizado.

Permissões

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão	Permissões (da com menos para a com mais privilégios)
Delegado (conta corporativa ou de estudante)	Agreement.ReadWrite.All
Delegado (conta pessoal da Microsoft)	Sem suporte.
Aplicativo	Sem suporte.

Solicitação HTTP

POST /agreements/{agreementsId}/files

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório.
Content-Type	application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON do objeto agreementFileLocalization .

Você pode especificar as propriedades a seguir ao criar um agreementFileLocalization.

Propriedade	Tipo	Descrição
displayName	Cadeia de caracteres	Nome de exibição localizado do arquivo de política de um contrato. O nome de exibição localizado é mostrado aos usuários finais que visualizam o contrato.
Filedata	agreementFileData	Dados que representam os termos de uso do documento PDF.
fileName	String	Nome do arquivo de contrato (por exemplo, TOU.pdf).
isDefault	Booliano	Se nenhum dos idiomas corresponder à preferência do cliente, indica se este é o arquivo de contrato padrão. Se nenhum dos arquivos for marcado como padrão, o primeiro será tratado como padrão. Somente leitura.
isMajorVersion	Booliano	Indica se o arquivo de contrato é uma atualização de versão principal. As atualizações de versão principal invalidam as aceitação do contrato no idioma correspondente.
idioma	Cadeia de caracteres	O idioma do arquivo de contrato no formato "languagecode2-country/regioncode2". "languagecode2" é um código de duas letras minúsculo derivado de ISO 639-1, enquanto "country/regioncode2" é derivado da ISO 3166 e geralmente consiste em duas letras maiúsculas ou uma marca de idioma BCP-47. Por exemplo, inglês americano é en-US.

Resposta

Se bem-sucedido, este método retorna um código 200 OK de resposta e um objeto agreementFileLocalization no corpo da resposta.

Exemplos

Solicitação

HTTP

POST https://graph.microsoft.com/v1.0/identityGovernance/termsOfUse/agreements/94410bbf-3d3e-4683-8149-f034e55c39dd/files
Content-Type: application/json

{
    "fileName": "Contoso ToU for guest users (French)",
    "language": "fr-FR",
    "isDefault": false,
    "isMajorVersion": false,
    "displayName": "Contoso ToU for guest users (French)",
    "fileData": {
        "data": "base64JVBERi0xLjUKJb/3ov4KNCAwIG9iago8PCAvTGluZWFyaX//truncated-binary-data"
    }
}

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var agreementFileLocalization = new AgreementFileLocalization
{
    FileName = "Contoso ToU for guest users (French)",
    Language = "fr-FR",
    IsDefault = false,
    IsMajorVersion = false,
    DisplayName = "Contoso ToU for guest users (French)",
    FileData = new AgreementFileData
    {
        Data = Convert.FromBase64String("base64JVBERi0xLjUKJb/3ov4KNCAwIG9iago8PCAvTGluZWFyaX//truncated-binary-data")
    }
};

await graphClient.IdentityGovernance.TermsOfUse.Agreements["{agreement-id}"].Files
    .Request()
    .AddAsync(agreementFileLocalization);

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

JavaScript

const options = {
    authProvider,
};

const client = Client.init(options);

const agreementFileLocalization = {
    fileName: 'Contoso ToU for guest users (French)',
    language: 'fr-FR',
    isDefault: false,
    isMajorVersion: false,
    displayName: 'Contoso ToU for guest users (French)',
    fileData: {
        data: 'base64JVBERi0xLjUKJb/3ov4KNCAwIG9iago8PCAvTGluZWFyaX//truncated-binary-data'
    }
};

await client.api('/identityGovernance/termsOfUse/agreements/94410bbf-3d3e-4683-8149-f034e55c39dd/files')
    .post(agreementFileLocalization);

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

Objective-C

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/identityGovernance/termsOfUse/agreements/94410bbf-3d3e-4683-8149-f034e55c39dd/files"]]];
[urlRequest setHTTPMethod:@"POST"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

MSGraphAgreementFileLocalization *agreementFileLocalization = [[MSGraphAgreementFileLocalization alloc] init];
[agreementFileLocalization setFileName:@"Contoso ToU for guest users (French)"];
[agreementFileLocalization setLanguage:@"fr-FR"];
[agreementFileLocalization setIsDefault: false];
[agreementFileLocalization setIsMajorVersion: false];
[agreementFileLocalization setDisplayName:@"Contoso ToU for guest users (French)"];
MSGraphAgreementFileData *fileData = [[MSGraphAgreementFileData alloc] init];
[fileData setData:@"base64JVBERi0xLjUKJb/3ov4KNCAwIG9iago8PCAvTGluZWFyaX//truncated-binary-data"];
[agreementFileLocalization setFileData:fileData];

NSError *error;
NSData *agreementFileLocalizationData = [agreementFileLocalization getSerializedDataWithError:&error];
[urlRequest setHTTPBody:agreementFileLocalizationData];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

AgreementFileLocalization agreementFileLocalization = new AgreementFileLocalization();
agreementFileLocalization.fileName = "Contoso ToU for guest users (French)";
agreementFileLocalization.language = "fr-FR";
agreementFileLocalization.isDefault = false;
agreementFileLocalization.isMajorVersion = false;
agreementFileLocalization.displayName = "Contoso ToU for guest users (French)";
AgreementFileData fileData = new AgreementFileData();
fileData.data = Base64.getDecoder().decode("base64JVBERi0xLjUKJb/3ov4KNCAwIG9iago8PCAvTGluZWFyaX//truncated-binary-data");
agreementFileLocalization.fileData = fileData;

graphClient.identityGovernance().termsOfUse().agreements("94410bbf-3d3e-4683-8149-f034e55c39dd").files()
    .buildRequest()
    .post(agreementFileLocalization);

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := msgraphsdk.NewAgreementFileLocalization()
fileName := "Contoso ToU for guest users (French)"
requestBody.SetFileName(&fileName)
language := "fr-FR"
requestBody.SetLanguage(&language)
isDefault := false
requestBody.SetIsDefault(&isDefault)
isMajorVersion := false
requestBody.SetIsMajorVersion(&isMajorVersion)
displayName := "Contoso ToU for guest users (French)"
requestBody.SetDisplayName(&displayName)
fileData := msgraphsdk.NewAgreementFileData()
requestBody.SetFileData(fileData)
data := []byte("base64JVBERi0xLjUKJb/3ov4KNCAwIG9iago8PCAvTGluZWFyaX//truncated-binary-data")
fileData.SetData(&data)
agreementId := "agreement-id"
result, err := graphClient.IdentityGovernance().TermsOfUse().AgreementsById(&agreementId).Files().Post(requestBody)

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

Resposta

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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')/files/$entity",
    "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": {
        "data": "base64JVBERi0xLjUKJb/"
    }
}