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

Получение доступных рабочих пространств

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

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

ParameterTypeFormatDefaultDescription
startintegerint320Начальный индекс для пагинации
totalintegerint321000Максимальное количество возвращаемых результатов
idintegerint64(empty)Необязательный фильтр по ID рабочего пространства
namestring(empty)Необязательный фильтр по имени рабочего пространства
rolesstring(empty)Необязательный фильтр по ролям

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

GET
CURL:

curl 'http://localhost:8160/v1/workspaces?start=0&total=1000&id=&name=&roles=' \
--header 'Api-Token: YOUR_SECRET_TOKEN'

C#:

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri( "http://localhost:8160/v1/workspaces?start=0&total=1000&id=&name=&roles="),
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/workspaces?start=0&total=1000&id=&name=&roles=

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

Ответ API:

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

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

{
"totalCount": 1,
"items": [
{
"workspaceId": 1,
"name": null,
"role": "Owner"
}
]
}

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

{
"message": null
}