Process and Process Instance Related REST APIs

Process Statistical Operations

/process/evaltime/average/
Method GET
Description Find processes having max average evaluation time.
Path Parameters None
Query Parameters
  • parameter: limit
  • Type: Integer [optional]
  • Description: Limits the number of records to be fetched
  • parameter: appname
  • Type: String [optional]
  • Description: Filters the output with Application Name
  • parameter: appversion
  • Type: String [optional]
  • Description: Filters the output with Application Version
  • parameter: processname
  • Type: String [optional]
  • Description: Filters the output with Process Name
Header Parameters None
Output
  • Code = 200

    Message = "Returns a list of processes sorted with average eval time."

  • Code = 503

    Message = "Internal Server Error"

/process/evaltime/average/
Method GET
Description Find processes having max average evaluation time.
Path Parameters None
Query Parameters
  • parameter: limit
  • Type: Integer [optional]
  • Description: Limits the number of records to be fetched
  • parameter: appname
  • Type: String [optional]
  • Description: Filters the output with Application Name
  • parameter: appversion
  • Type: String [optional]
  • Description: Filters the output with Application Version
  • parameter: processname
  • Type: String [optional]
  • Description: Filters the output with Process Name
Header Parameters None
Output
  • Code = 200

    Message = "Returns a list of processes sorted with average eval time."

  • Code = 503

    Message = "Internal Server Error"

/process/memory/average/
Method GET
Description Find processes having max average memory consumption.
Path Parameters None
Query Parameters
  • parameter: limit
  • Type: Integer [optional]
  • Description: Limits the number of records to be fetched
  • parameter: appname
  • Type: String [optional]
  • Description: Filters the output with Application Name
  • parameter: appversion
  • Type: String [optional]
  • Description: Filters the output with Application Version
  • parameter: processname
  • Type: String [optional]
  • Description: Filters the output with Process Name
Header Parameters None
Output
  • Code = 200

    Message = "Returns a list of processes sorted with average memory size."

  • Code = 503

    Message = "Internal Server Error"

Process instance Operations

/process/instance/evaltime/max/
Method GET
Description Find process instances, listed in decreasing order of time taken.
Path Parameters None
Query Parameters
  • parameter: limit
  • Type: Integer [optional]
  • Description: Limits the number of records to be fetched
  • parameter: appname
  • Type: String [optional]
  • Description: Filters the output with Application Name
  • parameter: appversion
  • Type: String [optional]
  • Description: Filters the output with Application Version
  • parameter: processname
  • Type: String [optional]
  • Description: Filters the output with Process Name
Header Parameters None
Output
  • Code = 200

    Message = "Returns a list of process instances sorted with eval time."

  • Code = 503

    Message = "Internal Server Error"

/process/instance/memory/max/
Method GET
Description Find process instances having maximum memory size.
Path Parameters None
Query Parameters
  • parameter: limit
  • Type: Integer [optional]
  • Description: Limits the number of records to be fetched
  • parameter: appname
  • Type: String [optional]
  • Description: Filters the output with Application Name
  • parameter: appversion
  • Type: String [optional]
  • Description: Filters the output with Application Version
  • parameter: processname
  • Type: String [optional]
  • Description: Filters the output with Process Name
Header Parameters None
Output
  • Code = 200

    Message = "Returns a list of process instances sorted with memory size."

  • Code = 503

    Message = "Internal Server Error"

/process/memory/average/
Method GET
Description Find processes having max average memory consumption.
Path Parameters None
Query Parameters
  • parameter: limit
  • Type: Integer [optional]
  • Description: Limits the number of records to be fetched
  • parameter: appname
  • Type: String [optional]
  • Description: Filters the output with Application Name
  • parameter: appversion
  • Type: String [optional]
  • Description: Filters the output with Application Version
  • parameter: processname
  • Type: String [optional]
  • Description: Filters the output with Process Name
Header Parameters None
Output
  • Code = 200

    Message = "Returns a list of processes sorted with average memory size."

  • Code = 503

    Message = "Internal Server Error"

/process/instance/details/{processid}
Method GET
Description Find process instances details with the specified process instance ID.
Path Parameters None
Query Parameters
  • parameter: processid
  • Type: String
  • Description: Process Instance ID to be searched for
Header Parameters None
Output
  • Code = 200

    Message = "Returns a process instances details."

  • Code = 503

    Message = "Internal Server Error"