GET
twins/{twinID}/inlinetemplate
Get twin template (including classification).
Resource Information
Method and URI | GET https://developer.api.autodesk.com/tandem/v1/twins/{twinID}/inlinetemplate |
Authentication Context | user context optional |
Required OAuth Scopes | data:read |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via either a two-legged or three-legged OAuth flow. |
* 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
classification object | |
name string | Classification name |
rows array: integer | Array of classification data (code, description, level) |
uuid string | Unique identifier of classification |
classificationId string | Unique identifier of classification |
description string | Description of template |
name string | Template name |
psets array: object | List of parameter sets |
applicationFilters object | |
hidden boolean | |
name string | |
owner string | |
parameters array: object | |
allowedValues object | |
applicationFilters object | When creating a “flattened” pset out of a list of psets in a template, this gets combined from several application filters on psets that may have duplicates of this parameter |
category string | |
context string | |
dataType int | |
description string | |
forgeSpec string | |
forgeSymbol string | |
forgeUnit string | |
name string | |
precision int | |
sourceAttribute string | |
uuid string | |
schemaVersion int | |
uuid string | |
version int | |
uuid string | Unique identifier of template |
Example
This example demonstrates successfully getting the information about the Facility Template that is currently applied. This is the “local” copy of the Template as it was last imported from the Template Library.
Request
curl -v 'https://developer.api.autodesk.com/tandem/v1/twins/urn:adsk.dtt:d5eZt_XtRzqUHT93-vNZxw/inlinetemplate' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsIm....'
Response
{
"uuid": "yxAF6Ja-St-Hz85F0A4pGA",
"name": "Uniclass - ExternalIDs",
"description": "Used to test Maximo and other integrations",
"classification": {
"uuid": "uniclass",
"name": "Uniclass",
"rows": [
[
"Co",
"Complexes (April 2021 - v1.13)",
"1"
],
[
"Co_20",
"Administrative, commercial and protective service complexes",
"2"
],
[
"Co_20_10",
"Legislative complexes",
"3"
],
[
"Ss_55_15_55_32",
"Flotation systems",
"5"
],
[
"Ss_55_15_55_46",
"Lamella plate settling systems",
"5"
],
[
"Ss_55_15_55_76",
"Sludge blanket settling systems",
"5"
],
[
"Ss_55_15_55_78",
"Sludge contact systems",
"5"
],
[
"Ss_55_15_55_80",
"Static settling systems",
"5"
],
[
"Ss_55_15_60",
"Polishing water treatment systems",
"4"
],
[
"Ss_55_15_85_46",
"Lamella plate systems",
"5"
],
[
"Ss_90_84",
"Specific demand of aerospace organizations",
"3"
]
]
},
"classificationId": "uniclass",
"psets": [
{
"version": 0,
"name": "Uniclass - ExternalIDs",
"uuid": "yxAF6Ja-St-Hz85F0A4pGA",
"owner": "",
"applicationFilters": null,
"parameters": [
{
"name": "Expected Life",
"category": "General",
"dataType": 20,
"forgeUnit": "",
"forgeSymbol": "",
"forgeSpec": "",
"precision": 0,
"description": "Expected lifespan of the equipment",
"uuid": "6OuuknhjSj-x3Dko8YiTrQ",
"context": "t",
"applicationFilters": {
"userClass": [
"Pr_30_59_23",
"Pr_30_59_98",
"Pr_40_20_76",
"Pr_40_20_93",
"Pr_40_20_96",
"Pr_40_50",
"Pr_40_70_15_24",
"Pr_60_50",
"Pr_60_50_20_10",
"Pr_60_50_20_28",
"Pr_60_50_47",
"Pr_60_55_97",
"Pr_60_60",
"Pr_60_60_08",
"Pr_60_60_13",
"Pr_60_60_36",
"Pr_60_60_96",
"Pr_60_65_03",
"Pr_60_70_22",
"Pr_60_70_22_15",
"Pr_60_70_22_22",
"Pr_60_70_48",
"Pr_60_70_48_05",
"Pr_60_70_64",
"Pr_60_70_65",
"Pr_60_70_65_63",
"Pr_65_54",
"Pr_65_55_76",
"Pr_65_57_02",
"Pr_65_65_24_93",
"Pr_65_67_16_02",
"Pr_65_67_29",
"Pr_65_67_39",
"Pr_65_70_46",
"Pr_65_72_43_96",
"Pr_65_80",
"Pr_70_60_36",
"Pr_70_60_37",
"Pr_70_65_03",
"Pr_70_65_03_29",
"Pr_70_65_04",
"Pr_70_65_04_25",
"Pr_70_70_47",
"Pr_70_70_48",
"Pr_70_75",
"Pr_75_51",
"Pr_75_51_52",
"Pr_75_75_04",
"Pr_75_80",
"Pr_75_80_30",
"Pr_75_80_30_29",
"Pr_75_80_42_41",
"Pr_80_51_51",
"Pr_80_77_28_29"
]
}
},
{
"name": "Param A",
"category": "JMA Test",
"dataType": 20,
"forgeUnit": "",
"forgeSymbol": "",
"forgeSpec": "",
"precision": 0,
"description": "Test string value A",
"uuid": "70bd69f1-a552-4370-8c49-32383b7b7ccf",
"context": "e",
"applicationFilters": {
"userClass": [
"Pr"
]
}
},
{
"name": "Air Flow, Max",
"category": "HVAC",
"dataType": 2,
"forgeUnit": "cubicFeetPerMinute",
"forgeSymbol": "cfm",
"forgeSpec": "hvac.airFlow",
"precision": 0,
"description": "Maximum air flow",
"uuid": "BSuW48XDT5iZG_n8z1mDSw",
"context": "t",
"applicationFilters": {
"userClass": [
"Pr_70_65_04"
]
}
},
{
"name": "Voltage",
"category": "Electrical",
"dataType": 2,
"forgeUnit": "volts",
"forgeSymbol": "volt",
"forgeSpec": "electrical.potential",
"precision": 0,
"description": "Nominal voltage, operating voltage",
"uuid": "cHlpqr-5SLCkLfUGLu3b5g",
"context": "t",
"applicationFilters": {
"userClass": [
"Pr_70_75"
]
}
},
{
"name": "Air Flow, Min",
"category": "HVAC",
"dataType": 2,
"forgeUnit": "cubicFeetPerMinute",
"forgeSymbol": "cfm",
"forgeSpec": "hvac.airFlow",
"precision": 0,
"description": "Minimum air flow",
"uuid": "cOVQyn9pS4OrGw0gd2ZHGg",
"context": "t",
"applicationFilters": {
"userClass": [
"Pr_70_65_04"
]
}
},
{
"name": "Param B",
"category": "JMA Test",
"dataType": 3,
"forgeUnit": "",
"forgeSymbol": "",
"forgeSpec": "",
"precision": 0,
"description": "Test number value",
"uuid": "d71354b3-723c-414e-b6f8-aaa4c7d184f0",
"context": "e",
"applicationFilters": {
"userClass": [
"EF_25_10"
]
}
},
{
"name": "Test_ID",
"category": "External IDs",
"dataType": 20,
"forgeUnit": "",
"forgeSymbol": "",
"forgeSpec": "",
"precision": 0,
"description": "Use this for manual testing of the External_ID link",
"uuid": "dX4AJGIrQaiHCnaRaKHPdw",
"sourceAttribute": "[Electrical - Loads][# of Ground Conductors][][]",
"context": "e",
"applicationFilters": {
"userClass": [
"Co",
"EF",
"En",
"Pr",
"SL",
"Ss"
]
}
},
{
"name": "Maximo_ID",
"category": "External IDs",
"dataType": 20,
"forgeUnit": "",
"forgeSymbol": "",
"forgeSpec": "",
"precision": 0,
"description": "Link to Maximo Asset ID",
"uuid": "eKlPsGzFSEmgv2Xdd7HsBQ",
"context": "e",
"applicationFilters": {
"userClass": [
"EF",
"En",
"Pr",
"SL",
"Ss"
]
}
},
{
"name": "Installation Date",
"category": "General",
"dataType": 20,
"forgeUnit": "",
"forgeSymbol": "",
"forgeSpec": "",
"precision": 0,
"description": "Date of installation",
"uuid": "ftF8pvXMQKKC5ZTDXUWv5g",
"context": "e",
"applicationFilters": {
"userClass": [
"Pr_30_59_23",
"Pr_30_59_98",
"Pr_40_20_76",
"Pr_40_20_93",
"Pr_40_20_96",
"Pr_40_50",
"Pr_40_70_15_24",
"Pr_60_50",
"Pr_60_50_20_10",
"Pr_60_50_20_28",
"Pr_60_50_47",
"Pr_60_55_97",
"Pr_60_60",
"Pr_60_60_08",
"Pr_60_60_13",
"Pr_60_60_36",
"Pr_60_60_96",
"Pr_60_65_03",
"Pr_60_70_22",
"Pr_60_70_22_15",
"Pr_60_70_22_22",
"Pr_60_70_48",
"Pr_60_70_48_05",
"Pr_60_70_64",
"Pr_60_70_65",
"Pr_60_70_65_63",
"Pr_65_54",
"Pr_65_55_76",
"Pr_65_57_02",
"Pr_65_65_24_93",
"Pr_65_67_16_02",
"Pr_65_67_29",
"Pr_65_67_39",
"Pr_65_70_46",
"Pr_65_72_43_96",
"Pr_65_80",
"Pr_70_60_36",
"Pr_70_60_37",
"Pr_70_65_03",
"Pr_70_65_03_29",
"Pr_70_65_04",
"Pr_70_65_04_25",
"Pr_70_70_47",
"Pr_70_70_48",
"Pr_70_75",
"Pr_75_51",
"Pr_75_51_52",
"Pr_75_75_04",
"Pr_75_80",
"Pr_75_80_30",
"Pr_75_80_30_29",
"Pr_75_80_42_41",
"Pr_80_51_51",
"Pr_80_77_28_29"
]
}
},
{
"name": "Width",
"category": "All Disciplines",
"dataType": 3,
"forgeUnit": "feet",
"forgeSymbol": "lf",
"forgeSpec": "length",
"precision": 2,
"description": "Nominal width",
"uuid": "G4RtB9e_RhK4tKeKwhv8ng",
"context": "t",
"applicationFilters": {
"userClass": [
"Pr_70_65_04"
]
}
},
{
"name": "Manufacturer",
"category": "General",
"dataType": 20,
"forgeUnit": "",
"forgeSymbol": "",
"forgeSpec": "",
"precision": 0,
"description": "Manufacturer's name",
"uuid": "gVjCHAqUROqTJi-GSQmPMA",
"context": "t",
"applicationFilters": {
"userClass": [
"Pr_30_59_23",
"Pr_30_59_98",
"Pr_40_20_76",
"Pr_40_20_93",
"Pr_40_20_96",
"Pr_40_50",
"Pr_40_70_15_24",
"Pr_60_50",
"Pr_60_50_20_10",
"Pr_60_50_20_28",
"Pr_60_50_47",
"Pr_60_55_97",
"Pr_60_60",
"Pr_60_60_08",
"Pr_60_60_13",
"Pr_60_60_36",
"Pr_60_60_96",
"Pr_60_65_03",
"Pr_60_70_22",
"Pr_60_70_22_15",
"Pr_60_70_22_22",
"Pr_60_70_48",
"Pr_60_70_48_05",
"Pr_60_70_64",
"Pr_60_70_65",
"Pr_60_70_65_63",
"Pr_65_54",
"Pr_65_55_76",
"Pr_65_57_02",
"Pr_65_65_24_93",
"Pr_65_67_16_02",
"Pr_65_67_29",
"Pr_65_67_39",
"Pr_65_70_46",
"Pr_65_72_43_96",
"Pr_65_80",
"Pr_70_60_36",
"Pr_70_60_37",
"Pr_70_65_03",
"Pr_70_65_03_29",
"Pr_70_65_04",
"Pr_70_65_04_25",
"Pr_70_70_47",
"Pr_70_70_48",
"Pr_70_75",
"Pr_75_51",
"Pr_75_51_52",
"Pr_75_75_04",
"Pr_75_80",
"Pr_75_80_30",
"Pr_75_80_30_29",
"Pr_75_80_42_41",
"Pr_80_51_51",
"Pr_80_77_28_29"
]
}
},
{
"name": "Param A",
"category": "JMA Test",
"dataType": 20,
"forgeUnit": "",
"forgeSymbol": "",
"forgeSpec": "",
"precision": 0,
"description": "Duplicate test",
"uuid": "rn_qfVTzR1mxn2p3JWAWFQ",
"context": "e",
"applicationFilters": {
"userClass": [
"EF_25_10",
"Pr"
]
}
},
{
"name": "Value 2",
"category": "Streams/Sensors",
"dataType": 3,
"forgeUnit": "",
"forgeSymbol": "",
"forgeSpec": "",
"precision": 0,
"description": "",
"uuid": "VEnH_jABQoC4qo37BV-ydw",
"sourceAttribute": "{\"path\":\"test_val2\"}",
"context": "e",
"applicationFilters": {
"userClass": [
"Pr_80_51"
]
}
},
{
"name": "Value 1",
"category": "Streams/Sensors",
"dataType": 3,
"forgeUnit": "",
"forgeSymbol": "",
"forgeSpec": "",
"precision": 0,
"description": "",
"uuid": "w1VR29ebTRO6Y4TAQxE-lQ",
"sourceAttribute": "{\"path\":\"test_val1\"}",
"context": "e",
"applicationFilters": {
"userClass": [
"Pr_80_51"
]
}
}
],
"hidden": false
}
]
}
Show More
NOTE: The response for /inlinetemplate
is usually very large. The above Response has been greatly trimmed down to just demonstrate the structure.