1. REST API for Content Management 1.1
  2. Tasks
  3. Files

Assign Values to a File Metadata Collection

post

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

Assign values to the fields in a specified file metadata collection. You must assign a collection to a particular file before you can assign values to the fields for the particular file.

Note: To set a metadata value on a file, you must have the contributor or manager role for that file.

Request

Supported Media Types
  • application/json
  • application/xml
Path Parameters
fileId
Type: string
Required: true

Globally unique identifier (GUID) for the file.

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. To work, this applink must have at least the contributor role granted. It can be used as appLinkID or AppLinkID.

Body Parameter
The request body defines details of the assign values to metadata collection request. There are no required attributes.
Root Schema : FileAssignValuesBody
Type: object

One or more field names.

For example, you can reference the collection and field names independently:

{

"collection": "CollectionA,"

"FieldA1": "Value1,"

"FieldA2": "Value2"

}

Alternatively, you can specify the collection and field name with each field reference:

{

"CollectionA.FieldA1": "Value1,"

"CollectionA.FieldA2": "Value2"

}

For user personal collections, the collection name must start with Personal., such as Personal.MyCollection.

Response

Supported Media Types
  • application/json
  • application/xml
200 Response

The request was fulfilled.

Body
The response body includes information about the assign collection to a file operation.
Root Schema : FileCollectionResponse
The response body includes information about the assign collection to a file operation.
Example application/json

{
    "idList":"D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type":"file",
    "errorCode":"0"
}
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 assigns specified string values to fields in the CollectionA metadata collection associated with the specified file. 

POST .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/metadata

Request Header

None.

Request Body

{
    "collection": "CollectionA",
    "A1": "A1_value",
    "A2": "A2_value"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
  "errorCode": "0",
  "idList": "D3C1C1F319CFE6B102095C5DT0000000000100000001",
  "type": "file"
}

Example 2

The following example assigns specified string values to fields in the Personal.CollectionA metadata collection associated with the specified file. 

POST .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/metadata

Request Header

None.

Request Body

{
    "collection": "Personal.CollectionA",
    "A1": "personal-A1_value",
    "A2": "personal-A2_value"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "idList": "D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type": "file"
}

Example 3

The following example assigns specified string values to fields in the ApplinkCollectionmetadata 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. 

POST .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/metadata

Request Header

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

Request Body

{
    "collection": "ApplinkCollection",
    "appField1": "UserB_valueFile_field1",
    "appField2": "UserB_valueFile_field2"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "idList": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
    "type": "file"
}