User—Get List of Workflows

This API allows a user to get a list of workflows and workflow actions assigned to that user. Cisco Finesse Release 12.5(1) onward, this API is deprecated.

For more information about the Workflow object, see Workflow.

URI:

https://<FQDN>/finesse/api/User/<id>/Workflows

Example URI:

https://finesse1.xyz.com/finesse/api/User/1234/Workflows

Security Constraints:

Any user can get their own workflows if they are signed in or they provide valid authorization credentials when challenged.

HTTP Method:

GET

Content Type:

—

Input/Output Format:

XML

HTTP Request:

—

HTTP Response:

200: Success

400: Bad Request (the request body is invalid)

400: Finesse API Error (for example, the object is stale or there is a violation of database constraints)

401: Authorization Failure

404: Not Found (the resource is not found)

500: Internal Server Error

Example Response: 

<Workflows>
   <Workflow>
      <name>google ring pop</name>
      <description> Pops a Google web page when an agent phone rings</description>
      <TriggerSet>
         <type>SYSTEM</type>
         <name>CALL_ARRIVES</name>
         <triggers>
            <Trigger>
               <Variable>
                  <name>mediaType</name>
                  <node>//Dialog/mediaType</node>
                  <type>CUSTOM</type>
               </Variable>
               <comparator>IS_EQUAL</comparator>
               <value>Voice</value>
            </Trigger>
            <Trigger>
               <Variable>
                  <name>callType</name>
                  <node>//Dialog/mediaProperties/callType</node>
                  <type>CUSTOM</type>
               </Variable>
               <comparator>IS_IN_LIST</comparator>
               <value>ACT_IN,PREROUTE_ACD_IN,PREROUTE_DIRECT_AGENT,
                TRANSFER,OVERFLOW_IN,OTHER_IN,AGENT_OUT,AGENT_INSIDE,
                OFFERED,CONSULT,CONSULT_OFFERED,CONSULT_CONFERENCE,
                CONFERENCE,TASK_ROUTED_BY_ICM,TASK_ROUTED_BY_
                APPLICATION</value>
            </Trigger>
            <Trigger>
               <Variable>
                  <name>state</name>
                  <node>//Dialog/participants/Participant/mediaAddress[.=${userExtension}]/../state</node>
                  <type>CUSTOM</type>
               </Variable>
               <comparator>IS_IN_LIST</comparator>
               <value>ALERTING,ACTIVE,HELD</value>
            </Trigger>
            <Trigger>
               <Variable>
                  <name>fromAddress</name>
                  <node>//Dialog/fromAddress</node> 
                  <type>CUSTOM</type>
               </Variable>
               <comparator>IS_NOT_EQUAL</comparator>
               <Variable>
                  <name>userExtension</name>
                  <type>SYSTEM</type>
               </Variable>
            </Trigger>
         </triggers>
      </TriggerSet>
      <ConditionSet> 
         <applyMethod>ALL</applyMethod>
         <conditions>
            <Condition>
               <Variable>
                  <name>callVariable1</name>
                  <type>SYSTEM</type>
               </Variable>
               <comparator>CONTAINS</comparator>
               <value>1234</value>
            </Condition>
            <Condition>
               <Variable>
                  <name>user.foo.bar[1]</name>
                  <node>//Dialog/mediaProperties/callvariables/CallVariable/name[.="user.foo.bar[1]"]/../value</node>
                  <type>CUSTOM</type>
               </Variable>
               <comparator>IS_NOT_EMPTY</comparator>
            </Condition>
         </conditions>
      </ConditionSet>
      <workflowActions>
         <WorkflowAction>
            <name>Google ring pop</name>
            <type>BROWSER_POP</type>
            <params>
               <Param>
                  <name>windowName</name>
                  <value>google</value>
               </Param>
               <Param>
                  <name>path</name>
                  <value>http://www.google.com?a=${CallVariable1}&amp;c=cat&amp;${DNIS}&amp;d=${user.foo.bar[1]}</value>
               </Param>
            </params>
            <actionVariables>
               <ActionVariable>
                  <name>callVariable1</name>
                  <type>SYSTEM</type>
                  <testValue>apple</testValue>
               </ActionVariable>
               <ActionVariable>
                  <name>user.foo.bar[1]</name>
                  <node>//Dialog/mediaProperties/callvariables/CallVariable/name[.="user.foo.bar[1]"]/../value</node>
                  <type>CUSTOM</type>
                  <testValue>1234</testValue>
               </ActionVariable>
            </actionVariables>
         </WorkflowAction>
         <WorkflowAction>
            <name>My Delay</name>
            <type>DELAY</type>
            <params>
               <Param>
                  <name>time</name>
                  <value>10</value>
               </Param>
            </params>
         </WorkflowAction>
      </workflowActions>
   </Workflow>
</Workflows>

Example Failure Response: 

<ApiErrors>
  <ApiError>
    <ErrorType>Unauthorized</ErrorType>
    <ErrorMessage>The user is not authorized to perform
     this operation</ErrorMessage>
  </ApiError>
</ApiErrors>