GET method for the create new activity resource

Draft comment:
This topic is shared by BAW, CP4BA. Last updated on 2025-03-13 12:15

The GET method returns the launch step information for the specified activity type that is required to add a user-created activity to the case. The launch step information is passed to the POST method to start the user-created activity.

Remember: You must call the GET method if the RequiresLaunchInfo property in payload returned by the GET method for the list of discretionary activity types resource is set to true.

URI

/CASEREST/v1/case/{case folder id}/tasktype/{symbolic task name}

The URI for the GET method includes the following path elements:

Table 1. Path elements for the GET method
Name	Type	Description
`{case folder id}`	String	The GUID that identifies the root folder of the case to which the activity is to be added.
`{symbolic task name}`	String	The symbolic name of the activity type to be used for the new activity.

The URI for the GET method includes the following parameter:

Table 2. Parameter for the GET method
Name	Type	Required?	Description
TargetObjectStore	String	Yes	The symbolic name of the object store that contains the case.

Request content

The request for this method contains no JSON content.

Response content

The GET method returns the following information that is required to add a user-created activity to the case:

Attachments
System properties
Workflow groups
Data fields
Step processor

The GET method also returns one of the following response codes:

Table 3. Response codes for the GET method
Code	Description
200 OK	The method completed successfully. The requested activity type information was returned.
400 Bad Request	The required TargetObjectStore parameter was not specified or a parameter value was invalid.
404 Not Found	The case folder ID or the symbolic activity name specified in the request URI was not found.
500 Internal Server Error	A server error occurred. For information about the error, see the userMessage element in the JSON response.

Example: GET method request

This sample code requests the launch step information for an AUTO_ContactCustomer activity:

GET http://example.com:9080/CaseManager/CASEREST/v1/case
/12345678-abcd-dcba-4321-12345678/tasktype/
AUTO_ContactCustomer?TargetObjectStore=MyTOS HTTP/1.1
Host: www.example.net

Example: GET method response

This sample code shows the launch step information for an AUTO_ContactCustomer activity:

HTTP/1.1 200 OK
Content-Type: application/json;charset-UTF-8
{
  "attachments": {},
  "systemProperties":
  {
    "responses": ["yes", "no"],
    "mapName": "Workflow",
    "stepId": 0,
    "stepName": "LaunchStep",
    "caseFolderId": "{8CA37883-9BA1-4513-AF94-120EA4255A2B}",
    "workflowName": "ETE_ETECase3_ETECase3Task1",
    "selectedResponse": "",
    "workObjectNumber": "D931E58C31E1DE44BDF519E88565614F",
    "subject": "ETE_ETECase3_ETECase3Task1",
    "authoredMapName": "Workflow",
    "instruction": ""
  },
  "workflowGroups":
  {
    "F_Trackers":
    {
      "value" : [],
      "desc": "",
      "mode": 3,
      "modified": false,
      "type": 64,
      "name": "F_Trackers",
      "isArray": true
    }
  },
  "dataFields":
  {
    "ETEProperty1":
    {
      "value": true,
      "desc": "",
      "mode": 3,
      "modified": false,
      "type": 4,
      "name": "ETEProperty1",
      "isArray": false
    },
    "ETEProperty2":
    {
      "value": 163,
      "desc": "",
      "mode": 3,
      "modified": false,
      "type": 1,
      "name": "ETEProperty2",
      "isArray":false
    },
    "ETEProperty3":
    {
      "value": "TestStringChoice1",
      "desc": "",
      "mode": 3,
      "modified": false,
      "type": 2,
      "name": "ETEProperty3",
      "isArray": false
    },
    "ETEProperty4":
    {
      "value": 3.1415926535,
      "desc": "",
      "mode": 3,
      "modified": false,
      "type": 8,
      "name": "ETEProperty4",
      "isArray": false
    },
    "ETEProperty5":
    {
      "value": "2010-07-05T19:21:24Z",
      "desc": "",
      "mode": 3,
      "modified": false,
      "type": 16,
      "name": "ETEProperty5",
      "isArray":false
    }
  },
  "stepProcessor":
  {
    "width":800,
    "height":600,
    "applicationName":"",
    "appType":32,
    "id":455,
    "name":"ETE_LaunchPage",
    "processorType":4,
    "locations":{"8":"123456"}
  }
}