Gebruiksgegevens van licenties ophalen
Informatie over het gebruik van licenties ophalen op workloadniveau voor Office en Dynamics.
Vereisten
Referenties zoals beschreven in Partnercentrum-verificatie. Dit scenario ondersteunt verificatie met App+User-referenties.
REST-aanvraag
Aanvraagsyntaxis
Methode | Aanvraag-URI |
---|---|
GET | {baseURL}/v1/analytics/commercial/usage/license/ HTTP/1.1 |
Aanvraagheaders
Zie Rest-headers van partnercentrum voor meer informatie.
URI-parameters
Parameter | Type | Beschrijving | Vereist |
---|---|---|---|
top | tekenreeks | Het aantal rijen met gegevens dat in de aanvraag moet worden geretourneerd. De maximumwaarde en de standaardwaarde als deze niet is opgegeven, is 10000. Als de query meer rijen bevat, bevat de antwoordtekst een volgende koppeling die u kunt gebruiken om de volgende pagina met gegevens op te vragen. | No |
skip | int | Het aantal rijen dat in de query moet worden overgeslagen. Gebruik deze parameter om grote gegevenssets te doorlopen. Met top=10000 en skip=0 worden bijvoorbeeld de eerste 10000 rijen met gegevens opgehaald, met top=10000 en skip=10000 worden de volgende 10000 rijen met gegevens opgehaald, enzovoort. | No |
filter | tekenreeks | De filterparameter van de aanvraag bevat een of meer instructies waarmee de rijen in het antwoord worden gefilterd. Elke instructie bevat een veld en waarde die zijn gekoppeld aan de eq operatoren of ne , en -instructies kunnen worden gecombineerd met of and or . Hier volgen enkele voorbeeldfilterparameters :filter=workloadCode eq 'SFB' filter=workloadCode eq 'SFB' of (kanaal eq 'Reseller') U kunt de volgende velden opgeven: workloadCode workloadName serviceCode Servicenaam Kanaal customerTenantId customerName Productid Productnaam |
No |
groupby | tekenreeks | Een instructie waarmee gegevensaggregatie alleen wordt toegepast op de opgegeven velden. U kunt de volgende velden opgeven: workloadCode workloadName serviceCode Servicenaam channelcustomerTenantId customerName Productid Productnaam De geretourneerde gegevensrijen bevatten de velden die zijn opgegeven in de parameter groupby en het volgende: licensesActive licensesQualified |
No |
processedDateTime | DateTime | U kunt de datum opgeven vanaf welke gebruiksgegevens zijn verwerkt. Standaard ingesteld op de laatste datum waarop de gegevens zijn verwerkt | No |
Voorbeeld van aanvraag
GET https://api.partnercenter.microsoft.com/partner/v1/analytics/commercial/usage/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
REST-antwoord
Als dit lukt, bevat de hoofdtekst van het antwoord de volgende velden met gegevens over het gebruik van licenties.
Veld | Type | Beschrijving |
---|---|---|
workloadCode | tekenreeks | Workloadcode |
workloadName | tekenreeks | Naam van workload |
serviceCode | tekenreeks | Servicecode |
Servicenaam | tekenreeks | Servicenaam |
Kanaal | tekenreeks | Kanaalnaam, reseller |
customerTenantId | tekenreeks | Unieke id voor de klant |
customerName | tekenreeks | Klantnaam |
productId | tekenreeks | Unieke id voor het product |
Productnaam | tekenreeks | Productnaam |
licensesActive | long | Aantal actieve licenties per workload |
licensesQualified | long | Aantal gekwalificeerde licenties voor de workload |
processedDateTime | DateTime | Datum waarop de gegevens voor het laatst zijn verwerkt |
Geslaagde en foutcodes voor antwoorden
Elk antwoord wordt geleverd met een HTTP-statuscode die aangeeft dat het is gelukt of mislukt en aanvullende informatie over foutopsporing. Gebruik een hulpprogramma voor netwerktracering om deze code, het fouttype en aanvullende parameters te lezen. Zie Partner Center REST-foutcodes voor de volledige lijst.
Voorbeeld van antwoord
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",
"workloadCode": "SPO",
"workloadName": "SharePoint",
"serviceCode": "o365",
"serviceName": "Microsoft Office 365",
"channel": "reseller",
"customerTenantId": "0112A436-B14E-4888-967B-CA4BB2CF1234",
"customerName": "TEST COMPANY",
"productId": "6FD2C87F-B296-42F0-B197-1E91E994B900",
"productName": "OFFICE 365 ENTERPRISE E3",
"licenseActive": 0,
"licensesQualified": 1
},
{
"processedDateTime": "2018-10-14T00:00:00",
"workloadCode": "EXO",
"workloadName": "Exchange",
"serviceCode": "o365",
"serviceName": "Microsoft Office 365",
"channel": "reseller",
"customerTenantId": "0112A436-B14E-4888-967B-CA4BB2CF1234",
"customerName": "TEST COMPANY",
"productId": "45A2423B-E884-448D-A831-D9E139C52D2F",
"productName": "EXCHANGE ONLINE PROTECTION",
"licenseActive": 0,
"licensesQualified": 1
}
}