REST API for Content Management 1.1

Get Folder Assigned Metadata Collections

get

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

Get field definitions of all fields in a specified metadata collection assigned to 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 a directly assigned collection should be retrieved (1) or if 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 assigned collections operation.

Root Schema : FolderGetAssignedCollectionResponse

The response body includes information about the get assigned collections 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.
metadataFields: Type: array metadataFields

Additional Properties Allowed:
type: Type: string

Item type folder.

Nested Schema : metadataFields

Type: array

Items

Type: object CollectionDefinition

Additional Properties Allowed:

Metadata collection definition.

Nested Schema : CollectionDefinition

Type: object

Metadata collection definition.

Properties

isEnabled: Type: string

Collection enable (1) or disable (0) status.
isInherited: Type: string

Collection inherited (1) or directly assigned (0) status.
items: Type: array items

Additional Properties Allowed:

List of field definitions.
type: Type: string

Item type collection.

Nested Schema : items

Type: array

List of field definitions.

Items

Type: object CollectionFieldDefinition

Additional Properties Allowed:

Metadata fields definition.

Nested Schema : CollectionFieldDefinition

Type: object

Metadata fields definition.

Properties

fieldName: Type: string

Field name.
fieldType: Type: string

Field type.
isEnabled: Type: string

Field enable (1) or disable (0) status.
type: Type: string

Item type field.

Example application/json


{
    "idList":"F94131468853B4845E0508854EE870070A1AA68C3354",
    "type":"folder",
    "errorCode":"0",
    "metadataFields":{
        "CollectionA":{
            "isEnabled":1,
            "isInherited":0,
            "type":"collection",
            "items":[
                {
                    "type":"field",
                    "fieldName":"A1",
                    "fieldType":"string",
                    "isEnabled":1
                },
                {
                    "type":"field",
                    "fieldName":"A2",
                    "fieldType":"string",
                    "isEnabled":0
                }
            ]
        }
    }
}

400 Response

Request parameters are not formatted correctly.

404 Response

Folder ID is not found.

Examples

The following example returns the metadata collection fields associated with the specified folder. In this example, the folder has one metadata collection associated with it. For the metadata collection, the response returns the definitions of all fields. Also, the value of the status field, isEnabled, shows whether the collection or field is enabled (1) or disabled (0). The field isInherited shows that CollectionA is not inherited (0) because it was directly assigned to this folder.

GET .../folders/FF4729683CD68C1AFB1AE87DT0000000000100000001/metadataFields

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "idList": "FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "metadataFields": {
        "CollectionA": {
            "isEnabled": "1",
            "isInherited": "0",
            "type": "collection",
            "items": [
                {
                    "type": "field",
                    "fieldName": "A1",
                    "fieldType": "string",
                    "isEnabled": "1"
                },
                {
                    "type": "field",
                    "fieldName": "A2",
                    "fieldType": "string",
                    "isEnabled": "0"
                }
            ]
        }
    },
    "type": "folder"
}

Example 2

The following example returns the metadata collection fields associated with the specified folder. In this example, the folder has two metadata collections associated with it, including a personal collection (Personal.CollectionA) created by this user and assigned to this folder. For the metadata collection, the response returns the definitions of all fields. Also, the value of the status field, isEnabled, shows whether the collection or field is enabled (1) or disabled (0). The field isInherited shows that CollectionA and Personal.CollectionA are not inherited (0) because they were directly assigned to this folder.

GET .../folders/FF4729683CD68C1AFB1AE87DT0000000000100000001/metadataFields

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "idList": "FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "metadataFields": {
        "CollectionA": {
            "isEnabled": "1",
            "isInherited": "0",
            "type": "collection",
            "items": [
                {
                    "type": "field",
                    "fieldName": "A1",
                    "fieldType": "string",
                    "isEnabled": "1"
                },
                {
                    "type": "field",
                    "fieldName": "A2",
                    "fieldType": "string",
                    "isEnabled": "0"
                }
            ]
        },
        "Personal.CollectionA": {
            "isEnabled": "1",
            "isInherited": "0",
            "type": "collection",
            "items": [
                {
                    "type": "field",
                    "fieldName": "A1",
                    "fieldType": "string",
                    "isEnabled": "1"
                },
                {
                    "type": "field",
                    "fieldName": "A2",
                    "fieldType": "string",
                    "isEnabled": "0"
                }
            ]
        }
    },
    "type": "folder"
}

Example 3

The following example returns the metadata collection fields 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/metadataFields

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",
    "metadataFields": {
        "ApplinkCollection": {
            "isEnabled": "1",
            "isInherited": "0",
            "type": "collection",
            "items": [
                {
                    "type": "field",
                    "fieldName": "appField1",
                    "fieldType": "string",
                    "isEnabled": "1"
                },
                {
                    "type": "field",
                    "fieldName": "appField2",
                    "fieldType": "string",
                    "isEnabled": "1"
                }
            ]
        }
    },
    "type": "folder"
}