REST API for Content Management 1.1

Get Folder Metadata Collection

get

/documents/api/1.1/folders/{folderId}/metadata

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

Request

Supported Media Types

application/json
application/xml

Path Parameters

folderId: Type: string

Required: true

Globally unique identifier (GUID) for the folder. If the referenced folder is the user's home folder, the value for folderId is self.

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 this folder. 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 this folder. 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 get collection values operation.

Root Schema : FolderGetCollectionResponse

The response body includes information about the get collection values operation.

Properties

errorCode: Type: string

An error code of zero (0) indicates no errors.
idList: Type: string

Globally unique identifier (GUID) of the original folder.
metadata: Type: object Collections

Additional Properties Allowed: Collection

Assigned collections.
type: Type: string

Item type folder.

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":"F94131468853B4845E0508854EE870070A1AA68C3354",
    "type":"folder",
    "errorCode":"0",
    "metadata":{
        "CollectionA":{
            "FieldA1":"Value1",
            "FieldA2":"Value2"
        }
    }
}

400 Response

Request parameters are not formatted correctly.

404 Response

Folder ID is not found.

Examples

The following example returns the metadata collection associated with the specified folder. In this example, the folder has one metadata collection associated with it. The response lists the folder collection (CollectionA).

GET .../folders/F94131468853B4845E0508854EE870070A1AA68C3354/metadata

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
  "errorCode": "0",
  "idList": "F94131468853B4845E0508854EE870070A1AA68C3354",
  "metadata": {
    "CollectionA": {
      "A1": "A1_value",
      "A2": "A2_value"
    }
  },
  "type": "folder"
}

Example 2

The following example returns the metadata collections associated with the specified folder. In this example, the folder has two metadata collections associated with it. The response lists the folder collection (CollectionA) as well as a personal collection (Personal.CollectionA) created by this user and assigned to the same folder.

GET .../folders/F94131468853B4845E0508854EE870070A1AA68C3354/metadata

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
  "errorCode": "0",
  "idList": "F94131468853B4845E0508854EE870070A1AA68C3354",
  "metadata": {
    "CollectionA": {
      "A1": "A1_value",
      "A2": "A2_value"
    },
    "Personal.CollectionA": {
      "A1": "personal-A1_value",
      "A2": "personal-A2_value"
    }
  },
  "type": "folder"
}

Example 3

The following example returns the metadata values associated with the specified folder. The example uses an applink ID because this folder 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 .../folders/FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518/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": "FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518",
    "metadata": {
        "ApplinkCollection": {
            "appField1": "UserB_value_field1",
            "appField2": "UserB_value_field2"
        }
    },
    "type": "folder"
}