Skip to main content
Version: 2026.0

GetProcessHistoryRequest

Configurable request object to query entries of the process history.

Allows to specify various search parameters, supports paging and sorting settings.

Example:

Methods​

getExecutionUIDs​

getExecutionUIDs(): string[]

Returns​

string[]

List of execution UIDs for which history entries should be returned.

getFromStartTime​

getFromStartTime(): number

The start date of a process execution from which entries are included in the result.

Returns​

number

the specified start date in milliseconds.

getPagingLimit​

getPagingLimit(): number

The maximum number of elements that are included in the result starting from the specified initial index.

Default is -1, so that all results starting from the specified initial index are returned.

Returns​

number

the maximum number of elementes included in the result.

getPagingOffset​

getPagingOffset(): number

The specified initial index at which the page should start to include found elementes in the result.

Default is 0, for the first found element to be returned.

Returns​

number

the initial index of the returned page.

getProcessHistoryLimit​

getProcessHistoryLimit(): number

The current specified limit of history entries per process which are included in the result.

If null, then the internal system default is used.

Returns​

number

the specified limit or null.

getProcessNames​

getProcessNames(): string[]

Returns​

string[]

List of process names for which history entries should be returned.

getServerUIDs​

getServerUIDs(): string[]

Returns​

string[]

List of ADITO server UIDs for which history entries should be returned.

getSystemIDs​

getSystemIDs(): string[]

Returns​

string[]

List of ADITO system ids for which history entries should be returned.

getToStartTime​

getToStartTime(): number

The start date of a process execution up to which entries are included in the result.

Returns​

number

the specified start date in milliseconds.

setExecutionUIDs​

setExecutionUIDs(pExecutionUIDs): GetProcessHistoryRequest

Specifies the List of execution UIDs for which history entries should be returned.

Parameters​

pExecutionUIDs
string[]

List of execution UIDs for which history entries should be returned.

Returns​

GetProcessHistoryRequest

the reference of this request object.

setFromStartTime​

setFromStartTime(pFromStartTime): GetProcessHistoryRequest

Specifies the start date of a process execution from which entries are included in the result.

Parameters​

pFromStartTime
number

the specified start date in milliseconds.

Returns​

GetProcessHistoryRequest

the reference of this request object.

setPagingLimit​

setPagingLimit(pLimit): GetProcessHistoryRequest

The maximum number of elements that are included in the result starting from the specified initial index.

Default is -1, so that all results starting from the specified initial index are returned.

Parameters​

pLimit
number

the maximum number of elementes included in the result.

Returns​

GetProcessHistoryRequest

the reference of this request object.

setPagingOffset​

setPagingOffset(pOffset): GetProcessHistoryRequest

The specified initial index at which the page should start to include found elementes in the result.

Default is 0, for the first found element to be returned.

Parameters​

pOffset
number

The initial index at which the page should start

Returns​

GetProcessHistoryRequest

the reference of this request object.

setProcessHistoryLimit​

setProcessHistoryLimit(pProcessHistoryLimit): GetProcessHistoryRequest

Specifies the current limit of history entries per process which are included in the result.

If null (default), then the internal system default is used.

If set to -1, no limit will be used.

Parameters​

pProcessHistoryLimit
number

The limit of history entries per process.

Returns​

GetProcessHistoryRequest

the reference of this request object.

setProcessNames​

setProcessNames(pProcessNames): GetProcessHistoryRequest

Specifies the List of process names for which history entries should be returned.

Parameters​

pProcessNames
string[]

List of process names for which history entries should be returned.

Returns​

GetProcessHistoryRequest

the reference of this request object.

setServerUIDs​

setServerUIDs(pServerUIDs): GetProcessHistoryRequest

Specifies the List of ADITO server UIDs for which history entries should be returned.

Parameters​

pServerUIDs
string[]

List of ADITO server UIDs for which history entries should be returned.

Returns​

GetProcessHistoryRequest

the reference of this request object.

setSystemIDs​

setSystemIDs(pSystemIDs): GetProcessHistoryRequest

Specifies the List of ADITO system ids for which history entries should be returned.

Parameters​

pSystemIDs
string[]

List of ADITO system ids for which history entries should be returned.

Returns​

GetProcessHistoryRequest

the reference of this request object.

setToStartTime​

setToStartTime(pToStartTime): GetProcessHistoryRequest

Specifies the start date of a process execution up to which entries are included in the result.

Parameters​

pToStartTime
number

the specified start date in milliseconds.

Returns​

GetProcessHistoryRequest

the reference of this request object.

useAscendingOrder​

useAscendingOrder(): GetProcessHistoryRequest

All results are returned sorted by start date in ascending order.

Returns​

GetProcessHistoryRequest

the reference of this request object.

useDescendingOrder​

useDescendingOrder(): GetProcessHistoryRequest

All results are returned sorted by start date in descending order.

Returns​

GetProcessHistoryRequest

the reference of this request object.

useNoOrder​

useNoOrder(): GetProcessHistoryRequest

All results are returned unsorted in the order they were read from the system.

Returns​

GetProcessHistoryRequest

the reference of this request object.

Example​

<code>// Create a new empty process history request that returns all entries of the process history.
var request = process.createProcessHistoryRequest();

// Specify the attributes of searched entries
request.(["myProcess_1", "myProcess_2"]) // List of process names
   .setExecutionUIDs(["P-01", "P-02"])                  // List of executionUIDs
   .setSystemIDs(["default", "default-bg"])             // List of ADITO systems
   .setServerUIDs(["default-F0A2", "default-bg-DCA3"])  // List of unique server UIDs
   .setFromStartTime(Date.now());                       // Earliest start time of the process in ms

// Specify the parameters for paging
request.setPagingOffset(0) // Start index of the page
   .setPagingLimit(10);    // Element count of the page

// Additional parameters.
request.setProcessHistoryLimit(5) // Defines how many entries per process are returned
   .useAscendingOrder()  // Sorts all results in ascending order based on the start time
   .useDescendingOrder() // Sorts all results in descending order based on the start time (default)
   .useNoOrder();        // Results are returned in no specific order

var historyEntries = getProcessHistory(request);
</code>