Properties Service API Data Structures
facets
{
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"label": "string",
"version": "integer",
"lastUpdated": "string",
"createdDate": "string",
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"tenantId": "string",
"orderIndex": "integer",
"id": "string"
}
isMultiValued
description
label
version
facets
lastUpdated
createdDate
displayAdvice
tenantId
orderIndex
id
{
"lastUpdated": "string",
"createdDate": "string",
"tenantId": "string",
"description": "string",
"id": "string",
"label": "string",
"version": "integer"
}
lastUpdated
createdDate
tenantId
description
id
label
version
properties
{
"typeId": "string"
}
typeId
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"providerEntityId": "string"
}
providerEntityId
{
"dependencies": [
"string"
],
"facets": [
{}
]
}
dependencies
{
"offset": "integer",
"count": "integer"
}
offset
count
{
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"columns": [
"Field Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"orderIndex": "integer",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
displayAdvice
isMultiValued
description
orderIndex
id
label
{
"key": "string"
}
key
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"label": "string",
"version": "integer",
"lastUpdated": "string",
"createdDate": "string",
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"tenantId": "string",
"orderIndex": "integer",
"id": "string"
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"lastUpdated": "string",
"createdDate": "string",
"tenantId": "string",
"description": "string",
"id": "string",
"label": "string",
"version": "integer"
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"key": "string"
}
key
{
"params": [
{
"key": "string"
}
]
}
{
"customAllowed": "boolean"
}
customAllowed
{
"fields": [
{
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"columns": [
"Field Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"orderIndex": "integer",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
]
}
Wraps a boolean value.
{
"value": "boolean"
}
The boolean value.
{
"pagingInfo": {
"offset": "integer",
"count": "integer"
},
"headers": {
"entries": [
{
"key": "string"
}
]
},
"tenantId": "string",
"text": "string",
"userId": "string",
"dependencyValues": {
"entries": [
{
"key": "string"
}
]
}
}
tenantId
text
userId
Wraps a value such that values of different types can be treated generically.
Equivalent of java.util.Map
{
"entries": [
{
"key": "string"
}
]
}
A literal defining period of time. This period is represented some integral number of a specified timeUnit.e.g. 6 days.
{
"unit": "string",
"amount": "integer"
}
The unit of measure for the time span. e.g: days.
The amount for the time span.
{
"label": "string"
}
label