Get File Assigned Metadata Collections
/documents/api/1.1/files/{fileId}/metadataFields
Request
- application/json
- application/xml
- fileId
-
Type:
string
Required:true
Globally unique identifier (GUID) for the file.
- directAssigned
-
Type:
string
Specify if just directly assigned collections should be retrieved (
1
) or if all inherited collections should be included as well (0
).
- 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 parameteraccessToken
must be provided as well. It can be used as appLinkID or AppLinkID.
Response
- application/json
- application/xml
The request was fulfilled.
- errorCode
-
Type:
number
An error code of zero (0) indicates no errors. - idList
-
Type:
string
Globally unique identifier (GUID) of the original file. - metadataFields
-
Type:
array
metadataFieldsAdditional Properties Allowed: - type
-
Type:
string
Item typefile
.
array
-
Type:
object
CollectionDefinitionAdditional Properties Allowed:Metadata collection definition.
object
- isEnabled
-
Type:
string
Collection enable (1
) or disable (0
) status. - isInherited
-
Type:
string
Collection inherited (1
) or directly assigned (0
) status. - items
-
Type:
array
itemsAdditional Properties Allowed:List of field definitions. - type
-
Type:
string
Item typecollection
.
array
-
Type:
object
CollectionFieldDefinitionAdditional Properties Allowed:Metadata fields definition.
object
- fieldName
-
Type:
string
Field name. - fieldType
-
Type:
string
Field type. - isEnabled
-
Type:
string
Field enable (1
) or disable (0
) status. - type
-
Type:
string
Item typefield
.
Example application/json
{
"idList":"D3C1C1F319CFE6B102095C5DT0000000000100000001",
"type":"file",
"errorCode":"0",
"metadataFields":{
"CollectionA":{
"isEnabled":1,
"isInherited":1,
"type":"collection",
"items":[
{
"type":"field",
"fieldName":"A1",
"fieldType":"string",
"isEnabled":1
},
{
"type":"field",
"fieldName":"A2",
"fieldType":"string",
"isEnabled":0
}
]
},
"CollectionB":{
"isEnabled":1,
"isInherited":0,
"type":"collection",
"items":[
{
"type":"field",
"fieldName":"B1",
"fieldType":"string",
"isEnabled":0
},
{
"type":"field",
"fieldName":"B2",
"fieldType":"string",
"isEnabled":1
}
]
}
}
}
Request parameters are not formatted correctly.
File ID is not found.
Examples
The following example returns the metadata collection fields 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
). For each 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 inherited (1
) from the parent folder, and the field also shows that CollectionB
is not inherited (0
) because it was directly assigned to this file.
GET .../files/D006C2CDD62654ABDCE0B8104EE870070A1AA68C3354/metadataFields
Request Header
None.
Request Body
None.
HTTP Status Code
HTTP_STATUS = 200
JSON Response
{ "errorCode": "0", "idList": "D006C2CDD62654ABDCE0B8104EE870070A1AA68C3354", "metadataFields": { "CollectionA": { "isEnabled": "1", "isInherited": "1", "type": "collection", "items": [ { "type": "field", "fieldName": "A1", "fieldType": "string", "isEnabled": "1" }, { "type": "field", "fieldName": "A2", "fieldType": "string", "isEnabled": "0" } ] }, "CollectionB": { "isEnabled": "1", "isInherited": "0", "type": "collection", "items": [ { "type": "field", "fieldName": "B1", "fieldType": "string", "isEnabled": "0" }, { "type": "field", "fieldName": "B2", "fieldType": "string", "isEnabled": "1" } ] } }, "type": "file" }
Example 2
The following example returns the metadata collection fields 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
) and a personal collection (Personal.CollectionA
) created by this user and assigned to the folder as well. For each metadata collection, the response returns the definition 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 inherited (1
) from the parent folder, and the field also shows that CollectionB
is not inherited (0
) because it was directly assigned to this file.
GET .../files/D006C2CDD62654ABDCE0B8104EE870070A1AA68C3354/metadataFields
Request Header
None.
Request Body
None.
HTTP Status Code
HTTP_STATUS = 200
JSON Response
{ "errorCode": "0", "idList": "D006C2CDD62654ABDCE0B8104EE870070A1AA68C3354", "metadataFields": { "CollectionA": { "isEnabled": "1", "isInherited": "1", "type": "collection", "items": [ { "type": "field", "fieldName": "A1", "fieldType": "string", "isEnabled": "1" }, { "type": "field", "fieldName": "A2", "fieldType": "string", "isEnabled": "0" } ] }, "CollectionB": { "isEnabled": "1", "isInherited": "0", "type": "collection", "items": [ { "type": "field", "fieldName": "B1", "fieldType": "string", "isEnabled": "0" }, { "type": "field", "fieldName": "B2", "fieldType": "string", "isEnabled": "1" } ] }, "Personal.CollectionA": { "isEnabled": "1", "isInherited": "1", "type": "collection", "items": [ { "type": "field", "fieldName": "A1", "fieldType": "string", "isEnabled": "1" }, { "type": "field", "fieldName": "A2", "fieldType": "string", "isEnabled": "0" } ] } }, "type": "file" }
Example 3
The following example returns the metadata collection fields 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/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": "DED694950C14AFF280419F9AB5D17B95F47087F4E518", "metadataFields": { "ApplinkCollection": { "isEnabled": "1", "isInherited": "1", "type": "collection", "items": [ { "type": "field", "fieldName": "appField1", "fieldType": "string", "isEnabled": "1" }, { "type": "field", "fieldName": "appField2", "fieldType": "string", "isEnabled": "1" } ] } }, "type": "file" }