Cisco Intersight Workflow API
The workflow API from Cisco Intersight — 58 operation(s) for workflow.
Cisco Intersight Workflow API is one of 117 APIs that Cisco Intersight publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.
This API exposes 136 operations across 58 paths, and defines 145 schemas. It is described by OpenAPI 3.2.0, at version 1.0.11-20260807064027971.
Requests are made against a single base URL, https://{server}.
136 operations
58 paths
145 schemas
19 DELETE56 GET20 PATCH41 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Cisco Intersight Workflow API declares
3 security schemes
for authenticating requests.
An API key is passed in the cookie as X-Starship-Token (cookieAuth).
It uses HTTP signature authentication (http_signature).
It supports OAuth 2.0 (oAuth2) using the authorizationCode and clientCredentials flows, exposing 3315 scopes.
cookieAuth— The authentication cookie obtained from a Single-Sign-On SAML assertion.http_signature— The 'HTTP signature' security scheme. Each HTTP request is cryptographically signed as specified in https://datatracker.ietf.org/doc/draft-cavage-http-signatur…oAuth2— The client uses the OAuth2 security scheme. To use OAuth2, a client application must be registered by creating a iam.AppRegistration resource. The user who cre…
Paths & Operations 136
Across 58 paths, the API surfaces 136 operations — 19 DELETE, 56 GET, 20 PATCH, 41 POST. Each is listed below with its method, path, parameters, and response codes.
workflow 136
GET
/api/v1/workflow/AnsibleBatchExecutors
Read a 'workflow.AnsibleBatchExecutor' resource.
POST
/api/v1/workflow/AnsibleBatchExecutors
Create a 'workflow.AnsibleBatchExecutor' resource.
GET
/api/v1/workflow/AnsibleBatchExecutors/{Moid}
Read a 'workflow.AnsibleBatchExecutor' resource.
POST
/api/v1/workflow/AnsibleBatchExecutors/{Moid}
Update a 'workflow.AnsibleBatchExecutor' resource.
PATCH
/api/v1/workflow/AnsibleBatchExecutors/{Moid}
Update a 'workflow.AnsibleBatchExecutor' resource.
DELETE
/api/v1/workflow/AnsibleBatchExecutors/{Moid}
Delete a 'workflow.AnsibleBatchExecutor' resource.
GET
/api/v1/workflow/BatchApiExecutors
Read a 'workflow.BatchApiExecutor' resource.
POST
/api/v1/workflow/BatchApiExecutors
Create a 'workflow.BatchApiExecutor' resource.
GET
/api/v1/workflow/BatchApiExecutors/{Moid}
Read a 'workflow.BatchApiExecutor' resource.
POST
/api/v1/workflow/BatchApiExecutors/{Moid}
Update a 'workflow.BatchApiExecutor' resource.
PATCH
/api/v1/workflow/BatchApiExecutors/{Moid}
Update a 'workflow.BatchApiExecutor' resource.
DELETE
/api/v1/workflow/BatchApiExecutors/{Moid}
Delete a 'workflow.BatchApiExecutor' resource.
GET
/api/v1/workflow/Catalogs
Read a 'workflow.Catalog' resource.
GET
/api/v1/workflow/Catalogs/{Moid}
Read a 'workflow.Catalog' resource.
GET
/api/v1/workflow/CatalogItemDefinitions
Read a 'workflow.CatalogItemDefinition' resource.
POST
/api/v1/workflow/CatalogItemDefinitions
Create a 'workflow.CatalogItemDefinition' resource.
GET
/api/v1/workflow/CatalogItemDefinitions/{Moid}
Read a 'workflow.CatalogItemDefinition' resource.
POST
/api/v1/workflow/CatalogItemDefinitions/{Moid}
Update a 'workflow.CatalogItemDefinition' resource.
PATCH
/api/v1/workflow/CatalogItemDefinitions/{Moid}
Update a 'workflow.CatalogItemDefinition' resource.
DELETE
/api/v1/workflow/CatalogItemDefinitions/{Moid}
Delete a 'workflow.CatalogItemDefinition' resource.
GET
/api/v1/workflow/CatalogServiceRequests
Read a 'workflow.CatalogServiceRequest' resource.
POST
/api/v1/workflow/CatalogServiceRequests
Create a 'workflow.CatalogServiceRequest' resource.
GET
/api/v1/workflow/CatalogServiceRequests/{Moid}
Read a 'workflow.CatalogServiceRequest' resource.
POST
/api/v1/workflow/CatalogServiceRequests/{Moid}
Update a 'workflow.CatalogServiceRequest' resource.
PATCH
/api/v1/workflow/CatalogServiceRequests/{Moid}
Update a 'workflow.CatalogServiceRequest' resource.
DELETE
/api/v1/workflow/CatalogServiceRequests/{Moid}
Delete a 'workflow.CatalogServiceRequest' resource.
GET
/api/v1/workflow/CustomDataTypeDefinitions
Read a 'workflow.CustomDataTypeDefinition' resource.
POST
/api/v1/workflow/CustomDataTypeDefinitions
Create a 'workflow.CustomDataTypeDefinition' resource.
GET
/api/v1/workflow/CustomDataTypeDefinitions/{Moid}
Read a 'workflow.CustomDataTypeDefinition' resource.
POST
/api/v1/workflow/CustomDataTypeDefinitions/{Moid}
Update a 'workflow.CustomDataTypeDefinition' resource.
PATCH
/api/v1/workflow/CustomDataTypeDefinitions/{Moid}
Update a 'workflow.CustomDataTypeDefinition' resource.
DELETE
/api/v1/workflow/CustomDataTypeDefinitions/{Moid}
Delete a 'workflow.CustomDataTypeDefinition' resource.
GET
/api/v1/workflow/ErrorResponseHandlers
Read a 'workflow.ErrorResponseHandler' resource.
POST
/api/v1/workflow/ErrorResponseHandlers
Create a 'workflow.ErrorResponseHandler' resource.
GET
/api/v1/workflow/ErrorResponseHandlers/{Moid}
Read a 'workflow.ErrorResponseHandler' resource.
POST
/api/v1/workflow/ErrorResponseHandlers/{Moid}
Update a 'workflow.ErrorResponseHandler' resource.
PATCH
/api/v1/workflow/ErrorResponseHandlers/{Moid}
Update a 'workflow.ErrorResponseHandler' resource.
DELETE
/api/v1/workflow/ErrorResponseHandlers/{Moid}
Delete a 'workflow.ErrorResponseHandler' resource.
GET
/api/v1/workflow/PowerShellBatchApiExecutors
Read a 'workflow.PowerShellBatchApiExecutor' resource.
POST
/api/v1/workflow/PowerShellBatchApiExecutors
Create a 'workflow.PowerShellBatchApiExecutor' resource.
GET
/api/v1/workflow/PowerShellBatchApiExecutors/{Moid}
Read a 'workflow.PowerShellBatchApiExecutor' resource.
POST
/api/v1/workflow/PowerShellBatchApiExecutors/{Moid}
Update a 'workflow.PowerShellBatchApiExecutor' resource.
PATCH
/api/v1/workflow/PowerShellBatchApiExecutors/{Moid}
Update a 'workflow.PowerShellBatchApiExecutor' resource.
DELETE
/api/v1/workflow/PowerShellBatchApiExecutors/{Moid}
Delete a 'workflow.PowerShellBatchApiExecutor' resource.
GET
/api/v1/workflow/RollbackWorkflows
Read a 'workflow.RollbackWorkflow' resource.
POST
/api/v1/workflow/RollbackWorkflows
Create a 'workflow.RollbackWorkflow' resource.
GET
/api/v1/workflow/RollbackWorkflows/{Moid}
Read a 'workflow.RollbackWorkflow' resource.
POST
/api/v1/workflow/RollbackWorkflows/{Moid}
Update a 'workflow.RollbackWorkflow' resource.
PATCH
/api/v1/workflow/RollbackWorkflows/{Moid}
Update a 'workflow.RollbackWorkflow' resource.
DELETE
/api/v1/workflow/RollbackWorkflows/{Moid}
Delete a 'workflow.RollbackWorkflow' resource.
GET
/api/v1/workflow/ServiceItemActionDefinitions
Read a 'workflow.ServiceItemActionDefinition' resource.
POST
/api/v1/workflow/ServiceItemActionDefinitions
Create a 'workflow.ServiceItemActionDefinition' resource.
GET
/api/v1/workflow/ServiceItemActionDefinitions/{Moid}
Read a 'workflow.ServiceItemActionDefinition' resource.
POST
/api/v1/workflow/ServiceItemActionDefinitions/{Moid}
Update a 'workflow.ServiceItemActionDefinition' resource.
PATCH
/api/v1/workflow/ServiceItemActionDefinitions/{Moid}
Update a 'workflow.ServiceItemActionDefinition' resource.
DELETE
/api/v1/workflow/ServiceItemActionDefinitions/{Moid}
Delete a 'workflow.ServiceItemActionDefinition' resource.
GET
/api/v1/workflow/ServiceItemActionInstances
Read a 'workflow.ServiceItemActionInstance' resource.
POST
/api/v1/workflow/ServiceItemActionInstances
Create a 'workflow.ServiceItemActionInstance' resource.
GET
/api/v1/workflow/ServiceItemActionInstances/{Moid}
Read a 'workflow.ServiceItemActionInstance' resource.
POST
/api/v1/workflow/ServiceItemActionInstances/{Moid}
Update a 'workflow.ServiceItemActionInstance' resource.
PATCH
/api/v1/workflow/ServiceItemActionInstances/{Moid}
Update a 'workflow.ServiceItemActionInstance' resource.
DELETE
/api/v1/workflow/ServiceItemActionInstances/{Moid}
Delete a 'workflow.ServiceItemActionInstance' resource.
GET
/api/v1/workflow/ServiceItemAttributes
Read a 'workflow.ServiceItemAttribute' resource.
GET
/api/v1/workflow/ServiceItemAttributes/{Moid}
Read a 'workflow.ServiceItemAttribute' resource.
GET
/api/v1/workflow/ServiceItemDefinitions
Read a 'workflow.ServiceItemDefinition' resource.
POST
/api/v1/workflow/ServiceItemDefinitions
Create a 'workflow.ServiceItemDefinition' resource.
GET
/api/v1/workflow/ServiceItemDefinitions/{Moid}
Read a 'workflow.ServiceItemDefinition' resource.
POST
/api/v1/workflow/ServiceItemDefinitions/{Moid}
Update a 'workflow.ServiceItemDefinition' resource.
PATCH
/api/v1/workflow/ServiceItemDefinitions/{Moid}
Update a 'workflow.ServiceItemDefinition' resource.
DELETE
/api/v1/workflow/ServiceItemDefinitions/{Moid}
Delete a 'workflow.ServiceItemDefinition' resource.
GET
/api/v1/workflow/ServiceItemHealthCheckDefinitions
Read a 'workflow.ServiceItemHealthCheckDefinition' resource.
GET
/api/v1/workflow/ServiceItemHealthCheckDefinitions/{Moid}
Read a 'workflow.ServiceItemHealthCheckDefinition' resource.
GET
/api/v1/workflow/ServiceItemHealthCheckExecutions
Read a 'workflow.ServiceItemHealthCheckExecution' resource.
GET
/api/v1/workflow/ServiceItemHealthCheckExecutions/{Moid}
Read a 'workflow.ServiceItemHealthCheckExecution' resource.
GET
/api/v1/workflow/ServiceItemInstances
Read a 'workflow.ServiceItemInstance' resource.
POST
/api/v1/workflow/ServiceItemInstances
Create a 'workflow.ServiceItemInstance' resource.
GET
/api/v1/workflow/ServiceItemInstances/{Moid}
Read a 'workflow.ServiceItemInstance' resource.
POST
/api/v1/workflow/ServiceItemInstances/{Moid}
Update a 'workflow.ServiceItemInstance' resource.
PATCH
/api/v1/workflow/ServiceItemInstances/{Moid}
Update a 'workflow.ServiceItemInstance' resource.
DELETE
/api/v1/workflow/ServiceItemInstances/{Moid}
Delete a 'workflow.ServiceItemInstance' resource.
GET
/api/v1/workflow/ServiceItemOutputs
Read a 'workflow.ServiceItemOutput' resource.
POST
/api/v1/workflow/ServiceItemOutputs
Create a 'workflow.ServiceItemOutput' resource.
GET
/api/v1/workflow/ServiceItemOutputs/{Moid}
Read a 'workflow.ServiceItemOutput' resource.
POST
/api/v1/workflow/ServiceItemOutputs/{Moid}
Update a 'workflow.ServiceItemOutput' resource.
PATCH
/api/v1/workflow/ServiceItemOutputs/{Moid}
Update a 'workflow.ServiceItemOutput' resource.
DELETE
/api/v1/workflow/ServiceItemOutputs/{Moid}
Delete a 'workflow.ServiceItemOutput' resource.
GET
/api/v1/workflow/SshBatchExecutors
Read a 'workflow.SshBatchExecutor' resource.
POST
/api/v1/workflow/SshBatchExecutors
Create a 'workflow.SshBatchExecutor' resource.
GET
/api/v1/workflow/SshBatchExecutors/{Moid}
Read a 'workflow.SshBatchExecutor' resource.
POST
/api/v1/workflow/SshBatchExecutors/{Moid}
Update a 'workflow.SshBatchExecutor' resource.
PATCH
/api/v1/workflow/SshBatchExecutors/{Moid}
Update a 'workflow.SshBatchExecutor' resource.
DELETE
/api/v1/workflow/SshBatchExecutors/{Moid}
Delete a 'workflow.SshBatchExecutor' resource.
GET
/api/v1/workflow/TaskDebugLogs
Read a 'workflow.TaskDebugLog' resource.
GET
/api/v1/workflow/TaskDebugLogs/{Moid}
Read a 'workflow.TaskDebugLog' resource.
GET
/api/v1/workflow/TaskDefinitions
Read a 'workflow.TaskDefinition' resource.
POST
/api/v1/workflow/TaskDefinitions
Create a 'workflow.TaskDefinition' resource.
GET
/api/v1/workflow/TaskDefinitions/{Moid}
Read a 'workflow.TaskDefinition' resource.
POST
/api/v1/workflow/TaskDefinitions/{Moid}
Update a 'workflow.TaskDefinition' resource.
PATCH
/api/v1/workflow/TaskDefinitions/{Moid}
Update a 'workflow.TaskDefinition' resource.
DELETE
/api/v1/workflow/TaskDefinitions/{Moid}
Delete a 'workflow.TaskDefinition' resource.
GET
/api/v1/workflow/TaskInfos
Read a 'workflow.TaskInfo' resource.
GET
/api/v1/workflow/TaskInfos/{Moid}
Read a 'workflow.TaskInfo' resource.
POST
/api/v1/workflow/TaskInfos/{Moid}
Update a 'workflow.TaskInfo' resource.
PATCH
/api/v1/workflow/TaskInfos/{Moid}
Update a 'workflow.TaskInfo' resource.
GET
/api/v1/workflow/TaskMetadata
Read a 'workflow.TaskMetadata' resource.
GET
/api/v1/workflow/TaskMetadata/{Moid}
Read a 'workflow.TaskMetadata' resource.
POST
/api/v1/workflow/TemplateEvaluations
Create a 'workflow.TemplateEvaluation' resource.
GET
/api/v1/workflow/TemplateFunctionMeta
Read a 'workflow.TemplateFunctionMeta' resource.
GET
/api/v1/workflow/TemplateFunctionMeta/{Moid}
Read a 'workflow.TemplateFunctionMeta' resource.
POST
/api/v1/workflow/TemplateParsers
Create a 'workflow.TemplateParser' resource.
GET
/api/v1/workflow/UiDisplayMetadata
Read a 'workflow.UiDisplayMetadata' resource.
POST
/api/v1/workflow/UiDisplayMetadata
Create a 'workflow.UiDisplayMetadata' resource.
GET
/api/v1/workflow/UiDisplayMetadata/{Moid}
Read a 'workflow.UiDisplayMetadata' resource.
POST
/api/v1/workflow/UiDisplayMetadata/{Moid}
Update a 'workflow.UiDisplayMetadata' resource.
PATCH
/api/v1/workflow/UiDisplayMetadata/{Moid}
Update a 'workflow.UiDisplayMetadata' resource.
DELETE
/api/v1/workflow/UiDisplayMetadata/{Moid}
Delete a 'workflow.UiDisplayMetadata' resource.
GET
/api/v1/workflow/Variables
Read a 'workflow.Variable' resource.
POST
/api/v1/workflow/Variables
Create a 'workflow.Variable' resource.
GET
/api/v1/workflow/Variables/{Moid}
Read a 'workflow.Variable' resource.
POST
/api/v1/workflow/Variables/{Moid}
Update a 'workflow.Variable' resource.
PATCH
/api/v1/workflow/Variables/{Moid}
Update a 'workflow.Variable' resource.
DELETE
/api/v1/workflow/Variables/{Moid}
Delete a 'workflow.Variable' resource.
GET
/api/v1/workflow/WorkflowDefinitions
Read a 'workflow.WorkflowDefinition' resource.
POST
/api/v1/workflow/WorkflowDefinitions
Create a 'workflow.WorkflowDefinition' resource.
GET
/api/v1/workflow/WorkflowDefinitions/{Moid}
Read a 'workflow.WorkflowDefinition' resource.
POST
/api/v1/workflow/WorkflowDefinitions/{Moid}
Update a 'workflow.WorkflowDefinition' resource.
PATCH
/api/v1/workflow/WorkflowDefinitions/{Moid}
Update a 'workflow.WorkflowDefinition' resource.
DELETE
/api/v1/workflow/WorkflowDefinitions/{Moid}
Delete a 'workflow.WorkflowDefinition' resource.
GET
/api/v1/workflow/WorkflowInfos
Read a 'workflow.WorkflowInfo' resource.
POST
/api/v1/workflow/WorkflowInfos
Create a 'workflow.WorkflowInfo' resource.
GET
/api/v1/workflow/WorkflowInfos/{Moid}
Read a 'workflow.WorkflowInfo' resource.
POST
/api/v1/workflow/WorkflowInfos/{Moid}
Update a 'workflow.WorkflowInfo' resource.
PATCH
/api/v1/workflow/WorkflowInfos/{Moid}
Update a 'workflow.WorkflowInfo' resource.
DELETE
/api/v1/workflow/WorkflowInfos/{Moid}
Delete a 'workflow.WorkflowInfo' resource.
GET
/api/v1/workflow/WorkflowMetadata
Read a 'workflow.WorkflowMetadata' resource.
GET
/api/v1/workflow/WorkflowMetadata/{Moid}
Read a 'workflow.WorkflowMetadata' resource.
Schemas 145
The contract defines 145 schemas that model the data the API accepts and returns. Each schema is shown below with its type and property counts.
workflow.Properties
Properties for the task definition like the inputs, outputs, timeout and retry policies. Tasks are the building blocks for workflows.
workflow.CustomDataTypeDefinition.Relationship
A relationship to the 'workflow.CustomDataTypeDefinition' resource, or the expanded 'workflow.CustomDataTypeDefinition' resource, or the 'null' value.
workflow.PowerShellBatchApiExecutor.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemDefinition.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemDefinition' resource. The value may be one of the following types. 1. When 'tag' is specif…
workflow.TaskDebugLog.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.CatalogItemDefinition
Catalog Item definition is a collection of Service items which are associated with workflow definition that can be used to deploy and manage service items.
workflow.SshBatchExecutor.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.CustomDataTypeDefinition.Response
The response body of a HTTP GET request for the 'workflow.CustomDataTypeDefinition' resource. The value may be one of the following types. 1. When 'tag' is spe…
workflow.BaseDataType
The base data type that is used to derive all the other data types for inputs and outputs.
workflow.BatchExecutor
Intersight support for creating generic API tasks using the API request body and a response parser specification in the form of a content.Grammar object. The B…
workflow.CatalogServiceRequest.Response
The response body of a HTTP GET request for the 'workflow.CatalogServiceRequest' resource. The value may be one of the following types. 1. When 'tag' is specif…
workflow.WorkflowCtx
The workflow context contains initiator and target information along with workflow type and action information.
workflow.UiDisplayMetadata.Response
The response body of a HTTP GET request for the 'workflow.UiDisplayMetadata' resource. The value may be one of the following types. 1. When 'tag' is specified…
workflow.ErrorResponseHandler.Response
The response body of a HTTP GET request for the 'workflow.ErrorResponseHandler' resource. The value may be one of the following types. 1. When 'tag' is specifi…
workflow.ServiceItemActionInstance
Service item action instance which represents one action on a service item instance.
workflow.RollbackWorkflow.Response
The response body of a HTTP GET request for the 'workflow.RollbackWorkflow' resource. The value may be one of the following types. 1. When 'tag' is specified i…
workflow.Variable.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.TaskDebugLog
The TaskDebugLog object provides detailed debugging information for task execution within workflows. It serves as a critical tool for isolating and resolving t…
workflow.ServiceItemInstance.Relationship
A relationship to the 'workflow.ServiceItemInstance' resource, or the expanded 'workflow.ServiceItemInstance' resource, or the 'null' value.
workflow.EnumEntry
Captures a single enum entry which has a label and value.
workflow.WorkflowProperties
Properties for a workflow definition.
workflow.RollbackWorkflow
The RollbackWorkflow object addresses the management and execution of rollback operations within the workflow system. This provides a structured approach to re…
workflow.PrimitiveDataProperty
Capture all the properties for primitive data type.
workflow.ServiceItemActionDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.BatchApiExecutor.Response
The response body of a HTTP GET request for the 'workflow.BatchApiExecutor' resource. The value may be one of the following types. 1. When 'tag' is specified i…
workflow.Comments
Contains detailed information about template function.
workflow.ServiceItemActionDefinition.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemActionDefinition' resource. The value may be one of the following types. 1. When 'tag' is…
workflow.CustomDataTypeProperties
Properties for a custom data type definition.
workflow.SelectorProperty
Selector properties to define HTTP method and 'body' in case of upsert (short for update or insert) operations. When requested resource (endpoint) does not exi…
workflow.ServiceItemHealthCheckExecution.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemOutput.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.WorkflowMetadata.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.CatalogServiceRequest.Relationship
A relationship to the 'workflow.CatalogServiceRequest' resource, or the expanded 'workflow.CatalogServiceRequest' resource, or the 'null' value.
workflow.ServiceItemActionInstance.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemActionInstance' resource. The value may be one of the following types. 1. When 'tag' is sp…
workflow.Constraints
Captures the constraints for valid parameter values.
workflow.BaseOperation
Specify operation type on a service item like deployment or post-deployment to be performed on catalog.
workflow.TaskInfo
The TaskInfos object represents the runtime instance of a task executing within a workflow. Purpose It tracks the execution lifecycle of a specific task instan…
workflow.TaskInfo.Response
The response body of a HTTP GET request for the 'workflow.TaskInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
workflow.UiViewConfig
Contains metadata which specify the UI view config for data. The type, schema of the data comes from the datatype definition and only the visual layout of data…
workflow.WorkflowDefinition.Relationship
A relationship to the 'workflow.WorkflowDefinition' resource, or the expanded 'workflow.WorkflowDefinition' resource, or the 'null' value.
workflow.MoReferenceProperty
Capture all the properties for an Intersight managed object reference.
workflow.WorkflowMetadata.Response
The response body of a HTTP GET request for the 'workflow.WorkflowMetadata' resource. The value may be one of the following types. 1. When 'tag' is specified i…
workflow.UiFormConfig
Contains metadata which specify the UI form layout for data. The type, schema of the data comes from the datatype definition and only the visual form layout is…
workflow.ServiceItemInstance
Service item instance is one instance of a service item based on a service item definition.
workflow.RollbackTask
Rollback task mapping information.
workflow.TaskLoopInfo
Keep track of loop information for every task executed inside the loop.
workflow.TaskDefinition.Relationship
A relationship to the 'workflow.TaskDefinition' resource, or the expanded 'workflow.TaskDefinition' resource, or the 'null' value.
workflow.InternalProperties
Internal properties for a task definition which are not editable by the user.
workflow.ServiceItemActionDefinition.Relationship
A relationship to the 'workflow.ServiceItemActionDefinition' resource, or the expanded 'workflow.ServiceItemActionDefinition' resource, or the 'null' value.
workflow.SshBatchExecutor
The SshBatchExecutor object is a core component of Intersight’s workflow system, specialized in handling the batch execution of SSH commands. It is designed to…
workflow.Catalog.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.WorkflowInfo.Relationship
A relationship to the 'workflow.WorkflowInfo' resource, or the expanded 'workflow.WorkflowInfo' resource, or the 'null' value.
workflow.UiDisplayMetadata.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.PrimitiveDataType
This data type is used to represent primitives like string, floats and integers.
workflow.BatchApiExecutor
The BatchApiExecutor object is a key component within the workflow system that facilitates the execution of multiple API requests as part of a single task exec…
workflow.DisplayMeta
Captures the meta data needed for displaying workflow data types in Intersight User Interface.
workflow.ServiceItemDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.DefaultValue
Captures default vales for a data type.
workflow.Message
Intermediate Task or Workflow message with severity.
workflow.AnsibleBatchExecutor.Response
The response body of a HTTP GET request for the 'workflow.AnsibleBatchExecutor' resource. The value may be one of the following types. 1. When 'tag' is specifi…
workflow.ServiceItemOutput.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemOutput' resource. The value may be one of the following types. 1. When 'tag' is specified…
workflow.WorkflowInfo
The WorkflowInfo object encapsulates the execution instance of a workflow, providing details about its progress, state, and execution context. It is essential…
workflow.Api
Intersight Orchestrator supports generic API workflow tasks that can execute an API given the request body and response parser specification. API type models a…
workflow.CatalogServiceRequest.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.Variable.Response
The response body of a HTTP GET request for the 'workflow.Variable' resource. The value may be one of the following types. 1. When 'tag' is specified in the UR…
workflow.Catalog.Relationship
A relationship to the 'workflow.Catalog' resource, or the expanded 'workflow.Catalog' resource, or the 'null' value.
workflow.ServiceItemHealthCheckDefinition.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemHealthCheckDefinition' resource. The value may be one of the following types. 1. When 'tag…
workflow.WorkflowTask
Task instance within the workflow to be executed.
workflow.TaskMetadata.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemActionDefinition
Definition to capture the details needed to execute an action on the service item.
workflow.ServiceItemHealthCheckExecution.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemHealthCheckExecution' resource. The value may be one of the following types. 1. When 'tag'…
workflow.ServiceItemOutput
Service item output which represents all the artifacts created or related to this service item instance.
workflow.BatchApiExecutor.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.MigrationHistory
Migration history of versions for service item instance.
workflow.DataSourceSelector
An alternative selector to MoReferenceProperty that serves as a data source for PrimitiveDataTypes. It supports selecting data from workflow execution sources,…
workflow.WorkflowInfo.Response
The response body of a HTTP GET request for the 'workflow.WorkflowInfo' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
workflow.TaskInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.Catalog
The Catalog object serves as a container for organizing definitions related to orchestration, including both workflow, task definitions and more. Purpose It pr…
workflow.TaskInfo.Relationship
A relationship to the 'workflow.TaskInfo' resource, or the expanded 'workflow.TaskInfo' resource, or the 'null' value.
workflow.ServiceItemAttribute.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.CatalogItemDefinition.Response
The response body of a HTTP GET request for the 'workflow.CatalogItemDefinition' resource. The value may be one of the following types. 1. When 'tag' is specif…
workflow.CatalogItemDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.AnsibleBatchExecutor
The AnsibleBatchExecutor object is a core component within Intersight's workflow framework, designed to facilitate the execution of Ansible commands in batch m…
workflow.WorkflowInfo.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ErrorResponseHandler.Relationship
A relationship to the 'workflow.ErrorResponseHandler' resource, or the expanded 'workflow.ErrorResponseHandler' resource, or the 'null' value.
workflow.Variable
The Variable object facilitates the management of user-defined entities within workflows, allowing for consistent and reusable data references across different…
workflow.WorkflowInfoProperties
Properties for a workflowInfo.
workflow.TargetContext
Target context holds information about the Intersight managed object on which the workflow is executing and hence the entity that is being affected by the work…
workflow.TemplateEvaluation
The TemplateEvaluation object focuses on the execution and evaluation of templates within the workflow system. This provides mechanisms to dynamically generate…
workflow.TaskDefinition
The TaskDefinition object is a foundational element of the workflow system, designed to define individual tasks that can be orchestrated within a workflow. It…
workflow.TaskConstraints
Captures the constraints for a task. Currently, it hold only targetDataType constraints such as Vendor, ObjectType that are properties of a target device.
workflow.ErrorResponseHandler.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.TaskMetadata.Relationship
A relationship to the 'workflow.TaskMetadata' resource, or the expanded 'workflow.TaskMetadata' resource, or the 'null' value.
workflow.TemplateParser
The TemplateParser object is designed to parse templates and extract placeholders within the workflow system. It plays a crucial role in template management an…
workflow.ServiceItemActionInstance.Relationship
A relationship to the 'workflow.ServiceItemActionInstance' resource, or the expanded 'workflow.ServiceItemActionInstance' resource, or the 'null' value.
workflow.ValidationError
Used to show validation errors for the workflow or for the task within the workflow.
workflow.BaseServiceItemActionProperty
BaseServiceItemActionProperty is the abstract definition to capture the properties in ServiceItemActionProperties.
workflow.ParameterSet
The parameter set is a rule with a condition to match the controlling parameter against a value and make a set of parameters applicable.
workflow.CustomDataTypeDefinition
The CustomDataTypeDefinition object provides a framework for defining customized data types used within workflows, enhancing flexibility and reusability. Purpo…
workflow.TemplateFunctionMeta.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemActionProperties
Definition to capture the action properties which will be used in the action of service item.
workflow.RollbackWorkflow.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ValidationInformation
Type used to capture all the validation information for the workflow definition.
workflow.CatalogItemDefinition.Relationship
A relationship to the 'workflow.CatalogItemDefinition' resource, or the expanded 'workflow.CatalogItemDefinition' resource, or the 'null' value.
workflow.WorkflowDefinition.Response
The response body of a HTTP GET request for the 'workflow.WorkflowDefinition' resource. The value may be one of the following types. 1. When 'tag' is specified…
workflow.WorkflowMetadata.Relationship
A relationship to the 'workflow.WorkflowMetadata' resource, or the expanded 'workflow.WorkflowMetadata' resource, or the 'null' value.
workflow.ErrorResponseHandler
The ErrorResponseHandler object is designed to manage error responses within the workflow system. This provides a standardized way to define error response spe…
workflow.ServiceItemActionInstance.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemDefinition
Service Item definition is a collection of actions and associated workflow definition that can be used to deploy a service item.
workflow.ServiceItemActionWorkflowDefinition
Definition to capture the workflow definition which will be used in the action of a service item definition.
workflow.CancelableType
Defines the conditions under which a workflow can be canceled.
workflow.TaskRetryInfo
Keep track of task retry information using TaskRetryInfo.
workflow.SshBatchExecutor.Response
The response body of a HTTP GET request for the 'workflow.SshBatchExecutor' resource. The value may be one of the following types. 1. When 'tag' is specified i…
workflow.RollbackWorkflowTask
Rollback workflow task information.
workflow.ServiceItemHealthCheckExecution
Health check execution result for a health check definition on a service item.
workflow.Catalog.Response
The response body of a HTTP GET request for the 'workflow.Catalog' resource. The value may be one of the following types. 1. When 'tag' is specified in the URL…
workflow.WorkflowMetadata
Workflow metadata is a collection of properties that are common across all the versions of a workflow.
workflow.WorkflowDefinition
The WorkflowDefinitions object serves as the blueprint for automation, representing a collection of tasks sequenced as a Directed Acyclic Graph (DAG). Purpose…
workflow.ServiceItemHealthCheckDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.WorkflowDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.TaskDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.TemplateFunctionMeta
The TemplateFunctionMeta object is a key component within the workflow system, designed to encapsulate the metadata and functionality of template functions. Pu…
workflow.ServiceItemDefinition.Relationship
A relationship to the 'workflow.ServiceItemDefinition' resource, or the expanded 'workflow.ServiceItemDefinition' resource, or the 'null' value.
workflow.TaskInfoUpdate
TaskInfoUpdate is used to capture the updates that are required for the task instance inside an executing workflow. WaitTask, included inside the workflow, can…
workflow.ServiceItemInputDefinitionType
Definition to capture the inputs for a service items included inside a catalog. It captures the input definition and the associated input parameter mappings fo…
workflow.TemplateFunctionMeta.Response
The response body of a HTTP GET request for the 'workflow.TemplateFunctionMeta' resource. The value may be one of the following types. 1. When 'tag' is specifi…
workflow.PowerShellBatchApiExecutor.Response
The response body of a HTTP GET request for the 'workflow.PowerShellBatchApiExecutor' resource. The value may be one of the following types. 1. When 'tag' is s…
workflow.ServiceItemHealthCheckDefinition.Relationship
A relationship to the 'workflow.ServiceItemHealthCheckDefinition' resource, or the expanded 'workflow.ServiceItemHealthCheckDefinition' resource, or the 'null'…
workflow.TaskDefinition.Response
The response body of a HTTP GET request for the 'workflow.TaskDefinition' resource. The value may be one of the following types. 1. When 'tag' is specified in…
workflow.ServiceItemInstance.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.TaskMetadata.Response
The response body of a HTTP GET request for the 'workflow.TaskMetadata' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
workflow.ServiceItemType
Definition to capture the service items associated with the catalog.
workflow.UiInputFilter
A cascade filter enables the definition or extension of an optional filter for Intersight APIs, to narrow down the search results. This can be defined for work…
workflow.AnsibleBatchExecutor.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.PowerShellBatchApiExecutor
Intersight allows generic API tasks to be created by taking the API request body and a response parser specification in the form of content.Grammar object. Bat…
workflow.CatalogServiceRequest
Catalog Service Request is one instance of a catalog item based on a catalog item definition.
workflow.CustomDataTypeDefinition.List
This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.
workflow.ServiceItemHealthCheckDefinition
Service item health check definition metadata.
workflow.ServiceItemAttribute.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemAttribute' resource. The value may be one of the following types. 1. When 'tag' is specifi…
workflow.ServiceItemAttribute
Service item attribute which represents all the artifacts created or related to this service item instance.
workflow.TaskDebugLog.Response
The response body of a HTTP GET request for the 'workflow.TaskDebugLog' resource. The value may be one of the following types. 1. When 'tag' is specified in th…
workflow.InitiatorContext
Details about the workflow initiator name, type, initiator object Id if present and the result handler.
workflow.TaskMetadata
Task details is a collection of properties that are common across all the versions of a task.
workflow.UiDisplayMetadata
The UiDisplayMetadata object captures the visual layout metadata for user interfaces in workflow systems. It focuses on defining form and view layouts, contrib…
workflow.ServiceItemInstance.Response
The response body of a HTTP GET request for the 'workflow.ServiceItemInstance' resource. The value may be one of the following types. 1. When 'tag' is specifie…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Cisco Intersight 12
Other APIs Cisco Intersight publishes across the network.
Cisco Intersight Aaa API
Cisco Intersight Access API
Cisco Intersight Adapter API
Cisco Intersight Apiproxy API
Cisco Intersight Appliance API
Cisco Intersight Asset API
Cisco Intersight Auditd API
Cisco Intersight Bios API
Cisco Intersight Boot API
Cisco Intersight Bulk API
Cisco Intersight Capability API
Cisco Intersight Catalystsdwan API
#Workflows
Where this information came from
This is an independent, third-party profile of Cisco Intersight Workflow API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.