Loading...

REST API - GET Workflow

Description

This operation returns a list of workflows.

Request

Syntax

GET <webservice>/Workflow HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Headers

Name Description
Host The host name of the Web Server or Web Console used in the API request.
Accept The format of the response. Valid values are: application/xml or application/json.
Authtoken The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

XML

An .xml file is not needed.

Response

Response Parameters

Parameter Description Element Parent Element
version The version number of the workflow. container Workflow_GetWorkflowsResponse
flags   container Workflow_GetWorkflowsResponse
description The description of the workflow. container Workflow_GetWorkflowsResponse
uniqueGuid The globally unique identifier for the workflow. container Workflow_GetWorkflowsResponse
revision   container Workflow_GetWorkflowsResponse
capabilities   container Workflow_GetWorkflowsResponse
workflowId The system-generated ID assigned to the workflow. entity container
workflowName The name of the workflow. entity container
userId The system-generated ID assigned to the user who created the workflow. creator container
userGUID The globally unique identifier for the user who created the workflow. creator container
userName The name of the user who created the workflow. creator container
deployId The system-generated ID assigned to the workflow deployment. deployments container
deployed The deployment date of the workflow.

Valid values are UNIX-style timestamps (seconds since January 1, 1970).

deployments container
inputSchema   deployments container
inputsXml   deployments container
version The version number of the workflow that is deployed. deployments container
flags   deployments container
description The description of the workflow. deployments container
destPath   inputForm deployments
inputName The variable name of the workflow input, for example, clientGroupName. entries inputForm
displayName The display name of the workflow input, for example, Client Group. entries inputForm
defaultValue The default value for the input. Not all inputs have default values. entries inputForm
typeOptions   entries inputForm
documentation The tooltip for the input. Not all inputs have tooltips. entries inputForm
readOnly The option to mark the input as read-only.

Valid values are 0 or 1.

entries inputForm
listType The option to store multiple variable values in the input.

Valid values are 0 or 1.

entries inputForm
required The option to mark the input as required.

Valid values are 0 or 1.

