Overview
This use case will show how to use the Ardoq Import Builder to fetch data from the the Halo ITSM API, specifically focusing on tickets.
Setting Up the Connection
Pre-requisites in Halo ITSM
You will need to create an application in Halo ITSM API application.
In Halo ITSM, from the main menu, go to Configurations > Integrations > HaloITSM API and click View Applications.
Click New and create a new application with the Client ID and Secret (Services) authentication type. Copy the Client ID and Client Secret for use later in the connection creation.
Set the Login Type to Agent and select an agent account that will query the API.
Switch to the Permissions tab and enable the permissions for the assets you wish to query. In our case, we'll need to tick read:tickets.
Finally, click Save to finalize your application.
Ardoq Connection
In Ardoq, open up the Import Builder, go to the Connections tab and create a new connection. Next, configure the following setting for a basic set up:
Set the Base URL to your Halo ITSM domain, for instance
ardoq.haloitsm.comSet the Authentication method to OAuth 2.0 client credentials
Set the client ID and client secret values to those you got from Halo ITSM
Set the Auth URL to
https://[domain-name].haloitsm.com/auth/token, for instance:https://ardoq.haloitsm.com/auth/tokenSet the Scope to all
Set the endpoint to
/api/tickets?paginate=TrueThe
paginatequery parameter is required to enable pagination in the Halo ITSM API
Set the Pagination method to Page-based
Set the Limit parameter name to
page_sizeand the Limit value to 50Set the Page parameter name to
page_noClick Run to verify your connection.
In the response, select the tickets array — and verify that the the response data looks correct.
Finally, click on Save connection.
Your configuration should look similar to the following:
Running the Connection
Return to the Import Builder connections page in Ardoq and select the connection you just created.
The data you configured in the previous step will now appear as a table to query and map in the tabular importer.