extremecloudiq.HIQApi

All URIs are relative to http://localhost:8081

Method	HTTP request	Description
create_organization	POST /hiq/organizations	Create a new organization
delete_organization	DELETE /hiq/organizations/{id}	Delete an existing organization
get_creating_org_id	GET /hiq/context/creating	Get organization for creating new data
get_hiq_context	GET /hiq/context	Get HIQ context
get_hiq_status	GET /hiq/status	Get HIQ status
get_reading_org_ids	GET /hiq/context/reading	Get organizations for reading data
list_organizations	GET /hiq/organizations	List all organizations
rename_organization	POST /hiq/organizations/{id}/:rename	Rename an existing organization
set_creating_org_id	PUT /hiq/context/creating	Set organization for creating new data
set_hiq_context	PUT /hiq/context	Set HIQ context
set_reading_org_ids	PUT /hiq/context/reading	Set organizations for reading data

create_organization

XiqOrganization create_organization(xiq_create_organization_request)

Create a new organization

Create a new organization in current HIQ (Available when HIQ is enabled).

Example

Bearer (JWT) Authentication (Bearer):

from __future__ import print_function
import time
import extremecloudiq
from extremecloudiq.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8081
# See configuration.py for a list of all supported configuration parameters.
configuration = extremecloudiq.Configuration(
    host = "http://localhost:8081"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = extremecloudiq.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with extremecloudiq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = extremecloudiq.HIQApi(api_client)
    xiq_create_organization_request = extremecloudiq.XiqCreateOrganizationRequest() # XiqCreateOrganizationRequest | Create new organization request body

    try:
        # Create a new organization
        api_response = api_instance.create_organization(xiq_create_organization_request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling HIQApi->create_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
xiq_create_organization_request	XiqCreateOrganizationRequest	Create new organization request body

Return type

XiqOrganization

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
401	Unauthorized	-
400	Bad Request	-
500	Internal Server Error	-
201	Created	-

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

delete_organization

delete_organization(id)

Delete an existing organization

Delete an existing organization (Available when HIQ is enabled).

Example

Bearer (JWT) Authentication (Bearer):

from __future__ import print_function
import time
import extremecloudiq
from extremecloudiq.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8081
# See configuration.py for a list of all supported configuration parameters.
configuration = extremecloudiq.Configuration(
    host = "http://localhost:8081"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = extremecloudiq.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with extremecloudiq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = extremecloudiq.HIQApi(api_client)
    id = 56 # int | Organization ID to delete

    try:
        # Delete an existing organization
        api_instance.delete_organization(id)
    except ApiException as e:
        print("Exception when calling HIQApi->delete_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Organization ID to delete

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
401	Unauthorized	-
400	Bad Request	-
500	Internal Server Error	-
204	No Content	-

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

get_creating_org_id

int get_creating_org_id()

Get organization for creating new data

Get organization for creating new data (Only one organization is active for creating new data). Appliable when HIQ is enabled.

Example

Bearer (JWT) Authentication (Bearer):

from __future__ import print_function
import time
import extremecloudiq
from extremecloudiq.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8081
# See configuration.py for a list of all supported configuration parameters.
configuration = extremecloudiq.Configuration(
    host = "http://localhost:8081"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = extremecloudiq.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with extremecloudiq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = extremecloudiq.HIQApi(api_client)
    
    try:
        # Get organization for creating new data
        api_response = api_instance.get_creating_org_id()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling HIQApi->get_creating_org_id: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

int

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
401	Unauthorized	-
400	Bad Request	-
500	Internal Server Error	-
200	OK	-

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

get_hiq_context

XiqHiqContext get_hiq_context()

Get HIQ context

Get the current effective HIQ context for reading or creating data in organizations. Appliable when HIQ is enabled.

Example

Bearer (JWT) Authentication (Bearer):

from __future__ import print_function
import time
import extremecloudiq
from extremecloudiq.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8081
# See configuration.py for a list of all supported configuration parameters.
configuration = extremecloudiq.Configuration(
    host = "http://localhost:8081"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = extremecloudiq.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with extremecloudiq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = extremecloudiq.HIQApi(api_client)
    
    try:
        # Get HIQ context
        api_response = api_instance.get_hiq_context()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling HIQApi->get_hiq_context: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

XiqHiqContext

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
401	Unauthorized	-
400	Bad Request	-
500	Internal Server Error	-
200	OK	-

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

get_hiq_status

XiqHiqStatus get_hiq_status()

Get HIQ status

Get Hierarchical ExtremeCloud IQ (HIQ) status.

Example

Bearer (JWT) Authentication (Bearer):

from __future__ import print_function
import time
import extremecloudiq
from extremecloudiq.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8081
# See configuration.py for a list of all supported configuration parameters.
configuration = extremecloudiq.Configuration(
    host = "http://localhost:8081"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = extremecloudiq.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with extremecloudiq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = extremecloudiq.HIQApi(api_client)
    
    try:
        # Get HIQ status
        api_response = api_instance.get_hiq_status()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling HIQApi->get_hiq_status: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

XiqHiqStatus

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
401	Unauthorized	-
400	Bad Request	-
500	Internal Server Error	-
200	OK	-

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

get_reading_org_ids

list[int] get_reading_org_ids()

Get organizations for reading data

Get organizations for reading data (Empty list means reading data from all organizations in the HIQ). Appliable when HIQ is enabled.

Example

Bearer (JWT) Authentication (Bearer):

from __future__ import print_function
import time
import extremecloudiq
from extremecloudiq.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8081
# See configuration.py for a list of all supported configuration parameters.
configuration = extremecloudiq.Configuration(
    host = "http://localhost:8081"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = extremecloudiq.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with extremecloudiq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = extremecloudiq.HIQApi(api_client)
    
    try:
        # Get organizations for reading data
        api_response = api_instance.get_reading_org_ids()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling HIQApi->get_reading_org_ids: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[int]

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
401	Unauthorized	-
400	Bad Request	-
500	Internal Server Error	-
200	OK	-

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

list_organizations

list[XiqOrganization] list_organizations()

List all organizations

List all organizations in current HIQ (Available when HIQ is enabled).

Example

Bearer (JWT) Authentication (Bearer):

from __future__ import print_function
import time
import extremecloudiq
from extremecloudiq.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8081
# See configuration.py for a list of all supported configuration parameters.
configuration = extremecloudiq.Configuration(
    host = "http://localhost:8081"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = extremecloudiq.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with extremecloudiq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = extremecloudiq.HIQApi(api_client)
    
    try:
        # List all organizations
        api_response = api_instance.list_organizations()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling HIQApi->list_organizations: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[XiqOrganization]

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
401	Unauthorized	-
400	Bad Request	-
500	Internal Server Error	-
200	OK	-

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

rename_organization

rename_organization(id, body)

Rename an existing organization

Rename an existing organization (Available when HIQ is enabled).

Example

Bearer (JWT) Authentication (Bearer):

from __future__ import print_function
import time
import extremecloudiq
from extremecloudiq.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8081
# See configuration.py for a list of all supported configuration parameters.
configuration = extremecloudiq.Configuration(
    host = "http://localhost:8081"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = extremecloudiq.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with extremecloudiq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = extremecloudiq.HIQApi(api_client)
    id = 56 # int | Organization ID to rename
body = 'body_example' # str | The new organization name

    try:
        # Rename an existing organization
        api_instance.rename_organization(id, body)
    except ApiException as e:
        print("Exception when calling HIQApi->rename_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Organization ID to rename
body	str	The new organization name

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
401	Unauthorized	-
400	Bad Request	-
500	Internal Server Error	-
204	No Content	-

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

set_creating_org_id

set_creating_org_id(body)

Set organization for creating new data

Set organization for creating new data (Only one organization is active for creating new data). Only HIQ Admin can performance this operation when HIQ is enabled.

Example

Bearer (JWT) Authentication (Bearer):

from __future__ import print_function
import time
import extremecloudiq
from extremecloudiq.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8081
# See configuration.py for a list of all supported configuration parameters.
configuration = extremecloudiq.Configuration(
    host = "http://localhost:8081"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = extremecloudiq.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with extremecloudiq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = extremecloudiq.HIQApi(api_client)
    body = 56 # int | The organization ID used for creating new data

    try:
        # Set organization for creating new data
        api_instance.set_creating_org_id(body)
    except ApiException as e:
        print("Exception when calling HIQApi->set_creating_org_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	int	The organization ID used for creating new data

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
401	Unauthorized	-
400	Bad Request	-
500	Internal Server Error	-
200	OK	-

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

set_hiq_context

set_hiq_context(xiq_hiq_context)

Set HIQ context

Set the current effective HIQ context for reading or creating data in organizations. Only HIQ Admin can performance this operation when HIQ is enabled.

Example

Bearer (JWT) Authentication (Bearer):

from __future__ import print_function
import time
import extremecloudiq
from extremecloudiq.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8081
# See configuration.py for a list of all supported configuration parameters.
configuration = extremecloudiq.Configuration(
    host = "http://localhost:8081"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = extremecloudiq.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with extremecloudiq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = extremecloudiq.HIQApi(api_client)
    xiq_hiq_context = extremecloudiq.XiqHiqContext() # XiqHiqContext | The new HIQ context

    try:
        # Set HIQ context
        api_instance.set_hiq_context(xiq_hiq_context)
    except ApiException as e:
        print("Exception when calling HIQApi->set_hiq_context: %s\n" % e)

Parameters

Name	Type	Description	Notes
xiq_hiq_context	XiqHiqContext	The new HIQ context

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
401	Unauthorized	-
400	Bad Request	-
500	Internal Server Error	-
200	OK	-

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

set_reading_org_ids

set_reading_org_ids(request_body)

Set organizations for reading data

Set organization for reading data (Empty list means reading data from all organizations in the HIQ). Only HIQ Admin can performance this operation.

Example

Bearer (JWT) Authentication (Bearer):

from __future__ import print_function
import time
import extremecloudiq
from extremecloudiq.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8081
# See configuration.py for a list of all supported configuration parameters.
configuration = extremecloudiq.Configuration(
    host = "http://localhost:8081"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = extremecloudiq.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with extremecloudiq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = extremecloudiq.HIQApi(api_client)
    request_body = [56] # list[int] | The organization IDs used for reading data

    try:
        # Set organizations for reading data
        api_instance.set_reading_org_ids(request_body)
    except ApiException as e:
        print("Exception when calling HIQApi->set_reading_org_ids: %s\n" % e)

Parameters

Name	Type	Description	Notes
request_body	list[int]	The organization IDs used for reading data

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
401	Unauthorized	-
400	Bad Request	-
500	Internal Server Error	-
200	OK	-

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

Files

HIQApi.md

Latest commit

History

HIQApi.md

File metadata and controls

extremecloudiq.HIQApi

create_organization

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_organization

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_creating_org_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_hiq_context

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_hiq_status

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_reading_org_ids

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_organizations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

rename_organization

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

set_creating_org_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

set_hiq_context

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

set_reading_org_ids

Example

Parameters