NSX-T Data Center REST API

EmbeddedResource (type)

{
  "abstract": true,
  "extends": {
    "$ref": "RevisionedResource"
  },
  "id": "EmbeddedResource",
  "module_id": "Common",
  "polymorphic-type-descriptor": {
    "property-name": "resource_type"
  },
  "properties": {
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
      "items": {
        "$ref": "ResourceLink"
      },
      "readonly": true,
      "title": "References related to this resource",
      "type": "array"
    },
    "_owner": {
      "$ref": "OwnerResourceLink",
      "readonly": true,
      "title": "Owner of this resource"
    },
    "_revision": {
      "computed": true,
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
      "title": "Generation of this resource config",
      "type": "int"
    },
    "_schema": {
      "readonly": true,
      "title": "Schema for this resource",
      "type": "string"
    },
    "_self": {
      "$ref": "SelfResourceLink",
      "readonly": true,
      "title": "Link to this resource"
    },
    "description": {
      "can_sort": true,
      "maxLength": 1024,
      "title": "Description of this resource",
      "type": "string"
    },
    "display_name": {
      "can_sort": true,
      "description": "Defaults to ID if not set",
      "maxLength": 255,
      "title": "Identifier to use when displaying entity in logs or GUI",
      "type": "string"
    },
    "id": {
      "description": "Identifier of the resource",
      "readonly": true,
      "required": false,
      "type": "string"
    },
    "resource_type": {
      "description": "The type of this resource.",
      "readonly": false,
      "type": "string"
    }
  },
  "title": "Base class for resources that are embedded in other resources",
  "type": "object"
}