Faceplate Controller

get
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
faceplateIdstringRequired
Responses
200

OK

*/*
get
/api/faceplates/{faceplateId}
put
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

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
put
/api/faceplates/{faceplateId}

No content

delete
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
faceplateIdstringRequired
Responses
delete
/api/faceplates/{faceplateId}

No content

get
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
faceplateIdstringRequired
Responses
200

OK

*/*
Responsestring · binary
get
/api/faceplates/{faceplateId}/svg
put
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
faceplateIdstringRequired
Body
stringOptional
Responses
put
/api/faceplates/{faceplateId}/svg

No content

get
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
faceplateIdstringRequired
placeholderIdstringRequired
Responses
200

OK

*/*
get
/api/faceplates/{faceplateId}/placeholders/{placeholderId}
put
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

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
put
/api/faceplates/{faceplateId}/placeholders/{placeholderId}

No content

delete
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
faceplateIdstringRequired
placeholderIdstringRequired
Responses
delete
/api/faceplates/{faceplateId}/placeholders/{placeholderId}

No content

get
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
faceplateIdstringRequired
elementIdstringRequired
Responses
200

OK

*/*
get
/api/faceplates/{faceplateId}/elements/{elementId}
put
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

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
put
/api/faceplates/{faceplateId}/elements/{elementId}

No content

delete
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
faceplateIdstringRequired
elementIdstringRequired
Responses
delete
/api/faceplates/{faceplateId}/elements/{elementId}

No content

get
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Responses
200

OK

*/*
get
/api/faceplates
post
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

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

*/*
post
/api/faceplates
get
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
faceplateIdstringRequired
Responses
200

OK

*/*
get
/api/faceplates/{faceplateId}/placeholders
post
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

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

*/*
post
/api/faceplates/{faceplateId}/placeholders
get
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
faceplateIdstringRequired
Responses
200

OK

*/*
get
/api/faceplates/{faceplateId}/elements
post
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

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

*/*
post
/api/faceplates/{faceplateId}/elements
post
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
faceplateIdstringRequired
Query parameters
namestringRequired
Responses
200

OK

*/*
post
/api/faceplates/{faceplateId}/clone
post
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Query parameters
Body
filestring · binaryRequired
Responses
200

OK

*/*
Responseobject
post
/api/faceplates/import
get
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Query parameters
projectIdstringOptional
includeIdsbooleanOptionalDefault: false
Responses
200

OK

*/*
Responseobject
get
/api/faceplates/export
get
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Query parameters
projectIdstringRequired
Responses
200

OK

*/*
get
/api/faceplates/by-project
get
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Query parameters
projectIdstringRequired
namesstring[]Required
Responses
200

OK

*/*
get
/api/faceplates/by-project-and-names
delete
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
faceplateIdstringRequired
Query parameters
elementIdsstring[]Required
Responses
delete
/api/faceplates/{faceplateId}/elements/multi/by-ids

No content

Last updated