AlphaAlpha Docs
API Reference

Facade Restrictions

API calls concerning facade restrictions

Create a facade restriction

POST
/facade-restrictions

Authorization

AuthorizationBearer <token>

In: header

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/facade-restrictions" \  -H "Content-Type: application/json" \  -d '{    "description": "string",    "name": "string",    "restrictedAreas": [      {        "bounds": {          "height": {            "formula": "string",            "isConstant": true          },          "width": {            "formula": "string",            "isConstant": true          },          "x": {            "formula": "string",            "isConstant": true          },          "y": {            "formula": "string",            "isConstant": true          }        },        "id": "string",        "name": "string"      }    ]  }'
{
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "name": "string",
  "restrictedAreas": [
    {
      "bounds": {
        "height": {
          "formula": "string",
          "isConstant": true
        },
        "width": {
          "formula": "string",
          "isConstant": true
        },
        "x": {
          "formula": "string",
          "isConstant": true
        },
        "y": {
          "formula": "string",
          "isConstant": true
        }
      },
      "id": "string",
      "name": "string"
    }
  ],
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "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"
}

Download Csv_ Facade Restriction

GET
/facade-restrictions/csv-export

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/facade-restrictions/csv-export"
"string"
{
  "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 list of entities by their IDs

DELETE
/facade-restrictions/delete-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/facade-restrictions/delete-list?ids=string"
Empty
{
  "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"
}

Dynamic Search_ Facade Restriction

GET
/facade-restrictions/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/facade-restrictions/dynamic-search"
{
  "content": [
    {
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "description": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "name": "string",
      "restrictedAreas": [
        {
          "bounds": {
            "height": {
              "formula": "string",
              "isConstant": true
            },
            "width": {
              "formula": "string",
              "isConstant": true
            },
            "x": {
              "formula": "string",
              "isConstant": true
            },
            "y": {
              "formula": "string",
              "isConstant": true
            }
          },
          "id": "string",
          "name": "string"
        }
      ],
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "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"
}

Dynamic Search Post_ Facade Restriction

POST
/facade-restrictions/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

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/facade-restrictions/dynamic-search" \  -H "Content-Type: application/json" \  -d '{    "filters": {      "property1": null,      "property2": null    },    "page": 0,    "search": [      "string"    ],    "size": 0,    "sort": [      {        "ascending": true,        "field": "string"      }    ]  }'
{
  "content": [
    {
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "description": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "name": "string",
      "restrictedAreas": [
        {
          "bounds": {
            "height": {
              "formula": "string",
              "isConstant": true
            },
            "width": {
              "formula": "string",
              "isConstant": true
            },
            "x": {
              "formula": "string",
              "isConstant": true
            },
            "y": {
              "formula": "string",
              "isConstant": true
            }
          },
          "id": "string",
          "name": "string"
        }
      ],
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "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"
}

Find by list of ids in current tenant

GET
/facade-restrictions/find

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/facade-restrictions/find?ids=string"
[
  {
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "name": "string",
    "restrictedAreas": [
      {
        "bounds": {
          "height": {
            "formula": "string",
            "isConstant": true
          },
          "width": {
            "formula": "string",
            "isConstant": true
          },
          "x": {
            "formula": "string",
            "isConstant": true
          },
          "y": {
            "formula": "string",
            "isConstant": true
          }
        },
        "id": "string",
        "name": "string"
      }
    ],
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "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"
}

Find all for current tenant

GET
/facade-restrictions/find-all

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/facade-restrictions/find-all"
[
  {
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "name": "string",
    "restrictedAreas": [
      {
        "bounds": {
          "height": {
            "formula": "string",
            "isConstant": true
          },
          "width": {
            "formula": "string",
            "isConstant": true
          },
          "x": {
            "formula": "string",
            "isConstant": true
          },
          "y": {
            "formula": "string",
            "isConstant": true
          }
        },
        "id": "string",
        "name": "string"
      }
    ],
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "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"
}

Find a list of entities by their IDs

GET
/facade-restrictions/find-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/facade-restrictions/find-list"
[
  {
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "name": "string",
    "restrictedAreas": [
      {
        "bounds": {
          "height": {
            "formula": "string",
            "isConstant": true
          },
          "width": {
            "formula": "string",
            "isConstant": true
          },
          "x": {
            "formula": "string",
            "isConstant": true
          },
          "y": {
            "formula": "string",
            "isConstant": true
          }
        },
        "id": "string",
        "name": "string"
      }
    ],
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "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"
}

Find by id in current tenant

GET
/facade-restrictions/find/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/facade-restrictions/find/string"
{
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "name": "string",
  "restrictedAreas": [
    {
      "bounds": {
        "height": {
          "formula": "string",
          "isConstant": true
        },
        "width": {
          "formula": "string",
          "isConstant": true
        },
        "x": {
          "formula": "string",
          "isConstant": true
        },
        "y": {
          "formula": "string",
          "isConstant": true
        }
      },
      "id": "string",
      "name": "string"
    }
  ],
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "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"
}

Get page by page number and size with optional sorting based on field to sortBy and direction

GET
/facade-restrictions/page

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/facade-restrictions/page"
{
  "content": [
    {
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "description": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "name": "string",
      "restrictedAreas": [
        {
          "bounds": {
            "height": {
              "formula": "string",
              "isConstant": true
            },
            "width": {
              "formula": "string",
              "isConstant": true
            },
            "x": {
              "formula": "string",
              "isConstant": true
            },
            "y": {
              "formula": "string",
              "isConstant": true
            }
          },
          "id": "string",
          "name": "string"
        }
      ],
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "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 by id in current tenant

DELETE
/facade-restrictions/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/facade-restrictions/string"
Empty
{
  "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 a facade restriction

PUT
/facade-restrictions/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*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 PUT "http://localhost:18080/api/v1/facade-restrictions/string" \  -H "Content-Type: application/json" \  -d '{    "description": "string",    "name": "string",    "restrictedAreas": [      {        "bounds": {          "height": {            "formula": "string",            "isConstant": true          },          "width": {            "formula": "string",            "isConstant": true          },          "x": {            "formula": "string",            "isConstant": true          },          "y": {            "formula": "string",            "isConstant": true          }        },        "id": "string",        "name": "string"      }    ]  }'
{
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "name": "string",
  "restrictedAreas": [
    {
      "bounds": {
        "height": {
          "formula": "string",
          "isConstant": true
        },
        "width": {
          "formula": "string",
          "isConstant": true
        },
        "x": {
          "formula": "string",
          "isConstant": true
        },
        "y": {
          "formula": "string",
          "isConstant": true
        }
      },
      "id": "string",
      "name": "string"
    }
  ],
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "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"
}

Add a comment to an entity

POST
/facade-restrictions/{id}/comment

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/facade-restrictions/string/comment" \  -H "Content-Type: application/json" \  -d 'string'
{}
{
  "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"
}

Resolve a facade restriction with variable values

POST
/facade-restrictions/{id}/resolve

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*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/facade-restrictions/string/resolve" \  -H "Content-Type: application/json" \  -d '[    {      "id": "string",      "value": 0.1    }  ]'
{
  "description": "string",
  "id": "string",
  "name": "string",
  "resolvedAreas": [
    {
      "bounds": {
        "height": 0.1,
        "width": 0.1,
        "x": 0.1,
        "y": 0.1
      },
      "id": "string",
      "name": "string"
    }
  ]
}
{
  "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"
}

Facade Configurations

Previous Page

Favorites

Next Page