Queries
exchangeByFileUrn
Retrieves a single exchange by externalProjectId and fileUrn.
Template for Query:
query GetExchangeByFileUrn($externalProjectId: ID!, $fileUrn: ID!) {
exchangeByFileUrn(externalProjectId: $externalProjectId, fileUrn: $fileUrn) {
# ExchangeByFileUrn Fields
}
}
Template for Query Variables:
{
"externalProjectId" : "<SOME-ID-TYPE-SCALAR-VALUE>",
"fileUrn" : "<SOME-ID-TYPE-SCALAR-VALUE>"
}
Arguments
externalProjectId* ID! non-null | The external project Id. |
fileUrn* ID! non-null | The Exchange file Id. |
* Required
Possible Returns
Value Type | Description |
---|---|
Exchange! non-null |
A specific collection of Elements. |
Examples
Example 1
Retrieves a single exchange by exchangeFileIUrn and ProjectId.
Query:
query GetExchangeByFileUrn($externalProjectId: ID!, $fileUrn: ID!) {
exchangeByFileUrn(externalProjectId: $externalProjectId, fileUrn: $fileUrn) {
id
name
elements {
results {
id
name
}
}
}
}
}
Show More
Query Variables:
{
"externalProjectId" : "22a5dc47-ca19-4231-9f3e-157ebd4842ff",
"fileUrn" : "urn:adsk.wipprod:fs.file:vf.TtCj4eUwSaSlYnoveo3Znw"
}
Response:
{
"data": {
"exchangeByFileUrn": {
"id": "ZXhjfnlwdWFzY1NicWlIT0R1R0s4OUkwTHdfTDJDfmQ5N2Y2MTUxLTZhNTAtMzhjMi1hYmY5LWI0OGYxMDYyNGU5ZQ",
"name": "3D_Architectural_Overall_1791_Objects",
"elements": {
"results": [
{
"id": "034E45FDC11CA33DB6B8D00165C9E5A68C2770C6",
"name": "Railing__55607"
},
{
"id": "01A98D866211C82009CACC28C46746B12EFA5F6F",
"name": "264811"
},
{
"id": "0BCEFFBD45DCB27A186CE1DFA5E906EE107CF7F2",
"name": "73704"
},
{
"id": "068B1135E85D2D8C381CCE33343A682FB0E9AE19",
"name": "155396"
},
{
"id": "07A5428127B7E5FB720A96860EC345AD90A74453",
"name": "396667"
}
]
}
}
}
}
Show More