dtc:topology:label : DTC Topology Label object.

This is the label of the field in the Topology database.

Object Reference

References to dtc:topology:label are object references.

The name part of a DTC Topology Label object reference has the following components:

  • Field of DTC Topology label
  • Label of DTC Topology label

Example: dtc:topology:label/ZG5zLm5ldHdvcmtfdmlldyQxMTk:CONTINENT/Africa

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • Modify (update)
  • Permissions
  • 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): field, label.

field

field

The name of the field in the Topology database the label was obtained from.

Type

String.

Valid values are:
  • CITY
  • CONTINENT
  • COUNTRY
  • EA0
  • EA1
  • EA2
  • EA3
  • SUBDIVISION
  • SUBNET

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The field is part of the base object.

The field cannot be updated.

field cannot be written.

label

label

The DTC Topology label name.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The label is part of the base object.

The label cannot be updated.

label cannot be written.

Fields List

Field Type Req R/O Base Search
field String N Y Y =
label String N Y Y : = ~