Jump to

• Request
• Response

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: string
  ootbquery name or businessquery id

Query Parameters

• action(optional): string
  Set action parameter to 'execute' for retrieving execution result
• applicationName(optional): string
  application name
• assigneeType(optional): string
  Assignee type
• processNames(optional): array
  Collection Format: multi

  Process name

  • [0]: string

  {
      "name":"processNames",
      "in":"query",
      "description":"Process name",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• since(optional): integer(int32)
  since
• topN(optional): integer(int32)
  topN

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : BusinessQuery

Type: object

Show Source

• activityName(optional): string
• aggregation(optional): string
• dimensions(optional): array dimensions
• doName(optional): string
• entityAttributes(optional): array entityAttributes
• filters(optional): array filters
• measureName(optional): string
• measureType(optional): string
  Allowed Values: [ "COUNTER", "MEASURE" ]
• queryType(optional): string
  Allowed Values: [ "TACTICAL", "REAL_TIME" ]
• transientAttributes(optional): object transientAttributes
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "measureName":{
            "type":"string"
        },
        "aggregation":{
            "type":"string"
        },
        "measureType":{
            "type":"string",
            "enum":[
                "COUNTER",
                "MEASURE"
            ]
        },
        "doName":{
            "type":"string"
        },
        "queryType":{
            "type":"string",
            "enum":[
                "TACTICAL",
                "REAL_TIME"
            ]
        },
        "filters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Filter"
            }
        },
        "dimensions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "activityName":{
            "type":"string"
        },
        "transientAttributes":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "entityAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AttrObject"
            }
        }
    }
}

Nested Schema : dimensions

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : entityAttributes

Type: array

Show Source

• Array of: object AttrObject

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/AttrObject"
    }
}

Nested Schema : filters

Type: array

Show Source

• Array of: object Filter

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Filter"
    }
}

Nested Schema : transientAttributes

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : AttrObject

Type: object

Show Source

• attrType(optional): string
  Allowed Values: [ "VALUE", "REF" ]
• contentType(optional): string
  Allowed Values: [ "OBJECT", "NATIVE_OBJECT", "LIST", "SORTED_LIST", "MAP" ]
• defaultValue(optional): object defaultValue
• id(optional): string
• msg(optional): object Msg

{
    "type":"object",
    "properties":{
        "msg":{
            "$ref":"#/definitions/Msg"
        },
        "attrType":{
            "type":"string",
            "enum":[
                "VALUE",
                "REF"
            ]
        },
        "contentType":{
            "type":"string",
            "enum":[
                "OBJECT",
                "NATIVE_OBJECT",
                "LIST",
                "SORTED_LIST",
                "MAP"
            ]
        },
        "id":{
            "type":"string"
        },
        "defaultValue":{
            "type":"object"
        }
    }
}

Nested Schema : defaultValue

Type: object

Nested Schema : Msg

Type: object

Show Source

• allAvailableTranslationsForProjectLanguages(optional): object allAvailableTranslationsForProjectLanguages
  Additional Properties Allowed: additionalProperties
• argCount(optional): integer(int32)
• bundleName(optional): string
• bundleShortName(optional): string
• code(optional): string
• detail(optional): string
• imageFile(optional): string
• imageResource(optional): string(url)
• localizedLogMessage(optional): string
• logComponent(optional): string
  Allowed Values: [ "DEFAULT" ]
• mnemonic(optional): string
• nonLocalizedString(optional): string
• string(optional): string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "logComponent":{
            "type":"string",
            "enum":[
                "DEFAULT"
            ]
        },
        "argCount":{
            "type":"integer",
            "format":"int32"
        },
        "string":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        },
        "allAvailableTranslationsForProjectLanguages":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "mnemonic":{
            "type":"string"
        },
        "localizedLogMessage":{
            "type":"string"
        },
        "imageFile":{
            "type":"string"
        },
        "imageResource":{
            "type":"string",
            "format":"url"
        },
        "nonLocalizedString":{
            "type":"string"
        },
        "bundleShortName":{
            "type":"string"
        },
        "bundleName":{
            "type":"string"
        }
    }
}

Nested Schema : allAvailableTranslationsForProjectLanguages

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : Filter

Type: object

Show Source

• conditionalType(optional): string
  Allowed Values: [ "GREATER_THAN", "GREATER_THAN_EQUALS_TO", "LESS_THAN_EQUALS_TO", "EQUALS_TO", "LESS_THAN", "NEVER", "ALWAYS" ]
• conditionalValue(optional): string
• entityAttributes(optional): array entityAttributes
• transientAttributes(optional): object transientAttributes
  Additional Properties Allowed: additionalProperties
• variable(optional): string

{
    "type":"object",
    "properties":{
        "conditionalType":{
            "type":"string",
            "enum":[
                "GREATER_THAN",
                "GREATER_THAN_EQUALS_TO",
                "LESS_THAN_EQUALS_TO",
                "EQUALS_TO",
                "LESS_THAN",
                "NEVER",
                "ALWAYS"
            ]
        },
        "conditionalValue":{
            "type":"string"
        },
        "variable":{
            "type":"string"
        },
        "transientAttributes":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "entityAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AttrObject"
            }
        }
    }
}

Nested Schema : entityAttributes

Type: array

Show Source

• Array of: object AttrObject

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/AttrObject"
    }
}

Nested Schema : transientAttributes

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

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

Back to Top