Get reference data

POST /api/2.0/files/file/referencedata

Request

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.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

Request parameters for getting reference data

fileKeyintegerformat: int32

The unique document identifier used by the service to get a link to the file

instanceIdstring

The unique system identifier

sourceFileIdintegerformat: int32

Source file ID

pathstring

The file name or relative path for the formula editor

linkstring

Link to file

Examples

POST /api/2.0/files/file/referencedata HTTP/1.1
Accept: application/json
Content-Length: 115
Content-Type: application/json
Host: example.com

{
  "fileKey": 1234,
  "instanceId": "9694",
  "sourceFileId": 1234,
  "path": "some text",
  "link": "some text"
}

curl --request POST \
  --url https://example.com/api/2.0/files/file/referencedata \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "fileKey": 1234,
  "instanceId": "9694",
  "sourceFileId": 1234,
  "path": "some text",
  "link": "some text"
}'

Responses

200

File reference data

referenceDataobject

fileKeystring

File key

instanceIdstring

Instance ID

errorstring

Error

pathstring

Path

urlstringformat: uri

URL

fileTypestring

File type

keystring

Key

linkstring

Link

tokenstring

Token

401

Unauthorized