Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/ExecuteStatisticsQuery

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/ExecuteStatisticsQuery

 

Executes a request for statistical data of the system

 

 

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/ExecuteStatisticsQuery

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–  QueryType

 

 

restriction enum (xs:string)

- Undefined (0)

- Workflow_InstancesByProcess (100)

- Workflow_InstancesByTask (101)

- Workflow_InstancesRunningByProcess (102)

- Workflow_InstancesRunningByTask (103)

- Workflow_InstancesFinishedByProcess (104)

- Workflow_InstancesFinishedByTask (105)

- Workflow_OverdueInstancesByProcess (106)

- Workflow_OverdueInstancesByTask (107)

- Workflow_ErrorInstancesByProcess (108)

- Workflow_ErrorInstancesByTask (109)

- Documents_CreatedByCategory (200)

- Documents_CheckedOutByCategory (201)

- Documents_CreatedTodayByCategory (202)

- Documents_CreatedThisWeekByCategory (203)

- Documents_CreatedThisMonthByCategory (204)

- Documents_CreatedThisYearByCategory (205)

- Documents_CreatedLastWeekByCategory (206)

- Documents_CreatedLastMonthByCategory (207)

- Documents_CreatedLastYearByCategory (208)

- Tasks_ToDo (400)

- Tasks_Started (401)

- Tasks_Done (402)

- Tasks_AllByState (403)

- Tasks_OverdueToDo (404)

- Tasks_OverdueStarted (405)

Sets the type of statistics query to execute

â–¡ RestrictToObjNo

xs:int

nillable

Restricts the query to one specific object of the object type

â–  RestrictToUser

xs:boolean

 

Restrict the results to actions done

 

 

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/ExecuteStatisticsQueryResponse

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ QueryResult

 

nillable

Gets the query result.

â–  QueryType

 

 

restriction enum (xs:string)

- Undefined (0)

- Workflow_InstancesByProcess (100)

- Workflow_InstancesByTask (101)

- Workflow_InstancesRunningByProcess (102)

- Workflow_InstancesRunningByTask (103)

- Workflow_InstancesFinishedByProcess (104)

- Workflow_InstancesFinishedByTask (105)

- Workflow_OverdueInstancesByProcess (106)

- Workflow_OverdueInstancesByTask (107)

- Workflow_ErrorInstancesByProcess (108)

- Workflow_ErrorInstancesByTask (109)

- Documents_CreatedByCategory (200)

- Documents_CheckedOutByCategory (201)

- Documents_CreatedTodayByCategory (202)

- Documents_CreatedThisWeekByCategory (203)

- Documents_CreatedThisMonthByCategory (204)

- Documents_CreatedThisYearByCategory (205)

- Documents_CreatedLastWeekByCategory (206)

- Documents_CreatedLastMonthByCategory (207)

- Documents_CreatedLastYearByCategory (208)

- Tasks_ToDo (400)

- Tasks_Started (401)

- Tasks_Done (402)

- Tasks_AllByState (403)

- Tasks_OverdueToDo (404)

- Tasks_OverdueStarted (405)

The type of statistics query results

â–¡ ResultRows

 

nillable

Gets the query result rows.

≡ WSExecStatsQueryResultRow

 

list nillable


â–  CountValue

xs:int

 

count value returned for group

â–¡ EntryName

xs:string

nillable

name of the group

â–  EntryNo

xs:int

 

count value returned for group

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2024 Therefore Corporation, all rights reserved.