Advance API URL

The Advance API URL is the base URL to which you make API requests.

Overview

The URL consists of the path to the Advance API application and the API version you want to use. The format of the URL is typically:

  • https://{tenancyMoniker}.{serverName}.{yourDomain}/HdaApi/rest/v{apiVersionNumber}/

Where:

  • tenancyMoniker – the name of the Advance tenancy against which you are making requests; for example, tenancy1
  • serverName – the server on which Advance is installed; for example, testserver01
  • yourDomain – the domain under which Advance is installed; for example, yourorganization.com
  • apiVersionNumber – the version number of the Advance API you are using, e.g. v1.1

You need to know this URL when looking up the API documentation and making requests to the API endpoints.

For example, the URL for a request to get all work items in the tenancy might look like:

  • https://tenancy1.testserver01.yourorganization.com/HdaApi/rest/v1.1/WorkItems

Workflow

You use the base URL when making requests to the Advance REST API.