VMware Cloud Foundation Operations Orchestrator API Operations Index

VMware Cloud Foundation Operations Orchestrator API Operations Index

All available VMware Cloud Foundation Operations Orchestrator API Operations

Action Environments Repositories Service
GET
Get Action Environment Repository

Retrieves a specified action environment repository
PUT
Update Action Environment Repository

Updates specified action environment repository
DELETE
Delete Action Environment Repository

Deletes specified action environment repository
GET
Get All Action Environment Repositories

Retrieves a list of all action environment repositories
POST
Create Action Environment Repository

Creates an action environment repository
Action Environments Service
GET
Get Action Environment

Retrieves a specified action environment
PUT
Update Action Environment

Updates specified action environment
DELETE
Delete Action Environment

Deletes specified action environment
GET
Get All Action Environments

Retrieves a list of all action environments
POST
Create Action Environment

Creates an action environments
POST
Rebuild Action Environment

Re-installs the dependencies of the specified action environment
Actions Service
PUT
Update Action

Updates the action with the given ID with the parameters provided in the request body
GET
Get Debug Info

Returns the current debug context
PUT
Execute Debugger Operation

Execute a debugger operation in the current debug context
POST
Control Debugger

Execute a debugger operation that changes the debug context
GET
List All Actions

Retrieves a list of all actions
POST
Create Action

When a request is sent to this endpoint with "application/octet-stream" or "multipart/form-data" as the value for the Content-Type header this operation is equivalent to "Import an action in the given category":

Imports an action in a given category. The action binary content should be available as multi-part content (see RFC-2387 for details).

Details of working with multi-part resources depend on the used client's HTTP/REST library. For example, in Spring it will look like:

Sample client code:
-------------------
String url = "https://localhost:8281/vco/api/actions/";
MultiValueMap parts = new LinkedMultiValueMap();
Resource r = new FileSystemResource("D:/path/to/some.action");
parts.put("file", Arrays.asList(r));
parts.put("categoryName", "com.vmware.basic");
new RestTemplate().postForLocation(url, parts);
-------------------
GET
Download Action Bundle

Downloads action bundle with the specified id.
POST
Update Action Bundle

Updates action bundle with the specified id.
DELETE
Delete Action Bundle

Deletes action bundle with the specified id.
POST
Execute Action By Name

Runs an action with given category and name
POST
Execute Action By Id

Runs an action with given id
GET
Download Action Icon

The icon's binary data is returned and response Content-type is set to correct media type, for example "Content-Type:image/png"
GET
Export Action Logs 1

Retrieves logs for a given action execution. When a request is sent to this endpoint with "application/zip" as the desired response content type, this operation is equivalent to "Export all action run logs": Exports all logs for a given action execution
GET
Get Action

The returned definition contains base data for the action, as well the input parameter's definitions and the output type.
GET
Get Action 1

The returned definition contains base data for the action, as well the input parameter's definitions and the output type. When a request is sent to this endpoint with "application/zip" or "application/octet-stream" as the desired response content type, this operation is the equivalent to "Export an action with given id":

Exports an action by its ID. If the request is successful, the action binary content is available as an attachment with MIME type application/zip (that is, a normal ZIP file) with a default file name {actionname}.action.

It is up to the client application to properly fetch and process this attachment, i.e. by saving it to the local file system.

The exported action has the same internal format as the actions exported by using the VCF Operations Orchestrator client.
DELETE
Delete Action 1

Deletes an action with a given id.

If the action is referenced by some workflows, it is considered to be 'in use'and the delete operation will fail, unless the 'force' option is provided.
GET
Find Action Dependencies

Retrieves a list of dependencies for the given action
GET
Get Action Execution Result

Retrieves the result of a given asynchronous action execution
DELETE
Cancel Action Run

Cancels a given action execution
Audit Logs
GET
Get Logs
Authorization Groups Service
GET
Get Authorization Group

