ApiFilterType

Element:
ApiFilter
Type:
ApiFilterType
Namespace:
http://www.vmware.com/vcloud/extension/v1.5
Description:
Represents an extension service API filter as a UrlPattern or a ResponseContentType.
Since:
5.1
Schema:
services.xsd
Media type(s):
application/vnd.vmware.admin.apiFilter+json
application/vnd.vmware.admin.apiFilter+xml
Extends:
IdentifiableResourceType
XML Representation:
<ApiFilter xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string">
    <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string"/>
    <UrlPattern> xs:string </UrlPattern>
    <ResponseContentType> xs:string </ResponseContentType>
</ApiFilter>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
href anyURI No always 5.1 The URI of the entity.
type string No always 5.1 The MIME type of the entity.
id string No none 5.1 The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.
operationKey string No create 5.1 Optional unique identifier to support idempotent semantics for create and delete operations.

Elements

Element Type Required Modifiable Since Deprecated Description
Link LinkType No none 5.1 A reference to an entity or operation associated with this object.
ResponseContentType string No always 5.1 Response Content-Type, expressed as a MIME Content-Type string. Responses whose Content-Type attribute has a value that matches this string are routed to the service. ResponseContentType is mutually exclusive with UrlPattern.
UrlPattern string No always 5.1 Request URL pattern, written as a regular expression pattern recognized by java.util.regex.Pattern. Requests matching the pattern are sent to this extension service. Element content cannot exceed 1024 characters. UrlPattern is mutually exclusive with ResponseContentType.
VCloudExtension VCloudExtensionType No always 5.1 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD Operation Description Since Deprecated
create POST /admin/extension/service/{id}/apifilters Creates API filter. 5.1
read GET /admin/extension/service/apifilter/{id} Retrieves API filter.
delete DELETE /admin/extension/service/apifilter/{id} Deletes API filter.