Echo Object Extensions

Trigger a dummy object extension(s) execution, outside of any particular workflow. This is meant to be used during extensions development for testing purposes. The payload sent/received to/from the extensions is of the Echo data structure from this api specification or one of the core object extensibility schema types.

Request

URI

POST

https://{api_host}/cloudapi/1.0.0/extensibility/echo/object-extensions/invocations

COPY

Request Body

EchoContext of type(s) application/json

Required

{
    "request": {
        "message": "string"
    },
    "selectors": [
        "string"
    ],
    "phase": "string",
    "invocationOrder": "string"
}

Echo

request

Optional

This object will be sent to the first selected extension. Example payload received/sent by the extension(s):

xml (namespaces excluded; applicable only to AMQP extensions):

  <Echo
    xmlns="http://www.vmware.com/vcloud/extensibility/v1.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.vmware.com/vcloud/extensibility/v1.0 https://127.0.0.1:8443/api/extensibility/v1.0/master.xsd">
      <message>Hello World</message>
  </Echo>

json (this will be the embedded payload in the HalfDuplexEnvelope in case of a channel extension):

{
  "message": "Hello World"
}

array of string

selectors

Optional

If there is a selector extension for example on urn:selector:organization and urn:selector:organizationVdc, you would pass an urn id of an organization and/or a urn id of one of its VDCs

string As ^urn:extensionPoint:.*$

phase

Optional

The phase represents the particular extension point of an actual workflow where object extensions will be executed, given there is a selector extension on that phase.

string As ^HIGHEST_PRIORITY_FIRST|LOWEST_PRIORITY_FIRST$

invocationOrder

Optional

The execution order when there are multiple selected extensions. It is determined based on this and the individual selector priorities.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

202

Accepted

Operation doesn't return any data structure

Availability