Share file API - Share via microblog

Purpose

This API method is used to share a file or folder using a microblog. 

Request URL

POST    /shares/microblog

Sample request URL : https://domain.com/instance/api/1/shares/microblog

Request Body

            <share> 

                            <resourcetype>folder/file</resourcetype> {folder is required in case we want to share a folder already present in Collaborate}

                           <resourceid>folderid/fileid</resourceid>

                           <permissions> integer value for the two options (download / view)</permissions>

                          <sharegroup> List of sites to share with</sharegroup>

                          <microblogmessage>Message to the sent in the microblog</microblogmessage> {The microblog can accept # and @ mention}

                           <expiry>UTC date and time</expiry>

               <share>

Example Request XML:

<share>
   <resourcetype>file</resourcetype>
   <resourceid>425</resourceid>
   <permissions>1</permissions>
   <sharegroup>
      <internalorganisation>true</internalorganisation>
      <sites>
         <site>
            <id>3</id>
         </site>
      </sites>
   </sharegroup>
   <microblogmessage>Message to the sent in the microblog[~saviz.izadpanah@highq.com] to [#highq]</microblogmessage>
   <expiry>31 Dec 9999 00:00</expiry>
</share>

Response XML

200 Ok in case of a success an alternate error response otherwise. In case of success the response body will hold the share details. 

In case of an error our standard error object will be returned with explanation of the error.  

<share>

                  <shareid>{id of the share}</shareid> {database id}

                 <microblogid>{ID of the newly created microblog}</microblogid> This is a reference to the microblog id in the activity stream. The user can use this id to make any changes to the microblog if needed. 

</share>
 

Example Response XML:

<share>
   <shareid>92</shareid>
   <microblogid>3491</microblogid>
</share>

Response Codes