Получение списка папок
Пожалуйста, ознакомьтесь с Правилами использования материалов на данном ресурсе.
Описание: Этот запрос получает список папок, доступных в указанном рабочем пространстве.
Дополнительно вы можете ограничить количество результатов, задать фильтры или указать условия сортировки.
Параметры запроса:
| Parameter | Type | Format | Default | Description |
|---|---|---|---|---|
| workspaceId | integer | int64 | -1 | ID рабочего пространства, в котором будет создана папка профилей. По умолчанию -1, если не указано. |
| start | integer | int32 | 0 | Индекс первой папки (начиная с нуля). |
| total | integer | int32 | 1000 | Максимальное количество папок для получения. |
| id | string | uuid | (empty) | Уникальный идентификатор папки (необязательный фильтр). |
| name | string | (empty) | Имя папки (необязательный фильтр). | |
| sorting | string | (empty) | Условие сортировки: Id, Name, FolderType, Quantity (необязательный фильтр). | |
| location | string (enum) | Local | Расположение папки: "Local" или "Cloud". |
Пример запроса:
GET
CURL:
curl 'http://localhost:8160/v1/profile_folders?workspaceId=-1&start=0&total=1000&id=&name=&sorting=&location=' \
--header 'Api-Token: YOUR_SECRET_TOKEN'
С#:
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("http://localhost:8160/v1/profile_folders?workspaceId=-1&start=0&total=1000&id=&name=&sorting=&location="),
Headers =
{
{ "Api-Token", "YOUR_SECRET_TOKEN" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
Cube:
http://localhost:8160/v1/profile_folders?workspaceId=-1&start=0&total=1000&id=&name=&sorting=&location=

Дополнительно:
User-Agent: {-Profile.UserAgent-}
Api-Token: токен из UserArea2.

Ответ API:
| Код ответа | Результат |
|---|---|
200 OK | Успешно |
401 Unauthorized | Не авторизован |
403 Forbidden | Доступ запрещен |
500 Internal Server Error | Внутренняя ошибка сервера |
Успешный ответ (200 OK):
{
"totalCount": 1,
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": null,
"location": "Local",
"quantity": 1
}
]
}
Ответ с ошибкой (500):
{
"message": null
}