WorkflowStatusService
Class of the Workflow Status Web Service.
Endpoint Metadata
- Namespace: http://videoscape.cisco.com/epg/webservices/workflowstatus
- Endpoint Name: WorkflowStatusWebService
- Endpoint Address: http(s)://{VMS URL}/LinearManager/webservices/workflowstatus-service
The following methods are available on this endpoint:
Moves workflow to error state.
Input Parameters
name |
type |
description |
workflowUUID |
string |
UUID of workflow |
Faults
name |
description |
WorkflowStatusWebServiceFault |
Thrown if any exception is encountered. |
Retrieve status of current workflow. As EPG workflows are sequential, at most a single status will be returned.
Return Value
type |
description |
WorkflowStatus
|
Return status of workflow that is currently in progress. Return null if no workflow in progress. |
Retrieves a list of messages for workflow with specified severity and pagination.
Input Parameters
name |
type |
description |
workflowUUID |
string |
- UUID of the workflow |
severity |
workflowMessageSeverity
|
- message severity, if null - the messages of any severity type will be returned |
pageInfoAdapter |
PageInfoAdapter
|
- Page settings for result list. Settings include start, count and sort order. Null means return all |
Return Value
Faults
name |
description |
WorkflowStatusWebServiceFault |
Thrown if any exception is encountered. |
Retrieve status of workflow with the given UUID.
Input Parameters
name |
type |
description |
workflowUUID |
string |
UUID of workflow. |
Return Value
type |
description |
WorkflowStatus
|
Return status of workflow with the specified UUID. |
Faults
name |
description |
WorkflowStatusWebServiceFault |
Thrown if any exception is encountered. |
Checks if current workflow is defunct. Works for local and remote workflow.
Return Value
type |
description |
boolean |
true if current workflow is defunct |
Faults
name |
description |
WorkflowStatusWebServiceFault |
Thrown if any exception is encountered. |
Register a heartbeat event against a workflow with the given UUID.
Input Parameters
name |
type |
description |
workflowUUID |
string |
UUID of workflow. |
Faults
name |
description |
WorkflowStatusWebServiceFault |
Thrown if any exception is encountered. |
Register workflow in the status table.
Input Parameters
name |
type |
description |
workflowUUID |
string |
UUID of workflow |
Return Value
type |
description |
boolean |
true if workflow was registered, false otherwise. False means that same workflow was tried to be registered |
Faults
name |
description |
WorkflowStatusWebServiceFault |
Thrown if any exception is encountered. |
Terminates current running workflow.
Faults
name |
description |
WorkflowStatusWebServiceFault |
Thrown if any exception is encountered. |