NSX-T Data Center REST API

Get resources shared with a given org

Get the list of resource shared with a given org.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/orgs/<org-id>/shared-with-me

Request Headers:

n/a

Query Parameters:

SharedResourceListRequestParameters+

SharedResourceListRequestParameters (schema)

Name	Description	Type	Notes
resource_type	resource type	string

Request Body:

n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/orgs/default/shared-with-me

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

SharedResourceListResult+

SharedResourceListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	SharedResource list results	array of SharedResource	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

[{ "resourcePaths":[ { "resource_path": "/infra/domains/domain1/groups/group1", "include_children": false } ], "resource_type":"SharedResource", "id":"backup", "display_name":"backup", "path":"/infra/shares/default-org-share/resources/backup", "relative_path":"backup", "parent_path":"/infra/shares/default-org-share", "unique_id":null, "marked_for_delete":false, "overridden":false, "_create_user":"admin", "_system_owned":false, "_last_modified_user":"admin", "_create_time":1613559460360, "_last_modified_time":1613559460360, "_protection":"NOT_PROTECTED", "_revision":0 }]

Required Permissions:

read

Feature:

policy_share

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable