Alpha API ReferenceTypes
Types / Options
Operations on options
Get options for tree
AuthorizationBearer <token>
In: header
Path Parameters
typeId*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/types/options/string"[
{
"activeViews": [
"string"
],
"category": "string",
"codes": [
{
"code": "string",
"description": "string",
"option": "string",
"price": 0.1,
"visible": true
}
],
"id": "string",
"isNeighborOption": true,
"name": "string",
"neighborOption": true,
"phase": "PLAN",
"visible": 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"
}Create
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/options/string" \ -H "Content-Type: application/json" \ -d '{ "activeViews": [ "string" ], "category": "string", "isNeighborOption": true, "name": "string", "phase": "PLAN", "visible": true }'{
"activeViews": [
"string"
],
"category": "string",
"codes": [
{
"code": "string",
"description": "string",
"option": "string",
"price": 0.1,
"visible": true
}
],
"id": "string",
"isNeighborOption": true,
"name": "string",
"neighborOption": true,
"phase": "PLAN",
"visible": 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
AuthorizationBearer <token>
In: header
Path Parameters
typeId*string
optionId*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 PATCH "http://localhost:18080/api/v1/types/options/string/string" \ -H "Content-Type: application/json" \ -d '{ "activeViews": [ "string" ], "category": "string", "isNeighborOption": true, "name": "string", "phase": "PLAN", "visible": true }'{
"activeViews": [
"string"
],
"category": "string",
"codes": [
{
"code": "string",
"description": "string",
"option": "string",
"price": 0.1,
"visible": true
}
],
"id": "string",
"isNeighborOption": true,
"name": "string",
"neighborOption": true,
"phase": "PLAN",
"visible": 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
AuthorizationBearer <token>
In: header
Path Parameters
typeId*string
optionId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/types/options/string/string"[
{
"activeViews": [
"string"
],
"category": "string",
"codes": [
{
"code": "string",
"description": "string",
"option": "string",
"price": 0.1,
"visible": true
}
],
"id": "string",
"isNeighborOption": true,
"name": "string",
"neighborOption": true,
"phase": "PLAN",
"visible": 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"
}Move
AuthorizationBearer <token>
In: header
Path Parameters
typeId*string
optionId*string
newIndex*integer
Format
int32Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/types/options/string/string/move/0"[
{
"activeViews": [
"string"
],
"category": "string",
"codes": [
{
"code": "string",
"description": "string",
"option": "string",
"price": 0.1,
"visible": true
}
],
"id": "string",
"isNeighborOption": true,
"name": "string",
"neighborOption": true,
"phase": "PLAN",
"visible": 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"
}