Create Action | VMware Cloud Foundation Operations Orchestrator API

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);
-------------------

Request

URI

POST

https://{api_host}/vco/api/actions

COPY

Query Parameters

boolean

uniqueName

Optional

Constraints: default: false

uniqueName

Request Body

Action of type(s) application/json

Required

Show optional properties

{
    "name": "string",
    "module": "string"
}

{
    "relations": {
        "startIndex": 0,
        "count": 0,
        "total": 0,
        "link": [
            {
                "rel": "string",
                "type": "string",
                "attributes": [
                    {
                        "name": "string",
                        "displayName": "string",
                        "value": "string",
                        "displayValue": "string"
                    }
                ],
                "href": "string"
            }
        ]
    },
    "id": "string",
    "name": "string",
    "module": "string",
    "description": "string",
    "version": "string",
    "fqn": "string",
    "script": "string",
    "runtime": "string",
    "outputParameterType": "string",
    "href": "string",
    "input-parameters": [
        {
            "name": "string",
            "type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
            "description": "string",
            "scope": "string",
            "updated": false,
            "encrypt-value": false
        }
    ],
    "output-type": "string",
    "iconId": "string",
    "bundleHasContent": false,
    "runtimeMemoryLimit": 0,
    "runtimeTimeout": 0,
    "entryPoint": "string",
    "actionEnvironmentId": "string",
    "actionEnvironmentName": "string",
    "validationMessage": "string"
}

object

relations

Optional

relations

string

Optional

string As ^[\p{L}_$][\p{L}0-9_$]*$

name

Required

name

string As ^[\p{L}_][\p{L}0-9_-]*(\.[\p{L}0-9_-]+)*$

module

Required

module

string

description

Optional

description

string

version

Optional

version

string

fqn

Optional

fqn

string

script

Optional

script

string

runtime

Optional

runtime

string

outputParameterType

Optional

outputParameterType

string

href

Optional

href

array of object

input-parameters

Optional

input-parameters

string

output-type

Optional

output-type

string

iconId

Optional

iconId

boolean

bundleHasContent

Optional

bundleHasContent

integer As int64 As int64

runtimeMemoryLimit

Optional

runtimeMemoryLimit

integer As int64 As int64

runtimeTimeout

Optional

runtimeTimeout

string

entryPoint

Optional

entryPoint

string

actionEnvironmentId

Optional

actionEnvironmentId

string

actionEnvironmentName

Optional

actionEnvironmentName

string

validationMessage

Optional

validationMessage

Authentication

This operation uses the following authentication methods.

BearerAuth

BasicAuth

Responses

201

The action was created successfully

Returns Action of type(s) application/json

"Action Object"

object

relations

Optional

relations

string

Optional

string As ^[\p{L}_$][\p{L}0-9_$]*$

name

Required

name

string As ^[\p{L}_][\p{L}0-9_-]*(\.[\p{L}0-9_-]+)*$

module

Required

module

string

description

Optional

description

string

version

Optional

version

string

fqn

Optional

fqn

string

script

Optional

script

string

runtime

Optional

runtime

string

outputParameterType

Optional

outputParameterType

string

href

Optional

href

array of object

input-parameters

Optional

input-parameters

string

output-type

Optional

output-type

string

iconId

Optional

iconId

boolean

bundleHasContent

Optional

bundleHasContent

integer As int64 As int64

runtimeMemoryLimit

Optional

runtimeMemoryLimit

integer As int64 As int64

runtimeTimeout

Optional

runtimeTimeout

string

entryPoint

Optional

entryPoint

string

actionEnvironmentId

Optional

actionEnvironmentId

string

actionEnvironmentName

Optional

actionEnvironmentName

string

validationMessage

Optional

validationMessage

202

Action successfully imported

Returns Action of type(s) application/json

"Action Object"

object

relations

Optional

relations

string

Optional

string As ^[\p{L}_$][\p{L}0-9_$]*$

name

Required

name

string As ^[\p{L}_][\p{L}0-9_-]*(\.[\p{L}0-9_-]+)*$

module

Required

module

string

description

Optional

description

string

version

Optional

version

string

fqn

Optional

fqn

string

script

Optional

script

string

runtime

Optional

runtime

string

outputParameterType

Optional

outputParameterType

string

href

Optional

href

array of object

input-parameters

Optional

input-parameters

string

output-type

Optional

output-type

string

iconId

Optional

iconId

boolean

bundleHasContent

Optional

bundleHasContent

integer As int64 As int64

runtimeMemoryLimit

Optional

runtimeMemoryLimit

integer As int64 As int64

runtimeTimeout

Optional

runtimeTimeout

string

entryPoint

Optional

entryPoint

string

actionEnvironmentId

Optional

actionEnvironmentId

string

actionEnvironmentName

Optional

actionEnvironmentName

string

validationMessage

Optional

validationMessage

400

The request is invalid

Returns Action of type(s) application/json

"Action Object"

object

relations

Optional

relations

string

Optional

string As ^[\p{L}_$][\p{L}0-9_$]*$

name

Required

name

string As ^[\p{L}_][\p{L}0-9_-]*(\.[\p{L}0-9_-]+)*$

module

Required

module

string

description

Optional

description

string

version

Optional

version

string

fqn

Optional

fqn

string

script

Optional

script

string

runtime

Optional

runtime

string

outputParameterType

Optional

outputParameterType

string

href

Optional

href

array of object

input-parameters

Optional

input-parameters

string

output-type

Optional

output-type

string

iconId

Optional

iconId

boolean

bundleHasContent

Optional

bundleHasContent

integer As int64 As int64

runtimeMemoryLimit

Optional

runtimeMemoryLimit

integer As int64 As int64

runtimeTimeout

Optional

runtimeTimeout

string

entryPoint

Optional

entryPoint

string

actionEnvironmentId

Optional

actionEnvironmentId

string

actionEnvironmentName

Optional

actionEnvironmentName

string

validationMessage

Optional

validationMessage

401

The user is not authorized

Returns Action of type(s) application/json

"Action Object"

object

relations

Optional

relations

string

Optional

string As ^[\p{L}_$][\p{L}0-9_$]*$

name

Required

name

string As ^[\p{L}_][\p{L}0-9_-]*(\.[\p{L}0-9_-]+)*$

module

Required

module

string

description

Optional

description

string

version

Optional

version

string

fqn

Optional

fqn

string

script

Optional

script

string

runtime

Optional

runtime

string

outputParameterType

Optional

outputParameterType

string

href

Optional

href

array of object

input-parameters

Optional

input-parameters

string

output-type

Optional

output-type

string

iconId

Optional

iconId

boolean

bundleHasContent

Optional

bundleHasContent

integer As int64 As int64

runtimeMemoryLimit

Optional

runtimeMemoryLimit

integer As int64 As int64

runtimeTimeout

Optional

runtimeTimeout

string

entryPoint

Optional

entryPoint

string

actionEnvironmentId

Optional

actionEnvironmentId

string

actionEnvironmentName

Optional

actionEnvironmentName

string

validationMessage

Optional

validationMessage

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"module:"string","name:"string"}' https://{api_host}/vco/api/actions

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

201 Response Body

202 Response Body

Errors

Actions Service Operations

PUT