Retrieve an VCF Operations Orchestrator's authorization group.
PUT
Update Authorization Group

Update an VCF Operations Orchestrator's authorization group.
DELETE
Delete Authorization Group

Delete an VCF Operations Orchestrator's authorization group.
PUT
Add Reference To Group

Creates an VCF Operations Orchestrator's authorization group.
DELETE
Remove Reference From Group

Delete an VCF Operations Orchestrator's authorization group.
GET
Get All

Retrieve the VCF Operations Orchestrator's authorization groups.
POST
Create Authorization Group

Creates an VCF Operations Orchestrator's authorization group.
Catalog Service
GET
List Object Tags

A REST endpoint to retrieve tags attached to an element.
POST
Tag Object

A REST endpoint for attaching tag to entity.
GET
List Namespaces

A REST endpoint for listing all catalog entry points. Each VCF Operations Orchestrator plug-in exposes its own catalog entry point that is accessible at /catalog/{pluginname}. The VCF Operations Orchestrator server exposes a separate catalog entry point that is accessible at /catalog/System
GET
Find Root Element

A REST endpoint for retrieving the root elements in a namespace. All VCF Operations Orchestrator plug-ins that have an inventory, usually provide a single root element. The VCF Operations Orchestrator server does not have a single root. Instead, for the System namespace, the VCF Operations Orchestrator REST API returns a list that contains links to all system types (workflows, tasks, etc.)
GET
Find Simple List Query

If the request is successful, the API responds with an HTTP 200 OK status code and the requested list of objects
GET
Find By Id

A REST endpoint for retrieving an element by its type and ID. All VCF Operations Orchestrator objects can be accessed or identified by their unique combination of namespace, type and ID.
GET
Download Icon For Type

All types that a VCF Operations Orchestrator plug-in defines, and the system types that the VCF Operations Orchestrator server defines, have default icon images. If the request is successful, the API responds with an HTTP 200 OK status code and the requested icon image as a downloadable attachment that has an 'image/png' MIME type.
GET
Find By Relation

Every VCF Operations Orchestrator plug-in can define relations between its types. For example, hierarchy structures can be defined as 'CHILDREN' relations between parent and children types. If the request is successful, the API responds with an HTTP 200 OK status code and a list containing the child objects that are accessible through a given relation, if any.
GET
Fetch Plugin Metadata

Plug-in metadata contains information about the types that this plug-in defines and their attributes or relations.
GET
Download Icon For Module

If the request is successful, the API responds with an HTTP 200 OK status code and the requested icon image as a downloadable attachment that has an 'image/png' MIME type.
DELETE
Untag Object

To remove global tag form entity tag name must be prefixed with ":".
Category Service
GET
Get Category

Endpoint for retrieving details for a category.
PUT
Update Category

Updates the category with the given ID. The type of the category can't be changed.
POST
Add Child Category

Endpoint for adding child categories.
DELETE
Delete Category

Deletes a category with a given ID.
GET
List Categories

Endpoint for retrieving all categories.
POST
Add Root Category

Endpoint for adding categories in root.
Change Log Controller
GET
Get Content Updates
Configuration Service
GET
Get Configuration

Retrieves the definition of a configuration. The returned definition contains base data for the configuration. When a request is sent to this endpoint with "application/vcoobject+xml" as the desired response content type, this operation is the equivalent of "Export configuration": Exports a configuration by its ID. If the request is successful, the configuration binary content is available in the body of the response message. It is up to the client application to properly fetch and process this attachment, for example, by saving it to the local file system. The exported configuration has the same internal format as the configurations exported by using the VCF Operations Orchestrator client.
PUT
Update Configuration

Update а configuration.
DELETE
Delete Configuration

Deletes a configuration with a given ID. If the configuration is referenced by some workflow it is considered to be 'in use' and the delete operation will fail, unless the 'force' option is provided.
GET
List All Configurations

Retrieves a list of all configurations.
POST
Create Configuration

