Skip to content

Get metadata document

GET{{API_BASE_URL}}/ticketinghub/odata/v1/$metadata

The authoritative column catalogue for all four datasets. This is what a BI or ETL tool reads to map the schema, and what you should point a code generator at.

Request

No parameters and no body.

Response

An XML CSDL document. For every dataset it states:

  • every column, with its type
  • whether each column is nullable
  • which columns form the key
  • an Org.OData.Core.V1.Description annotation per column, holding its business label

Notes

Generated from the running build, so it can never drift from the instance you are querying. Column sets do evolve as the underlying datasets do, which is exactly why reading the catalogue beats maintaining your own copy of it — a loader driven by $metadata keeps working across releases.

Most OData connectors — Power BI, Tableau, Azure Data Factory, Fivetran — read this automatically when you point them at the service root. See Connecting your BI tool.

Two caveats on what you will find here. It describes types, not value sets: a status column appears as Edm.String, and what it can actually contain is in Datasets → Column values. And the labels for the custom registration fields (TicketOwnerInfo*) are generic, because only your own registration configuration knows what those hold.

Authentication#auth

This endpoint does not require authentication.

Headers#headers

AuthorizationBearer {{ACCESS_TOKEN}}

Required. A client-credentials token carrying the scope ticketinghub-api and no subject.

Responses#responses

200OKGet metadata document (abridged)