Application Url (risksense_api.__subject.__application_urls.__application_urls)

Application Url module defined for different application url related api endpoints.

class risksense_api.__subject.__application_urls.__application_urls.ApplicationUrls(profile)

Bases: Subject

ApplicationUrl class

__init__(profile)

Initialization of ApplicationUrl object.

Parameters:

profile – Profile Object

get_model(client_id=None)

Get available projections and models for ApplicationUrl.

Parameters:

client_id (typing.Optional[int]) – Client ID

Return type:

dict

Returns:

ApplicationUrl projections and models are returned.

Examples

To get model for application url using get_model() function

>>> self.{risksenseobject}.application_url.get_model()

list_applicationurl_filter_fields(client_id=None)

List filter endpoints.

Parameters:

• filter_subject – Supported Subjects are:

• client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Return type:

list

Returns:

The JSON output from the platform is returned, listing the available filters.

Examples

>>>  self.{risksenseobject}.application_url.list_applicationurl_filter_fields()

suggest(search_filter_1, search_filter_2, client_id=None)

Suggest values for filter fields.

Parameters:

• search_filter_1 (list) – Search Filter 1

• search_filter_2 (dict) – Search Filter 2

• client_id (typing.Optional[int]) – Client ID

Return type:

list

Returns:

Value suggestions

Example

To use suggest function is

>>> self.{risksenseobject}.application_url.suggest([],{})

get_single_search_page(search_filters, page_num=0, page_size=150, sort_field='id', sort_dir='ASC', client_id=None)

Searches for and returns application url data based on the provided filter(s) and other parameters.

Parameters:

• search_filters (list) – List of dictionaries containing filter parameters.

• page_num (int) – Page number of results to be returned.

• page_size (int) – Number of results to be returned per page.

• sort_field (str) – Name of field to sort results on.

• sort_dir (str) – Direction to sort. SortDirection.ASC or SortDirection.DESC

• client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Return type:

dict

Returns:

The paginated JSON response from the platform is returned.

Example

An example to get single search page of application url data

>>> self.{risksenseobject}.application_url.get_single_search_page([])

You can also try changing the other arguments to your liking to reflect the data as you suffice such as change page_size or page_num etc.

>>> self.{risksenseobject}.application_url.get_single_search_page([],page_num=2,page_size=10)

search(search_filters, page_size=150, sort_field='id', sort_dir='ASC', csvdump=False, client_id=None)

Searches for and returns application url based on the provided filter(s) and other parameters. Rather than returning paginated results, this function cycles through all pages of results and returns them all in a single list.

Parameters:

• search_filters (list) – A list of dictionaries containing filter parameters.

• page_size (int) – The number of results per page to be returned.

• sort_field (str) – The field to be used for sorting results returned.

• csvdump (bool) – Dumps the data in csv

• sort_dir (str) – The direction of sorting to be used. SortDirection.ASC or SortDirection.DESC

• client_id (typing.Optional[int]) – Client ID. If an ID isn’t passed, will use the profile’s default Client ID.

Return type:

list

Returns:

A list containing all application url returned by the search using the filter provided.

Example

An example to search for application url data is

>>> self.{risksenseobject}.application_url.search([])

Note

You can also dump the search based data in a csv by simply providing csvdump=True argument

>>> self.{risksenseobject}.application_url.search([],csvdump=True)