S 7 Variable 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

Responses
200

OK

*/*
get
/api/protocols/s7/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

Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
keepLastValuesbooleanRequired
unitstringOptional
engZeroScalenumber · doubleOptional
fractionalDigitCountinteger · int32Optional
namestring · max: 100Required
logExpressionIdstringOptional
logTypestring · enumOptionalPossible values:
logExpressionCodestring · max: 4000Optional
valueExpressionCodestring · max: 4000Optional
valueExpressionIdstringOptional
isPulseOffbooleanRequired
frameIdstringOptional
setMinValuenumber · doubleOptional
pulseOffDurationinteger · int32Optional
codestring · max: 20Optional
engFullScalenumber · doubleOptional
pulseOnDurationinteger · int32Optional
logThresholdnumber · doubleOptional
rawFullScalenumber · doubleOptional
isPulseOnbooleanRequired
valueExpressionTypestring · enumOptionalPossible values:
logMaxValuenumber · doubleOptional
setMaxValuenumber · doubleOptional
logMinValuenumber · doubleOptional
isActivebooleanRequired
projectIdstringOptional
rawZeroScalenumber · doubleOptional
logPeriodinteger · int32 · min: 1Optional
dscstring · max: 255Optional
bitOffsetinteger · int32Optional
maxLeninteger · int32Optional
startAddressinteger · int32Required
typestring · enumRequiredPossible values:
connectionIdstringOptional
deviceIdstringOptional
Responses
200

OK

*/*
post
/api/protocols/s7/variables
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

Bodyobject[]
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
keepLastValuesbooleanRequired
unitstringOptional
engZeroScalenumber · doubleOptional
fractionalDigitCountinteger · int32Optional
namestring · max: 100Required
logExpressionIdstringOptional
logTypestring · enumOptionalPossible values:
logExpressionCodestring · max: 4000Optional
valueExpressionCodestring · max: 4000Optional
valueExpressionIdstringOptional
isPulseOffbooleanRequired
frameIdstringOptional
setMinValuenumber · doubleOptional
pulseOffDurationinteger · int32Optional
codestring · max: 20Optional
engFullScalenumber · doubleOptional
pulseOnDurationinteger · int32Optional
logThresholdnumber · doubleOptional
rawFullScalenumber · doubleOptional
isPulseOnbooleanRequired
valueExpressionTypestring · enumOptionalPossible values:
logMaxValuenumber · doubleOptional
setMaxValuenumber · doubleOptional
logMinValuenumber · doubleOptional
isActivebooleanRequired
projectIdstringOptional
rawZeroScalenumber · doubleOptional
logPeriodinteger · int32 · min: 1Optional
dscstring · max: 255Optional
bitOffsetinteger · int32Optional
maxLeninteger · int32Optional
startAddressinteger · int32Required
typestring · enumRequiredPossible values:
connectionIdstringOptional
deviceIdstringOptional
Responses
put
/api/protocols/s7/variables

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

OK

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

No content

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
namestringOptional
typestringOptional
dscInstringOptional
projectIdstringRequired
frameIdstringOptional
connectionIdstringOptional
nameInstringOptional
deviceIdstringOptional
Responses
200

OK

*/*
post
/api/protocols/s7/variables/filter/pages
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/protocols/s7/variables/pages/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
Responses
200

OK

*/*
get
/api/protocols/s7/variables/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
namestringRequired
Responses
200

OK

*/*
get
/api/protocols/s7/variables/by-project-and-name
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
variableIdsstring[]Required
Responses
200

OK

*/*
get
/api/protocols/s7/variables/by-ids
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
frameIdstringRequired
Responses
200

OK

*/*
get
/api/protocols/s7/variables/by-frame
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

Query parameters
variableIdsstring[]Required
Responses
delete
/api/protocols/s7/variables/multi/by-ids

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

Body
namestringOptional
typestringOptional
dscInstringOptional
projectIdstringRequired
frameIdstringOptional
connectionIdstringOptional
nameInstringOptional
deviceIdstringOptional
Responses
delete
/api/protocols/s7/variables/filter

No content

Last updated