Get Folder Assigned Metadata Collections
/documents/api/1.2/folders/{folderId}/metadataFields
Request
- application/json
- application/xml
-
folderId: string
Globally unique identifier (GUID) for the folder. If the referenced folder is the user's home folder, the value for
folderId
isself
.
-
directAssigned(optional): string
Specify if just a directly assigned collection should be retrieved (
1
) or if all inherited collections should be included as well (0
).
-
accessToken(optional): 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(optional): string
Applink ID authorizing the current user to access this folder. Any time the parameter
appLinkID
is used, a parameteraccessToken
must be provided as well. It can be used as appLinkID or AppLinkID.
Response
- application/json
- application/xml
200 Response
The request was fulfilled.
object
-
errorCode(optional):
string
An error code of zero (0) indicates no errors.
-
idList(optional):
string
Globally unique identifier (GUID) of the original folder.
-
metadataFields(optional):
array metadataFields
-
type(optional):
string
Item type
folder
.
array
-
Array of:
object CollectionDefinition
Metadata collection definition.
object
-
isEnabled(optional):
string
Collection enable (
1
) or disable (0
) status. -
isInherited(optional):
string
Collection inherited (
1
) or directly assigned (0
) status. -
items(optional):
array items
List of field definitions.
-
type(optional):
string
Item type
collection
.
array
-
Array of:
object CollectionFieldDefinition
Metadata fields definition.
object
-
fieldDescription(optional):
string
Field description.
-
fieldName(optional):
string
Field name.
-
fieldType(optional):
string
Field type.
-
isEnabled(optional):
string
Field enable (1) or disable (0) status.
-
type(optional):
string
Item type
field
.
{
"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" }