Admin section - HighQ 5.4 API improvements

The following Site API's have been updated in HighQ 5.4

Site metadata

The site metadata capability has been implemented using a system iSheet. The iSheet template used at the system level is called "site metadata" and system iSheet records are maintained for each site.  In order to work with the site metadata, you need to get the system iSheet ID that stores the site metadata. In order to do that, call the site API to get the site object, the site object has been updated to provide you with two new parameters which are:

sitemetadatasheetid and itemid

GET /sites/{site_id}
<site>
          <itemid>444</itemid>
          <sitemetadatasheetid>6</sitemetadatasheetid>
</site>

The site metadatasheetid can now be used to get the system iSheet structure to find out what columns have been configured to store the site metadata fields .

In order to get the metadata record for a specific site call the iSheet item API using the itemid details returned for the site. This will return the current fields for the site metadata.

You can now use the Update item API for the iSheet to update the iSheet item record which will update the site metadata. 

The following iSheet API methods have been updated to support site metadata:

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}

In order to add an attachment that shows as the site metadata attachment, you will need to provide a siteid parameter

Add attachment - 
                             POST /api/9/isheet/{isheetid}/attachment?siteid= ,  
                             POST /api/3/progressivekeystatus/{progressive_key}

The Get User API now returns the role of the user

GET /users/{userId_Email}
<user>
           ...
          <userid>127</userid>
          <email>vijay.odedra@highq.com</email>
          <role>System Admin</role>
</user>

The Get Site list and Get Site API now returns information if its a mySite

GET /sites
<sites>
      <site>
            <id>3</id>
            <sitename>My site</sitename>
            <mysite>true</mysite>
       </site>
</sites>

Ability to get the list of system groups for a user
 

GET /users/{userid}/groups

API to get the list of Application names

GET /configuration/application

The Changes API has been improved to record changes when the site security restrictions are changed 

Ability to get the list of site groups for a user. Available for both admin and normal users.
 

GET /sites/{siteid}/users/{userid}/groups

Favourite sites list now works with site order parameter

GET /sites?ordertype=lastAccessedDate&orderby=desc&filterby=favourite

The Client and Matter Number are returned for an external user

GET /sites
GET /sitetemplates
GET /sites/{site_id}
GET /sites/templates
GET /sites/templates/{template_id}

The Site List API returns the total number of sites for the requesting user

GET /sites

<sites>
	<sitecount>2</sitecount>
	<site>
		<sitename>xyz</sitename>
	</site>
	<site>
		<sitename>abc</sitename>
	</site>
</sites>

The Get Site list API now returns the last accessed date for sites and favourite sites

GET /sites

<sites>
 <site>
     <sitename>abc</sitename>
     <lastaccesseddate></lastaccesseddate>
</site>
<site>
     <sitename>xyz</sitename>
     <lastaccesseddate></lastaccesseddate>
</site>
</sites>