HighQ 5.3

HighQ 5.3 changes for the files module

OVERVIEW

Other API changes are as belows:

1. Add Folder

Path: /{version}/folders

Method: POST

Newly Added Parameter: allowduplicatefolder

Purpose: To allow or prevent a user from creating a duplicate folder in the same folder.

Possible values:

  • true: Allow the duplicate folder to be added, irrespective of the same folder already existing(existing functionality)
  • false: Prevent the user from adding a duplicate folder if the same folder already exists

Default value: true

Response codes:

  • 409 (Conflicts), if allowduplicatefolder:"false" and the same folder already exists in the given folder
  • 201 (Success), if allowduplicatefolder:"false" and the same folder does not exist in the given folder
  • 201 (Success),  if allowduplicatefolder:"true"

Response body: 

  • if allowduplicatefolder: "false" and the same folder already exists
  • Then, we'll get folderId of the existing oldest active folder

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<folder>
<id>201069</id>
</folder>

Screenshots:

HighQ 5.3 changes for the files module-1.png

HighQ 5.3 changes for the files module-2.png

2. Move folder

Path: /folders/{folderid}/parent

Method: PUT

Changes: The move folder operation is now enabled for the folder admin as previously, the access was limited to the content admin. The folder which the user has folder admin rights to, will be moved to the target level, leaving the subfolders/files behind and revoking the users admin access. To maintain a hierarchy, the required folders are created at the target level.

 

3. Move file

Path: /files/{fileid}/parent

Method: PUT

Changes: The move file action is now enabled for the folder admin, as previously, the access was limited to the content admin. The file's parent folder where  the user has admin rights, will be moved to the target level.

 

4. Copy folder

Path: /folders/{folderid}/parent

Method: POST

Changes:

  1. Copy folder user access
                 The copy folder operation is now enabled for the folder admin as previously, the access was limited to the content admin. The folder where the user has folder admin rights will be copied to the target level, leaving the subfolders/files behind where the user has no admin access to.
     
  2. Site restriction  

                  In ASP admin : "Apply site restriction rule for API" is TRUE
   

                  In API version 8 onward
                         In the source site or target site, site restriction (Terms & condition, Enable site password, Enable two factor authentication) is selected and authenticated (or is not). If it is not authenticated, then the API response is as follows:

                         Example : Configured "Terms & Conditions" in source site or target site or both site
                             Response code : 403
                             Response body :

                                  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                                        <error>
                                             <link> https://savan.local.com/savan_dev_5_3/checkSiteSecurityTrustEntries.action?value=rU3SMrA7EhM3meKpUbw2bqxEQbpSzjQxbBV7gsu2YpNsZTWyJY5PIg==&amp;siteId=3044 </link>
                                             <ref>434</ref>
                                             <summary>Please accept the Terms & Conditions to access this site</summary>
                                       </error>
    
                  In API version up to 7
                           In the source site or target site has site restrictions applied (Terms & condition, Enable site password, Enable two factor authentication). The API responses given are:
     
                          Example : Configured "Terms & Conditions" in target site or both site          
                               Response code : 403
                               Response body :

                                    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                                   <error>
                                          <summary>Access denied</summary>
                                   </error>

 

5. Copy file

Path: /files/{fileid}/parent

Method: POST

Changes:

  1. Copy file user Access  
                   The copy file operation is now enabled for the folder admin as previously, the access was limited to a content admin. The file's parent folder where the user has admin rights, will be copied to the target level.
       
  2. Copy file from attachment and index folder 
                   Users will now be able to copy files from an attachment folder or inbox folder to same site folder or other site folder.
     

  3. Site restriction 
         In ASP admin : "Apply site restriction rule for API" is TRUE
       

         In API version 8 onward
                 In the source site or target site, if site restrictions (Terms & condition, Enable site password, Enable two factor authentication) is checked and/or authenticated (or not). If it is not authenticated then the API response is as follows: 

                 Example : Configured "Terms & Conditions" in source site or target site or both site
                         Response code : 403
                         Response body :

                              <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                              <error>
                                    <link> https://savan.local.com/savan_dev_5_3/checkSiteSecurityTrustEntries.action?value=rU3SMrA7EhM3meKpUbw2bqxEQbpSzjQxbBV7gsu2YpNsZTWyJY5PIg==&amp;siteId=3044 </link>
                                    <ref>434</ref>
                                    <summary>Please accept the Terms & Conditions to access this site</summary>
                             </error>
        
         In API version up to 7
                In the source site or target site, applied site restrictions (Terms & condition, Enable site password, Enable two-factor authentication) gives the following API response:
         
                Example: Configured "Terms & Conditions" in the target site or both site          
                       Response code : 403
                       Response body :

                            <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                           <error>
                                    <summary>Access denied</summary>
                           </error>


    Redaction API Changes List are below

     