Creates new configuration. When a request is sent to this endpoint with "multipart/form-data" as the request body content type, this operation is equivalent to "Import configuration": Imports configuration in a given category. The configuration binary content should be available as multi-part content (see RFC-2387 for details). Details of working with multi-part resources depend on the used client's HTTP/REST library. For example, in Spring it will look like:

Sample client code:
-------------------
String url = "https://localhost:8281/vco/api/configurations/";
MultiValueMap parts = new LinkedMultiValueMap();
Resource r = new FileSystemResource("D:/path/to/some.vsoconf");
parts.put("file", Arrays.asList(r));
parts.put("categoryId", "828080808080808080808080808080807F818080013217004819830adebdb10ea");
new RestTemplate().postForLocation(url, parts);
-------------------

GET
Find Configuration Dependencies

Retrieves a list of dependencies for the given configuration
Content Service
POST
GET
List All Packages 1

Returns a list of all deployed packages.
POST
POST
GET
List Content Types

Returns links to entity type that can be exported, imported, or deleted from the VCF Operations Orchestrator database content. Currently, only packages, workflows, and actions are supported. Other VCF Operations Orchestrator objects, for example resources, can be imported or exported by wrapping them inside a package.
GET
List Workflows

Returns a list of all deployed workflows.
GET
Export Workflow

Exports a package by its ID. If the request is successful, the package binary content is available as an attachment with MIME type application/zip (that is, a normal ZIP file) with a default file name {workflowname}.workflow. It is up to the client application to properly fetch and process this attachment, for example by saving it to the local file system. The exported package has the same internal format as the workflows exported by using the VCF Operations Orchestrator client.
DELETE
Delete Workflow 1

Deletes a workflow with a given ID. If the workflow is referenced by some other workflows, or is running, it is considered to be 'in use' and the delete operation will fail, unless the 'force' option is provided.
GET
Export Package 1

Exports a package by its name. If the request is successful, the package binary content is available as an attachment with MIME type application/zip (that is, a normal ZIP file) with a default file name {packagename}.package. It is up to the client application to properly fetch and process this attachment, for example by saving it to the local file system. The exported package has the same internal format as the packages exported by using the VCF Operations Orchestrator client
DELETE
Delete Package 1

Deletes a package with a given name. If a package has some content (workflows, actions or other elements put inside it), it is considered to be 'in use' and the delete operation will fail, unless the 'force' option is provided.
GET
List Actions

Returns a list of all deployed actions.
GET
Export Action

Export an action by its fully qualified name (category name + action name). If the request is successful, the action binary content is available as attachment with MIME type application/zip (that is, a normal ZIP file) with a default file name {actionname}.action. It is up to the client application to properly fetch and process this attachment, for example by saving it to the local file system. The exported action has the same internal format as the actions exported by using the VCF Operations Orchestrator client.
DELETE
Delete Action

Deletes an action with a given fully qualified name. If the action is referenced by some workflows, it is considered to be 'in use' and the delete operation will fail, unless the 'force' option is provided.
Content Version Controller
GET
Get Workflow History
POST
Create Workflow Changeset
GET
Get Resource History
POST
Revert Resource To Changeset
GET
Get Policy Template History
POST
Revert Policy Template To Changeset
GET
Get Package History
POST
Revert Package To Changeset
GET
Get Configuration History
POST
Revert Configuration To Changeset
GET
Get Action History
POST
Revert Action To Changeset
GET
Get Workflow For Commit
GET
Get Resource For Commit
GET
Get Policy Template For Commit
GET
Get Dunes Object Link For Commit
GET
Get Package For Commit
GET
List Deleted Objects
GET
Get Workflow For Commit From Remote Repository
GET
Get Resource For Commit From Remote Repository
GET
Get Policy Template For Commit From Remote Repository
GET
Get Dunes Object Link For Commit From Remote Repository
GET
Get Package For Commit From Remote Repository
GET
Get Configuration For Commit From Remote Repository
GET
Get Action For Commit From Remote Repository
GET
Get Action For Commit From Remote Repository 1
GET
Get Configuration For Commit
GET
Get Action For Commit
GET
Get Action For Commit 1
Custom Event Service
POST
Send Custom Event

