Skip to content

ResourceMappingServiceApi.md

Latest commit

 

History

History
350 lines (231 loc) · 12.2 KB

ResourceMappingServiceApi.md

File metadata and controls

350 lines (231 loc) · 12.2 KB
Raw

ResourceMappingServiceApi

All URIs are relative to http://localhost

Method Description
create create a resource hierarchy mapping
create_mappings_from_query create resource hierarchy mappings from query
delete_mappings_by_node_ids delete resource hierarchy mappings by node ids
get_mapping_by_ol_id get resource hierarchy mapping by ol id
get_node_metrics get hierarchy node metrics

create

object create(resource_hierarchy_mapping_request)

create a resource hierarchy mapping

Example

import onelens_backend_client
from onelens_backend_client.models.resource_hierarchy_mapping_request import ResourceHierarchyMappingRequest
from onelens_backend_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = onelens_backend_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with onelens_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelens_backend_client.ResourceMappingServiceApi(api_client)
    resource_hierarchy_mapping_request = onelens_backend_client.ResourceHierarchyMappingRequest() # ResourceHierarchyMappingRequest | 

    try:
        # create a resource hierarchy mapping
        api_response = api_instance.create(resource_hierarchy_mapping_request)
        print("The response of ResourceMappingServiceApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourceMappingServiceApi->create: %s\n" % e)

Parameters

Name Type Description Notes
resource_hierarchy_mapping_request ResourceHierarchyMappingRequest

Return type

object

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

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

create_mappings_from_query

object create_mappings_from_query(create_resource_hierarchy_mappings_from_query_request)

create resource hierarchy mappings from query

Example

import onelens_backend_client
from onelens_backend_client.models.create_resource_hierarchy_mappings_from_query_request import CreateResourceHierarchyMappingsFromQueryRequest
from onelens_backend_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = onelens_backend_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with onelens_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelens_backend_client.ResourceMappingServiceApi(api_client)
    create_resource_hierarchy_mappings_from_query_request = onelens_backend_client.CreateResourceHierarchyMappingsFromQueryRequest() # CreateResourceHierarchyMappingsFromQueryRequest | 

    try:
        # create resource hierarchy mappings from query
        api_response = api_instance.create_mappings_from_query(create_resource_hierarchy_mappings_from_query_request)
        print("The response of ResourceMappingServiceApi->create_mappings_from_query:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourceMappingServiceApi->create_mappings_from_query: %s\n" % e)

Parameters

Name Type Description Notes
create_resource_hierarchy_mappings_from_query_request CreateResourceHierarchyMappingsFromQueryRequest

Return type

object

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

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

delete_mappings_by_node_ids

object delete_mappings_by_node_ids(delete_resource_hierarchy_mappings_by_node_ids_request)

delete resource hierarchy mappings by node ids

Example

import onelens_backend_client
from onelens_backend_client.models.delete_resource_hierarchy_mappings_by_node_ids_request import DeleteResourceHierarchyMappingsByNodeIdsRequest
from onelens_backend_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = onelens_backend_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with onelens_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelens_backend_client.ResourceMappingServiceApi(api_client)
    delete_resource_hierarchy_mappings_by_node_ids_request = onelens_backend_client.DeleteResourceHierarchyMappingsByNodeIdsRequest() # DeleteResourceHierarchyMappingsByNodeIdsRequest | 

    try:
        # delete resource hierarchy mappings by node ids
        api_response = api_instance.delete_mappings_by_node_ids(delete_resource_hierarchy_mappings_by_node_ids_request)
        print("The response of ResourceMappingServiceApi->delete_mappings_by_node_ids:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourceMappingServiceApi->delete_mappings_by_node_ids: %s\n" % e)

Parameters

Name Type Description Notes
delete_resource_hierarchy_mappings_by_node_ids_request DeleteResourceHierarchyMappingsByNodeIdsRequest

Return type

object

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

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

get_mapping_by_ol_id

GetResourceHierarchyMappingByOlIdResponse get_mapping_by_ol_id(get_resource_hierarchy_mapping_by_ol_id_request)

get resource hierarchy mapping by ol id

Example

import onelens_backend_client
from onelens_backend_client.models.get_resource_hierarchy_mapping_by_ol_id_request import GetResourceHierarchyMappingByOlIdRequest
from onelens_backend_client.models.get_resource_hierarchy_mapping_by_ol_id_response import GetResourceHierarchyMappingByOlIdResponse
from onelens_backend_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = onelens_backend_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with onelens_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelens_backend_client.ResourceMappingServiceApi(api_client)
    get_resource_hierarchy_mapping_by_ol_id_request = onelens_backend_client.GetResourceHierarchyMappingByOlIdRequest() # GetResourceHierarchyMappingByOlIdRequest | 

    try:
        # get resource hierarchy mapping by ol id
        api_response = api_instance.get_mapping_by_ol_id(get_resource_hierarchy_mapping_by_ol_id_request)
        print("The response of ResourceMappingServiceApi->get_mapping_by_ol_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourceMappingServiceApi->get_mapping_by_ol_id: %s\n" % e)

Parameters

Name Type Description Notes
get_resource_hierarchy_mapping_by_ol_id_request GetResourceHierarchyMappingByOlIdRequest

Return type

GetResourceHierarchyMappingByOlIdResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

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

get_node_metrics

GetHierarchyNodeMetricsResponse get_node_metrics(get_hierarchy_node_metrics_request)

get hierarchy node metrics

Example

import onelens_backend_client
from onelens_backend_client.models.get_hierarchy_node_metrics_request import GetHierarchyNodeMetricsRequest
from onelens_backend_client.models.get_hierarchy_node_metrics_response import GetHierarchyNodeMetricsResponse
from onelens_backend_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = onelens_backend_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with onelens_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelens_backend_client.ResourceMappingServiceApi(api_client)
    get_hierarchy_node_metrics_request = onelens_backend_client.GetHierarchyNodeMetricsRequest() # GetHierarchyNodeMetricsRequest | 

    try:
        # get hierarchy node metrics
        api_response = api_instance.get_node_metrics(get_hierarchy_node_metrics_request)
        print("The response of ResourceMappingServiceApi->get_node_metrics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourceMappingServiceApi->get_node_metrics: %s\n" % e)

Parameters

Name Type Description Notes
get_hierarchy_node_metrics_request GetHierarchyNodeMetricsRequest

Return type

GetHierarchyNodeMetricsResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

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