1. Download file
Path: /{version}/files/{fileid}/content
Method: GET

Changes: 
These changes are available in API version 1 to 8 and HighQ version 5.3 onwards.

  • Redacted files will be served if the file is redacted. Redacted files will also always be in .pdf format

  • Restricted files are downloaded as the originals to a normal user
    Response: 

    Error: 403
{
  "summary": "Access denied"
}

     

  • Previous versions of redacted files are download-restricted to normal users.
    Response:

    Error: 403
{
  "summary": "Access denied"
}

2. Copy file
Path: /{version}/files/{fileid}/parent
Method: POST
Changes: 
This change is available in API versions 1 to 8 and Collaborate versions 5.3 onwards

  • If a file is redacted and then burnt, the redacted file will be copied as a .pdf file


3. Copy folder
Path:  /{version}/folders/{folderid}/parent
Method: POST
Changes: 
This change is available in API versions 1 to 8 and Collaborate versions 5.3 onwards

  • If a file is redacted in the copying folder and then burnt, the redacted file will be copied as a .pdf file in the copied folder

4. Delete file from Recycle

Path: /{version}/files/{fileid}/recycle
Method:  DELETE

Changes: 
This change is available in API versions 1 to 8 and Collaborate versions 5.3 onwards

  • When a redacted file is permanently deleted then the cache file is removed from the redactionCache folder from the repository, and the Redaction XML and annotation XML is removed from the repository affiliated with file.

5. Gets the changes for sync
Path: /{version}/changes
Method: GET
Changes: 
This change is available in API versions 1 to 8 and Collaborate versions 5.3 onwards

  • When the Enable document redaction property has it's value changed at ASP level, that change will be shown in the changes list
    Response:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <changes>
    <nextsyncposition>21459</nextsyncposition>
    <items>
      <item>
        <changeid>21459</changeid>
        <contenttype>CONTENT_SYSTEM</contenttype>
        <eventid>51</eventid>
        <sourceclient>
        </sourceclient>
        <createddate>16 Jan 2020 11:45</createddate>
        <itemdetails>
          <id>-1</id>
          <parentid>-1</parentid>
          <siteid>-1</siteid>
        </itemdetails>
      </item>
	  <item>
        <changeid>21458</changeid>
        <contenttype>CONTENT_SYSTEM</contenttype>
        <eventid>52</eventid>
        <sourceclient>
        </sourceclient>
        <createddate>16 Jan 2020 11:45</createddate>
        <itemdetails>
          <id>-1</id>
          <parentid>-1</parentid>
          <siteid>-1</siteid>
        </itemdetails>
      </item>
    </items>
  </changes>

  • When the Enable document redaction property value changes at site level, that change will be provided in the changes list
    Response:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <changes>
    <nextsyncposition>21457</nextsyncposition>
    <items>
      <item>
        <changeid>21457</changeid>
        <contenttype>CONTENT_SITE</contenttype>
        <eventid>53</eventid>
        <sourceclient>
        </sourceclient>
        <createddate>16 Jan 2020 11:32</createddate>
        <itemdetails>
          <id>-1</id>
          <parentid>-1</parentid>
          <siteid>4098</siteid>
        </itemdetails>
      </item>
      <item>
        <changeid>21456</changeid>
        <contenttype>CONTENT_SITE</contenttype>
        <eventid>54</eventid>
        <sourceclient>
        </sourceclient>
        <createddate>16 Jan 2020 11:32</createddate>
        <itemdetails>
          <id>-1</id>
          <parentid>-1</parentid>
          <siteid>4098</siteid>
        </itemdetails>
      </item>
    </items>
  </changes>

  • When a Document has been redacted, saved, updated or deleted, the change will be listed in the changes list
    Response:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <changes>
    <nextsyncposition>21453</nextsyncposition>
    <items>
     <item>
        <changeid>21455</changeid>
        <contenttype>CONTENT_DOCUMENT</contenttype>
        <eventid>48</eventid>
        <sourceclient>
        </sourceclient>
        <createddate>16 Jan 2020 11:22</createddate>
        <itemdetails>
          <id>7584</id>
          <contentname>Jan 2020</contentname>
          <parentfolder>preConvertToPDF-Test</parentfolder>
          <parentfolderpath>/preConvertToPDF-Test/</parentfolderpath>
          <parentid>6593</parentid>
          <siteid>4098</siteid>
        </itemdetails>
     </item> 
     <item>
        <changeid>21453</changeid>
        <contenttype>CONTENT_DOCUMENT</contenttype>
        <eventid>49</eventid>
        <sourceclient>
        </sourceclient>
        <createddate>16 Jan 2020 11:19</createddate>
        <itemdetails>
          <id>7584</id>
          <contentname>Jan 2020</contentname>
          <parentfolder>preConvertToPDF-Test</parentfolder>
          <parentfolderpath>/preConvertToPDF-Test/</parentfolderpath>
          <parentid>6593</parentid>
          <siteid>4098</siteid>
        </itemdetails>
      </item>
	  <item>
        <changeid>21454</changeid>
        <contenttype>CONTENT_DOCUMENT</contenttype>
        <eventid>50</eventid>
        <sourceclient>
        </sourceclient>
        <createddate>16 Jan 2020 11:21</createddate>
        <itemdetails>
          <id>7584</id>
          <contentname>Jan 2020</contentname>
          <parentfolder>preConvertToPDF-Test</parentfolder>
          <parentfolderpath>/preConvertToPDF-Test/</parentfolderpath>
          <parentid>6593</parentid>
          <siteid>4098</siteid>
        </itemdetails>
      </item>
	</items>
  </changes>

