Cisco Cisco Process Orchestrator 3.1 User Guide
Copyright 2014 Cisco Systems
12
Cisco Highly Confidential – Controlled Access
A printed copy of this document is considered uncontrolled. Refer to the online version for the controlled revision.
Start[StartbyWebService]
Users can start any process that is defined in Cisco Process Orchestrator and contains a “Started by Web service”
trigger. These Web services, which display in the list as Start[Started by Web service], are based on the names of the
triggers in the process.
trigger. These Web services, which display in the list as Start[Started by Web service], are based on the names of the
triggers in the process.
The input variables for the process are the parameters of each process listed. You can also specify the
StartPointNameOrId parameter that sets a start point for the process.
StartPointNameOrId parameter that sets a start point for the process.
The Web service publishes these processes as dynamic methods that can change as processes are added, removed,
or the input variables are modified. The list of the processes changes each time the Web service is refreshed or
restarted. See
or the input variables are modified. The list of the processes changes each time the Web service is refreshed or
restarted. See
Chapter 0Refreshing the Cisco Process Orchestrator Web service
.
StartProcessByName
Starts a Cisco Process Orchestrator process using a single process name or process ID. This method can only
start processes that contain a "Start by Web service" trigger. To ensure the process can start on the trigger, be sure
to add the "Start by Web service" trigger to the process during the authoring phase.
start processes that contain a "Start by Web service" trigger. To ensure the process can start on the trigger, be sure
to add the "Start by Web service" trigger to the process during the authoring phase.
When starting a process, users have the option of overriding the target (or targets) that the job runs against. The
user can specify either a single target or a single target group. If a target group is selected, the server will
broadcast the job to all members of that target group.
user can specify either a single target or a single target group. If a target group is selected, the server will
broadcast the job to all members of that target group.
If no target is specified, then the process will execute against the default target selection of the process.
Parameters
processNameOrId (string)—display name or Id of the process
targetOverride (string)—display name or Id of a target to specify a non-default target for the run
startPointNameOrId(string) —point at which a process can be started
Return Type
Guid[]
Exceptions
DeserializationFailed if an improper type of variable parameter is provided to this call.
If no process is found whose Id or display name matches the given name. "The request to run a process with name
<name> could not be completed because no process with this name was found."
<name> could not be completed because no process with this name was found."