Request

Response

    GET

    twins/{twinID}

    Returns the twin definition.

    Resource Information

    Method and URI
    GET
    https://developer.api.autodesk.com/tandem/v1/twins/{twinID}
    Authentication Context
    user context optional
    Required OAuth Scopes
    data:read
    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.
    * Required

    Request

    URI Parameters

    twinID
    string
    Twin URN

    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)

    Expand all
    accessLevel
    int
    Level of access to the corresponding resource.
    accountGroup
    string
    accountType
    string
    Account type
    boundByUpperFloor
    boolean
    Use overhead floor slab as upper bounds for room assignment
    dateCreated
    string
    Date of creation of the facility.
    dateModified
    string
    docs
    array: object
    List of documents linked to the facility.
    accAccountId
    string
    Optional account ID of Autodesk Docs where original document is stored
    accLineage
    string
    Optional item id of document
    accProjectId
    string
    Optional project ID of Autodesk Docs where original document is stored
    accVersion
    string
    Optional version of of document
    contentType
    string
    content type (i.e. application/pdf)
    id
    string
    Unique id of document
    label
    string
    Optional label
    lastUpdated
    string
    Optional timestamp of last modification (ISO 8601 format)
    name
    string
    Document name
    s3Path
    string
    S3 storage location
    signedLink
    string
    Optional signed URL
    uploadPending
    boolean
    Optional readability of a document
    etag
    string
    links
    array: object
    List of models linked to the facility.
    accessLevel
    int
    Level of access to the corresponding resource.
    disciplines
    array: string
    label
    string
    main
    boolean
    modelId
    string
    on
    boolean
    props
    object
    Identity Data
    object
    Address
    string
    Building Name
    string
    Owner
    string
    Project Name
    string
    timeZone
    string
    TimeZone IANA identifier from iana.org/time-zones
    Other
    object
    Project Number
    string
    handover
    object
    receiverId
    string
    receiverName
    string
    Cached details on the receiver’s account
    twinId
    string
    URN of the transferred Twin
    region
    string
    schemaVersion
    int
    Schema version used by the models of this twin
    schemaVersionUpgradeTriggered
    int
    timestamp of the last attempt to trigger a schema upgrade
    skipRoomBounders
    boolean
    Don’t assign walls/ceilings/floors to rooms
    template
    object
    classificationId
    string
    Unique identifier of classification
    description
    string
    Description of template
    name
    string
    Template name
    psetIds
    array: string
    List of parameter ids
    uuid
    string
    Unique identifier of template
    thumbnailLastUpdate
    int
    Timestamp of the last thumbnail update in Unix milliseconds.

    Example

    This example demonstrates successfully getting the information about a specific twin (aka “facility”).

    Request

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

    Response

    {
        "links": [
            {
                "disciplines": null,
                "label": "R21 Mill Building - Elec.rvt",
                "main": false,
                "modelId": "urn:adsk.dtm:fTIXhuewSxuROOMTHC5yUQ",
                "on": true,
                "accessLevel": "Owner"
            },
            {
                "disciplines": null,
                "label": "R21 Mill Building - Mech.rvt",
                "main": false,
                "modelId": "urn:adsk.dtm:mNn_ajmuR96t-hIQLa47eQ",
                "on": true,
                "accessLevel": "Owner"
            },
            {
                "disciplines": null,
                "label": "R21 Mill Building - Arch.rvt",
                "main": true,
                "modelId": "urn:adsk.dtm:k5ZZZkIYQ9ixvxFDVBNoTg",
                "on": true,
                "accessLevel": "Owner"
            },
            {
                "disciplines": null,
                "label": "",
                "main": false,
                "modelId": "urn:adsk.dtm:d5eZt_XtRzqUHT93-vNZxw",
                "on": true,
                "accessLevel": "Owner"
            }
        ],
        "docs": [
            {
                "id": "urn:adsk.dtd:4uY1NEJjTpGiuG9kGMLG7w",
                "contentType": "application/pdf",
                "s3Path": "d5eZt_XtRzqUHT93-vNZxw/e2e63534-4263-4e91-a2b8-6f6418c2c6ef/v0",
                "lastUpdated": "2022-05-31T17:00:45Z",
                "signedLink": "https://tandem.autodesk.com/api/v1/twins/urn:adsk.dtt:d5eZt_XtRzqUHT93-vNZxw/documents/urn:adsk.dtd:4uY1NEJjTpGiuG9kGMLG7w/content?lastupdated=1654016445",
                "name": "schlage_warranty.pdf",
                "accProjectId": "b.510b9020-0be4-4a1e-abae-8da3e438955d",
                "accAccountId": "b.485ec674-e1cf-48cf-9aff-022376591171",
                "accLineage": "urn:adsk.wipprod:dm.lineage:Rog3z9MoRmuf80HmcKXWoA",
                "accVersion": "urn:adsk.wipprod:fs.file:vf.Rog3z9MoRmuf80HmcKXWoA?version=1"
            },
            {
                "id": "urn:adsk.dtd:HlsYAql5TmSnIzLD4t_3Og",
                "contentType": "application/pdf",
                "s3Path": "d5eZt_XtRzqUHT93-vNZxw/1e5b1802-a979-4e64-a723-32c3e2dff73a/v0",
                "lastUpdated": "2022-05-31T17:00:45Z",
                "signedLink": "https://tandem.autodesk.com/api/v1/twins/urn:adsk.dtt:d5eZt_XtRzqUHT93-vNZxw/documents/urn:adsk.dtd:HlsYAql5TmSnIzLD4t_3Og/content?lastupdated=1654016445",
                "name": "301-1070D_KS_8013D-1160.pdf",
                "accProjectId": "b.510b9020-0be4-4a1e-abae-8da3e438955d",
                "accAccountId": "b.485ec674-e1cf-48cf-9aff-022376591171",
                "accLineage": "urn:adsk.wipprod:dm.lineage:BZjAcVQHQKCnAXWWRLXfYQ",
                "accVersion": "urn:adsk.wipprod:fs.file:vf.BZjAcVQHQKCnAXWWRLXfYQ?version=1"
            },
            {
                "id": "urn:adsk.dtd:RmcWEt7FTaSCYGkmw8qR2g",
                "contentType": "application/pdf",
                "s3Path": "d5eZt_XtRzqUHT93-vNZxw/46671612-dec5-4da4-8260-6926c3ca91da/v0",
                "lastUpdated": "2022-05-31T17:00:45Z",
                "signedLink": "https://tandem.autodesk.com/api/v1/twins/urn:adsk.dtt:d5eZt_XtRzqUHT93-vNZxw/documents/urn:adsk.dtd:RmcWEt7FTaSCYGkmw8qR2g/content?lastupdated=1654016445",
                "name": "300-1.3_KS-SKS_Catalog.pdf",
                "accProjectId": "b.510b9020-0be4-4a1e-abae-8da3e438955d",
                "accAccountId": "b.485ec674-e1cf-48cf-9aff-022376591171",
                "accLineage": "urn:adsk.wipprod:dm.lineage:VQKP5jA0QLaCVWhfZj3GVw",
                "accVersion": "urn:adsk.wipprod:fs.file:vf.VQKP5jA0QLaCVWhfZj3GVw?version=1"
            },
            {
                "id": "urn:adsk.dtd:oTu7dvOTT36Qj968fpe20Q",
                "contentType": "application/pdf",
                "s3Path": "d5eZt_XtRzqUHT93-vNZxw/a13bbb76-f393-4f7e-908f-debc7e97b6d1/v0",
                "lastUpdated": "2022-05-31T17:00:45Z",
                "signedLink": "https://tandem.autodesk.com/api/v1/twins/urn:adsk.dtt:d5eZt_XtRzqUHT93-vNZxw/documents/urn:adsk.dtd:oTu7dvOTT36Qj968fpe20Q/content?lastupdated=1654016445",
                "name": "Brochure - Fleet&Network.pdf",
                "accProjectId": "b.510b9020-0be4-4a1e-abae-8da3e438955d",
                "accAccountId": "b.485ec674-e1cf-48cf-9aff-022376591171",
                "accLineage": "urn:adsk.wipprod:dm.lineage:ZW_t7DbQR-O1w-KTOYeSEw",
                "accVersion": "urn:adsk.wipprod:fs.file:vf.ZW_t7DbQR-O1w-KTOYeSEw?version=1"
            }
        ],
        "props": {
            "Identity Data": {
                "Address": "1 Market St #500, San Francisco, CA 94105",
                "Building Name": "Mill",
                "Owner": "Mr. X",
                "Project Name": "Autodesk Samples"
            },
            "Other": {
                "Project Number": ""
            }
        },
        "dateCreated": "2022-05-24T23:45:09Z",
        "boundByUpperFloor": false,
        "skipRoomBounders": false,
        "template": {
            "uuid": "yxAF6Ja-St-Hz85F0A4pGA",
            "name": "Uniclass - ExternalIDs",
            "description": "Used to test Maximo and other integrations",
            "classificationId": "uniclass",
            "psetIds": [
                "yxAF6Ja-St-Hz85F0A4pGA"
            ]
        },
        "accessLevel": "Owner",
        "accountGroup": "urn:adsk.dtg:ysqziKwTSCejQaUVfqj32Q",
        "accountType": "free",
        "dateModified": "2023-07-26T07:46:43Z",
        "etag": "1690357603997"
    }
    
    Show More