Obter informações de implantação de licençasGet licenses deployment information

Aplica-se aApplies To

  • Partner CenterPartner Center

Como obter informações de implantação para licenças do Office e Dynamics.How to get deployment information for Office and Dynamics licenses.

Pré-requisitosPrerequisites

Credenciais, conforme descrito em Autenticação do Partner Center.Credentials as described in Partner Center authentication. Este cenário dá suporte à autenticação com credenciais de aplicativo + usuário.This scenario supports authentication with App+User credentials.

Solicitação RESTREST request

Sintaxe da solicitaçãoRequest syntax

MétodoMethod URI da solicitaçãoRequest URI
GETGET {baseURL}/v1/Analytics/Commercial/Deployment/License/http/1.1{baseURL}/v1/analytics/commercial/deployment/license/ HTTP/1.1

Cabeçalhos de solicitaçãoRequest headers

Para obter mais informações, confira Cabeçalhos REST do Partner Center.For more information, see Partner Center REST headers.

Parâmetros do URIURI parameters

ParâmetroParameter TipoType DescriçãoDescription ObrigatórioRequired
toptop cadeia de caracteresstring O número de linhas de dados a serem retornadas na solicitação.The number of rows of data to return in the request. O valor máximo e o valor padrão; se não forem especificados, será 10.000.The maximum value and the default value if not specified is 10000. Se houver mais linhas na consulta, o corpo da resposta incluirá um link que você poderá usar para solicitar a próxima página de dados.If there are more rows in the query, the response body includes a next link that you can use to request the next page of data. NoNo
skipskip INTint O número de linhas a serem ignoradas na consulta.The number of rows to skip in the query. Use este parâmetro para percorrer grandes conjuntos de dados.Use this parameter to page through large data sets. Por exemplo, top=10000 e skip=0 recuperam as primeiras 10.000 linhas de dados, top=10000 e skip=10000 recuperam as próximas 10.000 linhas de dados e assim por diante.For example, top=10000 and skip=0 retrieves the first 10000 rows of data, top=10000 and skip=10000 retrieves the next 10000 rows of data, and so on. NoNo
filterfilter cadeia de caracteresstring O parâmetro filter da solicitação contém uma ou mais instruções que filtram as linhas da resposta.The filter parameter of the request contains one or more statements that filter the rows in the response. Cada instrução contém um campo e um valor que são associados aos eq ne operadores ou, e as instruções podem ser combinadas usando and ou or .Each statement contains a field and value that are associated with the eq or ne operators, and statements can be combined using and or or. Estes são alguns exemplos dos parâmetros filter:Here are some example filter parameters:

Filter = ' O365 ' do InCode EQfilter=serviceCode eq 'O365'
Filter = não Code EQ ' O365 ' ou (Channel EQ ' revendedor ')filter=serviceCode eq 'O365' or (channel eq 'Reseller')

Você pode especificar os campos a seguir:You can specify the following fields:

Código doserviceCode
serviceNameserviceName
canalizachannel
customerTenantIdcustomerTenantId
CustomercustomerName
productIdproductId
NomeDoProdutoproductName
NoNo
groupbygroupby cadeia de caracteresstring Uma instrução que aplica a agregação de dados apenas aos campos especificados.A statement that applies data aggregation only to the specified fields. Você pode especificar os campos a seguir:You can specify the following fields:

Código doserviceCode
serviceNameserviceName
canalizachannel
customerTenantIdcustomerTenantId
CustomercustomerName
productIdproductId
NomeDoProdutoproductName

As linhas de dados retornados conterão os campos especificados no parâmetro groupby, bem como o seguinte:The returned data rows will contain the fields specified in the groupby parameter as well as the following:

licensesDeployedlicensesDeployed
licensesSoldlicensesSold
NoNo
processedDateTimeprocessedDateTime DatetimeDateTime É possível especificar a data a partir da qual os dados de uso foram processados.One can specify the date from which usage data was processed. O padrão é a data mais recente em que os dados foram processadosDefaults to the latest date when the data was processed NoNo

Exemplo de solicitaçãoRequest example

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/commercial/deployment/license?filter=customerTenantId%20eq%20%270112A436-B14E-4888-967B-CA4BB2CF1234%27 HTTP 1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: bad5f75f-fd44-43ab-9325-bbc79dcba9da
MS-CorrelationId: 9cbdf63c-2608-4ad8-b0a9-abae27d859d9
X-Locale: en-US
Host: api.partnercenter.microsoft.com

Resposta RESTREST response

Se for bem-sucedido, o corpo da resposta conterá os campos a seguir contendo dados sobre as licenças implantadas.If successful, the response body contains the following fields containing data about the licenses deployed.

CampoField TipoType DescriptionDescription
Código doserviceCode cadeia de caracteresstring Código de serviçoService code
serviceNameserviceName cadeia de caracteresstring Nome do serviçoService name
channelchannel cadeia de caracteresstring Nome do canal, revendedorChannel name, reseller
customerTenantIdcustomerTenantId cadeia de caracteresstring Identificador exclusivo do clienteUnique identifier for the customer
customerNamecustomerName cadeia de caracteresstring Nome do clienteCustomer name
productIdproductId stringstring Identificador exclusivo do produtoUnique identifier for the product
productNameproductName cadeia de caracteresstring Nome do produtoProduct name
licensesDeployedlicensesDeployed longlong Número de licenças implantadasNumber of licenses deployed
licensesSoldlicensesSold longlong Número de licenças vendidasNumber of licenses sold
processedDateTimeprocessedDateTime DatetimeDateTime Data em que os dados foram processados pela última vezDate when the data was last processed

Códigos de êxito e de erro de respostaResponse success and error codes

Cada resposta vem com um código de status HTTP que indica êxito ou falha e informações de depuração adicionais.Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e os parâmetros adicionais.Use a network trace tool to read this code, error type, and additional parameters. Para obter a lista completa, confira Códigos de erro REST do Partner Center.For the full list, see Partner Center REST error codes.

Exemplo de respostaResponse example

HTTP/1.1 200 OK
Content-Length: 487
Content-Type: application/json; charset=utf-8
MS-CorrelationId: 9cbdf63c-2608-4ad8-b0a9-abae27d859d9
MS-RequestId: bad5f75f-fd44-43ab-9325-bbc79dcba9da
MS-CV: f0trvmq8mEScHcFS.0
MS-ServerId: 4
Date: Wed, 24 Oct 2018 22:37:18 GMT
{
  "Value": [

{
      "processedDateTime": "2018-10-14T00:00:00",
      "serviceCode": "crm",
      "serviceName": "Microsoft Dynamics",
      "channel": "reseller",
      "customerTenantId": "0112A436-B14E-4888-967B-CA4BB2CF1234",
      "customerName": "TEST COMPANY",
      "productId": "54B84594-9C77-4499-8D65-5E0D5F410E78",
      "productName": "DYNAMICS AX TASK",
      "licensesDeployed": 0,
      "licensesSold": 9
    },
    {
      "processedDateTime": "2018-10-14T00:00:00",
      "serviceCode": "o365",
      "serviceName": "Microsoft Office 365",
      "channel": "reseller",
      "customerTenantId": "0112A436-B14E-4888-967B-CA4BB2CF1234",
      "customerName": "TEST COMPANY",
      "productId": "D3B4FE1F-9992-4930-8ACB-CA6EC609365E",
      "productName": "DOMESTIC AND INTERNATIONAL CALLING PLAN",
      "licensesDeployed": 0,
      "licensesSold": 5
    }
],
  "@nextLink": null,
  "TotalCount": 2
}