smartfolder:children : Smart Folder children object.

The Smart Folder children object is used to read the objects that are associated with either a Smart Folder (global or personal) or a set of queries that users can make without saving a Smart Folder object on the appliance.

The Smart Folder children object can be used for both “filtering” and “grouping” the results of Smart Folder associated objects.

Object Reference

References to smartfolder:children are object references.

The name part of the Smart Folder object reference has the following components:

  • The ‘children’ string
Example:
smartfolder:children/ ZG5zLm9wdGlvbl9kZWZpbml0aW9uJGluZm8uLmZhbHNlLjI1Mg:children

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • Modify (update)
  • Read by object reference
  • Global search (searches via the search object)
  • Scheduling
  • CSV export

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): resource, value, value_type.

resource

resource

The object retuned by the Smart Folder query.

Type

String.

This field supports nested return fields as described here.

Search

The field is not available for search.

Notes

The resource is part of the base object.

The resource cannot be updated.

resource cannot be written.

value

value

The value returned by the Smart Folder query.

Type

A/An Smart Folder query item value structure struct.

Search

The field is not available for search.

Notes

The value is part of the base object.

The value cannot be updated.

value cannot be written.

value_type

value_type

The type of the returned value.

Type

String.

Valid values are:
  • BOOLEAN
  • DATE
  • EMAIL
  • ENUM
  • INTEGER
  • OBJTYPE
  • STRING
  • URL

Search

The field is not available for search.

Notes

The value_type is part of the base object.

The value_type cannot be updated.

value_type cannot be written.

Search-only Fields

These fields are used only for searching. They are not actual members of the object and therefore the server does not return these fields with this name unless they are nested return fields.

group_by_values

group_by_values

The Smart Folder query values groupping information.

Type

A/An Smart Folder group by value structure struct array.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

group_by_values is a search-only field.

group_bys

group_bys

The Smart Folder query groupping information.

Type

A/An Smart Folder group by structure struct array.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

group_bys is a search-only field.

query_items

query_items

The Smart Folder query parameters.

Type

A/An Smart Folder query item structure struct array.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

query_items is a search-only field.

smart_folder

smart_folder

The reference to a global or a personal Smart Folder.

Type

String.

This field supports nested return fields as described here.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

smart_folder is a search-only field.

Fields List

Field Type Req R/O Base Search
resource String N Y Y N/A
value struct N Y Y N/A
value_type String N Y Y N/A

Search-only Fields List

Field Type Search
group_by_values [struct] =
group_bys [struct] =
query_items [struct] =
smart_folder String =