Obtener la información de implementación de licenciasGet licenses deployment information

Se aplica aApplies To

  • Centro de partnersPartner Center

Cómo obtener información de implementación para licencias de Office y Dynamics.How to get deployment information for Office and Dynamics licenses.

Requisitos previosPrerequisites

Credenciales tal como se describen en el artículo Autenticación del Centro de partners.Credentials as described in Partner Center authentication. Este escenario admite la autenticación con credenciales de aplicación y usuario.This scenario supports authentication with App+User credentials.

Solicitud RESTREST request

Sintaxis de la solicitudRequest syntax

MétodoMethod URI de la solicitudRequest URI
GETGET {baseurl}/v1/Analytics/Commercial/Deployment/License/http/1.1{baseURL}/v1/analytics/commercial/deployment/license/ HTTP/1.1

Encabezados de solicitudRequest headers

Para obtener más información, consulta Encabezados REST del Centro de partners.For more information, see Partner Center REST headers.

Parámetros de URIURI parameters

ParámetroParameter TipoType DescripciónDescription ObligatorioRequired
toptop stringstring Número de filas de datos que se devuelven en la solicitud.The number of rows of data to return in the request. El valor máximo y el valor predeterminado, si no se especifican, es 10 000.The maximum value and the default value if not specified is 10000. Si hay más filas en la consulta, el cuerpo de la respuesta incluye un vínculo que puedes usar para solicitar la siguiente página de datos.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 Número de filas que se omiten en la consulta.The number of rows to skip in the query. Usa este parámetro para consultar grandes conjuntos de datos.Use this parameter to page through large data sets. Por ejemplo, los valores top=10000 y skip=0 recuperan las primeras 10 000 filas de datos, los valores top=10000 y skip=10000 recuperan las siguientes 10 000 filas de datos, y así sucesivamente.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 stringstring

El parámetro filter de la solicitud contiene una o más instrucciones que filtran las filas de la respuesta.The filter parameter of the request contains one or more statements that filter the rows in the response. Cada instrucción contiene un campo y un valor que están asociados a eq los ne operadores o, y las instrucciones se pueden combinar mediante and o 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. Estos son algunos ejemplos de parámetros filter:Here are some example filter parameters:

  • Filter = serviceCode EQ ' O365 'filter=serviceCode eq 'O365'
  • Filter = serviceCode EQ ' O365 ' or (Channel EQ ' reseller ')filter=serviceCode eq 'O365' or (channel eq 'Reseller')

Puede especificar los campos siguientes:You can specify the following fields

  • serviceCodeserviceCode
  • serviceNameserviceName
  • MiCanalchannel
  • customerTenantIdcustomerTenantId
  • customerNamecustomerName
  • productIdproductId
  • ProductNameproductName
NoNo
groupbygroupby stringstring

Una instrucción que aplica la agregación de datos únicamente a los campos especificados.A statement that applies data aggregation only to the specified fields. Puedes especificar los siguientes campos:You can specify the following fields:

  • serviceCodeserviceCode
  • serviceNameserviceName
  • MiCanalchannel
  • customerTenantIdcustomerTenantId
  • customerNamecustomerName
  • productIdproductId
  • ProductNameproductName

Las filas de datos que se devuelvan contendrán los campos especificados en el parámetro groupby y en los siguientes:The returned data rows will contain the fields specified in the groupby parameter as well as the following:

  • licensesDeployedlicensesDeployed
  • licensesSoldlicensesSold
NoNo
processedDateTimeprocessedDateTime DateTimeDateTime Se puede especificar la fecha desde la que se procesaron los datos de uso.One can specify the date from which usage data was processed. Tiene como valor predeterminado la última fecha en que se procesaron los datosDefaults to the latest date when the data was processed NoNo

Ejemplo de solicitudRequest 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

Respuesta RESTREST response

Si se realiza correctamente, el cuerpo de la respuesta contiene los siguientes campos que contienen datos sobre las licencias implementadas.If successful, the response body contains the following fields containing data about the licenses deployed.

CampoField TipoType DescripciónDescription
serviceCodeserviceCode stringstring Código de servicioService code
serviceNameserviceName stringstring Nombre del servicioService name
canalchannel stringstring Nombre del canal, ResellerChannel name, reseller
customerTenantIdcustomerTenantId stringstring Identificador único para el clienteUnique identifier for the customer
customerNamecustomerName stringstring Nombre de clienteCustomer name
productIdproductId stringstring Identificador único del productoUnique identifier for the product
ProductNameproductName stringstring Nombre de productoProduct name
licensesDeployedlicensesDeployed longlong Número de licencias implementadasNumber of licenses deployed
licensesSoldlicensesSold longlong Número de licencias vendidasNumber of licenses sold
processedDateTimeprocessedDateTime DateTimeDateTime Fecha en que se procesaron los datos por última vezDate when the data was last processed

Códigos de error y de respuesta correctosResponse success and error codes

Cada respuesta incluye un código de estado HTTP que indica si la operación se ha realizado correctamente o con errores y proporciona información de depuración adicional.Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use una herramienta de seguimiento de red para leer este código, el tipo de error y los parámetros adicionales.Use a network trace tool to read this code, error type, and additional parameters. Para obtener la lista completa, consulta Códigos de error de REST del Centro de partners.For the full list, see Partner Center REST error codes.

Ejemplo de respuestaResponse 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
}