Queries
application
Retrieves application information of APS Application based on Authentication token.
Template for Query:
query GetApplication() {
application() {
# Application Fields
}
}
Possible Returns
Value Type | Description |
---|---|
Application | Object representing an application. |
Examples
Example 1
Retrieve application details along with all the collections and property definitions attached to APS application based on authentication token.
Query:
query GetCurrentApplication {
application {
id
name
}
}
Response:
{
"data": {
"application": {
"id": "CfXoaC4K53STwb6TnIrXXZTAIEddG9Ar",
"name": "TestApp"
}
}
}
Show More
Example 2
Retrieve application details along with all the collections and property definitions attached to APS application based on authentication token.
Query:
query GetCurrentApplication($filter: PropertyDefinitionCollectionFilterInput) {
application {
id
name
propertyDefinitionCollections(filter: $filter) {
results {
id
name
definitions{
results{
id
name
isArchived
isHidden
shouldCopy
specification
propertyBehavior
}
}
}
}
}
}
Show More
Query Variables:
{
"filter": {
"id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcxODM4NTM3NDc1Nw"
}
}
Response:
{
"data": {
"application": {
"id": "CfXoaC4K53STwb6TnIrXXZTAIEddG9Ar",
"name": "TestApp",
"propertyDefinitionCollections": {
"results": [
{
"id": "cHJvcGRlZmNvbH5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcxODM4NTM3NDc1Nw",
"name": "prop_def_col_1718385374757",
"definitions": {
"results": [
{
"id": "cHJvcGRlZn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5DZlhvYUM0SzUzU1R3YjZUbklyWFhaVEFJRWRkRzlBcn5wcm9wX2RlZl9jb2xfMTcxODM4NTM3NDc1N35wYXJhbWV0ZXJzLkNmWG9hQzRLNTNTVHdiNlRuSXJYWFpUQUlFZGRHOUFyOjg1Y2QyZjdkNDM2YzRjZjg5MTIyOGRmOGJiZDc4Mjc4LTEuMC4w",
"name": "Surface Texture",
"isArchived": false,
"isHidden": false,
"shouldCopy": true,
"specification": "STRING",
"propertyBehavior": "STANDARD"
}
]
}
}
]
}
}
}
}
Show More