pp108 : GetFollowupActivities

GetFollowupActivities

This Web service operation is used to obtain the follow-up activities for a particular activity. If the ID of the activity is not specified, the response will provide all the possible follow-up activities for all the states. The GetFollowupActivities is a part of the Method Set Case Instance Execution 4.2 Web service interface with the namespace 'http://schemas.cordys.com/casemanagement/execution/1.0'.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <GetFollowupActivities xmlns="http://schemas.cordys.com/casemanagement/execution/1.0">
            <caseinstanceid>2I0C054B-E0FB-4DB4-B031-601EA31853AF</caseinstanceid>
            <activityid>2A0C054B-E0FB-4DB4-B031-601EA31853AF</activityid>
            <detail>false</detail>
        </GetFollowupActivities>
    </SOAP:Body>
</SOAP:Envelope>
Request Parameters

Parameter

Description

Mandatory

Accepted Input Values

caseinstanceid

Refers to the instance ID of the Case model. The Case instance ID can be obtained from any of the following:

  • The response of the CreateCase API
  • The Workflow.getCaseInstanceId API that is invoked from a human task of the Case instance

Yes

activityid

Refers to the ID of the activity whose follow-up activities are to be retrieved. If the activity ID is not mentioned, the Web service returns all the free follow-up activities of the current active states of the Case instance.

The activity ID can be obtained from the Workflow.getCaseActivityId() Web API.

No

detail

Retrieves the details of the follow-up activity. The default state is false.

No
  • true
  • false

SOAP Response

<GetFollowupActivitiesResponse
    xmlns="http://schemas.cordys.com/casemanagement/execution/1.0" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <case:followups xmlns=""
        xmlns:case="http://schemas.cordys.com/casemanagement/1.0"
        xmlns:ns="http://orders.com/1.0"
        xmlns:ns1="http://orders.com/1.0"
        xmlns:ns2="http://schemas.cordys.com/default"
        xmlns:ns3="http://schemas.cordys.com/bpm/instance/1.0" xmlns:sm="http://www.w3.org/2005/07/scxml">
        <case:followup activityid="001A6BFA-F5BF-11E0-EE95-1F107EF45F96"
            activityname="F2" activitytype="HUMANTASK"
            stateId="001A6BFA-F5BF-11E0-EE94-EC915D957F96" stateName="A"/>
        <case:followup activityid="001A6BFA-F5BF-11E0-EEA9-FA28BB303F9A"
            activityname="DemoProcess" activitytype="BPMTASK"
            stateId="001A6BFA-F5BF-11E0-EE94-EC915D957F96" stateName="A"/>
        <case:followup activityid="001A6BFA-F5BF-11E0-EE95-1F107EF65F96"
            activityname="F1" activitytype="HUMANTASK"
            stateId="001A6BFA-F5BF-11E0-EE94-EC915D957F96" stateName="A"/>
    </case:followups>
</GetFollowupActivitiesResponse>
Response Parameters

Parameter

Description

followup

Contains the details of the follow-up activities. If the detail element value is set to true in the request, the follow-up element will contain the task related details.