Search Entities

Search Entities

Using search API you can search vRealize Network Insight entities by specifying entity type and filter expression. A filter expression is a predicate expression (similar to SQL where clause) used to define the search criteria. Please refer to API Guide on details of how to construct filter expression. A successful search request will return a list of entity ids that matches the search criteria.

Request
URI
POST
https://vrni.example.com/api/ni/search
COPY
Request Body

Search Request

SearchRequest of type(s) application/json
Optional 
{
    "entity_type": "string",
    "filter": "string",
    "sort_by": {
        "field": "string",
        "order": "string"
    },
    "size": 0,
    "cursor": "string",
    "time_range": {
        "start_time": 0,
        "end_time": 0
    }
}
AllEntityType
entity_type
Optional

entity_type

string
filter
Optional

query filter

SortByClause
sort_by
Optional

sort_by

integer As int32 As int32
size
Optional

size

string
cursor
Optional

cursor

TimeRange
time_range
Optional

time_range

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns PagedListResponseWithTime of type(s) application/json 
{
    "results": [
        {
            "entity_id": "string",
            "entity_type": "string",
            "time": 0
        }
    ],
    "cursor": "ML12eu02==",
    "total_count": 100,
    "start_time": 1504739809,
    "end_time": 1504739809
}
array of EntityIdWithTime
results
Optional

results

string
cursor
Optional

cursor

integer
total_count
Optional

total_count

integer As int64 As int64
start_time
Optional

start_time

integer As int64 As int64
end_time
Optional

end_time


400

Bad Request

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


401

Unauthorized

Operation doesn't return any data structure

500

Internal Error

Operation doesn't return any data structure

On This Page
Search Operations
POST
Search Entities