Send custom event.
Debugger Service
GET
Get Workflow Breakpoints

Retrieves the breakpoints for a workflow
POST
Set Workflow Breakpoints

Sets multiple breakpoints for a workflow
DELETE
Remove All Workflow Breakpoints

Removes all set breakpoints for a workflow
POST
Set Workflow Breakpoint

Sets a single breakpoint for a workflow
POST
Step Return Workflow

StepReturn the workflow execution
POST
Step Over Workflow

Step over the workflow execution. Moves the debugger to the next item.
POST
Step Into Workflow

Step into the workflow execution
POST
Resume Workflow

Resumes the workflow execution
POST
Change Slot Entry

Changes the value of a variable while stopped on a breakpoint.
POST
Eval Script

Evaluate a script on the current debug location of the workflow execution.
GET
Get Debugger Enabled

Retrieves the current global debugger state
POST
Set Debugger Enabled

Sets the global debugger state
GET
Get Workflow Debug Location

Retrieves the current debugger location for a requested workflow run
GET
Get Script Slot Entries

Retrieve the variables in the current debug location of the workflow execution.
GET
Get Workflow Debugger Enabled

Retrieves the debugger mode for a requested workflow run
GET
Get Debug Configuration

Applicable only for supported runtimes
Feature Service
GET
System

Retrieves the available system features.
GET
All

Retrieves the available features.
Forms Service
GET
Get

Get form by item id
PUT
Update

Update form.
POST
Create 1

Create a form.
DELETE
Delete

Delete a form.
GET
Get 1

Get form by item id
PUT
Update 1

Update form.
DELETE
Delete 1

Delete a form.
GET
Get All Forms Form Workflow

Get all forms for a workflow.
POST
Create

Create a form.
POST
Execute All For Item

Execute item with a form.
POST
Execute All

Execute all items with their forms.
GET
Get Context

Get the evaluation context of an item.
GET
Get Context 1

Get the evaluation context of an item.
GET
Get User Interaction 1

Get user interaction form.
GET
Get Context 2

Get user interaction evaluation context.
Inventory Service
GET
Browse Inventory Path

If the request is successful, the API responds with an HTTP 200 OK status code and a list containing the child objects that are located at this hierarchy level. The user can navigate hierarchy using 'up'/'down' links in the result. If there is no 'up' link, you are at the root level. If there is no 'down' link, you have reached a leaf object which is not a parent or other objects in this hierarchy. Depending on the level where you invoke the service, the results should be interpreted differently.
Logs Service
GET
Get Log Configuration

Returns a list of all logs settings.
POST
Update Log Configuration

Updates the log configuration.
Packages Service
GET
Export Package

Exports a package by its name. If the request is successful, the package binary content is available as attachment with MIME type application/zip (that is, a normal ZIP file) with a default file name {packagename}.package<. It is up to the client application to properly fetch and process this attachment, for example by saving it to the local file system. The exported package has the same internal format as the packages exported by using the VCF Operations Orchestrator client. When a request is sent to this endpoint with "application/xml" or "application/json" as the desiredresponse content type, this operation is the equivalent to "": Returns details of the package, with list all contained workflows and actions.
PUT
Create Package

Create new package.
DELETE
Delete Package

Deletes a package with a given name.

Takes 3 options for deleting a package:

  • deletePackage - deletes the package without the content
  • deletePackageWithContent - deletes the package along with the content. If other packages share elements with this package, they will be deleted
  • deletePackageKeepingShared - deletes the package along with the content. If other packages share elements with this package, the elements will not be removed.

If no option parameter is provided, the default one is used: deletePackage
PATCH
Update Package

