Faceplate Controller
get
Authorizations
Path parameters
faceplateIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/faceplates/{faceplateId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"dsc": "text",
"projectId": "text",
"faceplateElements": [
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"type": "Bar",
"name": "text",
"expression": "text",
"props": "text",
"faceplateId": "text",
"domId": "text",
"expressionType": "EXPRESSION"
}
],
"color": "text",
"name": "text",
"svgContent": "text",
"faceplatePlaceholders": [
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"props": "text",
"type": "number",
"name": "text",
"group": "text",
"faceplateId": "text",
"order": 1,
"dsc": "text"
}
]
}
put
Authorizations
Path parameters
faceplateIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
dscstring · max: 255Optional
projectIdstringOptional
colorstring · max: 25Optional
namestring · max: 100Required
svgContentstringRequired
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
put
PUT /api/faceplates/{faceplateId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 402
{
"id": "text",
"dsc": "text",
"projectId": "text",
"faceplateElements": [
{
"id": "text",
"type": "Bar",
"name": "text",
"expression": "text",
"props": "text",
"faceplateId": "text",
"domId": "text",
"expressionType": "EXPRESSION"
}
],
"color": "text",
"name": "text",
"svgContent": "text",
"faceplatePlaceholders": [
{
"id": "text",
"props": "text",
"type": "number",
"name": "text",
"group": "text",
"faceplateId": "text",
"order": 1,
"dsc": "text"
}
]
}
No content
delete
Authorizations
Path parameters
faceplateIdstringRequired
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
delete
DELETE /api/faceplates/{faceplateId} HTTP/1.1
Host: inscada.cloud
Accept: */*
No content
get
Authorizations
Path parameters
faceplateIdstringRequired
Responses
200
OK
*/*
Responsestring · binary
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/faceplates/{faceplateId}/svg HTTP/1.1
Host: inscada.cloud
Accept: */*
binary
put
Authorizations
Path parameters
faceplateIdstringRequired
Body
stringOptional
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
put
PUT /api/faceplates/{faceplateId}/svg HTTP/1.1
Host: inscada.cloud
Content-Type: text/plain
Accept: */*
Content-Length: 6
"text"
No content
get
Authorizations
Path parameters
faceplateIdstringRequired
placeholderIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/faceplates/{faceplateId}/placeholders/{placeholderId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"props": "text",
"type": "number",
"name": "text",
"group": "text",
"faceplateId": "text",
"order": 1,
"dsc": "text"
}
put
Authorizations
Path parameters
faceplateIdstringRequired
placeholderIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
propsstringOptional
typestring · enumRequiredPossible values:
namestring · max: 100Optional
groupstringOptional
faceplateIdstringRequired
orderinteger · int32Optional
dscstringOptional
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
put
PUT /api/faceplates/{faceplateId}/placeholders/{placeholderId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 117
{
"id": "text",
"props": "text",
"type": "number",
"name": "text",
"group": "text",
"faceplateId": "text",
"order": 1,
"dsc": "text"
}
No content
delete
Authorizations
Path parameters
faceplateIdstringRequired
placeholderIdstringRequired
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
delete
DELETE /api/faceplates/{faceplateId}/placeholders/{placeholderId} HTTP/1.1
Host: inscada.cloud
Accept: */*
No content
get
Authorizations
Path parameters
faceplateIdstringRequired
elementIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/faceplates/{faceplateId}/elements/{elementId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"type": "Bar",
"name": "text",
"expression": "text",
"props": "text",
"faceplateId": "text",
"domId": "text",
"expressionType": "EXPRESSION"
}
put
Authorizations
Path parameters
faceplateIdstringRequired
elementIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
typestring · enumRequiredPossible values:
namestring · max: 100Optional
expressionstringOptional
propsstringRequired
faceplateIdstringRequired
domIdstring · max: 100Required
expressionTypestring · enumRequiredPossible values:
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
put
PUT /api/faceplates/{faceplateId}/elements/{elementId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 141
{
"id": "text",
"type": "Bar",
"name": "text",
"expression": "text",
"props": "text",
"faceplateId": "text",
"domId": "text",
"expressionType": "EXPRESSION"
}
No content
delete
Authorizations
Path parameters
faceplateIdstringRequired
elementIdstringRequired
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
delete
DELETE /api/faceplates/{faceplateId}/elements/{elementId} HTTP/1.1
Host: inscada.cloud
Accept: */*
No content
get
Authorizations
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/faceplates HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"dsc": "text",
"projectId": "text",
"faceplateElements": [
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"type": "Bar",
"name": "text",
"expression": "text",
"props": "text",
"faceplateId": "text",
"domId": "text",
"expressionType": "EXPRESSION"
}
],
"color": "text",
"name": "text",
"svgContent": "text",
"faceplatePlaceholders": [
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"props": "text",
"type": "number",
"name": "text",
"group": "text",
"faceplateId": "text",
"order": 1,
"dsc": "text"
}
]
}
]
post
Authorizations
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
dscstring · max: 255Optional
projectIdstringOptional
colorstring · max: 25Optional
namestring · max: 100Required
svgContentstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/faceplates HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 402
{
"id": "text",
"dsc": "text",
"projectId": "text",
"faceplateElements": [
{
"id": "text",
"type": "Bar",
"name": "text",
"expression": "text",
"props": "text",
"faceplateId": "text",
"domId": "text",
"expressionType": "EXPRESSION"
}
],
"color": "text",
"name": "text",
"svgContent": "text",
"faceplatePlaceholders": [
{
"id": "text",
"props": "text",
"type": "number",
"name": "text",
"group": "text",
"faceplateId": "text",
"order": 1,
"dsc": "text"
}
]
}
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"dsc": "text",
"projectId": "text",
"faceplateElements": [
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"type": "Bar",
"name": "text",
"expression": "text",
"props": "text",
"faceplateId": "text",
"domId": "text",
"expressionType": "EXPRESSION"
}
],
"color": "text",
"name": "text",
"svgContent": "text",
"faceplatePlaceholders": [
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"props": "text",
"type": "number",
"name": "text",
"group": "text",
"faceplateId": "text",
"order": 1,
"dsc": "text"
}
]
}
get
Authorizations
Path parameters
faceplateIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/faceplates/{faceplateId}/placeholders HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"props": "text",
"type": "number",
"name": "text",
"group": "text",
"faceplateId": "text",
"order": 1,
"dsc": "text"
}
]
post
Authorizations
Path parameters
faceplateIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
propsstringOptional
typestring · enumRequiredPossible values:
namestring · max: 100Optional
groupstringOptional
faceplateIdstringRequired
orderinteger · int32Optional
dscstringOptional
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/faceplates/{faceplateId}/placeholders HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 117
{
"id": "text",
"props": "text",
"type": "number",
"name": "text",
"group": "text",
"faceplateId": "text",
"order": 1,
"dsc": "text"
}
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"props": "text",
"type": "number",
"name": "text",
"group": "text",
"faceplateId": "text",
"order": 1,
"dsc": "text"
}
get
Authorizations
Path parameters
faceplateIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/faceplates/{faceplateId}/elements HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"type": "Bar",
"name": "text",
"expression": "text",
"props": "text",
"faceplateId": "text",
"domId": "text",
"expressionType": "EXPRESSION"
}
]
post
Authorizations
Path parameters
faceplateIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
typestring · enumRequiredPossible values:
namestring · max: 100Optional
expressionstringOptional
propsstringRequired
faceplateIdstringRequired
domIdstring · max: 100Required
expressionTypestring · enumRequiredPossible values:
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/faceplates/{faceplateId}/elements HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 141
{
"id": "text",
"type": "Bar",
"name": "text",
"expression": "text",
"props": "text",
"faceplateId": "text",
"domId": "text",
"expressionType": "EXPRESSION"
}
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"type": "Bar",
"name": "text",
"expression": "text",
"props": "text",
"faceplateId": "text",
"domId": "text",
"expressionType": "EXPRESSION"
}
post
Authorizations
Path parameters
faceplateIdstringRequired
Query parameters
namestringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/faceplates/{faceplateId}/clone HTTP/1.1
Host: inscada.cloud
Accept: */*
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"dsc": "text",
"projectId": "text",
"faceplateElements": [
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"type": "Bar",
"name": "text",
"expression": "text",
"props": "text",
"faceplateId": "text",
"domId": "text",
"expressionType": "EXPRESSION"
}
],
"color": "text",
"name": "text",
"svgContent": "text",
"faceplatePlaceholders": [
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"props": "text",
"type": "number",
"name": "text",
"group": "text",
"faceplateId": "text",
"order": 1,
"dsc": "text"
}
]
}
post
Authorizations
Query parameters
Body
filestring · binaryRequired
Responses
200
OK
*/*
Responseobject
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/faceplates/import HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"file": "binary"
}
{}
get
Authorizations
Query parameters
projectIdstringOptional
includeIdsbooleanOptionalDefault:
false
Responses
200
OK
*/*
Responseobject
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/faceplates/export HTTP/1.1
Host: inscada.cloud
Accept: */*
{}
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/faceplates/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"dsc": "text",
"projectId": "text",
"faceplateElements": [
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"type": "Bar",
"name": "text",
"expression": "text",
"props": "text",
"faceplateId": "text",
"domId": "text",
"expressionType": "EXPRESSION"
}
],
"color": "text",
"name": "text",
"svgContent": "text",
"faceplatePlaceholders": [
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"props": "text",
"type": "number",
"name": "text",
"group": "text",
"faceplateId": "text",
"order": 1,
"dsc": "text"
}
]
}
]
get
Authorizations
Query parameters
projectIdstringRequired
namesstring[]Required
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/faceplates/by-project-and-names HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"dsc": "text",
"projectId": "text",
"faceplateElements": [
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"type": "Bar",
"name": "text",
"expression": "text",
"props": "text",
"faceplateId": "text",
"domId": "text",
"expressionType": "EXPRESSION"
}
],
"color": "text",
"name": "text",
"svgContent": "text",
"faceplatePlaceholders": [
{
"creationDate": "2025-07-05T19:48:30.783Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:48:30.783Z",
"id": "text",
"props": "text",
"type": "number",
"name": "text",
"group": "text",
"faceplateId": "text",
"order": 1,
"dsc": "text"
}
]
}
]
delete
Authorizations
Path parameters
faceplateIdstringRequired
Query parameters
elementIdsstring[]Required
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
delete
DELETE /api/faceplates/{faceplateId}/elements/multi/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*
No content