Retrieve Analytics Query Definition or Execution Result
get
/ic/api/process/v1/analyticsqueries/{businessQueryId}
Retrieve query definition or execution result of a saved analytics query.
Request
Path Parameters
-
businessQueryId(required): string
ootbquery name or businessquery id
Query Parameters
-
action: string
Set action parameter to 'execute' for retrieving execution result
-
applicationName: string
application name
-
assigneeType: string
Assignee type
-
processNames: array[string]
Collection Format:
multi
Process name -
since: integer(int32)
since
-
topN: integer(int32)
topN
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : BusinessQuery
Type:
Show Source
object
-
activityName:
string
-
aggregation:
string
-
dimensions:
array dimensions
-
doName:
string
-
entityAttributes:
array entityAttributes
-
filters:
array filters
-
measureName:
string
-
measureType:
string
Allowed Values:
[ "COUNTER", "MEASURE" ]
-
queryType:
string
Allowed Values:
[ "TACTICAL", "REAL_TIME" ]
-
transientAttributes:
object transientAttributes
Additional Properties Allowed: additionalProperties
Nested Schema : AttrObject
Type:
Show Source
object
-
attrType:
string
Allowed Values:
[ "VALUE", "REF" ]
-
contentType:
string
Allowed Values:
[ "OBJECT", "NATIVE_OBJECT", "LIST", "SORTED_LIST", "MAP" ]
-
defaultValue:
object defaultValue
-
id:
string
-
msg:
object Msg
Nested Schema : defaultValue
Type:
object
Nested Schema : Msg
Type:
Show Source
object
-
allAvailableTranslationsForProjectLanguages:
object allAvailableTranslationsForProjectLanguages
Additional Properties Allowed: additionalProperties
-
argCount:
integer(int32)
-
bundleName:
string
-
bundleShortName:
string
-
code:
string
-
detail:
string
-
imageFile:
string
-
imageResource:
string(url)
-
localizedLogMessage:
string
-
logComponent:
string
Allowed Values:
[ "DEFAULT" ]
-
mnemonic:
string
-
nonLocalizedString:
string
-
string:
string
Nested Schema : allAvailableTranslationsForProjectLanguages
Type:
object
Additional Properties Allowed
Show Source
Nested Schema : Filter
Type:
Show Source
object
-
conditionalType:
string
Allowed Values:
[ "GREATER_THAN", "GREATER_THAN_EQUALS_TO", "LESS_THAN_EQUALS_TO", "EQUALS_TO", "LESS_THAN", "NEVER", "ALWAYS" ]
-
conditionalValue:
string
-
entityAttributes:
array entityAttributes
-
transientAttributes:
object transientAttributes
Additional Properties Allowed: additionalProperties
-
variable:
string
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
400 Response
Bad Request
401 Response
Unauthorized
404 Response
No result found for query
500 Response
Internal Server Error