Request

Response

    POST

    models/{modelID}/getstreamssecrets

    Retrieves ingestion secret(s), associated with specific data stream(s).

    Resource Information

    Method and URI
    POST
    https://developer.api.autodesk.com/tandem/v1/models/{modelID}/getstreamssecrets
    Authentication Context
    user context optional
    Required OAuth Scopes
    data:write
    Data Format
    JSON

    Request

    Headers

    Authorization*
    string
    Must be Bearer <token>, where <token> is a two-legged access token obtained via a Client Credentials Grant flow, or a three-legged access token obtained via Authorization Code flow, Authorization Code flow with PKCE, or Secure Service Account flow (for headless scenarios).
    Region
    string
    Specifies the region where your request should be routed. Possible values: US, EMEA. For more details, see Regions.
    Content-Type*
    string
    Must be application/json
    * Required

    Request

    URI Parameters

    modelID
    string
    ID of the model owning the stream

    Request

    Body Structure

    Query, containing list of keys to get secrets for

    hardReset
    boolean
    Only relevant in the reset secret context.
    includeEmpty
    boolean
    Only relevant in the query context (if false, missing secret results in a 404).
    keys
    array: string
    List of element IDs (with flags) to get secrets for.

    Response

    HTTP Status Code Summary

    200
    OK
    OK
    403
    Forbidden
    The request was successfully validated but it did not have the required permissions.
    404
    Not Found
    The requested resource was not found. Check the URI of your request before you resend this request.
    500
    Internal Server Error
    The service encountered an error that it was unable to handle. Wait for a few minutes and resend the request. If the error persists, contact us at aps.help@autodesk.com.

    Response

    Body Structure (200)

    string

    Example

    This example demonstrates successfully getting the stream secrets for a given set of streams. NOTE: streams are in the “default” model of a given twin.

    Request

    curl -v 'https://developer.api.autodesk.com/tandem/v1/models/urn:adsk.dtm:d5eZt_XtRzqUHT93-vNZxw/getstreamssecrets' \
      -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsIm....'
    

    Response

    {
        "AQAAADAHSf1eZk5riuuYV0Rrh8kAAAAA": "bvYu5r_VSqC3FWsmse6uoQ",
        "AQAAADbRZeoiJ0Vnku5FJJvH5F8AAAAA": "8oMjkI7sTS2erpcu9XJzKA"
    }