Facade Configurations
API calls concerning facade configurations
Create a facade configuration
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-configurations" \ -H "Content-Type: application/json" \ -d '{ "description": "string", "elements": [ { "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", "type": "WINDOW" } ], "name": "string", "theme": "string" }'{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"elements": [
{
"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",
"type": "WINDOW"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"name": "string",
"restrictionId": "string",
"tenantId": "string",
"theme": "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 Configuration
In: header
Query Parameters
0int3220int32Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/facade-configurations/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
In: header
Query Parameters
Response Body
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/facade-configurations/delete-list?ids=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"
}Dynamic Search_ Facade Configuration
In: header
Query Parameters
0int3220int32Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/facade-configurations/dynamic-search"{
"content": [
{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"elements": [
{
"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",
"type": "WINDOW"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"name": "string",
"restrictionId": "string",
"tenantId": "string",
"theme": "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 Configuration
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-configurations/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": [
{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"elements": [
{
"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",
"type": "WINDOW"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"name": "string",
"restrictionId": "string",
"tenantId": "string",
"theme": "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
In: header
Query Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/facade-configurations/find?ids=string"[
{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"elements": [
{
"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",
"type": "WINDOW"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"name": "string",
"restrictionId": "string",
"tenantId": "string",
"theme": "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
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/facade-configurations/find-all"[
{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"elements": [
{
"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",
"type": "WINDOW"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"name": "string",
"restrictionId": "string",
"tenantId": "string",
"theme": "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
In: header
Query Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/facade-configurations/find-list"[
{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"elements": [
{
"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",
"type": "WINDOW"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"name": "string",
"restrictionId": "string",
"tenantId": "string",
"theme": "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
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/facade-configurations/find/string"{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"elements": [
{
"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",
"type": "WINDOW"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"name": "string",
"restrictionId": "string",
"tenantId": "string",
"theme": "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
In: header
Query Parameters
int32int32"ASC" | "DESC"Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/facade-configurations/page"{
"content": [
{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"elements": [
{
"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",
"type": "WINDOW"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"name": "string",
"restrictionId": "string",
"tenantId": "string",
"theme": "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
In: header
Path Parameters
Response Body
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/facade-configurations/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"
}Update a facade configuration
In: header
Path Parameters
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-configurations/string" \ -H "Content-Type: application/json" \ -d '{ "description": "string", "elements": [ { "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", "type": "WINDOW" } ], "name": "string", "theme": "string" }'{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"elements": [
{
"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",
"type": "WINDOW"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"name": "string",
"restrictionId": "string",
"tenantId": "string",
"theme": "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"
}Upload an asset to a facade configuration
In: header
Path Parameters
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-configurations/string/assets" \ -H "Content-Type: application/json" \ -d '{ "file": "string" }'{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"elements": [
{
"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",
"type": "WINDOW"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"name": "string",
"restrictionId": "string",
"tenantId": "string",
"theme": "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"
}Delete an asset from a facade configuration
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/facade-configurations/string/assets/string"{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"elements": [
{
"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",
"type": "WINDOW"
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"name": "string",
"restrictionId": "string",
"tenantId": "string",
"theme": "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
In: header
Path Parameters
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-configurations/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 configuration with variable values
In: header
Path Parameters
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-configurations/string/resolve" \ -H "Content-Type: application/json" \ -d '[ { "id": "string", "value": 0.1 } ]'{
"description": "string",
"id": "string",
"name": "string",
"resolvedElements": [
{
"bounds": {
"height": 0.1,
"width": 0.1,
"x": 0.1,
"y": 0.1
},
"id": "string",
"name": "string",
"type": "WINDOW"
}
],
"restrictionId": "string",
"theme": "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"
}