entries inputForm
inputType The variable type for the input, for example, java.lang.String, workflow.types.EncryptedString, or commvault.msgs.CvEntities.MediaAgentEntity. entries inputForm
type Additional information about the inputType parameter, for example, {http://www.w3.org/2001/XMLSchema}string, {workflow.types}EncryptedString, or {commvault.msgs.CvEntities}MediaAgentEntity. entries inputForm
controlType The control type for the input. For example, the input appears as a check box.

Valid values are:

  • 0, text box
  • 1, multiple line
  • 2, drop-down
  • 4, radio button
  • 5, check box
entries inputForm
searchable   entries inputForm
val The default value for the input. If possible values are defined in the val parameter in the <options> element, one of the values can be the default value. defaultValues entries
val The possible values for some control types. For example, for drop-down control types, the val parameter holds the values that appear in the drop-down box. options entries
clientId The system-generated ID assigned to the client. client deployments
clientName The name of the client. client deployments

Examples

Sample Request

GET <webservice>/Workflow HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<Workflow_GetWorkflowsResponse><container version="3" flags="6" description="Perform analytics on files and e-mail data" uniqueGuid="3ec7d558-48e6-49cd-bd93-184ff6c7e110" revision="$Revision: 1.4.4.6 $" capabilities="4328650375167"><entity workflowId="18" workflowName="Analytics"/><creator userId="1" userGUID="6CBA35F0-56C2-4089-BDA8-9B3B6A21044A" userName="admin"/><deployments deployId="18" deployed="1408574016" inputSchema="&lt;xs:schema xmlns:xs=&quot;http://www.w3.org/2001/XMLSchema&quot; xmlns:tns=&quot;commvault.workflow.inputs&quot; xmlns:commvault.msgs.CvEntities=&quot;commvault.msgs.CvEntities&quot; xmlns:workflow.types=&quot;workflow.types&quot; targetNamespace=&quot;commvault.workflow.inputs&quot;&gt;&lt;xs:import namespace=&quot;workflow.types&quot; schemaLocation=&quot;workflow.types&quot; /&gt;&lt;xs:import namespace=&quot;commvault.msgs.CvEntities&quot; schemaLocation=&quot;commvault.msgs.CvEntities&quot; /&gt;&lt;xs:element name=&quot;inputs&quot;&gt;&lt;xs:complexType&gt;&lt;xs:sequence&gt;&lt;xs:element name=&quot;clientGroupName&quot; type=&quot;commvault.msgs.CvEntities:ClientGroupEntity&quot;&gt;&lt;xs:annotation&gt;&lt;xs:appinfo&gt;&lt;readOnly&gt;false&lt;/readOnly&gt;&lt;displayName&gt;Client Group&lt;/displayName&gt;&lt;controlType&gt;DROPDOWN&lt;/controlType&gt;&lt;searchable&gt;false&lt;/searchable&gt;&lt;/xs:appinfo&gt;&lt;xs:documentation&gt;Select Client Group.&lt;/xs:documentation&gt;&lt;/xs:annotation&gt;&lt;/xs:element&gt;&lt;xs:element name=&quot;appType&quot; type=&quot;xs:string&quot; default=&quot;FileSystem&quot;&gt;&lt;xs:annotation&gt;&lt;xs:appinfo&gt;&lt;readOnly&gt;false&lt;/readOnly&gt;&lt;displayName&gt;Application Type&lt;/displayName&gt;&lt;controlType&gt;DROPDOWN&lt;/controlType&gt;&lt;searchable&gt;false&lt;/searchable&gt;&lt;userOptions&gt;FileSystem&lt;/userOptions&gt;&lt;userOptions&gt;VirtualServer&lt;/userOptions&gt;&lt;userOptions&gt;ExchangeMailbox&lt;/userOptions&gt;&lt;userOptions&gt;Sharepoint&lt;/userOptions&gt;&lt;userOptions&gt;NAS&lt;/userOptions&gt;&lt;userOptions&gt;SystemDiscovery&lt;/userOptions&gt;&lt;userOptions&gt;All Apptypes&lt;/userOptions&gt;&lt;/xs:appinfo&gt;&lt;xs:documentation&gt;Please select the operation type.&lt;/xs:documentation&gt;&lt;/xs:annotation&gt;&lt;/xs:element&gt;&lt;xs:element name=&quot;analyticsEngine&quot; type=&quot;commvault.msgs.CvEntities:MediaAgentEntity&quot;&gt;&lt;xs:annotation&gt;&lt;xs:appinfo&gt;&lt;readOnly&gt;false&lt;/readOnly&gt;&lt;displayName&gt;Analytics Engine MA&lt;/displayName&gt;&lt;controlType&gt;DROPDOWN&lt;/controlType&gt;&lt;searchable&gt;false&lt;/searchable&gt;&lt;/xs:appinfo&gt;&lt;xs:documentation&gt;Select MA which has analytics engine running.&lt;/xs:documentation&gt;&lt;/xs:annotation&gt;&lt;/xs:element&gt;&lt;xs:element name=&quot;WindowsUserName&quot; type=&quot;xs:string&quot; minOccurs=&quot;0&quot;&gt;&lt;xs:annotation&gt;&lt;xs:appinfo&gt;&lt;readOnly&gt;false&lt;/readOnly&gt;&lt;displayName&gt;System Discovery Username&lt;/displayName&gt;&lt;controlType&gt;TEXTBOX&lt;/controlType&gt;&lt;searchable&gt;false&lt;/searchable&gt;&lt;/xs:appinfo&gt;&lt;xs:documentation&gt;&lt;/xs:documentation&gt;&lt;/xs:annotation&gt;&lt;/xs:element&gt;&lt;xs:element name=&quot;WindowsUserPassword&quot; type=&quot;workflow.types:EncryptedString&quot; minOccurs=&quot;0&quot;&gt;&lt;xs:annotation&gt;&lt;xs:appinfo&gt;&lt;readOnly&gt;false&lt;/readOnly&gt;&lt;displayName&gt;System Discovery Password&lt;/displayName&gt;&lt;controlType&gt;TEXTBOX&lt;/controlType&gt;&lt;searchable&gt;false&lt;/searchable&gt;&lt;/xs:appinfo&gt;&lt;xs:documentation&gt;&lt;/xs:documentation&gt;&lt;/xs:annotation&gt;&lt;/xs:element&gt;&lt;xs:element name=&quot;clientType&quot; type=&quot;xs:string&quot; minOccurs=&quot;0&quot; default=&quot;WINDOWS&quot;&gt;&lt;xs:annotation&gt;&lt;xs:appinfo&gt;&lt;readOnly&gt;false&lt;/readOnly&gt;&lt;displayName&gt;System Discovery Client Type&lt;/displayName&gt;&lt;controlType&gt;DROPDOWN&lt;/controlType&gt;&lt;searchable&gt;false&lt;/searchable&gt;&lt;userOptions&gt;WINDOWS&lt;/userOptions&gt;&lt;userOptions&gt;UNIX&lt;/userOptions&gt;&lt;userOptions&gt;EXCHANGE&lt;/userOptions&gt;&lt;/xs:appinfo&gt;&lt;xs:documentation&gt;&lt;/xs:documentation&gt;&lt;/xs:annotation&gt;&lt;/xs:element&gt;&lt;xs:element name=&quot;clientsNameFile&quot; type=&quot;xs:string&quot; minOccurs=&quot;0&quot;&gt;&lt;xs:annotation&gt;&lt;xs:appinfo&gt;&lt;readOnly&gt;false&lt;/readOnly&gt;&lt;displayName&gt;Input File Path on Analytics MA&lt;/displayName&gt;&lt;controlType&gt;TEXTBOX&lt;/controlType&gt;&lt;searchable&gt;false&lt;/searchable&gt;&lt;/xs:appinfo&gt;&lt;xs:documentation&gt;File containing System Discovery Inputs.&lt;/xs:documentation&gt;&lt;/xs:annotation&gt;&lt;/xs:element&gt;&lt;xs:element name=&quot;PerformCCM&quot; type=&quot;xs:boolean&quot; minOccurs=&quot;0&quot; default=&quot;false&quot;&gt;&lt;xs:annotation&gt;&lt;xs:appinfo&gt;&lt;readOnly&gt;false&lt;/readOnly&gt;&lt;displayName&gt;Perform Commcell Migration&lt;/displayName&gt;&lt;controlType&gt;CHECKBOX&lt;/controlType&gt;&lt;searchable&gt;false&lt;/searchable&gt;&lt;/xs:appinfo&gt;&lt;xs:documentation&gt;&lt;/xs:documentation&gt;&lt;/xs:annotation&gt;&lt;/xs:element&gt;&lt;xs:element name=&quot;v9_appType&quot; type=&quot;xs:string&quot; minOccurs=&quot;0&quot; default=&quot;File System&quot;&gt;&lt;xs:annotation&gt;&lt;xs:appinfo&gt;&lt;readOnly&gt;false&lt;/readOnly&gt;&lt;displayName&gt;Cross Commcell AppTypeName&lt;/displayName&gt;&lt;controlType&gt;DROPDOWN&lt;/controlType&gt;&lt;searchable&gt;false&lt;/searchable&gt;&lt;userOptions&gt;File System&lt;/userOptions&gt;&lt;userOptions&gt;NetApp NAS NDMP&lt;/userOptions&gt;&lt;userOptions&gt;NAS&lt;/userOptions&gt;&lt;/xs:appinfo&gt;&lt;xs:documentation&gt;&lt;/xs:documentation&gt;&lt;/xs:annotation&gt;&lt;/xs:element&gt;&lt;xs:element name=&quot;CommCellType&quot; type=&quot;xs:string&quot; default=&quot;Local&quot;&gt;&lt;xs:annotation&gt;&lt;xs:appinfo&gt;&lt;readOnly&gt;false&lt;/readOnly&gt;&lt;displayName&gt;CommCell Type&lt;/displayName&gt;&lt;controlType&gt;DROPDOWN&lt;/controlType&gt;&lt;searchable&gt;false&lt;/searchable&gt;&lt;userOptions&gt;Local&lt;/userOptions&gt;&lt;userOptions&gt;Remote&lt;/userOptions&gt;&lt;/xs:appinfo&gt;&lt;xs:documentation&gt;&lt;/xs:documentation&gt;&lt;/xs:annotation&gt;&lt;/xs:element&gt;&lt;xs:element name=&quot;remotecommcell&quot; type=&quot;xs:string&quot; minOccurs=&quot;0&quot;&gt;&lt;xs:annotation&gt;&lt;xs:appinfo&gt;&lt;readOnly&gt;false&lt;/readOnly&gt;&lt;displayName&gt;Remote Commcell AliasName&lt;/displayName&gt;&lt;controlType&gt;TEXTBOX&lt;/controlType&gt;&lt;searchable&gt;false&lt;/searchable&gt;&lt;/xs:appinfo&gt;&lt;xs:documentation&gt;&lt;/xs:documentation&gt;&lt;/xs:annotation&gt;&lt;/xs:element&gt;&lt;/xs:sequence&gt;&lt;/xs:complexType&gt;&lt;/xs:element&gt;&lt;/xs:schema&gt;" inputsXml="&lt;inputs&gt;&lt;appType class=&quot;java.lang.String&quot;&gt;FileSystem&lt;/appType&gt;&lt;clientsNameFile class=&quot;java.lang.String&quot; /&gt;&lt;clientGroupName class=&quot;commvault.msgs.CvEntities.ClientGroupEntity&quot;&gt;&lt;clientGroupName /&gt;&lt;clientGroupId /&gt;&lt;/clientGroupName&gt;&lt;clientType class=&quot;java.lang.String&quot;&gt;WINDOWS&lt;/clientType&gt;&lt;analyticsEngine class=&quot;commvault.msgs.CvEntities.MediaAgentEntity&quot;&gt;&lt;mediaAgentName /&gt;&lt;mediaAgentId /&gt;&lt;/analyticsEngine&gt;&lt;v9_appType class=&quot;java.lang.String&quot;&gt;File System&lt;/v9_appType&gt;&lt;PerformCCM class=&quot;java.lang.Boolean&quot;&gt;false&lt;/PerformCCM&gt;&lt;CommCellType class=&quot;java.lang.String&quot;&gt;Local&lt;/CommCellType&gt;&lt;remotecommcell class=&quot;java.lang.String&quot; /&gt;&lt;WindowsUserName class=&quot;java.lang.String&quot; /&gt;&lt;WindowsUserPassword class=&quot;workflow.types.EncryptedString&quot; /&gt;&lt;/inputs&gt;" version="3" flags="0" description="Perform analytics on files and e-mail data"><inputForm destPath="C:\Program Files\##_DOC_OEM_INSTALL_DESTINATION_COMPANY_FOLDER_##\SnapProtect\iDataAgent\JobResults"><entries inputName="clientGroupName" displayName="Client Group" defaultValue="" typeOptions="0" documentation="Select Client Group." readOnly="0" listType="0" required="1" inputType="commvault.msgs.CvEntities.ClientGroupEntity" type="{commvault.msgs.CvEntities}ClientGroupEntity" controlType="2" searchable="0"><defaultValues val=""/></entries><entries inputName="appType" displayName="Application Type" defaultValue="FileSystem" typeOptions="0" documentation="Please select the operation type." readOnly="0" listType="0" required="1" inputType="java.lang.String" type="{http://www.w3.org/2001/XMLSchema}string" controlType="2" searchable="0"><defaultValues val="FileSystem"/><options val="FileSystem"/><options val="VirtualServer"/><options val="ExchangeMailbox"/><options val="Sharepoint"/><options val="NAS"/><options val="SystemDiscovery"/><options val="All Apptypes"/></entries><entries inputName="analyticsEngine" displayName="Analytics Engine MA" defaultValue="" typeOptions="0" documentation="Select MA which has analytics engine running." readOnly="0" listType="0" required="1" inputType="commvault.msgs.CvEntities.MediaAgentEntity" type="{commvault.msgs.CvEntities}MediaAgentEntity" controlType="2" searchable="0"><defaultValues val=""/></entries><entries inputName="WindowsUserName" displayName="System Discovery Username" defaultValue="" typeOptions="0" documentation="" readOnly="0" listType="0" required="0" inputType="java.lang.String" type="{http://www.w3.org/2001/XMLSchema}string" controlType="0" searchable="0"><defaultValues val=""/></entries><entries inputName="WindowsUserPassword" displayName="System Discovery Password" defaultValue="" typeOptions="0" documentation="" readOnly="0" listType="0" required="0" inputType="workflow.types.EncryptedString" type="{workflow.types}EncryptedString" controlType="0" searchable="0"><defaultValues val=""/></entries><entries inputName="clientType" displayName="System Discovery Client Type" defaultValue="WINDOWS" typeOptions="0" documentation="" readOnly="0" listType="0" required="0" inputType="java.lang.String" type="{http://www.w3.org/2001/XMLSchema}string" controlType="2" searchable="0"><defaultValues val="WINDOWS"/><options val="WINDOWS"/><options val="UNIX"/><options val="EXCHANGE"/></entries><entries inputName="clientsNameFile" displayName="Input File Path on Analytics MA" defaultValue="" typeOptions="0" documentation="File containing System Discovery Inputs." readOnly="0" listType="0" required="0" inputType="java.lang.String" type="{http://www.w3.org/2001/XMLSchema}string" controlType="0" searchable="0"><defaultValues val=""/></entries><entries inputName="PerformCCM" displayName="Perform Commcell Migration" defaultValue="false" typeOptions="0" documentation="" readOnly="0" listType="0" required="0" inputType="java.lang.Boolean" type="{http://www.w3.org/2001/XMLSchema}boolean" controlType="5" searchable="0"><defaultValues val="false"/></entries><entries inputName="v9_appType" displayName="Cross Commcell AppTypeName" defaultValue="File System" typeOptions="0" documentation="" readOnly="0" listType="0" required="0" inputType="java.lang.String" type="{http://www.w3.org/2001/XMLSchema}string" controlType="2" searchable="0"><defaultValues val="File System"/><options val="File System"/><options val="NetApp NAS NDMP"/><options val="NAS"/></entries><entries inputName="CommCellType" displayName="CommCell Type" defaultValue="Local" typeOptions="0" documentation="" readOnly="0" listType="0" required="1" inputType="java.lang.String" type="{http://www.w3.org/2001/XMLSchema}string" controlType="2" searchable="0"><defaultValues val="Local"/><options val="Local"/><options val="Remote"/></entries><entries inputName="remotecommcell" displayName="Remote Commcell AliasName" defaultValue="" typeOptions="0" documentation="" readOnly="0" listType="0" required="0" inputType="java.lang.String" type="{http://www.w3.org/2001/XMLSchema}string" controlType="0" searchable="0"><defaultValues val=""/></entries></inputForm><client clientId="2" clientName="fall"/></deployments></container></Workflow_GetWorkflowsResponse>