File resource

Get isheet record id for a file

OVERVIEW

Collaborate site can be configured with a file metadata isheet. With a file metadata isheet a new record is created in the file metadata isheet when a file is uploaded to the files module of the site. There can only be one file metadata isheet in a site. 

On uploading the file to the files module the associated record in the file metadata isheet can be obtained by calling the following method. This method can also be called for any existing file in the site, to update the metadata records for the file. 

Call the isheetRecordID to obtain the isheet record which is to be updated. 

Request

GET files/${fileid}/isheetRecordID

Where fileid parameter is the ID of the file for which the metadata record ID is required. 

Response

The method returns the iSheet Record ID in the following format:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<sheet>
    <IsheetRecordID>{numeric record ID}</IsheetRecordID>
</sheet>

Please note that the isheetRecordID parameter is case sensitive 

In case of an invalid file ID an error object is returned 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
    <ref>136</ref>
    <summary>File not found</summary>
</error>

 

Comments


12 Comments


Imran Aziz Following up on Maarten and Dan's question. Specifically is there a way to get all files from a specific folder of a File Metedata iSheet?


Imran Aziz Is there an equivalent function for folder isheets? To obtain the isheetrecord for a folder type iSheet that corresponds to a speciic folderid? Following up on Dan Hey 's question


Hi Sebastiaan Bos I did not know that (sorry Imran Aziz, enjoy a good holiday!). Regarding urgency, I am trying to finish an iSheet integration before my own holiday:-). The issue above would mean that the integration would only work part of the time, but hopefully the issue can be worked around using Imran's suggestion.


Imran Aziz thanks, We will try that. Just now it changed back to a lowercase i , this is my log:

23-07 15:27:20.430 | Interface | 8BD9C1DA-FB95-4606-82A9-6860EA3D425B | reply:

23-07 15:27:20.430 | Interface | 8BD9C1DA-FB95-4606-82A9-6860EA3D425B | {"metaData":null,"head":null,"data":null,"name":null,"id":null,"type":null,"templateID":null,"isheetRecordID":231469}

 


Maarten Van.duijn that is very strange, it seems to be an issue with JSON response side of things. Can you please use the XML response if possible. I will raise this issue with the technical team.


Hi Imran Aziz,

Calling this function, we sometime seem to get responses that differ a little bit:

Today I get: {"metaData":null,"head":null,"data":null,"IsheetRecordID":231466,"name":null,"id":null,"type":null,"templateID":null}

Yesterday it was : {"metaData":null,"head":null,"data":null,"isheetRecordID":231466,"name":null,"id":null,"type":null,"templateID":null}

(isheetRecordID with a small i). Is this because we are working on a betaversion, and it is updated between my calls? Or should we revert to XML to make sure we get consistent naming?

Submitted on Mon, 02/19/2018 - 22:44


Is there a way to easily get an isheetRecord for a folder's metadata isheet item?


Fernando Deleon i am afraid by default we stick with the permissions applied by Collaborate. Going forward we will provide a method to accept terms through the API.


I have a site that uses Terms and Conditions on first entry. This site also uses calls to the above API. However when the Terms and conditions is activated, the API or I believe any Collaborate API will return with 'Access denied' Which i believe is the case because you have to accept the Term and conditions.

However, this becomes a problem when you want to proxy as a user and you call the API (ie you use the users Auth Token) you still get Access denied.

Is there a way to make the Terms and conditions applicable only to browser interaction but not to API interactions?

Last Updated: Jun 09,2023