6. Gets the file info
Path: /{version}/files/{fileid}
Method: GET
Changes: 
This change is available in API versions 1 to 8 and Collaborate versions 5.3 onwards

  • You can get a file's Redaction status based on whether the file is redacted or not
    Response:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <file>
    <name>New Text Document</name>
    <id>7585</id>
    <folderID>6593</folderID>
    <siteid>4098</siteid>
    <versionid>1</versionid>
    <versionnote>
    </versionnote>
    <createddate>10 Jan 2020 10:34</createddate>
    <modifieddate>10 Jan 2020 10:34</modifieddate>
    <type>txt</type>
    <size>89</size>
    <icon>https://rushin.local.com/rushin_dev/images/fileicon/large_default.svg</icon>
    <commentscount>0</commentscount>
    <likescount>0</likescount>
    <tags/>
    <location>preConvertToPDF-Test</location>
    <createdby>
      <firstname>Tom</firstname>
      <lastname>Chick</lastname>
      <email>tom.chick@highq.com</email>
      <userid>100</userid>
    </createdby>
    <modifiedby>
      <firstname>Tom</firstname>
      <lastname>Chick</lastname>
      <email>tom.chick@highq.com</email>
      <userid>100</userid>
    </modifiedby>
    <permission>
      <view>1</view>
      <edit>1</edit>
      <delete>1</delete>
    </permission>
    <contentstatus>1</contentstatus>
    <redactionstatus>true</redactionstatus>
  </file>

7. Gets the file list
Path: /{version}/files
Method: GET

