Request

Response

    GET

    modeldata/{modelID}/schema

    Returns a model schema for a given model.

    Resource Information

    Method and URI
    GET
    https://developer.api.autodesk.com/tandem/v1/modeldata/{modelID}/schema
    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

    modelID
    string
    Model URN

    Response

    HTTP Status Code Summary

    200
    OK
    OK
    403
    Forbidden
    The request was successfully validated but it did not have the required permissions.

    Response

    Body Structure (200)

    Expand all
    attributes
    array: object
    List of property definitions
    allowedValues
    object
    Optional list of allowed values
    category
    string
    Category of the property (display value)
    col
    string
    Column identifier
    context
    string
    Optional context
    dataType
    int
    Numeric value which describes data type of property. Supported values are: 0 = Unknown, 1 = Boolean, 2 = Integer, 3 = Double, 4 = Float, 20 = String, 21 = Localizable string, 22 = Date time (ISO 8601 date), 23 = Geolocation (ISO 6709 Annex H string), 24 = Position (“x y z w” space separated string), 25 = URL)
    dataTypeContext
    string
    Optional data type context
    description
    string
    Optional description of the property
    displayName
    string
    Optional display name of the property
    displayOptions
    object
    Optional list of display options, sorted according to allowedValues.list on a best effort basis
    flags
    int
    Optional property flags
    forgeSpec
    string
    Optional specification (APS)
    forgeSymbol
    string
    Optional symbol (APS)
    forgeUnit
    string
    Optional unit (APS)
    name
    string
    Name of the property
    precision
    int
    Optional numeric precision
    version
    string
    Version of the schema (v1)

    Example

    This example demonstrates successfully getting the schema definition from a specific modelURN.

    Request

    curl -v 'https://developer.api.autodesk.com/tandem/v1/modeldata/urn:adsk.dtm:k5ZZZkIYQ9ixvxFDVBNoTg/schema' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsIm....'
    

    Response

    {
        "version": "v1",
        "attributes": [
            {
                "id": "n:b",
                "fam": "n",
                "col": "b",
                "name": "System Class",
                "category": "Common",
                "dataType": 2,
                "flags": 8
            },
            {
                "id": "n:!u",
                "fam": "n",
                "col": "!u",
                "name": "Assembly Code",
                "category": "Common",
                "dataType": 20
            },
            {
                "id": "n:c",
                "fam": "n",
                "col": "c",
                "name": "Category Id",
                "category": "Common",
                "dataType": 2,
                "flags": 8
            },
            {
                "id": "n:el",
                "fam": "n",
                "col": "el",
                "name": "Elevation",
                "category": "Common",
                "dataType": 3
            },
            {
                "id": "n:cfg",
                "fam": "n",
                "col": "n:cfg",
                "name": "Configuration",
                "category": "Common",
                "dataType": 10,
                "flags": 1
            },
            {
                "id": "k",
                "fam": "",
                "col": "k",
                "name": "externalId",
                "category": "ID",
                "dataType": 20,
                "flags": 9
            },
            {
                "id": "n:!b",
                "fam": "n",
                "col": "!b",
                "name": "System Class",
                "category": "Common",
                "dataType": 2
            },
            {
                "id": "n:n",
                "fam": "n",
                "col": "n",
                "name": "Name",
                "category": "Common",
                "dataType": 20,
                "flags": 8
            },
            {
                "id": "r:6QM",
                "fam": "r",
                "col": "6QM",
                "name": "Side_Keystone_Bases",
                "category": "Dimensions",
                "dataType": 3,
                "dataTypeContext": "autodesk.unit.unit:feetFractionalInches-1.0.0",
                "displayName": "Side_Keystone_Bases",
                "forgeUnit": "feetFractionalInches"
            },
            {
                "id": "r:8AY",
                "fam": "r",
                "col": "8AY",
                "name": "Stile",
                "category": "Materials and Finishes",
                "dataType": 20,
                "displayName": "Stile"
            },
    
            {
                "id": "z:zQc",
                "fam": "z",
                "col": "zQc",
                "name": "Voltage",
                "category": "Electrical",
                "dataType": 2,
                "description": "Nominal voltage, operating voltage",
                "flags": 16,
                "forgeUnit": "volts",
                "forgeSymbol": "volt",
                "forgeSpec": "electrical.potential",
                "context": "t"
            },
            {
                "id": "r:zgE",
                "fam": "r",
                "col": "zgE",
                "name": "Thermal expansion coefficient Y",
                "category": "Materials and Finishes",
                "dataType": 3,
                "dataTypeContext": "autodesk.unit.unit:inverseDegreesFahrenheit-1.0.1",
                "displayName": "Thermal expansion coefficient Y",
                "flags": 8,
                "forgeUnit": "inverseDegreesFahrenheit"
            },
            {
                "id": "r:zgI",
                "fam": "r",
                "col": "zgI",
                "name": "Thermal expansion coefficient Z",
                "category": "Materials and Finishes",
                "dataType": 3,
                "dataTypeContext": "autodesk.unit.unit:inverseDegreesFahrenheit-1.0.1",
                "displayName": "Thermal expansion coefficient Z",
                "flags": 8,
                "forgeUnit": "inverseDegreesFahrenheit"
            },
            {
                "id": "r:zgM",
                "fam": "r",
                "col": "zgM",
                "name": "Centerline Symbol",
                "category": "Graphics",
                "dataType": 20,
                "displayName": "Centerline Symbol"
            },
            {
                "id": "r:zgQ",
                "fam": "r",
                "col": "zgQ",
                "name": "Grade",
                "category": "Materials and Finishes",
                "dataType": 20,
                "displayName": "Grade"
            },
            {
                "id": "r:zgU",
                "fam": "r",
                "col": "zgU",
                "name": "Elevation Mark Use",
                "category": "Other",
                "dataType": 20,
                "displayName": "Elevation Mark Use"
            },
            {
                "id": "r:zgY",
                "fam": "r",
                "col": "zgY",
                "name": "Moves With Grids",
                "category": "Constraints",
                "dataType": 1,
                "displayName": "Moves With Grids"
            },
            {
                "id": "z:zgc",
                "fam": "z",
                "col": "zgc",
                "name": "Air Flow, Min",
                "category": "HVAC",
                "dataType": 2,
                "description": "Minimum air flow",
                "flags": 16,
                "forgeUnit": "cubicFeetPerMinute",
                "forgeSymbol": "cfm",
                "forgeSpec": "hvac.airFlow",
                "context": "t"
            },
            {
                "id": "r:zwE",
                "fam": "r",
                "col": "zwE",
                "name": "Power Load",
                "category": "Energy Analysis",
                "dataType": 3,
                "dataTypeContext": "autodesk.unit.unit:britishThermalUnitsPerHour-1.0.1",
                "displayName": "Power Load",
                "flags": 8,
                "forgeUnit": "britishThermalUnitsPerHour"
            },
            {
                "id": "r:zwI",
                "fam": "r",
                "col": "zwI",
                "name": "Start Join Cutback",
                "category": "Geometric Position",
                "dataType": 3,
                "dataTypeContext": "autodesk.unit.unit:feetFractionalInches-1.0.0",
                "displayName": "Start Join Cutback",
                "forgeUnit": "feetFractionalInches"
            },
            {
                "id": "r:zwM",
                "fam": "r",
                "col": "zwM",
                "name": "End Fx",
                "category": "Releases / Member Forces",
                "dataType": 1,
                "displayName": "End Fx",
                "flags": 8
            },
            {
                "id": "r:zwQ",
                "fam": "r",
                "col": "zwQ",
                "name": "Heating Information",
                "category": "Energy Analysis",
                "dataType": 20,
                "displayName": "Heating Information"
            },
            {
                "id": "r:zwU",
                "fam": "r",
                "col": "zwU",
                "name": "Cut with Voids When Loaded",
                "category": "Other",
                "dataType": 1,
                "displayName": "Cut with Voids When Loaded"
            },
            {
                "id": "r:zwY",
                "fam": "r",
                "col": "zwY",
                "name": "Primary Air Flow",
                "category": "Mechanical - Flow",
                "dataType": 3,
                "dataTypeContext": "autodesk.unit.unit:cubicFeetPerMinute-1.0.1",
                "displayName": "Primary Air Flow",
                "flags": 8,
                "forgeUnit": "cubicFeetPerMinute"
            },
            {
                "id": "z:zwc",
                "fam": "z",
                "col": "zwc",
                "name": "Installation Date",
                "category": "General",
                "dataType": 20,
                "description": "Date of installation",
                "flags": 16,
                "context": "e"
            },
            {
                "id": "z:3Qc",
                "fam": "z",
                "col": "3Qc",
                "name": "Param bool",
                "category": "JMA Test",
                "dataType": 1,
                "description": "test boolean value",
                "flags": 17,
                "context": "e"
            },
            {
                "id": "z:3gc",
                "fam": "z",
                "col": "3gc",
                "name": "Doc link",
                "category": "JMA Test",
                "dataType": 25,
                "description": "test document links",
                "flags": 17,
                "context": "e"
            },
            {
                "id": "z:3wc",
                "fam": "z",
                "col": "3wc",
                "name": "Param A",
                "category": "JMA Test",
                "dataType": 20,
                "description": "Test string value A",
                "flags": 16,
                "context": "e"
            },
            {
                "id": "z:4Ac",
                "fam": "z",
                "col": "4Ac",
                "name": "M&Ms Color",
                "category": "JMA Test",
                "dataType": 20,
                "description": "Test restricted values param",
                "flags": 17,
                "allowedValues": {
                    "list": [
                        "Green",
                        "Brown",
                        "Red",
                        "Yellow"
                    ]
                },
                "context": "e"
            },
            {
                "id": "z:4Qc",
                "fam": "z",
                "col": "4Qc",
                "name": "Param B",
                "category": "JMA Test",
                "dataType": 3,
                "description": "Test number value",
                "flags": 16,
                "context": "e"
            },
            {
                "id": "z:4gc",
                "fam": "z",
                "col": "4gc",
                "name": "Beta",
                "category": "JMA Test",
                "dataType": 3,
                "description": "test number",
                "flags": 17,
                "precision": 2,
                "context": "e"
            },
            {
                "id": "z:4wc",
                "fam": "z",
                "col": "4wc",
                "name": "Alpha",
                "category": "JMA Test",
                "dataType": 20,
                "description": "test str",
                "flags": 17,
                "context": "e"
            },
            {
                "id": "z:5Ac",
                "fam": "z",
                "col": "5Ac",
                "name": "Maximo_ID",
                "category": "External IDs",
                "dataType": 20,
                "description": "Link to Maximo Asset ID",
                "flags": 16,
                "context": "e"
            },
            {
                "id": "z:5Qc",
                "fam": "z",
                "col": "5Qc",
                "name": "Amperage",
                "category": "Electrical",
                "dataType": 3,
                "description": "Maximum load/capacity, Rated Load Amps (RLA), Full Load Amps (FLA) design current, etc.",
                "flags": 16,
                "forgeUnit": "amperes",
                "forgeSymbol": "ampere",
                "forgeSpec": "electrical.current",
                "context": "t"
            },
            {
                "id": "z:5gc",
                "fam": "z",
                "col": "5gc",
                "name": "Robin_ID",
                "category": "External IDs",
                "dataType": 20,
                "description": "Link to Robin room ID",
                "flags": 16,
                "context": "e"
            },
            {
                "id": "z:5wc",
                "fam": "z",
                "col": "5wc",
                "name": "Test_ID",
                "category": "External IDs",
                "dataType": 20,
                "description": "Use this for manual testing of the External_ID link",
                "flags": 16,
                "context": "e"
            },
            {
                "id": "z:6Ac",
                "fam": "z",
                "col": "6Ac",
                "name": "Value 2",
                "category": "Streams/Sensors",
                "dataType": 3,
                "flags": 20,
                "context": "e"
            },
            {
                "id": "z:6Qc",
                "fam": "z",
                "col": "6Qc",
                "name": "Value 1",
                "category": "Streams/Sensors",
                "dataType": 3,
                "flags": 20,
                "context": "e"
            },
            {
                "id": "z:6gc",
                "fam": "z",
                "col": "6gc",
                "name": "Param A",
                "category": "JMA Test",
                "dataType": 20,
                "description": "Duplicate test",
                "flags": 16,
                "context": "e"
            },
            {
                "id": "z:6wc",
                "fam": "z",
                "col": "6wc",
                "name": "Barometer",
                "category": "Streams/Sensors",
                "dataType": 3,
                "description": "Barometric Pressure",
                "flags": 20,
                "forgeUnit": "atmospheres",
                "forgeSymbol": "atm",
                "forgeSpec": "hvac.pressure",
                "context": "e"
            }
        ]
    }
    
    Show More