Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Headers

x-vol-tenant
integer<int32>
required

Tenant

x-vol-site
integer<int32>
required

Site

Body

application/json
booleanOperator
enum<string>
required
Available options:
filter.logic.equal,
filter.logic.not.equal,
filter.logic.greater.than,
filter.logic.less.than,
filter.logic.greater.or.equal,
filter.logic.less.or.equal,
filter.logic.in,
filter.logic.not.in,
filter.logic.between,
filter.logic.starts.with,
filter.logic.ends.with,
filter.logic.contains,
filter.logic.equal,
filter.logic.not.equal,
filter.logic.in,
filter.logic.not.in,
filter.logic.subset
dotDelimitedPropertyName
string
required
environmentID
integer<int32>
required
name
string
required
Required string length: 1 - 255
siteID
integer<int32>
required
tenantID
integer<int32>
required
acceptNulls
boolean
created
string<date-time>
creatorUsername
string
customAttributeName
string
dataPointExtensibleAttributeFQN
string
dataPointExtensibleAttributeName
string
dataPointExtensibleAttributeType
string
dataPointExtensibleFilter
boolean
definitions
object[]
extensibleAttributeFQN
string
extensibleAttributeName
string
extensibleFilter
boolean
filterID
integer<int32>
filterLogicalGroupOrderIndex
integer<int32>
filterUnit
object
inventoryBasedFilter
boolean
itemBasedFilter
boolean
locationBasedFilter
boolean
locationCriteriaSet
object
orderIndex
integer<int32>
orderLocationFilterEqualToLocationOrInventoryFilter
boolean
pathString
string
persisted
boolean
suggestionEventListeners
object[]
updated
string<date-time>
updaterUsername
string
userContext
object

Response

OK

booleanOperator
enum<string>
required
Available options:
filter.logic.equal,
filter.logic.not.equal,
filter.logic.greater.than,
filter.logic.less.than,
filter.logic.greater.or.equal,
filter.logic.less.or.equal,
filter.logic.in,
filter.logic.not.in,
filter.logic.between,
filter.logic.starts.with,
filter.logic.ends.with,
filter.logic.contains,
filter.logic.equal,
filter.logic.not.equal,
filter.logic.in,
filter.logic.not.in,
filter.logic.subset
dotDelimitedPropertyName
string
required
environmentID
integer<int32>
required
name
string
required
Required string length: 1 - 255
siteID
integer<int32>
required
tenantID
integer<int32>
required
created
string<date-time>
creatorUsername
string
customAttributeName
string
dataPointExtensibleAttributeFQN
string
dataPointExtensibleAttributeName
string
dataPointExtensibleAttributeType
string
dataPointExtensibleFilter
boolean
extensibleAttributeFQN
string
extensibleAttributeName
string
extensibleFilter
boolean
filterID
integer<int32>
filterLogicalGroupOrderIndex
integer<int32>
filterUnit
object
inventoryBasedFilter
boolean
itemBasedFilter
boolean
locationBasedFilter
boolean
orderIndex
integer<int32>
orderLocationFilterEqualToLocationOrInventoryFilter
boolean
pathString
string
persisted
boolean
suggestionEventListeners
object[]
updated
string<date-time>
updaterUsername
string
userContext
object