Changes: 
This change is available in API version 1 to 8 and Collaborate versions 5.3 onwards

  • You can get a file's Redaction status based on whether file is redacted or not within file list
    Response:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <files>
    <filetotal>4</filetotal>
    <file>
      <name>New Text Document 1</name>
      <id>7586</id>
      <folderID>6593</folderID>
      <siteid>4098</siteid>
      <versionid>2</versionid>
      <createddate>10 Jan 2020 13:18</createddate>
      <modifieddate>16 Jan 2020 09:21</modifieddate>
      <type>pdf</type>
      <size>5383</size>
      <icon>https://rushin.local.com/rushin_dev/images/fileicon/large_default.svg</icon>
      <commentscount>0</commentscount>
      <likescount>0</likescount>
      <location>preConvertToPDF-Test</location>
      <createdby>
        <firstname>Tom</firstname>
        <lastname>Chick</lastname>
        <email>tom.chick@highq.com</email>
        <userid>100</userid>
      </createdby>
      <modifiedby>
        <firstname>Tom</firstname>
        <lastname>Chick</lastname>
        <email>tom.chick@highq.com</email>
        <userid>100</userid>
      </modifiedby>
      <permission>
        <view>1</view>
        <edit>1</edit>
        <delete>1</delete>
      </permission>
      <redactionstatus>false</redactionstatus>
    </file>
    <file>
      <name>New Text Document</name>
      <id>7585</id>
      <folderID>6593</folderID>
      <siteid>4098</siteid>
      <versionid>1</versionid>
      <createddate>10 Jan 2020 10:34</createddate>
      <modifieddate>10 Jan 2020 10:34</modifieddate>
      <type>txt</type>
      <size>89</size>
      <icon>https://rushin.local.com/rushin_dev/images/fileicon/large_default.svg</icon>
      <commentscount>0</commentscount>
      <likescount>0</likescount>
      <location>preConvertToPDF-Test</location>
      <createdby>
        <firstname>Tom</firstname>
        <lastname>Chick</lastname>
        <email>tom.chick@highq.com</email>
        <userid>100</userid>
      </createdby>
      <modifiedby>
        <firstname>Tom</firstname>
        <lastname>Chick</lastname>
        <email>tom.chick@highq.com</email>
        <userid>100</userid>
      </modifiedby>
      <permission>
        <view>1</view>
        <edit>1</edit>
        <delete>1</delete>
      </permission>
      <redactionstatus>true</redactionstatus>
    </file>
</files>

8. Get Activity List
Path: /{version}/activities
Method: GET
Changes: 
This change is available in API versions 1 to 8 and Collaborate versions 5.3 onwards

  • You can now get the Redaction status of a content type(file), if redaction is enabled at site and ASP admin level
    Response:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <activities>
<activity>
      <activitydesc>Tom Chick uploaded a file</activitydesc>
      <activitydeschtml><![CDATA[]]></activitydeschtml>
      <timepublished>07 Jan 2020 13:57</timepublished>
      <actors>
        <actor>
          <username>Tom Chick</username>
          <email>tom.chick@highq.com</email>
          <httpavatar>https://rushin.local.com/rushin_dev/images/griffin/socialdealroom/avatar/48avatar.gif</httpavatar>
          <avatar>https://rushin.local.com/rushin_dev/api/2/users/100/avatar?size=48&amp;lastmodifieddate=1568949913470</avatar>
          <userlink>https://rushin.local.com/rushin_dev/api/2/users/100</userlink>
          <httplink>https://rushin.local.com/rushin_dev/viewUserProfile.action?metaData.encryptTargetUserID=E7gcHZJOZvM=&amp;metaData.updateUserProfileProcess=true</httplink>
        </actor>
      </actors>
      <sitename>Test_Pre_Convert_To_PDF</sitename>
      <siteid>4097</siteid>
      <addcommentaccess>1</addcommentaccess>
      <contentitem>
        <id>7564</id>
        <title>r7vme357</title>
        <link>https://rushin.local.com/rushin_dev/externalAccess.action?linkParam=248Md4JKaximeA4F1dPL8xJ%2Bml%2FsN0OwQhMz9VP5HpA%3D&amp;documentDownload=link</link>
        <apilink>https://rushin.local.com/rushin_dev/api/2/files/7564/content</apilink>
        <type>files</type>
        <imagetype>dxf</imagetype>
        <filesize>451145</filesize>
        <version>1</version>
        <siterootfolderid>0</siterootfolderid>
        <author>
          <username>Tom Chick</username>
          <email>tom.chick@highq.com</email>
          <httpavatar>https://rushin.local.com/rushin_dev/images/griffin/socialdealroom/avatar/48avatar.gif</httpavatar>
          <avatar>https://rushin.local.com/rushin_dev/api/2/users/100/avatar?size=48&amp;lastmodifieddate=1568949913470</avatar>
          <userlink>https://rushin.local.com/rushin_dev/api/2/users/100</userlink>
          <httplink>https://rushin.local.com/rushin_dev/viewUserProfile.action?metaData.encryptTargetUserID=E7gcHZJOZvM=&amp;metaData.updateUserProfileProcess=true</httplink>
        </author>
        <datepublished>07 Jan 2020 13:57</datepublished>
        <parentcontent>
          <title>Test_Pre_Convert_To_PDF</title>
          <link>https://rushin.local.com/rushin_dev/documentHome.action?metaData.siteID=4097&amp;metaData.parentFolderID=6588</link>
          <apilink>https://rushin.local.com/rushin_dev/api/2/folders/6588</apilink>
        </parentcontent>
        <redactionstatus>true</redactionstatus>
      </contentitem>
      <contentspecificdetail>
        <versionnotes>
        </versionnotes>
        <folderid>6588</folderid>
        <folderpath>/</folderpath>
        <folderhttplink>https://rushin.local.com/rushin_dev/documentHome.action?metaData.siteID=4097&amp;metaData.parentFolderID=6588</folderhttplink>
      </contentspecificdetail>
      <activitytypealias>ACTIVITY_DOCUMENT_ADDED</activitytypealias>
      <timepublisedutc>07 Jan 2020 13:57:31</timepublisedutc>
    </activity>
