NSX-T Data Center REST API

AssociationListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "AssociationListRequestParameters", 
  "module_id": "Association", 
  "properties": {
    "associated_resource_type": {
      "$ref": "AssociationTargetType, 
      "required": true, 
      "title": "Type of the associated resources"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "fetch_ancestors": {
      "default": false, 
      "description": "If set to true, will fetch direct as well as indirect(considering containment as well as nesting) associated objects for the given source Id.", 
      "required": false, 
      "title": "Fetch complete list of associated resources considering\ncontainment and nesting\n", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "resource_id": {
      "required": true, 
      "title": "The resource for which associated resources are to be fetched", 
      "type": "string"
    }, 
    "resource_type": {
      "$ref": "AssociationSourceType, 
      "required": true, 
      "title": "Type of the resource for which associated resources are to be fetched"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "title": "Association list request parameters", 
  "type": "object"
}