Adding metainformation for a resource

Use the PATCH method to send a request to add metainformation.

https://cloud-api.yandex.net/v1/disk/resources/
 ? path=<resource path>
 & [fields=<properties to include in the response>]

^* Required

Request body

The added attributes should be passed in the request body, in the custom_properties object (you can pass any parts of the Resource object, but everything except for custom_properties will be ignored). Attributes can only be name:value properties, so you can't use arrays or parent objects.

Restriction. The limit on the length of the custom_properties object (the names and values of embedded keys, along with syntactic symbols) is 1024 characters.

Attributes passed are added to the existing ones. For example, let's take the following object with the attributes foo and bar:

"custom_properties": {"foo":"1", "bar":"2"}

If the custom_properties object did not exist in the resource metainformation before this, the API simply adds the passed object to it.

If this object already exists (for example, "custom_properties": {"oof":"3", "bar":"0"}), the Yandex.Disk API updates the keys with the same names and adds the new ones. In the resource metainformation, you can see the object:

"custom_properties": {"oof": "3", "bar":"0", "foo":"1"}

To delete an attribute, pass it with the null value, for example:

"custom_properties": {"foo": null}

If the request was processed without errors, the Yandex.Disk API responds with the 200 OK code and returns metainformation about the requested resource in the Resource object in the response body. If the request caused an error, the relevant response code is returned, and the response body contains the error description.

For non-empty folders, the response includes the ResourceList object (under the _embedded name). Each resource in the folder is an element of the items array. Regardless of the requested sorting, resources in the array are ordered by type: first all the subfolders are listed, then all the files.

{  "public_key": "HQsmHLoeyBlJf8Eu1jlmzuU+ZaLkjPkgcvmokRUCIo8=",  "_embedded": {    "sort": "",    "path": "disk:/foo",    "items": [      {        "path": "disk:/foo/bar",        "type": "dir",        "name": "bar",        "modified": "2014-04-22T10:32:49+04:00",        "created": "2014-04-22T10:32:49+04:00"      },      {        "name": "photo.png",        "preview": "https://downloader.disk.yandex.ru/preview/...",        "created": "2014-04-21T14:57:13+04:00",        "modified": "2014-04-21T14:57:14+04:00",        "path": "disk:/foo/photo.png",        "md5": "4334dc6379c8f95ddf11b9508cfea271",        "type": "file",        "mime_type": "image/png",        "size": 34567      }    ],    "limit": 20,    "offset": 0  },  "name": "foo",  "created": "2014-04-21T14:54:42+04:00",  "custom_properties": {"foo":"1", "bar":"2"},  "public_url": "https://yadi.sk/d/AaaBbb1122Ccc",  "modified": "2014-04-22T10:32:49+04:00",  "path": "disk:/foo",  "type": "dir"}