Class: StartProcessIncomingReceiveTaskRequest

tibco.objectapi.service.request.StartProcessIncomingReceiveTaskRequest

new StartProcessIncomingReceiveTaskRequest(payload, moduleName, processName, version)

Object StartProcessIncomingReceiveTaskRequest Usage: RestApiService.getProcessManagementService().startProcessIncomingReceiveTask(request, callback);
Parameters:
Name Type Description
payload tibco.objectapi.common.datafeed.DataPayload The page data for the formal parameters associated with the process. This is required if the process has formal parameters. Note - You cannot determine the names of these formal parameters programmatically. Instead, you must obtain them by examining the process in TIBCO Business Studio. Do not provide a payload if the process has no formal parameters.
moduleName string Name of the module to which the service belongs. This can be obtained from the REST Module Name field on the REST Service Details pane in TIBCO Business Studio when a process is published as a REST service.
processName string Name of the process for which an instance is being started. This can be obtained from the REST Service Name field on the REST Service Details pane in TIBCO Business Studio when a process is published as a REST service.
version string OSGi-style version number of the process template. (This version number is the same as that of the module.)

The parameters listed above can be obtained using the listServices function. They can also be obtained from the process/REST service definition in TIBCO Business Studio.

Since:
  • 4.0.0

Members

responseType :string

Query parameter: 'responsetype' (optional, default=JSON) Specifies the type of response data: XML or JSON.
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = JSON