Update package.
PUT
Increment Version

Updates the version of the elements in a package
GET
List All Packages

Returns a list of all deployed packages.
POST
POST
Add Workflow Category To Package

Add all workflows from given category and its subcategories to package
POST
Add Workflow To Package

Add workflow and its dependencies to package
POST
Add Resource Category To Package

Add all resource elements from resource category and its children to package
POST
Add Resource Element To Package

Add resource element and its dependencies to package
POST
Rebuild Package

Rebuild package.
POST
Add Environment Repository To Package

Add environment repository to package
POST
Add Environment To Package

Add environment to package
POST
Add Configuration Element Category To Package

Recursive add configuration category resources to package
POST
Add Configuration Element To Package

Add configuration element and its dependencies to package
POST
Add Action To Package

Add action and its dependencies to package
POST
Add Actions To Package

Add all actions and its dependencies from given category to package
POST
POST
Get Import Package Details 1
POST
GET
Export Troubleshooting Data
DELETE
Delete Workflow Element

Delete workflow element
DELETE
Delete Resource Element

Delete resource element
DELETE
Delete Configuration Element

Delete configuration element
DELETE
Delete Action Element

Delete action element
Plug In Service
POST
Create Plugin Installation

Creates a pending plug-in installation and returns the contents of the package
GET
List All Plugins

Retrieves all installed plug-ins
DELETE
Delete Plugins

Marks the plug-ins with matching IDs. for removal
PATCH
Patch Plugins

Updates the log level and/or state of matching plug-ins
GET
Get Plugin Installation

Retrieves a pending plug-in installation and returns the contents of the package
DELETE
Cancel Plugin Installation

Cancels a plug-in installation with a matching ID
PATCH
Finish Plugin Installation

Confirm or reject the pending plug-in install
GET
Download Plugin 1

Retrieves an installed plug-in's metadata
DELETE
Delete Plugin

Marks the plug-in with matching ID for removal
GET
Get Plugin Icon

Retrieves an installed plug-in's icon
GET
Get Plugin Installation Entry Icon

Retrieves the icon of a plugin from the installation package with the provided id
Policy Service
GET
Get Policy

Get policy
PUT
Update Policy

Updates the policy. Can be used to set startup behavior and priority
DELETE
Delete Policy

Delete policy
GET
Get Policy State

Get policy state
PUT
Update Policy State

Updates the policy state. Can be used to start or stop a policy
GET
Get Policy Template

Get policy template When a request is sent to this endpoint with a desired response content type of "application/vcoobject+xml", this operation is the equivalent to "Export policy template": Exports a policy template by its ID. If the request is successful, the policy template xml content is available in the body of the response message. It is up to the client application to properly fetch and process this attachment, for example, by saving it to the local file system
PUT
Update Policy Template

Update policy template
DELETE
Delete Policy Template

Delete policy template
GET
Get All Policies

Get all policies
POST
Create Policy

Create policy
GET
Get All Policy Templates

Get all policy templates
POST
Create Policy Template

Create policy template
GET
Get Policy Logs

Policy information about each individual event that occurs when a policy is active. When a request is sent to this endpoint with "application/zip" as the desired response content type, this operation is equivalent to "Export all policy logs": Export all policy information about each individual event that occurs when a policy is active.
GET
Find Policy Template Usages

Retrieves a list of usages for the given policy template
GET
Find Policy Template Dependencies

Retrieves a list dependencies for the given policy template
GET
Get Policies For State

Get all policies in state
Repository(version Control) Service
GET
Get Content Repositories
POST
Create Content Repository
POST
Validate 1
POST
Create Reset Request
POST
Create Reset Request 1
POST
Create Push Request
POST
Create Push Request 1
POST
Create Pull Request
POST
Create Pull Request 1
POST
Create Initialize Remote Request
POST
Create Export Folders Request
POST
Create Branch Request
GET
Get Content Repository
GET
Get Branches
GET
Get Local State
GET
Get Request
GET
Get Request 1
GET
Get Request 2
GET
Get Request 3
GET
Get Request 4
GET
Get Request 5
GET
Get Request 6
GET
Get Request 7
GET
Get Public Keys
GET
Get Remote History
GET
Get Commit
Resource Service
GET
Get Resource

