Перейти к основному содержимому

Получение списка папок

Описание: Этот запрос получает список папок, доступных в указанном рабочем пространстве.
Дополнительно вы можете ограничить количество результатов, задать фильтры или указать условия сортировки.

Параметры запроса:

ParameterTypeFormatDefaultDescription
workspaceIdintegerint64-1ID рабочего пространства, в котором будет создана папка профилей. По умолчанию -1, если не указано.
startintegerint320Индекс первой папки (начиная с нуля).
totalintegerint321000Максимальное количество папок для получения.
idstringuuid(empty)Уникальный идентификатор папки (необязательный фильтр).
namestring(empty)Имя папки (необязательный фильтр).
sortingstring(empty)Условие сортировки: Id, Name, FolderType, Quantity (необязательный фильтр).
locationstring (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:

Response codeResult
200 OKУспешно
500 ErrorВнутренняя ошибка сервера

Успешный ответ (200 OK):

{
"totalCount": 1,
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": null,
"location": "Local",
"quantity": 1
}
]
}

Ответ с ошибкой (500):

{
"message": null
}