Queries
elementsByDesignAtVersion
Retrieves elements from given design at given design version, using additional RSQL filters if provided.
Template for Query:
query GetElementsByDesignAtVersion($designId: ID!, $versionNumber: Int!, $filter: ElementFilterInput, $pagination: PaginationInput) {
elementsByDesignAtVersion(designId: $designId, versionNumber: $versionNumber, filter: $filter, pagination: $pagination) {
# ElementsByDesignAtVersion Fields
}
}
Template for Query Variables:
{
"designId" : "<SOME-ID-TYPE-SCALAR-VALUE>",
"versionNumber" : "<SOME-INT-TYPE-SCALAR-VALUE>",
"filter" : "<SOME-ELEMENTFILTER-INPUT-TYPE-VALUE>",
"pagination" : "<SOME-PAGINATION-INPUT-TYPE-VALUE>"
}
Arguments
| designId* ID! non-null | Design to retrieve elements from. |
| versionNumber* Int! non-null | Design version to retrieve elements from. |
| filter | RSQL filter to use for searching elements. |
| pagination | Specifies how to split the response into multiple pages. |
* Required
Possible Returns
| Value Type | Description |
|---|---|
| Elements | Contains a list of Elements returned in response to a query. |
Examples
Example 1
Retrieves elements of category ‘Pipes’ under a design at a specific version by design ID and design’s version number.
Query:
query GetElementsByDesignAtVersion($designId: ID!, $versionNumber: Int!, $filter: ElementFilterInput, $pagination: PaginationInput) {
elementsByDesignAtVersion(designId: $designId, versionNumber: $versionNumber, filter: $filter, pagination: $pagination) {
pagination {
pageSize
cursor
}
results {
id
name
}
}
}
Show More
Query Variables:
{
"designId": "YWVjZH5FMnRqOFJFOXRsSlRQNU9WVzBiaDZ4X0wyQ35yRHlnWFdiYVFIeU81dmlUc0VkUFlR",
"versionNumber": 1,
"filter": {
"query": "property.name.category==Pipes and 'property.name.Element Context'==Instance"
},
"pagination": {
"limit": 5
}
}
Show More
Response:
{
"data": {
"elements": {
"pagination": {
"pageSize": 5,
"cursor": "Y3Vyc35CUT09fjU"
},
"results": [
{
"id": "YWVjZX5FMnRqOFJFOXRsSlRQNU9WVzBiaDZ4X0wyQ35yRHlnWFdiYVFIeU81dmlUc0VkUFlRXzE1M2IxOA",
"name": "HVAC FM CHW,CND,HHW Threaded"
},
{
"id": "YWVjZX5FMnRqOFJFOXRsSlRQNU9WVzBiaDZ4X0wyQ35yRHlnWFdiYVFIeU81dmlUc0VkUFlRXzE1M2IxYg",
"name": "HVAC FM CHW,CND,HHW Threaded"
},
{
"id": "YWVjZX5FMnRqOFJFOXRsSlRQNU9WVzBiaDZ4X0wyQ35yRHlnWFdiYVFIeU81dmlUc0VkUFlRXzE1M2IyMQ",
"name": "HVAC FM CHW,CND,HHW Threaded"
},
{
"id": "YWVjZX5FMnRqOFJFOXRsSlRQNU9WVzBiaDZ4X0wyQ35yRHlnWFdiYVFIeU81dmlUc0VkUFlRXzE1M2IyNA",
"name": "HVAC FM CHW,CND,HHW Threaded"
},
{
"id": "YWVjZX5FMnRqOFJFOXRsSlRQNU9WVzBiaDZ4X0wyQ35yRHlnWFdiYVFIeU81dmlUc0VkUFlRXzE1M2IyNw",
"name": "HVAC FM CHW,CND,HHW Threaded"
}
]
}
}
}
Show More
