POST api/2.0/files/file/referencedata This function requires authentication

Description

Returns the reference data to uniquely identify a file in its system and check the availability of insering data into the destination spreadsheet by the external link.

Parameters

Name	Description	Type	Example
FileKey sent in body	The unique document identifier used by the service to get a link to the file	System.Int32
InstanceId sent in body	The unique system identifier	System.String
SourceFileId sent in body	Source file ID	System.Int32
Path sent in body	The file name or relative path for the formula editor	System.String

Example

POST api/2.0/files/file/referencedata
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "FileKey": 1234,
  "InstanceId": "some text",
  "SourceFileId": 1234,
  "Path": "some text"
}

Returns

File reference data

Example Response

application/json

{
  "status": 0,
  "response": {
    "ReferenceData": {
      "FileKey": 1234,
      "InstanceId": "some text"
    },
    "Error": "some text",
    "Path": "some text",
    "Url": "some text",
    "FileType": "some text",
    "Token": "some text"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <ReferenceData>
      <FileKey>1234</FileKey>
      <InstanceId>some text</InstanceId>
    </ReferenceData>
    <Error>some text</Error>
    <Path>some text</Path>
    <Url>some text</Url>
    <FileType>some text</FileType>
    <Token>some text</Token>
  </response>
</result>