Local Template 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
deviceIdstringRequired
Responses
200

OK

*/*
get
/api/protocols/local/templates/devices/{deviceId}
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
deviceIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
propertiesstringOptional
dscstring · max: 255Optional
namestring · max: 100Required
scanTimeinteger · int32 · min: 1Required
scanTypestring · enumRequiredPossible values:
Responses
put
/api/protocols/local/templates/devices/{deviceId}

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
deviceIdstringRequired
Responses
delete
/api/protocols/local/templates/devices/{deviceId}

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
deviceIdstringRequired
frameIdstringRequired
Responses
200

OK

*/*
get
/api/protocols/local/templates/devices/{deviceId}/frames/{frameId}
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
deviceIdstringRequired
frameIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
deviceIdstringOptional
dscstring · max: 255Optional
scanTimeFactorinteger · int32Optional
namestring · max: 100Required
isWritablebooleanRequired
isReadablebooleanRequired
minutesOffsetinteger · int32Optional
Responses
put
/api/protocols/local/templates/devices/{deviceId}/frames/{frameId}

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
deviceIdstringRequired
frameIdstringRequired
Responses
delete
/api/protocols/local/templates/devices/{deviceId}/frames/{frameId}

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
deviceIdstringRequired
frameIdstringRequired
variableIdstringRequired
Responses
200

OK

*/*
get
/api/protocols/local/templates/devices/{deviceId}/frames/{frameId}/variables/{variableId}
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
deviceIdstringRequired
frameIdstringRequired
variableIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
engFullScalenumber · doubleOptional
logMaxValuenumber · doubleOptional
fractionalDigitCountinteger · int32Optional
isPulseOnbooleanRequired
logExpressionCodestring · max: 4000Optional
frameIdstringOptional
valueExpressionTypestring · enumOptionalPossible values:
logMinValuenumber · doubleOptional
rawZeroScalenumber · doubleOptional
valueExpressionCodestring · max: 4000Optional
isActivebooleanRequired
codestring · max: 20Optional
valueExpressionIdstringOptional
setMaxValuenumber · doubleOptional
logTypestring · enumOptionalPossible values:
setMinValuenumber · doubleOptional
keepLastValuesbooleanRequired
logThresholdnumber · doubleOptional
isPulseOffbooleanRequired
logPeriodinteger · int32 · min: 1Optional
pulseOffDurationinteger · int32Optional
pulseOnDurationinteger · int32Optional
engZeroScalenumber · doubleOptional
dscstring · max: 255Optional
unitstringOptional
logExpressionIdstringOptional
rawFullScalenumber · doubleOptional
namestring · max: 100Required
typestring · enumRequiredPossible values:
deviceIdstringOptional
Responses
put
/api/protocols/local/templates/devices/{deviceId}/frames/{frameId}/variables/{variableId}

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
deviceIdstringRequired
frameIdstringRequired
variableIdstringRequired
Responses
delete
/api/protocols/local/templates/devices/{deviceId}/frames/{frameId}/variables/{variableId}

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/protocols/local/templates/devices
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
propertiesstringOptional
dscstring · max: 255Optional
namestring · max: 100Required
scanTimeinteger · int32 · min: 1Required
scanTypestring · enumRequiredPossible values:
Responses
200

OK

*/*
post
/api/protocols/local/templates/devices
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
deviceIdstringRequired
Responses
200

OK

*/*
get
/api/protocols/local/templates/devices/{deviceId}/frames
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
deviceIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
deviceIdstringOptional
dscstring · max: 255Optional
scanTimeFactorinteger · int32Optional
namestring · max: 100Required
isWritablebooleanRequired
isReadablebooleanRequired
minutesOffsetinteger · int32Optional
Responses
200

OK

*/*
post
/api/protocols/local/templates/devices/{deviceId}/frames
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
deviceIdstringRequired
frameIdstringRequired
Responses
200

OK

*/*
get
/api/protocols/local/templates/devices/{deviceId}/frames/{frameId}/variables
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
deviceIdstringRequired
frameIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
engFullScalenumber · doubleOptional
logMaxValuenumber · doubleOptional
fractionalDigitCountinteger · int32Optional
isPulseOnbooleanRequired
logExpressionCodestring · max: 4000Optional
frameIdstringOptional
valueExpressionTypestring · enumOptionalPossible values:
logMinValuenumber · doubleOptional
rawZeroScalenumber · doubleOptional
valueExpressionCodestring · max: 4000Optional
isActivebooleanRequired
codestring · max: 20Optional
valueExpressionIdstringOptional
setMaxValuenumber · doubleOptional
logTypestring · enumOptionalPossible values:
setMinValuenumber · doubleOptional
keepLastValuesbooleanRequired
logThresholdnumber · doubleOptional
isPulseOffbooleanRequired
logPeriodinteger · int32 · min: 1Optional
pulseOffDurationinteger · int32Optional
pulseOnDurationinteger · int32Optional
engZeroScalenumber · doubleOptional
dscstring · max: 255Optional
unitstringOptional
logExpressionIdstringOptional
rawFullScalenumber · doubleOptional
namestring · max: 100Required
typestring · enumRequiredPossible values:
deviceIdstringOptional
Responses
200

OK

*/*
post
/api/protocols/local/templates/devices/{deviceId}/frames/{frameId}/variables

Last updated