Get Associations

Get Associations

Returns information about resources that are associated with the given resource. Id and type of the resource for which associated resources are to be fetched are to be specified as query parameter in the URI. Resource type of the associated resources must be specified as query parameter.

Request
URI
GET
https://nsxmanager.your.domain/api/v1/associations
COPY
Query Parameters
string
included_fields
Optional

Comma separated list of fields that should be included to result of query

string
associated_resource_type
Required

Resource type valid for use as target in association API

string
resource_id
Required

The resource for which associated resources are to be fetched

boolean
fetch_ancestors
Optional

Fetch complete list of associated resources considering containment and nesting

integer
page_size
Optional

Maximum number of results to return in this page (server may return fewer)

string
sort_by
Optional

Field by which records are sorted

string
cursor
Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

boolean
sort_ascending
Optional

sort_ascending

string
resource_type
Required

Resource type valid for use as source in association API

Possible values are : NSGroup, IPSet, MACSet, LogicalSwitch, LogicalPort,
Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns AssociationListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineAssociationListResult1 
{
    "_self": {
        "rel": "string"
    },
    "cursor": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "sort_ascending": false,
    "result_count": 0,
    "_schema": "string",
    "sort_by": "string",
    "results": [
        {
            "target_display_name": "string",
            "is_valid": false,
            "target_id": "string",
            "target_type": "string"
        }
    ]
}

default

Unexpected error

Returns ApiError of type(s) application/json 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
string
module_name
Optional

module_name

string
error_message
Optional

error_message

integer As int64 As int64
error_code
Optional

error_code


On This Page
Associations Operations
GET
Get Associations