REST API for Content Management 1.1

Delete Values in File Metadata Collection

delete

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

Reset (delete) values in specified fields in a metadata collection.

Note: To remove a metadata value from a file, you must be the owner or have the manager role for the 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 delete values in the metadata collection request. Bold indicates a required value.

Root Schema : FileDeleteValuesBody

The request body defines details of the delete values in the metadata collection request. Bold indicates a required value.

Properties

collection: Type: string

Required: true

Collection name. For a user personal collection, it must start with Personal., such as Personal.MyCollection.
fields: Type: string

Required: true

One or more field names, separated by commas, whose values you want to delete.

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.

Properties

errorCode: Type: number

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

Globally unique identifier (GUID) of the original file.
type: Type: string

Item type file.

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 deletes the values in fields A1 and A2 in the CollectionA metadata collection associated with the specified file.

DELETE .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/metadata

Request Header

None.

Request Body

{
    "collection": "CollectionA",
    "fields": "A1,A2"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

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

Example 2

The following example deletes the values in fields A1 and A2 in the Personal.CollectionA metadata collection associated with the specified file.

DELETE .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/metadata

Request Header

None.

Request Body

{
    "collection": "Personal.CollectionA",
    "fields": "A1,A2"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

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

Example 3

The following example deletes the values in fields appField1 and appField2 in the ApplinkCollection metadata 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.

DELETE .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/metadata

Request Header

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

Request Body

{
    "collection": "ApplinkCollection",
    "fields": "appField1,appField2"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

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