openapi_client.ConfigurationPolicySiteListBuilderApi

All URIs are relative to /dataservice

Method	HTTP request	Description
create_default_site_list	POST /template/policy/list/site/defaultsite
create_policy_list32	POST /template/policy/list/site
delete_policy_list32	DELETE /template/policy/list/site/{id}
delete_policy_lists_with_info_tag32	DELETE /template/policy/list/site
edit_policy_list32	PUT /template/policy/list/site/{id}
get_lists_by_id32	GET /template/policy/list/site/{id}
get_policy_lists29	GET /template/policy/list/site
get_policy_lists_with_info_tag32	GET /template/policy/list/site/filtered
preview_policy_list32	POST /template/policy/list/site/preview
preview_policy_list_by_id32	GET /template/policy/list/site/preview/{id}

create_default_site_list

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_default_site_list()

Create default site list for sites missing from centralized policy

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_site_list_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        api_response = api_instance.create_default_site_list()
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicySiteListBuilderApi->create_default_site_list: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_policy_list32

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_policy_list32()

Create policy list

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_site_list_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client)
    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.create_policy_list32(body=body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicySiteListBuilderApi->create_policy_list32: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	{str: (bool, date, datetime, dict, float, int, list, str, none_type)}	Policy list	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_policy_list32

delete_policy_list32(id)

Delete policy list entry for a specific type of policy list

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_site_list_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client)
    id = "id_example" # str | Policy Id

    # example passing only required values which don't have defaults set
    try:
        api_instance.delete_policy_list32(id)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicySiteListBuilderApi->delete_policy_list32: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Policy Id

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_policy_lists_with_info_tag32

[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] delete_policy_lists_with_info_tag32()

Delete policy lists with specific info tag

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_site_list_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client)
    info_tag = "infoTag_example" # str | InfoTag (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.delete_policy_lists_with_info_tag32(info_tag=info_tag)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicySiteListBuilderApi->delete_policy_lists_with_info_tag32: %s\n" % e)

Parameters

Name	Type	Description	Notes
info_tag	str	InfoTag	[optional]

Return type

[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_policy_list32

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} edit_policy_list32(id)

Edit policy list entries for a specific type of policy list

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_site_list_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client)
    id = "id_example" # str | Policy Id
    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional)

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.edit_policy_list32(id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicySiteListBuilderApi->edit_policy_list32: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.edit_policy_list32(id, body=body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicySiteListBuilderApi->edit_policy_list32: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Policy Id
body	{str: (bool, date, datetime, dict, float, int, list, str, none_type)}	Policy list	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_lists_by_id32

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_lists_by_id32(id)

Get a specific policy list based on the id

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_site_list_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client)
    id = "id_example" # str | Policy Id

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.get_lists_by_id32(id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicySiteListBuilderApi->get_lists_by_id32: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Policy Id

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_policy_lists29

[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists29()

Get policy lists

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_site_list_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        api_response = api_instance.get_policy_lists29()
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicySiteListBuilderApi->get_policy_lists29: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_policy_lists_with_info_tag32

[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}] get_policy_lists_with_info_tag32()

Get policy lists with specific info tag

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_site_list_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client)
    info_tag = "infoTag_example" # str | InfoTag (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.get_policy_lists_with_info_tag32(info_tag=info_tag)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicySiteListBuilderApi->get_policy_lists_with_info_tag32: %s\n" % e)

Parameters

Name	Type	Description	Notes
info_tag	str	InfoTag	[optional]

Return type

[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

preview_policy_list32

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list32()

Preview a policy list based on the policy list type

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_site_list_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client)
    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | Policy list (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.preview_policy_list32(body=body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicySiteListBuilderApi->preview_policy_list32: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	{str: (bool, date, datetime, dict, float, int, list, str, none_type)}	Policy list	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

preview_policy_list_by_id32

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} preview_policy_list_by_id32(id)

Preview a specific policy list entry based on id provided

Example

import time
import openapi_client
from openapi_client.api import configuration_policy_site_list_builder_api
from pprint import pprint
# Defining the host is optional and defaults to /dataservice
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/dataservice"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = configuration_policy_site_list_builder_api.ConfigurationPolicySiteListBuilderApi(api_client)
    id = "id_example" # str | Policy Id

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.preview_policy_list_by_id32(id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling ConfigurationPolicySiteListBuilderApi->preview_policy_list_by_id32: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Policy Id

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ConfigurationPolicySiteListBuilderApi.md

Latest commit

History

ConfigurationPolicySiteListBuilderApi.md

File metadata and controls

openapi_client.ConfigurationPolicySiteListBuilderApi

create_default_site_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_policy_list32

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_policy_list32

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_policy_lists_with_info_tag32

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

edit_policy_list32

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_lists_by_id32

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_policy_lists29

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_policy_lists_with_info_tag32

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

preview_policy_list32

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

preview_policy_list_by_id32

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details