Request

Response

    Reference Guide

    HTTP Specification

    This page provides an overview of the endpoints that are accessible via HTTPS and originate at https://developer.api.autodesk.com/tokenflex/v1/.

    Note: Each of the endpoints listed below provide responses that are only specific to the client ID performing the API invocation.

    For an overview of the Token Flex Usage Data API endpoints, see API Basics for more information.

    Contracts
    EndpointDescription
    GET contract Gets a list of all contracts.
    GET contract/:contract_number Gets details about the specified contract.
    GET contract/:contract_number/enrichment Gets a list of enrichment fields for the specified contract.
    GET contract/:contract_number/enrichment/:enrichment_category Returns a list of all unique values in the specified enrichment_category.
    GET contract/:contract_number/:field Returns a list of all unique values in the specified field (note: only standard fields, not custom enrichment fields).

    Usage
    EndpointDescription
    GET usage/:contract_number/summary Get summary usage data at a monthly level.
    GET usage/:contract_number/last Gets last updated dates for the specified contract.
    POST usage/:contract_number/query Run a custom ad-hoc query.
    GET usage/:contract_number/query/:query_id Get status and results of a custom ad-hoc query.

    Export
    EndpointDescription
    POST /export/:contract_number/requests Request a new export.
    GET /export/:contract_number/requests List existing export requests.
    GET /export/:contract_number/requests/:request_key Get details of a specific export.
    DELETE /export/:contract_number/requests/:request_key Delete a specific export request (along with any associated files)
    POST /export/:contract_number/requests/:request_key/retry Retry a previous (failed) export.
    POST /export/:contract_number/requests/:request_key/refreshUrl Get a fresh pre-signed download URL for the specified export.
    POST /export/:contract_number/requests/markRead Mark the specified export as read.
    GET /export/:contract_number/schedules List scheduled exports.
    POST /export/:contract_number/schedules Setup a new schedule for exports.
    GET /export/:contract_number/schedules/:schedule_id Get an existing scheduled export.
    PUT /export/:contract_number/schedules/:schedule_id Update an existing scheduled export.
    DELETE /export/:contract_number/schedules/:schedule_id Delete an existing export schedule.