Skip to main content

Getting Extension List

Description: Retrieves extensions accessible to the current user.

Request parameters:

ParameterTypeFormatDefaultDescription
workspaceIdintegerint64-1Workspace ID. Use -1 for the default workspace
startintegerint32(empty)Starting index for pagination
totalintegerint32(empty)Maximum number of results to return
idstring(empty)Optional extension ID filter
namestring(empty)Optional extension name filter
presetIdstring(empty)Optional extension preset ID filter

Example request:

GET
CURL:

curl 'http://localhost:8160/v1/presets/extensions?workspaceId=-1&start=0&total=1000&id=&name=ApiEntity&presetId=123e4567-e89b-12d3-a456-426614174000' \
--header 'Api-Token: YOUR_SECRET_TOKEN'

C#:

using System.Text;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("http://localhost:8160/v1/presets/extensions?workspaceId=-1&start=0&total=1000&id=&name=ApiEntity&presetId=123e4567-e89b-12d3-a456-426614174000"),
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/presets/extensions?workspaceId=-1&start=0&total=1000&id=&name=ApiEntity&presetId=123e4567-e89b-12d3-a456-426614174000

Additionally:
User-Agent: {-Profile.UserAgent-}
Api-Token: Token from UserArea2.

Response API:

Response codeResult
200 OKOK
401 UnauthorizedUnauthorized
403 ForbiddenForbidden
500 Internal Server ErrorInternal Server Error

Success Response (200 OK):

{
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"presetId": "123e4567-e89b-12d3-a456-426614174000",
"name": "Sample Name",
"extensionWebId": "string",
"extensionWebUrl": "https://example.com",
"icon": "string",
"status": "Ok",
"source": "string",
"version": {
"versionNumber": "1.0.0",
"status": "Ok"
}
}
],
"totalCount": 1
}

Error Response (500):

{
"message": null
}