Property Filter Get Spec

Specifications for this filter.

Request

URI

GET

https://{vcenter-host}/sdk/vim25/{release}/PropertyFilter/{moId}/spec

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case PropertyFilter/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns PropertyFilterSpec of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "propSet": [
        {
            "_typeName": "string",
            "type": "string",
            "all": false,
            "pathSet": [
                "string"
            ]
        }
    ],
    "objectSet": [
        {
            "_typeName": "string",
            "obj": {
                "type": "string",
                "value": "string"
            },
            "skip": false,
            "selectSet": [
                {
                    "_typeName": "string",
                    "name": "string"
                }
            ]
        }
    ],
    "reportMissingObjectsInResults": false
}

array of PropertySpec

propSet

Required

Set of properties to include in the filter, specified for each object type.

array of ObjectSpec

objectSet

Required

Set of specifications that determine the objects to filter.

boolean

reportMissingObjectsInResults

Optional

Control how to report missing objects during filter creation.

If false or unset and PropertyFilterSpec.objectSet refers to missing objects, filter creation will fail with a ManagedObjectNotFound fault.

If true and PropertyFilterSpec.objectSet refers to missing objects, filter creation will not fail and missing objects will be reported via filter results. This is the recommended setting when PropertyFilterSpec.objectSet refers to transient objects.

In an UpdateSet missing objects will appear in the PropertyFilterUpdate.missingSet field.

In a RetrieveResult missing objects will simply be omitted from the objects field.

For a call to PropertyCollector.RetrieveProperties missing objects will simply be omitted from the results.

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Property Filter Operations

POST