</activities>

  • You can now get the Redaction status of a content item(microblog with redacted file as file attachment or image attachment) if redaction is enabled at ASP admin level
    Response:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <activities>
	<activity>
      <activitydesc>test redacted file from kk</activitydesc>
      <activitydeschtml>
        <![CDATA[<p>test redacted file from kk</p>
        
]]>
      </activitydeschtml>
      <timepublished>07 Jan 2020 10:02</timepublished>
      <actors>
        <actor>
          <username>Krushnakant</username>
          <email>krushnakant@highq.com</email>
          <httpavatar>https://rushin.local.com/rushin_dev/images/griffin/socialdealroom/avatar/48avatar.gif</httpavatar>
          <avatar>https://rushin.local.com/rushin_dev/api/2/users/128/avatar?size=48&amp;lastmodifieddate=1567499957170</avatar>
          <userlink>https://rushin.local.com/rushin_dev/api/2/users/128</userlink>
          <httplink>https://rushin.local.com/rushin_dev/viewUserProfile.action?metaData.encryptTargetUserID=xzwEMQ8DR4Y=&amp;metaData.updateUserProfileProcess=true</httplink>
        </actor>
      </actors>
      <sitename>Site_one, l5</sitename>
      <siteid>3052</siteid>
      <addcommentaccess>1</addcommentaccess>
      <contentitem>
        <id>1019</id>
        <title>test redacted file from kk</title>
        <link>https://rushin.local.com/rushin_dev/dashboard.action?metaData.microBlogID=1019</link>
        <apilink>https://rushin.local.com/rushin_dev/api/2/activities/1019</apilink>
        <type>microblogs</type>
        <imagetype>microblogs</imagetype>
        <filesize>0</filesize>
        <siterootfolderid>0</siterootfolderid>
        <author>
          <username>Krushnakant</username>
          <email>krushnakant@highq.com</email>
          <httpavatar>https://rushin.local.com/rushin_dev/images/griffin/socialdealroom/avatar/48avatar.gif</httpavatar>
          <avatar>https://rushin.local.com/rushin_dev/api/2/users/128/avatar?size=48&amp;lastmodifieddate=1567499957170</avatar>
          <userlink>https://rushin.local.com/rushin_dev/api/2/users/128</userlink>
          <httplink>https://rushin.local.com/rushin_dev/viewUserProfile.action?metaData.encryptTargetUserID=xzwEMQ8DR4Y=&amp;metaData.updateUserProfileProcess=true</httplink>
        </author>
        <datepublished>07 Jan 2020 10:02</datepublished>
      </contentitem>
      <attachments>
        <attachment>
          <id>6530</id>
          <name>Desc-19 Menu</name>
          <extension>jpg</extension>
          <siteId>3096</siteId>
          <parentfolderid>5575</parentfolderid>
          <filehttplink>https://rushin.local.com/rushin_dev/documentHome.action?metaData.siteID=3096&amp;metaData.parentFolderID=5575&amp;metaData.documentID=6530</filehttplink>
          <folderpath>/</folderpath>
          <folderhttplink>https://rushin.local.com/rushin_dev/documentHome.action?metaData.siteID=3096&amp;metaData.parentFolderID=5575</folderhttplink>
          <filesize>218690</filesize>
          <redactionstatus>true</redactionstatus>
        </attachment>
      </attachments>
      <contentspecificdetail>
        <sharewith>
          <sites>
            <site>
              <id>3052</id>
              <sitename>Site_one</sitename>
              <sitehttplink>https://rushin.local.com/rushin_dev/sitecontroller.action?metaData.siteID=3052</sitehttplink>
            </site>
            <site>
              <id>0</id>
              <sitename>l5</sitename>
            </site>
          </sites>
        </sharewith>
      </contentspecificdetail>
      <activitytypealias>ACTIVITY_MICROBLOG_ADDED</activitytypealias>
      <permissions>
        <delete>1</delete>
      </permissions>
      <timepublisedutc>07 Jan 2020 10:02:39</timepublisedutc>
    </activity>
	
	 <activity>
      <activitydesc>Test non redacted</activitydesc>
      <activitydeschtml>
        <![CDATA[<p>Test non redacted</p>
        
]]>
      </activitydeschtml>
      <timepublished>16 Jan 2020 10:51</timepublished>
      <actors>
        <actor>
          <username>Tom Chick</username>
          <email>tom.chick@highq.com</email>
          <httpavatar>https://rushin.local.com/rushin_dev/images/griffin/socialdealroom/avatar/48avatar.gif</httpavatar>
          <avatar>https://rushin.local.com/rushin_dev/api/2/users/100/avatar?size=48&amp;lastmodifieddate=1568949913470</avatar>
          <userlink>https://rushin.local.com/rushin_dev/api/2/users/100</userlink>
          <httplink>https://rushin.local.com/rushin_dev/viewUserProfile.action?metaData.encryptTargetUserID=E7gcHZJOZvM=&amp;metaData.updateUserProfileProcess=true</httplink>
        </actor>
      </actors>
      <sitename>Site_one, l5</sitename>
      <siteid>3052</siteid>
      <addcommentaccess>1</addcommentaccess>
      <contentitem>
        <id>1021</id>
        <title>Test non redacted</title>
        <link>https://rushin.local.com/rushin_dev/dashboard.action?metaData.microBlogID=1021</link>
        <apilink>https://rushin.local.com/rushin_dev/api/2/activities/1021</apilink>
        <type>microblogs</type>
        <imagetype>microblogs</imagetype>
        <filesize>0</filesize>
        <siterootfolderid>0</siterootfolderid>
        <author>
          <username>Tom Chick</username>
          <email>tom.chick@highq.com</email>
          <httpavatar>https://rushin.local.com/rushin_dev/images/griffin/socialdealroom/avatar/48avatar.gif</httpavatar>
          <avatar>https://rushin.local.com/rushin_dev/api/2/users/100/avatar?size=48&amp;lastmodifieddate=1568949913470</avatar>
          <userlink>https://rushin.local.com/rushin_dev/api/2/users/100</userlink>
          <httplink>https://rushin.local.com/rushin_dev/viewUserProfile.action?metaData.encryptTargetUserID=E7gcHZJOZvM=&amp;metaData.updateUserProfileProcess=true</httplink>
        </author>
        <datepublished>16 Jan 2020 10:51</datepublished>
      </contentitem>
      <images>
        <image>
          <id>7584</id>
          <imagelink>https://rushin.local.com/rushin_dev/documentHome.action?metaData.siteID=4098&amp;metaData.parentFolderID=6593&amp;metaData.documentID=7584</imagelink>
          <apilink>https://rushin.local.com/rushin_dev/api/2/files/7584/content?imagewidth=256&amp;thumbnail=true&amp;currentversion=1</apilink>
          <height>1753</height>
          <width>1240</width>
          <redactionstatus>false</redactionstatus>
        </image>
      </images>
      <contentspecificdetail>
        <sharewith>
          <sites>
            <site>
              <id>3052</id>
              <sitename>Site_one</sitename>
              <sitehttplink>https://rushin.local.com/rushin_dev/sitecontroller.action?metaData.siteID=3052</sitehttplink>
            </site>
            <site>
              <id>0</id>
              <sitename>l5</sitename>
            </site>
          </sites>
        </sharewith>
      </contentspecificdetail>
      <activitytypealias>ACTIVITY_MICROBLOG_ADDED</activitytypealias>
      <permissions>
        <delete>1</delete>
      </permissions>
      <timepublisedutc>16 Jan 2020 10:51:52</timepublisedutc>
    </activity>
