Skip to content

Resources

The resources in this page are available for both the getFloors and getFloorById query.

Floor object

Base properties of the floor object. Can be combined with the FloorFilter

graphql
query {
  getFloors {
    floors {
      id
      name
      customId
      createdAt
      updatedAt
      isPrivate
    }
  }
}
query {
  getFloors {
    floors {
      id
      name
      customId
      createdAt
      updatedAt
      isPrivate
    }
  }
}

Floor aggregation methods

Area, element count and space count can be computed for each floor.

graphql
query {
  getFloors {
    floors {
      area
      elementCount
      spaceCount
    }
  }
}
query {
  getFloors {
    floors {
      area
      elementCount
      spaceCount
    }
  }
}

You can use area and spaceCount with the SpaceFilter, elementCount with the ElementFilter.

graphql
query {
  getFloors {
    floors {
      meetArea: area(where: { program: { eq: "meet" } })
      workArea: area(where: { program: { eq: "work" } })
      meetCount: spaceCount(where: { program: { eq: "meet" } })
      workCount: spaceCount(where: { program: { eq: "work" } })
      windowCount: elementCount(where: { type: { eq: "element:window" } })
    }
  }
}
query {
  getFloors {
    floors {
      meetArea: area(where: { program: { eq: "meet" } })
      workArea: area(where: { program: { eq: "work" } })
      meetCount: spaceCount(where: { program: { eq: "meet" } })
      workCount: spaceCount(where: { program: { eq: "work" } })
      windowCount: elementCount(where: { type: { eq: "element:window" } })
    }
  }
}

Labels

Listing all labels attached to a space.

graphql
query {
  getFloors {
    floors {
      labels {
        color
        name
      }
    }
  }
}
query {
  getFloors {
    floors {
      labels {
        color
        name
      }
    }
  }
}

Location

Retrieve location as address or latitude longitude coordinates.

graphql
query {
  getFloors {
    floors {
      location {
        address {
          line1
          city
          country
          floor
        }
        coordinates {
          lat
          long
          bearing
        }
      }
    }
  }
}
query {
  getFloors {
    floors {
      location {
        address {
          line1
          city
          country
          floor
        }
        coordinates {
          lat
          long
          bearing
        }
      }
    }
  }
}

Custom attributes

Custom attributes are available for floors, spaces, elements and products.

graphql
query {
  getFloors {
    floors {
      customAttributes {
        key
        value
        title
      }
      spaces {
        customAttributes {
          key
          value
          title
        }
      }
      elements {
        customAttributes {
          key
          value
          title
        }
        product {
          customAttributes {
            key
            value
            title
          }
        }
      }
    }
  }
}
query {
  getFloors {
    floors {
      customAttributes {
        key
        value
        title
      }
      spaces {
        customAttributes {
          key
          value
          title
        }
      }
      elements {
        customAttributes {
          key
          value
          title
        }
        product {
          customAttributes {
            key
            value
            title
          }
        }
      }
    }
  }
}

Spaces

List the spaces in a floor. Can be filtered with the SpaceFilter

graphql
query {
  getFloors {
    floors {
      spaces {
        id
        name
        customId
        area
        program
        seatCapacity
        usage
      }
    }
  }
}
query {
  getFloors {
    floors {
      spaces {
        id
        name
        customId
        area
        program
        seatCapacity
        usage
      }
    }
  }
}

Elements by floor

Elements on a floor

graphql
query {
  getFloors {
    floors {
      elements {
        id
        name
        customId
        type
      }
    }
  }
}
query {
  getFloors {
    floors {
      elements {
        id
        name
        customId
        type
      }
    }
  }
}

Elements can be filtered using the ElementFilter

graphql
query {
  getFloors {
    floors {
      elements(where: { type: { eq: "element:asset" } }) {
        id
      }
    }
  }
}
query {
  getFloors {
    floors {
      elements(where: { type: { eq: "element:asset" } }) {
        id
      }
    }
  }
}

Elements by space

Elements that are within ( assets ) or adjacent ( walls ) to a space

graphql
query {
  getFloors {
    floors {
      spaces {
        elements {
          id
          name
          customId
          type
        }
      }
    }
  }
}
query {
  getFloors {
    floors {
      spaces {
        elements {
          id
          name
          customId
          type
        }
      }
    }
  }
}