pp108 : GetProcessActivities

GetProcessActivities


The GetProcessActivities SOAP method is used to retrieve the activity details of a business process instance. This method is a part of the Method Set Query Process Instance Data 4.2 interface with the namespace http://schemas.cordys.com/pim/queryinstancedata/1.0.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <GetProcessActivities xmlns="http://schemas.cordys.com/pim/queryinstancedata/1.0">
            <Query xmlns="http://schemas.cordys.com/cql/1.0">
                <Select>
                    <QueryableObject>PROCESS_ACTIVITY</QueryableObject>
                    <Field>ACTIVITY_ID</Field>
                    <Field>INSTANCE_ID</Field>
                    <Field>ITERATION_COUNT</Field>
                    <Field>ACTIVITY_NAME</Field>
                    <Field>ACTIVITY_TYPE</Field>
                    <Field>STATUS</Field>
                    <Field>START_TIME</Field>
                    <Field>END_TIME</Field>
                    <Field>MESSAGE_ID</Field>
                    <Field>EXECUTED_BY</Field>
                </Select>
                <Filters>
                    <And>
                        <Not>
                            <In field="ACTIVITY_TYPE">
                                <Value>SEQUENCE</Value>
                                <Value>ALL</Value>
                            </In>
                        </Not>
                        <EQ field="INSTANCE_ID">
                            <Value>0050568B-7618-71DE-BB34-92E1FE1C54E4</Value>
                        </EQ>
                    </And>
                </Filters>
                <OrderBy>
                    <Property direction="desc">START_TIME</Property>
                </OrderBy>
                <Cursor numRows="50"/>
            </Query>
        </GetProcessActivities>
    </SOAP:Body>
</SOAP:Envelope>
Request Parameters

Parameter

Description

Mandatory

Accepted Input Values

QueryableObject

Name of the database object that is to be queried

Yes

Fully qualified name of the data object

Field

Name of the data object field, whose details are to be queried.

No

Any field name of the data object

Filters

Fields on which the result data can be filtered

No

And, Or, EQ, NQ, LT, LE, GT, GE, In, Like, Between, IsNull, Not (may be nested and repeated)

GroupBy

Fields on which the results must be grouped

No

One or more of the Property elements

OrderBy

Fields by which the results must be ordered

No

One or more of the Property elements. The ordering sequence depends upon the sequence of the Property elements.

Cursor

Information on the set of results to be returned

No

Cursor/@numRows Number of rows to be fetched No

SOAP Response

<data>
    <GetProcessActivitiesResponse
        xmlns="http://schemas.cordys.com/pim/queryinstancedata/1.0" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
        <data>
            <constructor language="DBSQL">
                <cursor id="1.23" maxRows="99999949" numRows="50" position="50"/>
            </constructor>
            <tuple>
                <old>
                    <PROCESS_ACTIVITY>
                        <ACTIVITY_ID>o_20</ACTIVITY_ID>
                        <INSTANCE_ID>0050568B-7618-71DE-BB34-92E1FE1C54E4</INSTANCE_ID>
                        <ITERATION_COUNT>1</ITERATION_COUNT>
                        <ACTIVITY_NAME>CreateDelayedActivites</ACTIVITY_NAME>
                        <ACTIVITY_TYPE>PROCESS</ACTIVITY_TYPE>
                        <STATUS>COMPLETE</STATUS>
                        <START_TIME>1251361049598</START_TIME>
                        <END_TIME>1251362051955</END_TIME>
                        <MESSAGE_ID>0050568B-7618-71DE-BB34-92E20A0CE1B8</MESSAGE_ID>
                        <EXECUTED_BY null="true"
                            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
                    </PROCESS_ACTIVITY>
                </old>
            </tuple>
        </data>
    </GetProcessActivitiesResponse>
</data>
Response Parameters

Parameter

Description
ACTIVITY_ID ID of the process activity

INSTANCE_ID

ID of the process instance

ITERATION_COUNT

Number of times an activity is repeated in the process execution path
ACTIVITY_NAME Name of the activity
ACTIVITY_TYPE Type of the activity

STATUS

Indicates the activity status
START_TIME Start time of the process activity execution

END_TIME

End time of the process activity execution

MESSAGE_ID

ID of the the task related to the activity

EXECUTED_BY

DN of the process instance execution user