</activities>

9. Get User Activities
Path: /{version}/users/activities
Method: GET
Changes: 
This change is available in API versions 1 to 8 and cCollaborate versions 5.3 onwards

  • You can now get the Redaction status of a content type(file) if redaction is enabled at site and ASP level
    Response: 

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <activities>
    <activity>
      <activitydesc>Tom Chick moved a folder</activitydesc>
      <timepublished>15 Jan 2020 07:04</timepublished>
      <sitename>preConvertToPDF-Test</sitename>
      <siteid>4098</siteid>
      <siterole>CONTENT_ADMIN, MEMBER_ADMIN, QA_ADMIN, REPORTING_ADMIN, SITE_ADMIN</siterole>
      <contentitem>
        <id>12613</id>
        <title>Test Copy</title>
        <link>https://rushin.local.com/rushin_dev/sitecontroller.action?metaData.siteID=4098</link>
        <apilink>https://rushin.local.com/rushin_dev/api/2/folders/6593</apilink>
        <type>folder</type>
        <location>preConvertToPDF-Test</location>
        <siterootfolderid>6593</siterootfolderid>
        <author>
          <username>Tom Chick</username>
          <email>tom.chick@highq.com</email>
          <httpavatar>https://rushin.local.com/rushin_dev/images/griffin/socialdealroom/avatar/48avatar.gif</httpavatar>
          <avatar>https://rushin.local.com/rushin_dev/api/2/users/100/avatar?size=48&amp;lastmodifieddate=1568949913470</avatar>
          <userlink>https://rushin.local.com/rushin_dev/api/2/users/100</userlink>
          <httplink>https://rushin.local.com/rushin_dev/viewUserProfile.action?metaData.encryptTargetUserID=E7gcHZJOZvM=&amp;metaData.updateUserProfileProcess=true</httplink>
        </author>
        <datepublished>15 Jan 2020 07:02</datepublished>
        <parentcontent>
          <title>My files</title>
          <link>https://rushin.local.com/rushin_dev/documentHome.action?metaData.siteID=4098&amp;metaData.parentFolderID=6593</link>
          <apilink>https://rushin.local.com/rushin_dev/api/2/folders/6593</apilink>
        </parentcontent>
        <redactionstatus>false</redactionstatus>
      </contentitem>
    </activity>
