REST API - filter

vcenter folder: filter spec

The filter_spec structure contains fields used to filter the results when listing folders (see list). If multiple fields are specified, only folders matching all of the fields match the filter.

Representations:

JSON
XML

{
    "datacenters": [
        "obj-103",
        "obj-103"
    ],
    "folders": [
        "obj-103",
        "obj-103"
    ],
    "names": [
        "string",
        "string"
    ],
    "parent_folders": [
        "obj-103",
        "obj-103"
    ],
    "type": "DATACENTER"
}

<?xml version="1.0" ?>
<ns0:FilterSpec xmlns:ns0="http://vmware.com/vcenter/folder" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <datacenters-array>
    <array-item>obj-103</array-item>
    <array-item>obj-103</array-item>
  </datacenters-array>
  <names-array>
    <array-item>string</array-item>
    <array-item>string</array-item>
  </names-array>
  <folders-array>
    <array-item>obj-103</array-item>
    <array-item>obj-103</array-item>
  </folders-array>
  <parent_folders-array>
    <array-item>obj-103</array-item>
    <array-item>obj-103</array-item>
  </parent_folders-array>
  <type>DATACENTER</type>
</ns0:FilterSpec>

Attributes:

Name	Type	Description
Optional
folders	string[]	Identifiers of folders that can match the filter. Optional. If unset or empty, folders with any identifier match the filter.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: `Folder`. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: `Folder`.
names	string[]	Names that folders must have to match the filter (see vcenter.folder.summary.name). Optional. If unset or empty, folders with any name match the filter.
type	string	Type that folders must have to match the filter (see vcenter.folder.summary.type). Optional. If unset, folders with any type match the filter.
parent_folders	string[]	Folders that must contain the folder for the folder to match the filter. Optional. If unset or empty, folder in any folder match the filter.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: `Folder`. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: `Folder`.
datacenters	string[]	Datacenters that must contain the folder for the folder to match the filter. Optional. If unset or empty, folder in any datacenter match the filter.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: `Datacenter`. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: `Datacenter`.