Operation
get /data/common/dataDictionary/documentation/businessObjects
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ModelAndView
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/common/dashboardFilters/dataDictionary/businessObjects/{businessObjectName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
businessObjectName | required | businessObjectType can be retrieved from the REST call '/data/otn/businessObjects' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DataDictionaryObject
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/dashboardFilters/dataDictionary/businessObjects/{businessObjectName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
businessObjectName | required | businessObjectType can be retrieved from the REST call '/data/otn/businessObjects' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DataDictionaryObject
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/common/dashboardFilters/dataDictionary/businessObjects
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[DataDictionaryObject]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/dashboardFilters/dataDictionary/businessObjects
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[DataDictionaryObject]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/common/businessObjects/filterNames
Query parameters
Name |
IsRequired |
Description |
---|---|---|
businessObjectType | optional | businessObjectType can be retrieved from the REST call '/data/otn/businessObjects' |
filterName | optional | filterNames can be retrieved from the REST call '/data/otn/namedFilters' |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[String]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/common/businessObjects/namedFilters
Query parameters
Name |
IsRequired |
Description |
---|---|---|
businessObjectType | optional | businessObjectType can be retrieved from the REST call '/data/otn/businessObjects' |
filterName | optional | filterNames can be retrieved from the REST call '/data/otn/namedFilters' |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[String]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/common/businessObjects/namedFilters/names
Query parameters
Name |
IsRequired |
Description |
---|---|---|
businessObjectType | optional | businessObjectType can be retrieved from the REST call '/data/otn/businessObjects' |
filterName | optional | filterNames can be retrieved from the REST call '/data/otn/namedFilters' |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[String]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/businessObjects/filterNames
Query parameters
Name |
IsRequired |
Description |
---|---|---|
businessObjectType | optional | businessObjectType can be retrieved from the REST call '/data/otn/businessObjects' |
filterName | optional | filterNames can be retrieved from the REST call '/data/otn/namedFilters' |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[String]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/businessObjects/namedFilters
Query parameters
Name |
IsRequired |
Description |
---|---|---|
businessObjectType | optional | businessObjectType can be retrieved from the REST call '/data/otn/businessObjects' |
filterName | optional | filterNames can be retrieved from the REST call '/data/otn/namedFilters' |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[String]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/businessObjects/namedFilters/names
Query parameters
Name |
IsRequired |
Description |
---|---|---|
businessObjectType | optional | businessObjectType can be retrieved from the REST call '/data/otn/businessObjects' |
filterName | optional | filterNames can be retrieved from the REST call '/data/otn/namedFilters' |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[String]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/common/dashboardFilters/dataDictionary/businessObjects/names
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[String]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/dashboardFilters/dataDictionary/businessObjects/names
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[String]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/common/businessObjects
Query parameters
Name |
IsRequired |
Description |
---|---|---|
businessObjectType | optional | businessObjectType can be retrieved from the REST call '/data/otn/businessObjects' |
filterName | required | filterNames can be retrieved from the REST call '/data/otn/namedFilters' |
additionalFilter | optional | ex: additionalFilter=(attrName1=value1&attrName2=value2 |
groupBy | optional | groupBy is a comma-separated list of attributes/properties of the businessObject |
sortBy | optional | sortBy is a comma-separated list of attributes/properties of the businessObject |
groupByDay | optional | groupByDay is similar to groupBy, but for a date field |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ConnectionStatsResponse
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/businessObjects
Query parameters
Name |
IsRequired |
Description |
---|---|---|
businessObjectType | optional | businessObjectType can be retrieved from the REST call '/data/otn/businessObjects' |
filterName | required | filterNames can be retrieved from the REST call '/data/otn/namedFilters' |
additionalFilter | optional | ex: additionalFilter=(attrName1=value1&attrName2=value2 |
groupBy | optional | groupBy is a comma-separated list of attributes/properties of the businessObject |
sortBy | optional | sortBy is a comma-separated list of attributes/properties of the businessObject |
groupByDay | optional | groupByDay is similar to groupBy, but for a date field |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ConnectionStatsResponse
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
BaseDataPointObject
Name |
Type |
Description |
Enum |
---|---|---|---|
label | String string |
--- | --- |
className | String string |
ClassName | --- |
id | String string |
id | --- |
key | String string |
Key | --- |
guiLabel | String string |
GuiLabel | --- |
parentId | String string |
ParentId | --- |
hasChildren | String string |
HasChildren | --- |
characteristic | Object object |
--- | --- |
group | Object object |
--- | --- |
datum | Object object |
--- | --- |
value | Object object |
--- | --- |
navigationData | Object object |
--- | --- |
nestedDataPoints | Object object |
--- | --- |
name | Object object |
--- | --- |
ConnectionStatsResponse
Name |
Type |
Description |
Enum |
---|---|---|---|
reqCompletionStatus | Integer integer |
A value which indicates completion status of the request | --- |
requestId | Long long |
Id generated for the Request passed | --- |
clientName | String string |
Indicates name of the client | --- |
clientLocation | String string |
Indicates location of the client | --- |
clientUser | String string |
Indicates the client User | --- |
sessionId | String string |
Session Id of the event | --- |
mdcId | String string |
MDC Id,if any | --- |
sequenceNum | Integer integer |
Indicates the sequence Number generated for the response | --- |
moreToCome | Boolean boolean |
Indicates with true/false if more responses are to come | --- |
messages | array[OtnI18nMessage] OtnI18nMessage |
Response Messages,if any from the response like an Info,Warning etc | --- |
errcde | String string |
Indicates error code,if any error generated | --- |
errorParams | array[Object] object |
Indicates different error parameters,if any error generated | --- |
dataPoints | array[DataPoint] DataPoint |
dataPoints | --- |
hierarchicalDataPoints | array[HierarchicalDataPoint] HierarchicalDataPoint |
hierarchicalDataPoints | --- |
dataPointsByObjectId | array[Entry«object,List«BaseDataPointObject»»] Entry«object,List«BaseDataPointObject»» |
dataPointsByObjectId | --- |
invalidInputIds | array[Object] object |
--- | --- |
items | array[Object] object |
items | --- |
objectDetails | array[Entry«string,BaseObject»] Entry«string,BaseObject» |
--- | --- |
failedCompletion | Boolean boolean |
Indicates response completion failed with true/false | --- |
successfulCompletion | Boolean boolean |
Indicates successful response completion with true/false | --- |
timeout | Long long |
--- | --- |
nadString | String string |
--- | --- |
DataDictionaryObject
Name |
Type |
Description |
Enum |
---|---|---|---|
businessObject | String string |
--- | --- |
tableView | String string |
--- | --- |
fields | array[Map«string,object»] Map«string,object» |
--- | --- |
Entry«object,List«BaseDataPointObject»»
Name |
Type |
Description |
Enum |
---|---|---|---|
key | array[BaseDataPointObject] BaseDataPointObject |
--- | --- |
Entry«string,BaseObject»
Name |
Type |
Description |
Enum |
---|---|---|---|
key | BaseObject BaseObject |
--- | --- |
ModelAndView
Name |
Type |
Description |
Enum |
---|---|---|---|
view | View View |
--- | --- |
model | Object object |
--- | --- |
status | String string |
--- | [100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED] |
viewName | String string |
--- | --- |
reference | Boolean boolean |
--- | --- |
modelMap | ModelMap ModelMap |
--- | --- |
empty | Boolean boolean |
--- | --- |
OtnI18nMessage
Name |
Type |
Description |
Enum |
---|---|---|---|
messageTime | Long long |
Message Time | --- |
messageType | String string |
Message Type | [Info, Warning, Error] |
messageUnformatted | String string |
Message Unformatted | --- |
validPropertyResourceMessage | Boolean boolean |
--- | --- |
messageId | String string |
Message Id | --- |
messageParams | array[String] string |
Message Params | --- |
message | String string |
Message | --- |