</activities>

     

10. Get site list
Path: /{version}/sites
Method: GET
Changes: 
This change is available in API versions 1 to 8 and Collaborate versions 5.3 onwards

  • If redaction is enabled or disabled at Site level, information will be provided if redaction is enable at ASP level for each site
    Response: 

    <sites>
    <site>
      <id>1</id>
      <sitename>My site</sitename>
      <role>CONTENT_ADMIN, MEMBER_ADMIN, QA_ADMIN, REPORTING_ADMIN, SITE_ADMIN, SYSTEM_ADMIN</role>
      <sitedescription>
      </sitedescription>
      <sitefolderID>1</sitefolderID>
      <module>
        <home enable="0"/>
        <activity enable="0">
          <microblog>0</microblog>
        </activity>
        <document enable="1"/>
        <wiki enable="0"/>
        <blog enable="0"/>
        <task enable="1">
          <timelineview>0</timelineview>
        </task>
        <event enable="0"/>
        <isheet enable="0"/>
        <qa enable="0"/>
        <people enable="0"/>
      </module>
      <adminnote>
      </adminnote>
      <categories>
        <category>
          <id>1</id>
          <name>None</name>
        </category>
      </categories>
      <startdate>
      </startdate>
      <enddate>
      </enddate>
      <createddate>28 Jun 2019</createddate>
      <status>Active</status>
      <size>859.20KB</size>
      <rawsitesize>
        <activedocumentsize>879824</activedocumentsize>
        <deleteddocumentsize>4359321</deleteddocumentsize>
        <totalsize>5239145</totalsize>
      </rawsitesize>
      <siteowner>
        <firstname>Tom</firstname>
        <lastname>Chick</lastname>
        <email>tom.chick@highq.com</email>
        <userid>100</userid>
      </siteowner>
      <isSyncable>1</isSyncable>
      <file>
        <permissionlevel>SITE_ONLY</permissionlevel>
      </file>
      <sitenametranslations>
        <translation>
          <languagecode>en_GB</languagecode>
          <value>My site</value>
        </translation>
        <translation>
          <languagecode>nl_NL</languagecode>
          <value>Mijn site</value>
        </translation>
        <translation>
          <languagecode>de_DE</languagecode>
          <value>Meine Site</value>
        </translation>
        <translation>
          <languagecode>fr_FR</languagecode>
          <value>Mon site</value>
        </translation>
        <translation>
          <languagecode>es_ES</languagecode>
          <value>Mi Sitio</value>
        </translation>
      </sitenametranslations>
      <siteRestrictionType>
        <passwordprotected>0</passwordprotected>
        <twoFactorAuthentication>0</twoFactorAuthentication>
        <termsandconditions>0</termsandconditions>
        <iprestrictedsite>0</iprestrictedsite>
        <drm>0</drm>
        <checkout>0</checkout>
        <documentworkflow>0</documentworkflow>
        <visiableonhighqdrive>1</visiableonhighqdrive>
      </siteRestrictionType>
      <enabledocumentredaction>true</enabledocumentredaction>
    </site>
