Property Collector Continue Retrieve Properties Ex

Property Collector Continue Retrieve Properties Ex

Retrieves additional results from a retrieval started by RetrievePropertiesEx on the same session on the same PropertyCollector.

Required privileges: System.Read

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/PropertyCollector/{moId}/ContinueRetrievePropertiesEx
COPY
Path Parameters
string
moId
Required

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

string
release
Required

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

Request Body
ContinueRetrievePropertiesExRequestType of type(s) application/json
Required 
{
    "token": "string"
}
string
token
Required

the token returned in the previous RetrieveResult returned on the same session by the same PropertyCollector.

Authentication
This operation uses the following authentication methods.
Responses
200

retrieved objects.

Returns RetrieveResult of type(s) application/json
This response body class contains all of the following: DataObject 
{
    "_typeName": "string",
    "token": "string",
    "objects": [
        {
            "_typeName": "string",
            "obj": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "propSet": [
                {
                    "_typeName": "string",
                    "name": "string",
                    "val": {
                        "_typeName": "string"
                    }
                }
            ],
            "missingSet": [
                {
                    "_typeName": "string",
                    "path": "string",
                    "fault": {
                        "_typeName": "string",
                        "faultCause": "MethodFault Object",
                        "faultMessage": [
                            {
                                "_typeName": "string",
                                "key": "string",
                                "arg": [
                                    {
                                        "_typeName": "string",
                                        "key": "string",
                                        "value": {
                                            "_typeName": "string"
                                        }
                                    }
                                ],
                                "message": "string"
                            }
                        ]
                    }
                }
            ]
        }
    ]
}
string
token
Optional

A token used to retrieve further retrieve results.

If set, the token should be passed to PropertyCollector.ContinueRetrievePropertiesEx to retrieve more results. Each token may be passed to continueRetrievePropertiesEx only once, and only in the same session in which it was returned and to the same PropertyCollector object that returned it.

If unset, there are no further results to retrieve after this RetrieveResult.

array of ObjectContent
objects
Required

retrieved objects.


500

InvalidArgument: If the token does not match the token from the previous RetrieveResult returned on the same session by the same PropertyCollector.

Returns InvalidProperty of type(s) application/json
This response body class contains all of the following: MethodFault 
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ],
    "name": "string"
}
string
name
Required

The property name that generated the error.


On This Page
Property Collector Operations
POST
Property Collector Cancel Retrieve Properties Ex
POST
Property Collector Cancel Wait For Updates
POST
Property Collector Check For Updates
POST
Property Collector Continue Retrieve Properties Ex
POST
Property Collector Create Filter
POST
Property Collector Create Property Collector
POST
Property Collector Destroy Property Collector
GET
Property Collector Get Filter
POST
Property Collector Retrieve Properties
POST
Property Collector Retrieve Properties Ex
POST
Property Collector Wait For Updates
POST
Property Collector Wait For Updates Ex