The returned definition contains base data for the resource. When this endpoint is called with the MIME type of the specified resource as the desired response content type, this operation is the equivalent of "Export resource": Exports a resource by its ID. If the request is successful, the resource binary content is available in the body of response message. It is up to the client application to properly fetch and process this attachment, for example by saving it to local file system. The exported resource has the same internal format as the resource exported using VCF Operations Orchestrator client.
PUT
Update Resource

Update resource metadata. Mime type can't be updated separately from content.
POST
Update Resource 1

Update resource content.
DELETE
Delete Resource

If the resource is referenced by some workflow, it is considered to be 'in use' and the delete operation will fail, unless the 'force' option is provided.
GET
List All Resources

Retrieves a list of all resources.
POST
Import Resource

Imports a resource in a given category. The resource binary content should be available as multi-part content (see RFC-2387 for details). Details of working with multi-part resources depend on the used client's HTTP/REST library. For example, in Spring it will look like:

Sample client code:
-------------------
String url = "https://localhost:8281/vco/api/resources/";
MultiValueMap parts = new LinkedMultiValueMap();
Resource r = new FileSystemResource("D:/path/to/some.vsoconf");
parts.put("file", Arrays.asList(r));
parts.put("categoryId", "828080808080808080808080808080807F818080013217004819830adebdb10ea");
new RestTemplate().postForLocation(url, parts);
-------------------

GET
Find Resource Usages

Retrieves a list of usages for the given resource
Server Configuration Service
GET
Get Server Configuration

Returns a human-readable representation of the VCF Operations Orchestrator server configuration.
POST
Import Server Configuration

Imports/exports the server configuration. The exported file is available as an attachment with MIME type application/zip. To perform an export request, an empty file must be attached to the request. Otherwise, the server tries to import a configuration.

The format of the exported or imported file is same as that of files exported or imported by using the VCF Operations Orchestrator configuration interface. The configuration binary content must be available as multi-part content (see RFC-2387 for details). Details of working with multi-part resources depend on the used client HTTP/REST library. For example, in Spring it will look like:

Sample client code that imports a server configuration:
 -----------------------
MultiValueMap parts = new LinkedMultiValueMap();
parts.add("file", new FileSystemResource("/path/to/vco_config_file.zip"))
;parts.add("password", "secret")
;parts.add("importIdentity", Boolean.FALSE);

getRestTemplate().postForEntity("https://localhost:8281/vco/api/server-configuration", parts, Void.class);
-----------------------

GET
Get O1 1n Types

Returns supported VCF Operations Orchestrator types.
GET
Get Settings

Get subset of the server configuration settings
GET
Get O1 1n Polyglot Runtimes

Returns supported VCF Operations Orchestrator Polyglot Runtimes.
GET
Get Scripting Api

Returns supported VCF Operations Orchestrator scripting API.
GET
Get Plugin Api

Returns supported VCF Operations Orchestrator scripting API for a plugin.
GET
Get Category Details

Returns supported VCF Operations Orchestrator scripting API for actions grouped by categories.
Service Descriptor Service
GET
Supported Api Versions

Currently, there is only one version.
GET
Get Xml Schema

The XSD schema file defines the elements and types used by the REST service. You can use it to generate stub classes (in Java or other programming language).
GET
Get Xml Schema 1

The XSD schema file defines the elements and types used by the REST service. You can use it to generate stub classes (in Java or other programming language)
GET
Health Status

A REST endpoint for retrieving server health status calculated on its health components (DB, authentication and etc.).
GET
Health Status Readiness

