New idea

Filter Sites by Custom Properties using API

Is it possible to filter sites by custom site properties added using the system-level isheet metadata feature (the "Site Metadata" iSheet)?

I do not see a reference to that here:  https://collaborate.highq.com/sitepoint/wikiHome.action?metaData.siteID=714&metaData.wikiID=23444

Mark Salamon

  •  , no it isn't and I raised this in a support ticket (#94333):

    BUG: 5.4/5.5 Site meta-data iSheet not supported with iSheet Adv Search API

    Regarding the release notes for Collaborate 5.4 - Site meta-data: (https://collaborate.highq.com/sitepoint/wikiHome.action?metaData.siteID=714&metaData.wikiID=42740)

    It states the following API methods have been updated to support site meta-data:

    • Get attachment (GET /api/11/isheet/item/{itemid}/attachment/{attachmentid})
    • Update item (PUT /api/11/isheet/{isheetid}/items/{itemid})
    • Get item (GET /api/11/isheet/{isheetid}/items/{itemid})

    However, one important missing method from the above is the Advanced Search method (POST /api/11/isheet/{isheetid}/search)
    https://collaborate.highq.com/sitepoint/wikiHome.action?metaData.siteID=714&metaData.wikiID=26409

    I've verified this endpoint does not work with Site meta-data iSheets, where the response received is 403 Access Denied.
    This is true for both 5.4.10 and 5.5.0-RC.1

    Perhaps this was simply missed, however, as this isn't currently supported, the only way to filter sites by their iSheet meta-data is to retrieve ALL site info one by one, then for each site, obtain the iSheet meta-data item ID (and sheet ID) and call the supported Get Item endpoint. Then, after all data is collated, filter the list accordingly.

    What's at odds is that the Collaborate UI does seem to support Advanced Searching (Manage Sites page) so it doesn't seem it's a technical limitation. The workaround mention above isn't exactly a scalable alternative either, when we are dealing with hundreds of sites.

    It's also worth noting that the Get Site List endpoint (https://collaborate.highq.com/sitepoint/wikiHome.action?metaData.siteID=714&metaData.wikiID=23444) also does not return iSheet meta-data related site properties, though was updated to include other properties, as stated in the release notes mentioned at the start. Seems very odd that you would update this endpoint but not include the work done for site meta-data iSheets.

     

     

    HIGHQ Development Team Response (received 24th Feb 2021):
    I have been advised by our development team that the advance search and get function does not work for site metadata as per design. Currently the only functions available are add/update site metadata.

     

     

    So we can update site meta-data, but not use it to search for sites matching that meta-data criteria, not programmatically anyway. Not sure why they mentioned add, as site iSheet items are implicitly created.

    If you want support for site meta-data searching, i.e. site filtering based on site iSheet meta-data, then we need to ask for it, and the more that ask, the higher the priority. I'm still waiting for a non-admin API method to get (extended) column info (think choice options) dynamically, but hey it's only been 6 years