Skip to main content

Creating a Preset

Description: Creates a new preset.

Request parameters:

ParameterTypeFormatDefaultDescription
namestring(empty)Preset name
iconNamestring(empty)Preset icon name
workspaceIdintegerint64-1Workspace ID. Use -1 for the default workspace

Example request:

POST
CURL:

curl 'http://localhost:8160/v1/presets/create?name=ApiEntity&iconName=star&workspaceId=-1' \
--request POST \
--header 'Api-Token: YOUR_SECRET_TOKEN'

C#:

using System.Text;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("http://localhost:8160/v1/presets/create?name=ApiEntity&iconName=star&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/presets/create?name=ApiEntity&iconName=star&workspaceId=-1

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):

123e4567-e89b-12d3-a456-426614174000

Error Response (500):

{
"message": null
}