Auto Complete Search

Auto Complete Search

This API will provide auto-complete functionality for the filters provided on Potential Malware screen. This API will return the records matching the pattern string entered for the specific filter. If the user does not enter any value, then this API will return all unique records. This API will return maximum 10,000 unique records for any specified filter. Pagination is supported in the window upto 10,000 records.

Request
URI
POST
https://api.example.com/napp/api/v1/malware-prevention/auto-complete/search
COPY
Query Parameters
string
cursor
Optional

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

integer
page_size
Optional

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

boolean
sort_ascending
Optional

Sort records by ascending order.

string
sort_by
Optional

Conveys the key on which we want to provide the auto-complete functionality.

Possible values are : MALWARE_CLASS, MALWARE_FAMILY, FILE_TYPE,

Request Body

Auto-Complete Request

AutoCompleteRequest of type(s) application/json
Required
{
    "field_name": "string",
    "value": "string",
    "case_sensitive": false
}
string
field_name
Optional

Field to be filtered on.

Possible values are : MALWARE_CLASS, MALWARE_FAMILY, FILE_TYPE,
string
value
Optional

Filter value.

boolean
case_sensitive
Optional

Conveys if the value is case-sensitive or not.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

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