Dit artikel is vertaald met behulp van AI en kan kleine onnauwkeurigheden bevatten. Raadpleeg de Engelse versie voor volledige nauwkeurigheid.
Met de Reports API kun je elk rapport bekijken en exporteren dat is aangemaakt in BlueDolphin.
Overzicht van het downloaden van een rapport:
Haal een lijst met rapporten op en kies er één.
Exporteer het geselecteerde rapport.
Download het geëxporteerde bestand.
Volg de stappen in dit artikel om een rapport uit je BlueDolphin-omgeving te downloaden via de API.
Vereisten
Om BlueDolphin API's te gebruiken voor integraties, heb je het volgende nodig:
Een BlueDolphin-omgeving
Stel een API-sleutel in om in dit voorbeeld te gebruiken in je BlueDolphin-omgeving.
Stap 1: Selecteer een rapport
Je moet eerst het rapport selecteren dat je wilt exporteren. Alleen rapporten die zijn opgeslagen in de Dataset-map zijn beschikbaar om te downloaden.
Dit is het rapport dat we willen exporteren uit BlueDolphin:
1. Haal de lijst met beschikbare rapporten op
$ curl -X GET "https://{base}/api/v1/datasource-reports" \
-H "apiKey: f08a2bb9-3ab4-451a-9099-2ef531375147" \
-H "tenant: contoso"
Vervang:
{base} door "services.eu.bluedolphin.app" of "services.us.bluedolphin.app", voor respectievelijk EU- en US-tenants.
2. Controleer het resultaat en kies het rapport dat je wilt downloaden
Je ontvangt een antwoord zoals hieronder, het resultaat bevat een lijst met rapporten:
{
"error_code": 0,
"error_message": null,
"error_message_explain": null,
"data": [
...,
{
"name": "All applications Report",
"uri": "/Datasets/All_applications_Report"
},
]
}
Je moet het uri-veld onthouden van het rapport dat je wilt exporteren, zodat je dit in het volgende verzoek kunt gebruiken. In deze handleiding gebruiken we "/Datasets/All_applications_Report".
Stap 2: Exporteer het rapport
1. Bereid de parameters voor de export voor
{
"outputformat": "<outputformat>",
"reporturi": "<reporturi>",
"sharedaccessstring": "<sharedaccessstring>"
}Vervang:
<outputformat> door het gewenste uitvoerformaat. Ondersteunde formaten zijn: csv, xml, xls, xlsx. In het voorbeeld gebruiken we 'csv'.
<reporturi> door de uri van de geselecteerde dataset, bijvoorbeeld "/Datasets/All_applications_Report".
<sharedaccessstring> door een shared access string naar een blob-container, die schrijfrechten moet hebben. Het uitvoerbestand wordt op deze locatie geplaatst, bijvoorbeeld de string die je krijgt van de 'Get write shared access string'-endpoint.
2. Stuur een verzoek om het geselecteerde rapport te exporteren
$ curl -X POST "https://{base}/api/v1/datasource-reports/export" \
-H "apiKey: f08a2bb9-3ab4-451a-9099-2ef531375147" \
-H "tenant: contoso"
--data-raw '{
"outputformat": "csv",
"reporturi": "/Datasets/All_applications_Report",
"sharedaccessstring": "https://bddatastorageprd.blob.core.windows.net/97e78613-795e-4fc3-9cb1-d8ce344ea6ab?sv=2018-03-28&sr=c&sig=HsfuH%2B8Iqz2iN1tklQW7H5TVwEQuFr9mpZL9nn60d4M%3D&se=2022-01-17T13%3A30%3A05Z&sp=w"
}'Vervang:
{base} door "services.eu.bluedolphin.app" of "services.us.bluedolphin.app", voor respectievelijk EU- en US-tenants.
Stap 3: Download het uitvoerbestand
Nadat de export is voltooid, kun je het rapport downloaden dat op de opgegeven blobopslaglocatie is geplaatst.
1. Controleer het resultaat van het exportverzoek
{
"error_code": 0,
"error_message": null,
"error_message_explain": null,
"data": {
"file_name": "42e97865-ffed-4408-9670-10f218ddb8cf"
}
}
De file_name uit het resultaat is de naam van het geëxporteerde rapport. Dit bestand staat op de eerder opgegeven blobopslag.
2. Haal een read access string op die verwijst naar het geëxporteerde bestand
https://{base}/public-api/v0.1/sharedaccessstring/read?blob_name=<file-name>"Vervang:
{base} door "services.eu.bluedolphin.app" of "services.us.bluedolphin.app", voor respectievelijk EU- en US-tenants.
<file-name> door de bestandsnaam uit het exportresultaat, bijvoorbeeld "42e97865-ffed-4408-9670-10f218ddb8cf".
$ curl -X GET "https://{base}/api/v1/sharedaccessstring/read?blob_name=42e97865-ffed-4408-9670-10f218ddb8cf" \
-H "apiKey: f08a2bb9-3ab4-451a-9099-2ef531375147" \
-H "tenant: contoso"Vervang:
{base} door "services.eu.bluedolphin.app" of "services.us.bluedolphin.app", voor respectievelijk EU- en US-tenants.
Het resultaat bevat een read access string naar het bestand. Hiermee kun je het bestand downloaden.
{
"error_code": 0,
"error_message": null,
"error_message_explain": null,
"data": "https://bdtst00eudata.blob.core.windows.net/97e78613-795e-4fc3-9cb1-d8ce344ea6ab/42e97865-ffed-4408-9670-10f218ddb8cf?sv=2018-03-28&sr=b&sig=tQg9MY74rEwQWmxfG44G7Psh2wAhjS7vsSM2KFZvbfA%3D&se=2022-01-17T16%3A20%3A43Z&sp=r"
}De link is één uur geldig.
3. Download het bestand.
$ curl -X GET "https://bdtst00eudata.blob.core.windows.net/97e78613-795e-4fc3-9cb1-d8ce344ea6ab/42e97865-ffed-4408-9670-10f218ddb8cf?sv=2018-03-28&sr=b&sig=tQg9MY74rEwQWmxfG44G7Psh2wAhjS7vsSM2KFZvbfA%3D&se=2022-01-17T16%3A20%3A43Z&sp=r"
Uitvoer:
ID,Title,Version,Vendor,Category
5npOMiLzKK,Google Chrome,97.0.4692,Google Inc.,Browsers
ugumq9vKF2,Mozilla Firefox,96.0.1,Mozilla,Browsers
yXmx2D5F17,Notepad++,8.2,Notepad++ Team,Code editor
rfAh8ttZ5H,VLC media player,3.0.16,VideoLAN,Media player
xvqVA5OoWj,Visual Studio Code,1.63.2,Microsoft,Code editor