formkiq_client.SystemManagementApi

All URIs are relative to http://localhost

Method	HTTP request	Description
add_api_key	POST /sites/{siteId}/apiKeys	Add API Key
add_locale	POST /sites/{siteId}/locales	Add Locale
add_locale_resource_item	POST /sites/{siteId}/locales/{locale}/resourceItems	Add Locale Resource Item
add_open_search_restore_snapshot	POST /sites/{siteId}/opensearch/snapshots/{snapshotName}/restore	Add an OpenSearch Restore Snapshot
add_open_search_snapshot	POST /sites/{siteId}/opensearch/snapshots/{snapshotName}	Add an OpenSearch Snapshot
add_site	POST /sites	Add Site
delete_api_key	DELETE /sites/{siteId}/apiKeys/{apiKey}	Delete API Key
delete_locale	DELETE /sites/{siteId}/locales/{locale}	Delete Locale
delete_locale_resource_item	DELETE /sites/{siteId}/locales/{locale}/resourceItems/{itemKey}	Delete Local Resource Item
delete_open_search_index	DELETE /sites/{siteId}/opensearch/index	Deletes site(s) OpenSearch index
delete_open_search_index_by_name	DELETE /sites/global/opensearch/indices/{indexName}	Deletes OpenSearch index by name
delete_open_search_restore_snapshot	DELETE /sites/{siteId}/opensearch/snapshots/{snapshotName}/restore	Deletes site(s) OpenSearch Restore Snapshot
delete_open_search_snapshot	DELETE /sites/{siteId}/opensearch/snapshots/{snapshotName}	Deletes site(s) OpenSearch Snapshot
delete_open_search_snapshot_repository	DELETE /sites/{siteId}/opensearch/snapshotRepository	Deletes site(s) OpenSearch Snapshot Repository
delete_site_group	DELETE /sites/{siteId}/groups/{groupName}	Deletes Site Group and permissions
get_all_open_search_indices	GET /sites/global/opensearch/indices	Get all OpenSearch indices
get_api_keys	GET /sites/{siteId}/apiKeys	Get API Keys
get_configuration	GET /sites/{siteId}/configuration	Get site configuration
get_locale_resource_item	GET /sites/{siteId}/locales/{locale}/resourceItems/{itemKey}	Get Resource Item by Locale
get_locale_resource_items	GET /sites/{siteId}/locales/{locale}/resourceItems	Get Resource Items by Locale
get_locales	GET /sites/{siteId}/locales	Get Locales
get_open_search_index	GET /sites/{siteId}/opensearch/index	Get site(s) OpenSearch index settings
get_open_search_indices	GET /sites/{siteId}/opensearch/indices	Get site(s) OpenSearch indices
get_open_search_snapshot	GET /sites/{siteId}/opensearch/snapshots/{snapshotName}	Get site(s) OpenSearch snapshot
get_open_search_snapshot_repositories	GET /sites/global/opensearch/snapshotRepositories	Get site(s) OpenSearch snapshot repositories
get_open_search_snapshot_repository	GET /sites/{siteId}/opensearch/snapshotRepository	Get site(s) OpenSearch snapshot repository
get_open_search_snapshots	GET /sites/{siteId}/opensearch/snapshots	Get site(s) OpenSearch snapshots
get_site_group	GET /sites/{siteId}/groups/{groupName}	Get group and permissions belonging to site
get_site_groups	GET /sites/{siteId}/groups	Get group(s) and permissions belonging to site
get_sites	GET /sites	Get site(s) access
get_version	GET /version	Get FormKiQ version
set_locale_resource_item	PUT /sites/{siteId}/locales/{locale}/resourceItems/{itemKey}	Set Locale Resource Item
set_open_search_index	PUT /sites/{siteId}/opensearch/index	Set site(s) OpenSearch index settings
set_open_search_indices	PUT /sites/{siteId}/opensearch/indices	Set site(s) OpenSearch index to use for a SiteId
set_site_group_permissions	PUT /sites/{siteId}/groups/{groupName}/permissions	Set Site's Group Permissions
update_configuration	PATCH /sites/{siteId}/configuration	Update site configuration
update_site	PATCH /sites/{siteId}	Update Site

add_api_key

AddApiKeyResponse add_api_key(site_id, add_api_key_request)

