Delete Values in a Folder Metadata Collection

delete

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

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

Note: To remove a metadata value from a folder, you must be the owner or have the manager role for the folder.

• Request
• Response
• Examples

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.

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. 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 a folder metadata collection request. Bold indicates a required value.

Root Schema : FolderDeleteValuesBody

The request body defines details of the delete values in a folder 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 folder operation.

Root Schema : FolderCollectionResponse

The response body includes information about the assign collection to a folder 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.

type

Type: string

Item type folder.

Example application/json

{
    "idList":"F94131468853B4845E0508854EE870070A1AA68C3354",
    "type":"folder",
    "errorCode":"0"
}

400 Response

Request parameters are not formatted correctly.

404 Response

Folder 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 folder.

DELETE .../folders/F94131468853B4845E0508854EE870070A1AA68C3354/metadata

Request Header

None.

Request Body

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

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
  "errorCode": "0",
  "idList": "F94131468853B4845E0508854EE870070A1AA68C3354",
  "type": "folder"
}

Example 2

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

DELETE .../folders/F94131468853B4845E0508854EE870070A1AA68C3354/metadata

Request Header

None.

Request Body

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

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
  "errorCode": "0",
  "idList": "F94131468853B4845E0508854EE870070A1AA68C3354",
  "type": "folder"
}

Example 3

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.

DELETE .../templates/FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518/site

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": "FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518",
    "type": "folder"
}