</sites>

     

11. Get Site
Path: /{version}/sites/{siteid}
Method: GET
Changes: 
This change is available in API versions 1 to 8 and Collaborate versions 5.3 onwards

  • If redaction is enabled or disabled at Site level, information will be provided if redaction is enabled at ASP Level for an individual site
    Response:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <site>
    <id>4098</id>
    <sitename>preConvertToPDF-Test</sitename>
    <sitefolderID>6593</sitefolderID>
    <module>
      <home enable="0"/>
      <activity enable="0">
        <microblog>0</microblog>
      </activity>
      <document enable="1"/>
      <wiki enable="0"/>
      <blog enable="0"/>
      <task enable="0">
        <timelineview>0</timelineview>
      </task>
      <event enable="0"/>
      <isheet enable="0"/>
      <qa enable="0"/>
      <people enable="1"/>
    </module>
    <categories>
      <category>
        <id>1</id>
        <name>None</name>
      </category>
    </categories>
    <startdate>07 Jan 2020</startdate>
    <createddate>07 Jan 2020</createddate>
    <status>Active</status>
    <size>397.22KB</size>
    <rawsitesize>
      <activedocumentsize>406749</activedocumentsize>
      <deleteddocumentsize>3107988</deleteddocumentsize>
      <totalsize>3514737</totalsize>
    </rawsitesize>
    <billingnextinvoicedate>07 Feb 2020</billingnextinvoicedate>
    <siteowner>
      <firstname>Tom</firstname>
      <lastname>Chick</lastname>
      <email>tom.chick@highq.com</email>
      <userid>100</userid>
    </siteowner>
    <file>
      <permissionlevel>SITE_ONLY</permissionlevel>
      <approvaldocumentworkflow>0</approvaldocumentworkflow>
      <allowbulkdownload>0</allowbulkdownload>
      <emailnotification>1</emailnotification>
      <showsitemap>0</showsitemap>
      <inbox>
        <enable>0</enable>
      </inbox>
    </file>
    <contactus>
      <type>email</type>
      <values>
        <value>POC@highq.com</value>
      </values>
    </contactus>
    <enforceusergroups>1</enforceusergroups>
    <biddersite>
      <enable>0</enable>
      <advancedqapermission>0</advancedqapermission>
    </biddersite>
    <landingpage>files (root folder)</landingpage>
    <sitenametranslations>
      <translation>
        <languagecode>en_GB</languagecode>
        <value>preConvertToPDF-Test</value>
      </translation>
    </sitenametranslations>
    <siteRestrictionType>
      <passwordprotected>0</passwordprotected>
      <twoFactorAuthentication>0</twoFactorAuthentication>
      <termsandconditions>0</termsandconditions>
      <iprestrictedsite>0</iprestrictedsite>
      <drm>0</drm>
      <checkout>0</checkout>
      <documentworkflow>0</documentworkflow>
      <visiableonhighqdrive>1</visiableonhighqdrive>
    </siteRestrictionType>
    <enabledocumentredaction>true</enabledocumentredaction>
  </site>

Comments


0 Comments

Last Updated: Nov 08,2024