AplasAplas API Reference

Create a view

id is NOT accepted. Unlike every other v3 resource, a view's slug is never freed — archiving does not release it — so the slug is derived from name and auto-suffixed (-2, -3, …) until free. Read the assigned id from the response rather than predicting it.

POST
/workspaces/{workspaceId}/views

Authorization

BearerAuth
AuthorizationBearer <token>

API authentication via Authorization: Bearer <your-api-key>. Obtain your API key from Config → API in the Aplas web app.

In: header

Path Parameters

workspaceId*string

The workspace's slug.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.au.aplas.com/api/v3/workspaces/string/views" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "viewType": "map"  }'
{
  "id": "string",
  "name": "string",
  "description": "string",
  "viewType": "string",
  "config": {},
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "The permissions of your API key only allow read-only/GET calls."
}
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "The permissions of your API key only allow read-only/GET calls."
}
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "The permissions of your API key only allow read-only/GET calls."
}
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "The permissions of your API key only allow read-only/GET calls."
}