Register Extension

Register Extension

Create a new object extension. Required right: "Object Extensions: Manage". Objects extensions are unique on:

  • (namespace, vendor) - these values are extracted from the channel urn
  • channel For further details, see the description of the data structure ObjectExtension.
Request
URI
POST
https://{api_host}/cloudapi/1.0.0/extensions/object-extensions
COPY
Request Body
ObjectExtension of type(s) application/json
Optional 
{
    "id": "string",
    "channel": {
        "name": "string",
        "id": "string"
    },
    "enabled": false,
    "selectorTypes": [
        "string"
    ]
}
string
id
Optional

The unique id of the extension

EntityReference
channel
Required

Entity reference used to describe VCD entities

boolean
enabled
Optional

Only enabled object extensions are considered for the workflow executions.

array of string
selectorTypes
Optional

An enum set of selector types to which this object extension can be applied. If not specified(missing, null or empty), this extension applies to any selector type. Valid selector types are:

  • urn:selector:providerVdc
  • urn:selector:organizationVdc
  • urn:selector:organization

Create a selector extension to assign an object extension to a group of- or particular objects of a selector type:

HTTP Verb Request URL Prototype Summary
POST host/api/admin/{type}/extension any object of the selector type(default policy)
POST host/api/admin/{type}/{selectorId}/extension specific object of the selector type(overriden policy)

where the mapping between the selector type and the type is:

Selector type type
urn:selector:providerVdc providervdcs
urn:selector:organizationVdc vdcs
urn:selector:organization orgs
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ObjectExtension of type(s) application/json;version=39.0 
{
    "id": "string",
    "channel": {
        "name": "string",
        "id": "string"
    },
    "enabled": false,
    "selectorTypes": [
        "string"
    ]
}
string
id
Optional

The unique id of the extension

EntityReference
channel
Required

Entity reference used to describe VCD entities

boolean
enabled
Optional

Only enabled object extensions are considered for the workflow executions.

array of string
selectorTypes
Optional

An enum set of selector types to which this object extension can be applied. If not specified(missing, null or empty), this extension applies to any selector type. Valid selector types are:

  • urn:selector:providerVdc
  • urn:selector:organizationVdc
  • urn:selector:organization

Create a selector extension to assign an object extension to a group of- or particular objects of a selector type:

HTTP Verb Request URL Prototype Summary
POST host/api/admin/{type}/extension any object of the selector type(default policy)
POST host/api/admin/{type}/{selectorId}/extension specific object of the selector type(overriden policy)

where the mapping between the selector type and the type is:

Selector type type
urn:selector:providerVdc providervdcs
urn:selector:organizationVdc vdcs
urn:selector:organization orgs

Availability
Added in 37.3
On This Page
Object Extension Operations
DELETE
Delete Extension
GET
Get Extension
GET
Get Object Extensions
POST
Register Extension
PUT
Update Extension