Get File Metadata Collection

get

/documents/api/1.1/files/{fileId}/metadata

Get values assigned to fields in a specified metadata collection for a particular file.

• Request
• Response
• Examples

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

fileId

Type: string

Required: true

Globally unique identifier (GUID) for the file.

Query Parameters

directAssigned

Type: string

Specify if just directly assigned collection values should be retrieved (1) or if values from all inherited collections should be included as well (0).

Header Parameters

accessToken

Type: string

Applink access token authorizing the current user to access the parent folder or this file. This parameter is mandatory if appLinkID is used. It can be used as accessToken or AccessToken.

appLinkID

Type: string

Applink ID authorizing the current user to access the parent folder or this file. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. It can be used as appLinkID or AppLinkID.

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body

The response body includes information about the assign collection operation.

Root Schema : FileGetCollectionResponse

The response body includes information about the assign collection operation.

Properties

errorCode

Type: number

An error code of zero (0) indicates no errors.

idList

Type: string

Globally unique identifier (GUID) of the original file.

metadata

Type: object Collections

Additional Properties Allowed: Collection

Assigned collections.

type

Type: string

Item type file.

Nested Schema : Collections

Type: object

Additional Properties Allowed

• Type: object Collection
  Additional Properties Allowed: true
  Additional Properties Allowed: true
  Collection fields and values, where keys are the actual field name.

Assigned collections.

Nested Schema : Collection

Type: object

Additional Properties Allowed: true

Collection fields and values, where keys are the actual field name.

Example application/json

{
    "idList":"D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type":"file",
    "errorCode":"0",
    "metadata":{
        "CollectionA":{
            "FieldA1":"Value1",
            "FieldA2":"Value2"
        },
        "CollectionB":{
            "FieldB1":"Value1",
            "FieldB2":"Value2"
        }
    }
}

400 Response

Request parameters are not formatted correctly.

403 Response

Forbidden if the user does not have read permission.

404 Response

File ID is not found.

Examples

The following example returns the metadata collection associated with the specified file. In this example, both the file and the parent folder have metadata collections associated with them. The response lists the folder collection (CollectionA) followed by the file collection (CollectionB).

GET .../files/D006C2CDD62654ABDCE0B8104EE870070A1AA68C3354/metadata

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
  "errorCode": "0",
  "idList": "D006C2CDD62654ABDCE0B8104EE870070A1AA68C3354",
  "metadata": {
    "CollectionA": {
      "A1": "A1_value",
      "A2": "A2_value"
    },
    "CollectionB": {
      "B1": "B1_value",
      "B2": "B2_value"
    }
  },
  "type": "file"
}

Example 2

The following example returns the metadata collection associated with the specified file. In this example, both the file and the parent folder have metadata collections associated with them. The response lists the folder collection (CollectionA) followed by the file collection (CollectionB). It also lists a personal collection (Personal.CollectionA) created by the user and assigned to the parent folder.

GET .../files/D006C2CDD62654ABDCE0B8104EE870070A1AA68C3354/metadata

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
  "errorCode": "0",
  "idList": "D006C2CDD62654ABDCE0B8104EE870070A1AA68C3354",
  "metadata": {
    "CollectionA": {
      "A1": "A1_value",
      "A2": "A2_value"
    },
    "CollectionB": {
      "B1": "B1_value",
      "B2": "B2_value"
    },
    "Personal.CollectionA": {
      "A1": "personal-A1_value",
      "A2": "personal-A2_value"
    }
  },
  "type": "file"
}

Example 3

The following example returns the metadata collection associated with the specified file. The example uses an applink ID because this file is under a folder structure not owned by or shared with the current user. The applink ID and access token are submitted in the request header.

GET .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/metadata

Request Header

appLinkID: LF5Bxj4TPo_p4n4qWn0tbKTicR2cTUJKv7X_ng9E7ry93rRuDokPqS1d6-wKwhb_wtcGYFDsI_cNMxeKQ-HR-FXQhiVoGRTYM_MPZY8qpICfYU94mmnMjM_cvsRhKMzc0NJgvwEJfqqDwPsAVrhc8cmg==
accessToken: 352FpiMmW66PeYI1Gh5b83I9CXRwZhLfYAu4TXdqpzD8uNKUBMZVVJ3ZvivUW8kQ

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "idList": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
    "metadata": {
        "ApplinkCollection": {
            "appField1": "UserB_valueFile_field1",
            "appField2": "UserB_valueFile_field2"
        }
    },
    "type": "file"
}