API: Retrieving metadata
| Target URL | /api.php/Drive/files/metadata/get |
| Required scope | metadata |
| HTTP Method | GET/POST |
| Output format | JSON |
Request Parameters Reference
| Parameter | Type | Required | Description |
|---|---|---|---|
| path | string | Yes | See this page |
Requires the account permission to access metadata.
The response
The data object holds the following. For an item which carries no metadata at all, data is an empty array.
| Field | Type | Description |
|---|---|---|
| fieldsets | array | The metadata field sets which hold a value for the item, each with id, name and fields. Each field has id, type, sort, name and values, an array of strings. |
| gps | object | x (the latitude) and y (the longitude), when the item has GPS coordinates |
| tagFieldId | integer | The id of the system field which stores the tags |
| tags | array | The tag records as stored. The val of each record is the tag as text|color. The tags listing answers with the parsed form. |
| rating | integer or null | |
| color | string or null | The folder color. Included only when folder colors are enabled on the installation. |