AlphaAlpha Docs

Types / Views

Views API

Add a view

POST
/types/views/{typeId}
AuthorizationBearer <token>

In: header

Path Parameters

typeId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/types/views/string" \  -H "Content-Type: application/json" \  -d '{    "id": "string"  }'
[
  {
    "active": true,
    "activeCategories": [
      "string"
    ],
    "description": "string",
    "id": "string",
    "maxHeight": 0.1,
    "position": {
      "x": {
        "formula": "string",
        "isConstant": true
      },
      "y": {
        "formula": "string",
        "isConstant": true
      },
      "z": {
        "formula": "string",
        "isConstant": true
      }
    },
    "target": {
      "x": {
        "formula": "string",
        "isConstant": true
      },
      "y": {
        "formula": "string",
        "isConstant": true
      },
      "z": {
        "formula": "string",
        "isConstant": true
      }
    }
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete a view

DELETE
/types/views/{typeId}/delete/{viewName}
AuthorizationBearer <token>

In: header

Path Parameters

typeId*string
viewName*string

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/types/views/string/delete/string"
[
  {
    "active": true,
    "activeCategories": [
      "string"
    ],
    "description": "string",
    "id": "string",
    "maxHeight": 0.1,
    "position": {
      "x": {
        "formula": "string",
        "isConstant": true
      },
      "y": {
        "formula": "string",
        "isConstant": true
      },
      "z": {
        "formula": "string",
        "isConstant": true
      }
    },
    "target": {
      "x": {
        "formula": "string",
        "isConstant": true
      },
      "y": {
        "formula": "string",
        "isConstant": true
      },
      "z": {
        "formula": "string",
        "isConstant": true
      }
    }
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Update views

POST
/types/views/{typeId}/update/{viewName}
AuthorizationBearer <token>

In: header

Path Parameters

typeId*string
viewName*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/types/views/string/update/string" \  -H "Content-Type: application/json" \  -d '{    "id": "string"  }'
[
  {
    "active": true,
    "activeCategories": [
      "string"
    ],
    "description": "string",
    "id": "string",
    "maxHeight": 0.1,
    "position": {
      "x": {
        "formula": "string",
        "isConstant": true
      },
      "y": {
        "formula": "string",
        "isConstant": true
      },
      "z": {
        "formula": "string",
        "isConstant": true
      }
    },
    "target": {
      "x": {
        "formula": "string",
        "isConstant": true
      },
      "y": {
        "formula": "string",
        "isConstant": true
      },
      "z": {
        "formula": "string",
        "isConstant": true
      }
    }
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}