A REST endpoint for retrieving server readiness health status calculated on its health components (DB, authentication and etc.).
GET
Health Status Liveness

A REST endpoint for retrieving server liveness probe.
GET
Docs

Redirect '/vco/api/docs' to '/vco/api/docs/index.html'
GET
About Info

A REST endpoint for retrieving server build properties
GET
Enumerate Services 1

Lists the available top-level service entry points.
System Properties Service
GET
Get Properties

Gets the configured system properties and their values
POST
Update Properties

Updates the values and descriptions of the provided properties
DELETE
Delete Properties

Clears the provided system properties
GET
Get Advanced Properties

Gets advanced properties and their current values.
Tagging Service
GET
List Tag Owners

Returned list contains users created at least one tag. Global tags are listed under system user GLOBAL.
GET
List Tags By Owner

Retrieves list of tag created by specific user. Global tags are listed under system user GLOBAL.
DELETE
Untag Objects By Tag Name And Owner

Removes all tags created by specified owner.
GET
Get Tags By Tag Name And Owner

Retrieves list of tag instance created by specific user. Retrieved information is composed of reference to tagged object, tag name, tag value and is this instance global or private.
GET
List All Tags

Retrieves list of tag created by current and GLOBAL users.
GET
List All Tags By Dunes Type

Retrieves list of tags created GLOBAL users and type.
Task Service
GET
Get Tasks

Endpoint for retrieving all tasks.
POST
Create Task

Use this endpoint to schedule a new task.
GET
Get Task

Endpoint for retrieving a single task.
POST
Update Task

Use this endpoint to update an already scheduled task. If the scheduling date is changed, the original task is rescheduled. It is not allowed to update the scheduled workflow. To update the scheduled workflow, remove the current task and schedule a new one.
DELETE
Delete Task

Use this endpoint to delete a scheduled task.
PATCH
Update Task Credentials

Use this endpoint to update the credentials of an already scheduled task.

GET
Get Executions

Endpoint for retrieving all task executions until the current date.

Token Replay Controller
GET
Get Token Replay Data
GET
Get Token Replay Count
User Interaction Service
GET
Get All User Interactions

Returns a list of all user interactions.
User Search Service
PUT
Update User Search

Updates the user search with the id provided in the model with the model's data. Can be used to update recent search usage.
DELETE
Delete User Search

Deletes the user search with the provided ID
GET
Get User Searches

Retrieves a list user searches that correspond to the provided context
POST
Create User Search

The creates search is associated with the user making the request
User Service
GET
User Meta

Returns the solution user and whether the current user has admin rights as well as its member groups.
Vcf Operations Orchestrator Cluster Configuration And Runtime Data
GET
Execution Statistics

Endpoint for retrieving workflow statistics.
GET
Get Cluster Runtime
GET
Get Cluster Config
Vcf Operations Orchestrator Server Instance Service
GET
Enumerate Services

A REST endpoint for listing VCF Operations Orchestrator Server instance services.
GET
Get Users

A REST endpoint for getting all available users that can be used for setting permissions. If maxResult requestparameters is not used the groups returned will be limited to 50
GET
Get Groups

A REST endpoint for getting all available user groups that can be used for setting permissions. If maxResult request parameters is not used the groups returned will be limited to 50
GET
Get Authentication

Retrieve the VCF Operations Orchestrator Server Authentication configuration type and login url.
GET
Search For User And Groups By Criteria

Searches for users and groups by certain criteria.
Workflow Run Service
GET
Get All Executions For

Retrieves all workflow runs for a given workflow and filters by current user's permissions.
POST
Start Workflow Execution

Creates a new instance of a workflow's run, by using the passed parameters. The workflow run is an asynchronous, so the call does not return a response body.
GET
Get User Interaction

Retrieves user interaction details for a workflow run. If a workflow run with ID: executionId has a user interaction request, the workflow run is suspended until a user answers the interaction request. This API call returns the user interaction parameter, which has to be filled to answer it.
POST
Answer User Interaction

