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

Удаление папки профилей с содержимым

Описание: Этот метод удаляет указанную папку профилей вместе со всеми содержащимися в ней профилями. Значение profileFolderId должно соответствовать существующей папке в указанном рабочем пространстве.

warning

Операция удаляет не только папку, но и все профили внутри неё.

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

ПараметрТипФорматЗначение по умолчаниюОписание
profileFolderIdstringuuid(required)Уникальный идентификатор папки профилей, которую требуется удалить.
workspaceIdintegerint64-1Идентификатор рабочего пространства, содержащего папку профилей. Значение -1 означает рабочее пространство по умолчанию.

Пример запроса:​

DELETE
CURL:

curl 'http://localhost:8160/v1/profile_folders/123e4567-e89b-12d3-a456-426614174000/cascade?workspaceId=-1' \
--request DELETE \
--header 'Api-Token: YOUR_SECRET_TOKEN'

C#:

var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("http://localhost:8160/v1/profile_folders/123e4567-e89b-12d3-a456-426614174000/cascade?workspaceId=-1"),
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/123e4567-e89b-12d3-a456-426614174000/cascade?workspaceId=-1

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

Ответ API:​

Код ответаРезультат
200 OKУспешно
401 UnauthorizedНе авторизован
403 ForbiddenДоступ запрещен
409 ConflictКонфликт состояния ресурса
422 Unprocessable ContentЗапрос не может быть обработан
423 LockedРесурс заблокирован
500 Internal Server ErrorВнутренняя ошибка сервера

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

Тело ответа отсутствует.

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

{
"message": null
}