Getworkflows

This method is used to return the list of Getworkflows of Cisco Intersight created in HCL BigFix CLM.

Method Signature:

Getworkflows (organizationMoid, controlId, async, callback, addlparam)

Sample Response:

{ "totalRecords": 1, "records": [ { "moid": "xxxxx", "name": "ACIBasicTenantConfig", 
"entityId": "CICOWF-76721C4C-A503-4471-B326-A2EEE17CBB71", 
"objectType": "workflow.WorkflowDefinition", 
"classId": "workflow.WorkflowDefinition", "description": "Creates a Tenant, VRF, BD, AP, 2 EPGs, Contract, Filters", 
"catalogDetail": { "ClassId": "mo.MoRef", "Moid": "xxxxx", "ObjectType": "workflow.Catalog", "link": "https://<enter URL>" }, "clonedFrom": "", "defaultVersion": "true", "inputDefinition": [ { "ClassId": "workflow.PrimitiveDataType", 
"Default": { "ClassId": "workflow.DefaultValue", "IsValueSet": false, "ObjectType": "workflow.DefaultValue", "Override": false, "Value": null }, "Description": "Name of the Tenant", "DisplayMeta": { "ClassId": "workflow.DisplayMeta",
 "InventorySelector": true, "ObjectType": "workflow.DisplayMeta", "WidgetType": "None" }, "InputParameters": null, "Label": "Name", "Name": "NAME", 
"ObjectType": "workflow.PrimitiveDataType", "Properties": { "ClassId": "workflow.PrimitiveDataProperty", 
"Constraints": { "ClassId": "workflow.Constraints", "EnumList": [], "Max": 0, "Min": 0, 
"ObjectType": "workflow.Constraints", "Regex": "^([A-Za-z0-9_-])+$" }, "InventorySelector": [], "ObjectType": "workflow.PrimitiveDataProperty", "Secure": false, "Type": "string" }, "Required": true }, { "ArrayItemType": { "ClassId": "workflow.PrimitiveArrayItem", "ObjectType": "workflow.PrimitiveArrayItem", 
"Properties": { "ClassId": "workflow.PrimitiveDataProperty", "Constraints": { "ClassId": "workflow.Constraints", "EnumList": [], "Max": 0, "Min": 0, "ObjectType": "workflow.Constraints", "Regex": "" }, "InventorySelector": [], "ObjectType": "workflow.PrimitiveDataProperty", "Secure": false, "Type": "string" } }, "ClassId": "workflow.ArrayDataType", "Default": { "ClassId": "workflow.DefaultValue", "IsValueSet": false, "ObjectType": "workflow.DefaultValue", "Override": false, "Value": null }, "Description": "Specify a port for the filter (Example: 443)", "DisplayMeta": { "ClassId": "workflow.DisplayMeta", "InventorySelector": true, "ObjectType": "workflow.DisplayMeta", "WidgetType": "None" }, "InputParameters": null, "Label": "Port", "Max": 99, "Min": 1, "Name": "PORT", "ObjectType": "workflow.ArrayDataType", "Required": true }, { "ClassId": "workflow.PrimitiveDataType", 
"Default": { "ClassId": "workflow.DefaultValue", "IsValueSet": false, 
"ObjectType": "workflow.DefaultValue", "Override": false, "Value": null }, 
"Description": "adress/mask (Example: xxx.xx.x.xx)", "DisplayMeta": 
{ "ClassId": "workflow.DisplayMeta", "InventorySelector": true, "ObjectType": "workflow.DisplayMeta", 
"WidgetType": "None" }, "InputParameters": null, "Label": "Gateway IP", "Name": "SUBNET", "ObjectType": "workflow.PrimitiveDataType", 
"Properties": { "ClassId": "workflow.PrimitiveDataProperty", "Constraints": { "ClassId": "workflow.Constraints", "EnumList": [], "Max": 0, "Min": 0, "ObjectType": "workflow.Constraints",
 "Regex": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/\\\\d+$" }, "InventorySelector": [], "ObjectType": "workflow.PrimitiveDataProperty", "Secure": false, 
"Type": "string" }, "Required": true }, { "ClassId": "workflow.TargetDataType", "CustomDataTypeProperties": { "CatalogMoid": "xxxxx", "ClassId": "workflow.CustomDataProperty", 
"CustomDataTypeId": "", "CustomDataTypeName": "", "ObjectType": "workflow.CustomDataProperty" }, "Default": { "ClassId": "workflow.DefaultValue", "IsValueSet": false, 
"ObjectType": "workflow.DefaultValue", "Override": true, "Value": null }, "Description": "The API call can be made to Intersight or an external Cloud Account added as Target. Target should be in claimed or connected state. 
Please refer Supported Cloud Accounts section in the Web API request end user documentation for the list of Intersight Targets on which Web API task can be invoked. An empty value for this input indicates that the API call is made to Intersight.", "DisplayMeta": { "ClassId": "workflow.DisplayMeta", "InventorySelector": true, "ObjectType": "workflow.DisplayMeta", "WidgetType": "None" }, "InputParameters": null, "IsArray": false, "Label": "External Target", "Max": 0, "Min": 0, "Name": "Target", "ObjectType": "workflow.TargetDataType", "Properties": [ { "ClassId": "workflow.TargetProperty", "ConnectorAttribute": "", "ConstraintAttributes": [], "DisplayAttributes": [ "Name", "TargetType" ], "ObjectType": "workflow.TargetProperty", "Selector": "/api/v1/asset/Targets?$filter=((TargetType eq HTTPEndpoint and Status eq Claimed) or ((TargetType eq PureStorageFlashArray or TargetType eq HitachiVirtualStoragePlatform or TargetType eq NetAppActiveIqUnifiedManager or TargetType eq TerraformCloud or TargetType eq VmwareVcenter or TargetType eq APIC or TargetType eq MDSDevice or TargetType eq NexusDevice) and Status eq Connected))", "SelectorProperty": { "Body": null, "ClassId": "workflow.SelectorProperty", "Method": "GET", "ObjectType": "workflow.SelectorProperty" }, "SupportedObjects": [ "asset.Target" ] } ], "Required": true } ], "inputParameterSet": "", "label": "_ACI_TanentConfiguration", "licenseEntitlement": "Premier", "maxTaskCount": 12, "maxWorkerTaskCount": 11, "outputDefinition": "", "outputParameters": "", "properties": { "ClassId": "workflow.WorkflowProperties", "Cloneable": true, "EnableDebug": true, "ExternalMeta": true, "ObjectType": "workflow.WorkflowProperties", "Retryable": false, "RollbackOnCancel": false, "RollbackOnFailure": false, "SupportStatus": "Supported" }, "cloneable": 1, "enableDebug": 1, "externalMeta": 1, "retryable": 0, "rollbackOnCancel": 0, "rollbackOnFailure": 0, "supportStatus": "Supported", "ssharedScope": "", "tasks": [ { "ClassId": "workflow.StartTask", "Description": "", "Label": "", "Name": "StartTask", "NextTask": "CreateTenant1", "ObjectType": "workflow.StartTask" }, { "CatalogMoid": "xxxxxx", "ClassId": "workflow.WorkerTask", "Description": "Creates a tenant in ACI", "InputParameters": { "NAME": "${workflow.input.NAME}", "Target": "${workflow.input.Target}" }, "Label": "Create Tenant", "Name": "CreateTenant1", "ObjectType": "workflow.WorkerTask", "OnFailure": "", "OnSuccess": "CreateVRF1", "RollbackDisabled": false, "TaskDefinitionId": "62ab2a93696f6e2d3368618f", "TaskDefinitionName": "CreateTenant", "UseDefault": false, "VariableParameters": null, "Version": 1 }, { "CatalogMoid": "xxxxx", "ClassId": "workflow.WorkerTask", "Description": "Creates a VRF in ACI", "InputParameters": { "TENANT": "${workflow.input.NAME}", "Target": "${workflow.input.Target}", "VRF": "${workflow.input.NAME}" }, "Label": "Create VRF", "Name": "CreateVRF1", "ObjectType": "workflow.WorkerTask", "OnFailure": "", "OnSuccess": "CreateBD1", "RollbackDisabled": false, "TaskDefinitionId": "62ab2a94696f6e2d336861a2", "TaskDefinitionName": "CreateVRF", "UseDefault": false, "VariableParameters": null, "Version": 1 }, { "CatalogMoid": "xxxxxx", "ClassId": "workflow.WorkerTask", "Description": "Creates a BD in ACI", "InputParameters": { "BD": "${workflow.input.NAME}", "SUBNET": "${workflow.input.SUBNET}", "TENANT": "${workflow.input.NAME}", "Target": "${workflow.input.Target}", "VRF": "${workflow.input.NAME}" }, "Label": "Create BD", "Name": "CreateBD1", "ObjectType": "workflow.WorkerTask", "OnFailure": "", "OnSuccess": "AP1", "RollbackDisabled": false, "TaskDefinitionId": "62ab2a94696f6e2d336861ad", "TaskDefinitionName": "CreateBD", "UseDefault": false, "VariableParameters": null, "Version": 1 }, { "CatalogMoid": "xxxxx", "ClassId": "workflow.WorkerTask", "Description": "Creates an Application Profile with 2 EPGs", "InputParameters": { "NAME": "${workflow.input.NAME}", "Target": "${workflow.input.Target}" }, "Label": "Create Application Profile in ACI", "Name": "AP1", "ObjectType": "workflow.WorkerTask", "OnFailure": "", "OnSuccess": "CreateEPG1", "RollbackDisabled": false, "TaskDefinitionId": "62ab2a94696f6e2d336861b8", "TaskDefinitionName": "AP", "UseDefault": false, "VariableParameters": null, "Version": 1 }, { "CatalogMoid": "xxxxx", "ClassId": "workflow.WorkerTask", "Description": "Create an EPG", "InputParameters": { "AP": "${workflow.input.NAME}", "EPG": "Public-EPG", "TENANT": "${workflow.input.NAME}", "Target": "${workflow.input.Target}" }, "Label": "Create Public-EPG", "Name": "CreateEPG1", "ObjectType": "workflow.WorkerTask", "OnFailure": "", "OnSuccess": "CreateEPG2", "RollbackDisabled": false, "TaskDefinitionId": "62ab2a95696f6e2d336861c3", "TaskDefinitionName": "CreateEPG", "UseDefault": false, "VariableParameters": null, "Version": 1 }, { "CatalogMoid": "xxxxxx", "ClassId": "workflow.WorkerTask", "Description": "Create an EPG", "InputParameters": { "AP": "${workflow.input.NAME}", "EPG": "Private-EPG", "TENANT": "${workflow.input.NAME}", "Target": "${workflow.input.Target}" }, "Label": "Create Private-EPG", "Name": "CreateEPG2", "ObjectType": "workflow.WorkerTask", "OnFailure": "", "OnSuccess": "CreateContract1", "RollbackDisabled": false, "TaskDefinitionId": "62ab2a95696f6e2d336861c3", "TaskDefinitionName": "CreateEPG", "UseDefault": false, "VariableParameters": null, "Version": 1 }, { "CatalogMoid": "xxxxx", "ClassId": "workflow.WorkerTask", "Description": "Creates a contract between EPGs", "InputParameters": { "CONTRACT": "Public-to-Private", "NAME": "${workflow.input.NAME}", "Target": "${workflow.input.Target}" }, "Label": "Create Contract", "Name": "CreateContract1", "ObjectType": "workflow.WorkerTask", "OnFailure": "", "OnSuccess": "parallelLoop1", "RollbackDisabled": false, "TaskDefinitionId": "62ab2a95696f6e2d336861ce", "TaskDefinitionName": "CreateContract", "UseDefault": false, "VariableParameters": null, "Version": 1 }, { "ClassId": "workflow.LoopTask", "Count": "", "Label": "For each Filter", "LoopStartTask": "CreateaFilter2", "Name": "parallelLoop1", "NumberOfBatches": 1, "ObjectType": "workflow.LoopTask", "OnSuccess": "parallelLoop2", "Parallel": true }, { "CatalogMoid": "xxxxxx", "ClassId": "workflow.WorkerTask", "Description": "Creates a filter", "InputParameters": { "NAME": "${workflow.input.NAME}", "PORT": "{{ index .global.workflow.input.PORT .iteration}}", "Target": "${workflow.input.Target}" }, "Label": "Create a Filter", "Name": "CreateaFilter2", "ObjectType": "workflow.WorkerTask", "OnFailure": "", "OnSuccess": "", "RollbackDisabled": false, "TaskDefinitionId": "62ab2a95696f6e2d336861d9", "TaskDefinitionName": "CreateaFilter", "UseDefault": false, "VariableParameters": null, "Version": 1 }, { "ClassId": "workflow.LoopTask", "Count": "", "Label": "For each Filter assignment", "LoopStartTask": "AssignFiltertoContract1", "Name": "parallelLoop2", "NumberOfBatches": 1, "ObjectType": "workflow.LoopTask", "OnSuccess": "AssignConsumerContract1", "Parallel": true }, { "CatalogMoid": "xxxxx", "ClassId": "workflow.WorkerTask", "Description": "Creates a contract between EPGs", "InputParameters": { "AP": "${workflow.input.NAME}", "EPG": "Private-EPG", "NAME": "Public-to-Private", "TENANT": "${workflow.input.NAME}", "Target": "${workflow.input.Target}" }, "Label": "Assign Provider Contract", "Name": "AssignProviderContract1", "ObjectType": "workflow.WorkerTask", "OnFailure": "", "OnSuccess": "SuccessEndTask", "RollbackDisabled": false, "TaskDefinitionId": "62ab2a96696f6e2d336861ec", "TaskDefinitionName": "AssignProviderContract", "UseDefault": false, "VariableParameters": null, "Version": 1 }, { "ClassId": "workflow.SuccessEndTask", "Description": "", "Label": "", "Name": "SuccessEndTask", "ObjectType": "workflow.SuccessEndTask" }, { "ClassId": "workflow.FailureEndTask", "Description": "", "Label": "", "Name": "FailureEndTask", "ObjectType": "workflow.FailureEndTask" }, { "CatalogMoid": "xxxxx", "ClassId": "workflow.WorkerTask", "Description": "Assign Consumer EPG to Contract", "InputParameters": { "AP": "${workflow.input.NAME}", "EPG": "Public-EPG", "NAME": "Public-to-Private", "TENANT": "${workflow.input.NAME}", "Target": "${workflow.input.Target}" }, "Label": "Assign Consumer Contract", "Name": "AssignConsumerContract1", "ObjectType": "workflow.WorkerTask", "OnFailure": "", "OnSuccess": "AssignProviderContract1", "RollbackDisabled": false, "TaskDefinitionId": "62ab2a96696f6e2d336861f8", "TaskDefinitionName": "AssignConsumerContract", "UseDefault": false, "VariableParameters": null, "Version": 1 }, { "CatalogMoid": "xxxxx", "ClassId": "workflow.WorkerTask", "Description": "", "InputParameters": { "FILTER": "Allow-{{ index .global.workflow.input.PORT .iteration}}", "NAME": "${workflow.input.NAME}", "Target": "${workflow.input.Target}" }, "Label": "Assign Filter to Contract", "Name": "AssignFiltertoContract1", "ObjectType": "workflow.WorkerTask", "OnFailure": "", "OnSuccess": "", "RollbackDisabled": false, "TaskDefinitionId": "62ab2a97696f6e2d33686203", "TaskDefinitionName": "AssignFiltertoContract", "UseDefault": false, "VariableParameters": null, "Version": 1 } ], "uiInputFilters": "", "uiRenderingData": { "Positions": [ { "Name": "StartTask", "X": 193.37934772363099, "Y": 77.9168159110187 }, { "Name": "SuccessEndTask", "X": 193.37934772363099, "Y": 1356.4168159110188 }, { "Name": "FailureEndTask", "X": 335.3793477236313, "Y": 1356.4168159110188 }, { "Name": "CreateTenant1", "X": 108.37934772363076, "Y": 149.41681591101863 }, { "Name": "AP1", "X": 108.37934772363076, "Y": 413.416815911019 }, { "Name": "parallelLoop1", "X": 98.37934772363077, "Y": 765.416815911019 }, { "Name": "CreateaFilter2", "X": 108.87934772363073, "Y": 856.4168159110192 }, { "Name": "CreateContract1", "X": 108.37934772363076, "Y": 677.4168159110191 }, { "Name": "parallelLoop2", "X": 98.37934772363077, "Y": 972.4168159110191 }, { "Name": "CreateEPG1", "X": 108.37934772363076, "Y": 501.4168159110192 }, { "Name": "CreateEPG2", "X": 108.37934772363076, "Y": 589.4168159110195 }, { "Name": "CreateVRF1", "X": 108.37934772363076, "Y": 237.41681591101855 }, { "Name": "CreateBD1", "X": 108.37934772363076, "Y": 325.4168159110186 }, { "Name": "AssignProviderContract1", "X": 108.37934772363076, "Y": 1268.4168159110195 }, { "Name": "AssignConsumerContract1", "X": 108.37934772363076, "Y": 1180.4168159110197 }, { "Name": "AssignFiltertoContract1", "X": 108.37934772363073, "Y": 1063.4168159110193 } ] }, "variableDefinition": "", "version": 1, "workflowMetadata": "", "tags": [ { "Key": "category", "Value": "ACI" } ], 
"organizations": [ { "name": "default", "moid": "xxxxx" } ] } ]}

Parameter Details:

Table 1. GetWorkflows
Parameter Name Type Mandatory Description
organizationMoid String N To filter the list on specific organizationMoid.
controlId String N

Id of ‘Select’ control to be populated.

If Id Control of dynamic UI is passed, then control will be populated with values return from this function else “Result set” will be returned in JSON format.

async Boolean N

In case it’s False:

Function will be called in synchronous mode. i.e., Current execution will wait for method execution to complete

In case it’s True:

Function will be called asynchronously. Execution will not wait for method execution completion. It will jump to next statement.

Callback Function N User can pass function name that can be executed on completion of Parent function call.
addlparam Object N

Addlparam is used for filtering and sorting the records. It contains 3 properties filter/sortby/sortorder.

To Filter:

To filter records based on column name received from output. e.g., filter="keyname='keyvalue'"

To Sort By:

To sort the data based on column name. e.g., sortby="keyname"

To Sort Order:

To define sorting order either ASC (Ascending) or DESC (descending). e.g., sortorder="ASC”