Add API Key

Adds a new API Key

Example

import formkiq_client
from formkiq_client.models.add_api_key_request import AddApiKeyRequest
from formkiq_client.models.add_api_key_response import AddApiKeyResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    add_api_key_request = {"name":"My API Key"} # AddApiKeyRequest | 

    try:
        # Add API Key
        api_response = api_instance.add_api_key(site_id, add_api_key_request)
        print("The response of SystemManagementApi->add_api_key:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->add_api_key: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
add_api_key_request	AddApiKeyRequest

Return type

AddApiKeyResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

add_locale

AddResponse add_locale(site_id, add_locale_request)

Add Locale

Adds a new locale to the specified site

Example

import formkiq_client
from formkiq_client.models.add_locale_request import AddLocaleRequest
from formkiq_client.models.add_response import AddResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    add_locale_request = formkiq_client.AddLocaleRequest() # AddLocaleRequest | 

    try:
        # Add Locale
        api_response = api_instance.add_locale(site_id, add_locale_request)
        print("The response of SystemManagementApi->add_locale:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->add_locale: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
add_locale_request	AddLocaleRequest

Return type

AddResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	201 CREATED	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

add_locale_resource_item

AddLocaleResourceItemResponse add_locale_resource_item(site_id, locale, add_locale_resource_item_request)

Add Locale Resource Item

Adds a new localized resource item for a given locale

Example

import formkiq_client
from formkiq_client.models.add_locale_resource_item_request import AddLocaleResourceItemRequest
from formkiq_client.models.add_locale_resource_item_response import AddLocaleResourceItemResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    locale = 'locale_example' # str | Site Locale (ISO 639 / ISO 3166)
    add_locale_resource_item_request = {"resourceItem":{"itemType":"INTERFACE","interfaceKey":"mainMenuTitle","localizedValue":"Main Menu"}} # AddLocaleResourceItemRequest | 

    try:
        # Add Locale Resource Item
        api_response = api_instance.add_locale_resource_item(site_id, locale, add_locale_resource_item_request)
        print("The response of SystemManagementApi->add_locale_resource_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->add_locale_resource_item: %s\n" % e)

Parameters

Name	Type	Description
site_id	str	Site Identifier
locale	str	Site Locale (ISO 639 / ISO 3166)
add_locale_resource_item_request	AddLocaleResourceItemRequest

Return type

AddLocaleResourceItemResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	201 CREATED	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

add_open_search_restore_snapshot

AddResponse add_open_search_restore_snapshot(site_id, snapshot_name)

Add an OpenSearch Restore Snapshot

Example

import formkiq_client
from formkiq_client.models.add_response import AddResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    snapshot_name = 'snapshot_name_example' # str | Snapshot Name

    try:
        # Add an OpenSearch Restore Snapshot
        api_response = api_instance.add_open_search_restore_snapshot(site_id, snapshot_name)
        print("The response of SystemManagementApi->add_open_search_restore_snapshot:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->add_open_search_restore_snapshot: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
snapshot_name	str	Snapshot Name

Return type

AddResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

add_open_search_snapshot

AddResponse add_open_search_snapshot(site_id, snapshot_name)

Add an OpenSearch Snapshot

Example

import formkiq_client
from formkiq_client.models.add_response import AddResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    snapshot_name = 'snapshot_name_example' # str | Snapshot Name

    try:
        # Add an OpenSearch Snapshot
        api_response = api_instance.add_open_search_snapshot(site_id, snapshot_name)
        print("The response of SystemManagementApi->add_open_search_snapshot:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->add_open_search_snapshot: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
snapshot_name	str	Snapshot Name

Return type

AddResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

add_site

AddResponse add_site(add_site_request)

Add Site

Example

import formkiq_client
from formkiq_client.models.add_response import AddResponse
from formkiq_client.models.add_site_request import AddSiteRequest
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    add_site_request = formkiq_client.AddSiteRequest() # AddSiteRequest | 

    try:
        # Add Site
        api_response = api_instance.add_site(add_site_request)
        print("The response of SystemManagementApi->add_site:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->add_site: %s\n" % e)

Parameters

Name	Type	Description	Notes
add_site_request	AddSiteRequest

Return type

AddResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	201 CREATED	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -
400	400 OK	-

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

delete_api_key

DeleteApiKeyResponse delete_api_key(site_id, api_key)

Delete API Key

Adds a new API Key

Example

import formkiq_client
from formkiq_client.models.delete_api_key_response import DeleteApiKeyResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    api_key = 'api_key_example' # str | API Key

    try:
        # Delete API Key
        api_response = api_instance.delete_api_key(site_id, api_key)
        print("The response of SystemManagementApi->delete_api_key:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->delete_api_key: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
api_key	str	API Key

Return type

DeleteApiKeyResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

delete_locale

DeleteResponse delete_locale(site_id, locale)

Delete Locale

Example

import formkiq_client
from formkiq_client.models.delete_response import DeleteResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    locale = 'locale_example' # str | Site Locale (ISO 639 / ISO 3166)

    try:
        # Delete Locale
        api_response = api_instance.delete_locale(site_id, locale)
        print("The response of SystemManagementApi->delete_locale:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->delete_locale: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
locale	str	Site Locale (ISO 639 / ISO 3166)

Return type

DeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

delete_locale_resource_item

DeleteResponse delete_locale_resource_item(site_id, locale, item_key)

Delete Local Resource Item

Example

import formkiq_client
from formkiq_client.models.delete_response import DeleteResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    locale = 'locale_example' # str | Site Locale (ISO 639 / ISO 3166)
    item_key = 'item_key_example' # str | Item Key (MUST be URL‑encoded)

    try:
        # Delete Local Resource Item
        api_response = api_instance.delete_locale_resource_item(site_id, locale, item_key)
        print("The response of SystemManagementApi->delete_locale_resource_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->delete_locale_resource_item: %s\n" % e)

Parameters

Name	Type	Description
site_id	str	Site Identifier
locale	str	Site Locale (ISO 639 / ISO 3166)
item_key	str	Item Key (MUST be URL‑encoded)

Return type

DeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

delete_open_search_index

DeleteResponse delete_open_search_index(site_id)

Deletes site(s) OpenSearch index

Deletes the OpenSearch index

Example

import formkiq_client
from formkiq_client.models.delete_response import DeleteResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier

    try:
        # Deletes site(s) OpenSearch index
        api_response = api_instance.delete_open_search_index(site_id)
        print("The response of SystemManagementApi->delete_open_search_index:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->delete_open_search_index: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier

Return type

DeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

delete_open_search_index_by_name

DeleteResponse delete_open_search_index_by_name(index_name)

Deletes OpenSearch index by name

Deletes the OpenSearch index by name

Example

import formkiq_client
from formkiq_client.models.delete_response import DeleteResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    index_name = 'index_name_example' # str | IndexName to path

    try:
        # Deletes OpenSearch index by name
        api_response = api_instance.delete_open_search_index_by_name(index_name)
        print("The response of SystemManagementApi->delete_open_search_index_by_name:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->delete_open_search_index_by_name: %s\n" % e)

Parameters

Name	Type	Description	Notes
index_name	str	IndexName to path

Return type

DeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

delete_open_search_restore_snapshot

DeleteResponse delete_open_search_restore_snapshot(site_id, snapshot_name)

Deletes site(s) OpenSearch Restore Snapshot

Deletes the OpenSearch Restore Snapshot

Example

import formkiq_client
from formkiq_client.models.delete_response import DeleteResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    snapshot_name = 'snapshot_name_example' # str | Snapshot Name

    try:
        # Deletes site(s) OpenSearch Restore Snapshot
        api_response = api_instance.delete_open_search_restore_snapshot(site_id, snapshot_name)
        print("The response of SystemManagementApi->delete_open_search_restore_snapshot:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->delete_open_search_restore_snapshot: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
snapshot_name	str	Snapshot Name

Return type

DeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

delete_open_search_snapshot

DeleteResponse delete_open_search_snapshot(site_id, snapshot_name)

Deletes site(s) OpenSearch Snapshot

Deletes the OpenSearch Snapshot

Example

import formkiq_client
from formkiq_client.models.delete_response import DeleteResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    snapshot_name = 'snapshot_name_example' # str | Snapshot Name

    try:
        # Deletes site(s) OpenSearch Snapshot
        api_response = api_instance.delete_open_search_snapshot(site_id, snapshot_name)
        print("The response of SystemManagementApi->delete_open_search_snapshot:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->delete_open_search_snapshot: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
snapshot_name	str	Snapshot Name

Return type

DeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

delete_open_search_snapshot_repository

DeleteResponse delete_open_search_snapshot_repository(site_id)

Deletes site(s) OpenSearch Snapshot Repository

Deletes the OpenSearch Snapshot Repository

Example

import formkiq_client
from formkiq_client.models.delete_response import DeleteResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier

    try:
        # Deletes site(s) OpenSearch Snapshot Repository
        api_response = api_instance.delete_open_search_snapshot_repository(site_id)
        print("The response of SystemManagementApi->delete_open_search_snapshot_repository:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->delete_open_search_snapshot_repository: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier

Return type

DeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

delete_site_group

DeleteResponse delete_site_group(site_id, group_name)

Deletes Site Group and permissions

Example

import formkiq_client
from formkiq_client.models.delete_response import DeleteResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    group_name = 'group_name_example' # str | Group Name

    try:
        # Deletes Site Group and permissions
        api_response = api_instance.delete_site_group(site_id, group_name)
        print("The response of SystemManagementApi->delete_site_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->delete_site_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
group_name	str	Group Name

Return type

DeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

get_all_open_search_indices

GetOpenSearchIndiceResponse get_all_open_search_indices()

Get all OpenSearch indices

Returns all OpenSearch indices

Example

import formkiq_client
from formkiq_client.models.get_open_search_indice_response import GetOpenSearchIndiceResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)

    try:
        # Get all OpenSearch indices
        api_response = api_instance.get_all_open_search_indices()
        print("The response of SystemManagementApi->get_all_open_search_indices:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_all_open_search_indices: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetOpenSearchIndiceResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

get_api_keys

GetApiKeysResponse get_api_keys(site_id, next=next, limit=limit)

Get API Keys

Returns the list of ApiKeys

Example

import formkiq_client
from formkiq_client.models.get_api_keys_response import GetApiKeysResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    next = 'next_example' # str | Next page of results token (optional)
    limit = '10' # str | Limit Results (optional) (default to '10')

    try:
        # Get API Keys
        api_response = api_instance.get_api_keys(site_id, next=next, limit=limit)
        print("The response of SystemManagementApi->get_api_keys:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_api_keys: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
next	str	Next page of results token	[optional]
limit	str	Limit Results	[optional] [default to '10']

Return type

GetApiKeysResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

get_configuration

GetConfigurationResponse get_configuration(site_id)

Get site configuration

Returns the list of sites that the user has access to

Example

import formkiq_client
from formkiq_client.models.get_configuration_response import GetConfigurationResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier

    try:
        # Get site configuration
        api_response = api_instance.get_configuration(site_id)
        print("The response of SystemManagementApi->get_configuration:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_configuration: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier

Return type

GetConfigurationResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

get_locale_resource_item

GetLocaleResourceItemResponse get_locale_resource_item(site_id, locale, item_key)

Get Resource Item by Locale

Returns the resource item

Example

import formkiq_client
from formkiq_client.models.get_locale_resource_item_response import GetLocaleResourceItemResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    locale = 'locale_example' # str | Site Locale (ISO 639 / ISO 3166)
    item_key = 'item_key_example' # str | Item Key (MUST be URL‑encoded)

    try:
        # Get Resource Item by Locale
        api_response = api_instance.get_locale_resource_item(site_id, locale, item_key)
        print("The response of SystemManagementApi->get_locale_resource_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_locale_resource_item: %s\n" % e)

Parameters

Name	Type	Description
site_id	str	Site Identifier
locale	str	Site Locale (ISO 639 / ISO 3166)
item_key	str	Item Key (MUST be URL‑encoded)

Return type

GetLocaleResourceItemResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

get_locale_resource_items

GetLocaleResourceItemsResponse get_locale_resource_items(site_id, locale, next=next, limit=limit)

Get Resource Items by Locale

Returns the list resource items

Example

import formkiq_client
from formkiq_client.models.get_locale_resource_items_response import GetLocaleResourceItemsResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    locale = 'locale_example' # str | Site Locale (ISO 639 / ISO 3166)
    next = 'next_example' # str | Next page of results token (optional)
    limit = '10' # str | Limit Results (optional) (default to '10')

    try:
        # Get Resource Items by Locale
        api_response = api_instance.get_locale_resource_items(site_id, locale, next=next, limit=limit)
        print("The response of SystemManagementApi->get_locale_resource_items:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_locale_resource_items: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
locale	str	Site Locale (ISO 639 / ISO 3166)
next	str	Next page of results token	[optional]
limit	str	Limit Results	[optional] [default to '10']

Return type

GetLocaleResourceItemsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

get_locales

GetLocalesResponse get_locales(site_id, next=next, limit=limit)

Get Locales

Returns a list of locale(s) in a specified site

Example

import formkiq_client
from formkiq_client.models.get_locales_response import GetLocalesResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    next = 'next_example' # str | Next page of results token (optional)
    limit = '10' # str | Limit Results (optional) (default to '10')

    try:
        # Get Locales
        api_response = api_instance.get_locales(site_id, next=next, limit=limit)
        print("The response of SystemManagementApi->get_locales:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_locales: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
next	str	Next page of results token	[optional]
limit	str	Limit Results	[optional] [default to '10']

Return type

GetLocalesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

get_open_search_index

GetOpenSearchIndexResponse get_open_search_index(site_id)

Get site(s) OpenSearch index settings

Returns the OpenSearch index settings

(Deprecated use /sites/{siteId}/opensearch/indices)

Example

import formkiq_client
from formkiq_client.models.get_open_search_index_response import GetOpenSearchIndexResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier

    try:
        # Get site(s) OpenSearch index settings
        api_response = api_instance.get_open_search_index(site_id)
        print("The response of SystemManagementApi->get_open_search_index:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_open_search_index: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier

Return type

GetOpenSearchIndexResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

get_open_search_indices

GetOpenSearchIndiceResponse get_open_search_indices(site_id)

Get site(s) OpenSearch indices

Returns the OpenSearch indices

Example

import formkiq_client
from formkiq_client.models.get_open_search_indice_response import GetOpenSearchIndiceResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier

    try:
        # Get site(s) OpenSearch indices
        api_response = api_instance.get_open_search_indices(site_id)
        print("The response of SystemManagementApi->get_open_search_indices:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_open_search_indices: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier

Return type

GetOpenSearchIndiceResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

get_open_search_snapshot

GetOpenSearchSnapshotResponse get_open_search_snapshot(site_id, snapshot_name)

Get site(s) OpenSearch snapshot

Returns the OpenSearch Snapshot

Example

import formkiq_client
from formkiq_client.models.get_open_search_snapshot_response import GetOpenSearchSnapshotResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    snapshot_name = 'snapshot_name_example' # str | Snapshot Name

    try:
        # Get site(s) OpenSearch snapshot
        api_response = api_instance.get_open_search_snapshot(site_id, snapshot_name)
        print("The response of SystemManagementApi->get_open_search_snapshot:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_open_search_snapshot: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
snapshot_name	str	Snapshot Name

Return type

GetOpenSearchSnapshotResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

get_open_search_snapshot_repositories

GetOpenSearchSnapshotRepositoryResponse get_open_search_snapshot_repositories()

Get site(s) OpenSearch snapshot repositories

Returns the OpenSearch Snapshot Repositories

Example

import formkiq_client
from formkiq_client.models.get_open_search_snapshot_repository_response import GetOpenSearchSnapshotRepositoryResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)

    try:
        # Get site(s) OpenSearch snapshot repositories
        api_response = api_instance.get_open_search_snapshot_repositories()
        print("The response of SystemManagementApi->get_open_search_snapshot_repositories:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_open_search_snapshot_repositories: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetOpenSearchSnapshotRepositoryResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

get_open_search_snapshot_repository

GetOpenSearchSnapshotRepositoryResponse get_open_search_snapshot_repository(site_id)

Get site(s) OpenSearch snapshot repository

Returns the OpenSearch Snapshot Repository

Example

import formkiq_client
from formkiq_client.models.get_open_search_snapshot_repository_response import GetOpenSearchSnapshotRepositoryResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier

    try:
        # Get site(s) OpenSearch snapshot repository
        api_response = api_instance.get_open_search_snapshot_repository(site_id)
        print("The response of SystemManagementApi->get_open_search_snapshot_repository:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_open_search_snapshot_repository: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier

Return type

GetOpenSearchSnapshotRepositoryResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

get_open_search_snapshots

GetOpenSearchSnapshotResponse get_open_search_snapshots(site_id)

Get site(s) OpenSearch snapshots

Returns the OpenSearch Snapshots

Example

import formkiq_client
from formkiq_client.models.get_open_search_snapshot_response import GetOpenSearchSnapshotResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier

    try:
        # Get site(s) OpenSearch snapshots
        api_response = api_instance.get_open_search_snapshots(site_id)
        print("The response of SystemManagementApi->get_open_search_snapshots:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_open_search_snapshots: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier

Return type

GetOpenSearchSnapshotResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

get_site_group

GetSiteGroupResponse get_site_group(site_id, group_name)

Get group and permissions belonging to site

Returns details of a group and permissions belonging to site

Example

import formkiq_client
from formkiq_client.models.get_site_group_response import GetSiteGroupResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    group_name = 'group_name_example' # str | Group Name

    try:
        # Get group and permissions belonging to site
        api_response = api_instance.get_site_group(site_id, group_name)
        print("The response of SystemManagementApi->get_site_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_site_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
group_name	str	Group Name

Return type

GetSiteGroupResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

get_site_groups

GetSiteGroupsResponse get_site_groups(site_id)

Get group(s) and permissions belonging to site

Returns list of groups and permissions belonging to site

Example

import formkiq_client
from formkiq_client.models.get_site_groups_response import GetSiteGroupsResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier

    try:
        # Get group(s) and permissions belonging to site
        api_response = api_instance.get_site_groups(site_id)
        print("The response of SystemManagementApi->get_site_groups:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_site_groups: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier

Return type

GetSiteGroupsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

get_sites

GetSitesResponse get_sites(status=status)

Get site(s) access

Returns the list of sites that the user has access to

Example

import formkiq_client
from formkiq_client.models.get_sites_response import GetSitesResponse
from formkiq_client.models.site_status import SiteStatus
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    status = formkiq_client.SiteStatus() # SiteStatus | Fetch sites with status (only valid when using SitePermissions 'defined' (optional)

    try:
        # Get site(s) access
        api_response = api_instance.get_sites(status=status)
        print("The response of SystemManagementApi->get_sites:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_sites: %s\n" % e)

Parameters

Name	Type	Description	Notes
status	SiteStatus	Fetch sites with status (only valid when using SitePermissions 'defined'	[optional]

Return type

GetSitesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

get_version

GetVersionResponse get_version()

Get FormKiQ version

Return the version of FormKiQ

Example

import formkiq_client
from formkiq_client.models.get_version_response import GetVersionResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)

    try:
        # Get FormKiQ version
        api_response = api_instance.get_version()
        print("The response of SystemManagementApi->get_version:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_version: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetVersionResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

set_locale_resource_item

SetResponse set_locale_resource_item(site_id, locale, item_key, set_locale_resource_item_request)

Set Locale Resource Item

Set a new Locale Resource Item

Example

import formkiq_client
from formkiq_client.models.set_locale_resource_item_request import SetLocaleResourceItemRequest
from formkiq_client.models.set_response import SetResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    locale = 'locale_example' # str | Site Locale (ISO 639 / ISO 3166)
    item_key = 'item_key_example' # str | Item Key (MUST be URL‑encoded)
    set_locale_resource_item_request = formkiq_client.SetLocaleResourceItemRequest() # SetLocaleResourceItemRequest | 

    try:
        # Set Locale Resource Item
        api_response = api_instance.set_locale_resource_item(site_id, locale, item_key, set_locale_resource_item_request)
        print("The response of SystemManagementApi->set_locale_resource_item:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->set_locale_resource_item: %s\n" % e)

Parameters

Name	Type	Description
site_id	str	Site Identifier
locale	str	Site Locale (ISO 639 / ISO 3166)
item_key	str	Item Key (MUST be URL‑encoded)
set_locale_resource_item_request	SetLocaleResourceItemRequest

Return type

SetResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

set_open_search_index

SetOpenSearchIndexResponse set_open_search_index(site_id, set_open_search_index_request)

Set site(s) OpenSearch index settings

Sets the OpenSearch index settings

Example

import formkiq_client
from formkiq_client.models.set_open_search_index_request import SetOpenSearchIndexRequest
from formkiq_client.models.set_open_search_index_response import SetOpenSearchIndexResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    set_open_search_index_request = formkiq_client.SetOpenSearchIndexRequest() # SetOpenSearchIndexRequest | 

    try:
        # Set site(s) OpenSearch index settings
        api_response = api_instance.set_open_search_index(site_id, set_open_search_index_request)
        print("The response of SystemManagementApi->set_open_search_index:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->set_open_search_index: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
set_open_search_index_request	SetOpenSearchIndexRequest

Return type

SetOpenSearchIndexResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

set_open_search_indices

SetResponse set_open_search_indices(site_id, set_open_search_indice_request)

Set site(s) OpenSearch index to use for a SiteId

Sets the OpenSearch index to use for a SiteId

Example

import formkiq_client
from formkiq_client.models.set_open_search_indice_request import SetOpenSearchIndiceRequest
from formkiq_client.models.set_response import SetResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    set_open_search_indice_request = formkiq_client.SetOpenSearchIndiceRequest() # SetOpenSearchIndiceRequest | 

    try:
        # Set site(s) OpenSearch index to use for a SiteId
        api_response = api_instance.set_open_search_indices(site_id, set_open_search_indice_request)
        print("The response of SystemManagementApi->set_open_search_indices:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->set_open_search_indices: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
set_open_search_indice_request	SetOpenSearchIndiceRequest

Return type

SetResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

set_site_group_permissions

SetResponse set_site_group_permissions(site_id, group_name, set_group_permissions_request)

Set Site's Group Permissions

Example

import formkiq_client
from formkiq_client.models.set_group_permissions_request import SetGroupPermissionsRequest
from formkiq_client.models.set_response import SetResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    group_name = 'group_name_example' # str | Group Name
    set_group_permissions_request = formkiq_client.SetGroupPermissionsRequest() # SetGroupPermissionsRequest | 

    try:
        # Set Site's Group Permissions
        api_response = api_instance.set_site_group_permissions(site_id, group_name, set_group_permissions_request)
        print("The response of SystemManagementApi->set_site_group_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->set_site_group_permissions: %s\n" % e)

Parameters

Name	Type	Description
site_id	str	Site Identifier
group_name	str	Group Name
set_group_permissions_request	SetGroupPermissionsRequest

Return type

SetResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

update_configuration

UpdateConfigurationResponse update_configuration(site_id, update_configuration_request)

Update site configuration

Update the System Management configuration

Example

import formkiq_client
from formkiq_client.models.update_configuration_request import UpdateConfigurationRequest
from formkiq_client.models.update_configuration_response import UpdateConfigurationResponse
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    update_configuration_request = formkiq_client.UpdateConfigurationRequest() # UpdateConfigurationRequest | 

    try:
        # Update site configuration
        api_response = api_instance.update_configuration(site_id, update_configuration_request)
        print("The response of SystemManagementApi->update_configuration:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->update_configuration: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
update_configuration_request	UpdateConfigurationRequest

Return type

UpdateConfigurationResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -
400	400 OK	-

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

update_site

UpdateResponse update_site(site_id, update_site_request)

Update Site

Example

import formkiq_client
from formkiq_client.models.update_response import UpdateResponse
from formkiq_client.models.update_site_request import UpdateSiteRequest
from formkiq_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 = formkiq_client.Configuration(
    host = "http://localhost"
)

# 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.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    update_site_request = formkiq_client.UpdateSiteRequest() # UpdateSiteRequest | 

    try:
        # Update Site
        api_response = api_instance.update_site(site_id, update_site_request)
        print("The response of SystemManagementApi->update_site:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->update_site: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
update_site_request	UpdateSiteRequest

Return type

UpdateResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

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

FilesExpand file tree

SystemManagementApi.md

Latest commit

History

SystemManagementApi.md

File metadata and controls

formkiq_client.SystemManagementApi

add_api_key

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_locale

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_locale_resource_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_open_search_restore_snapshot

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_open_search_snapshot

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_site

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_api_key

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_locale

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_locale_resource_item

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_open_search_index

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_open_search_index_by_name

Example

Parameters