Answers a user interaction for a specific workflow run. If a workflow run with ID: executionId has a user interaction request, the workflow run is suspended until a user answers the interaction request. To answer a user interaction, use this API call with appropriate parameters.
DELETE
Cancel User Interaction

Cancel an user interaction for a specific workflow run.
GET
Get Workflow Execution

Retrieves a workflow run for a given workflow. When request parameter showDetails is set to true additional information will be retrieved. In this case the result contains current execution stack of the workflow run.
DELETE
Delete Workflow Execution

Deletes a specific workflow run
GET
Export Execution Logs 1

Provides logs generated by workflow scripting and system events.
GET
Get Workflow Execution Statistics

Retrieves statistics for given workflow run.
GET
Get Workflow Execution State

Retrieves the current state for a requested workflow run
DELETE
Cancel Workflow Execution

Cancels a workflow run
GET
Get Workflow Execution Logs

Provides information about each individual event that occurs when the workflow runs. This information includes a description of the event, the user who triggered it, the type and origin of the event, and the time and date when it occurred.
Workflow Service
GET
Get Workflow Schema

The schema data is returned and response Content-type is set to correct media type, for example "Content-Type:application/json"
PUT
Update Workflow Schema Content

Updates workflow's schema for a given workflow ID and schema
PUT
Validate

Validate provided workflow content
GET
Get All Workflows

Get all workflows
POST
Create Workflow

Creates new workflow. When a request is sent to this endpoint with "application/octet-stream" or "multipart/form-data" as the value for the Content-Type header this operation is equivalent to "Import/upload a workflow": Imports a workflow in a given category. The workflow binary content should be available as multi-part content (see RFC-2387 for details).
Details of working with multi-part resources depend on the used client HTTP/REST library. For example, in Spring it will look like:

Sample client code:-------------------String url = "https://localhost:8281/vco/api/workflows/";MultiValueMap parts = new LinkedMultiValueMap();Resource r = new FileSystemResource("D:/path/to/some.workflow");parts.put("file", Arrays.asList(r));parts.put("categoryId", "");new RestTemplate().postForLocation(url, parts); -------------------

GET
Validate Existing

Validate existing workflow by workflow id
GET
Get All Tasks For Workflow

Retrieves all scheduled tasks for a requested workflow.
GET
Get All User Interactions For Workflow

Retrieves all user interactions for a requested workflow.
GET
Get Workflow

The returned definition contains base data for the workflow, as well the input and output parameter definitions. It also has links to the workflow presentation and workflow category in which this workflow is located.

To retrieve the input and output parameter definitions localized, add Accept-Language header, with the appropriate locale. In advance, localization resource should be present for the workflow, otherwise it defaults to the standard input and output parameter definitions.

When a request is sent to this endpoint with "" or "" as the desired response content type, this operation is the equivalent to "Export/Download a workflow": Exports a workflow by its ID. If the request is successful, the workflow binary content is available as an attachment with MIME type application/zip (that is, a normal ZIP file) with a default file name {workflowname}.workflow. It is up to the client application to properly fetch and process this attachment, for example by saving it to local file system. The exported workflow has the same internal format as the workflows exported by using the VCF Operations Orchestrator client.
GET
Find Workflow Usages

Retrieves a list of usages for the given workflow
GET
Get Workflow Schema Image

The icon's schema image binary data is returned and response Content-type is set to correct media type, for example "Content-Type:image/png"
GET
Download Workflow Icon

The icon's binary data is returned and response Content-type is set to correct media type, for example "Content-Type:image/png"
GET
Find Workflow Dependencies

Retrieves a list of dependencies for the given workflow
DELETE
Delete Workflow

Deletes a workflow with a given ID. If the workflow is referenced by some other workflows, or is running, it is considered to be 'in use' and the delete operation will fail, unless the 'force' option is provided.