formkiq_client.RulesetsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
add_rule	POST /rulesets/{rulesetId}/rules	Add New Rule
add_ruleset	POST /rulesets	Add New Ruleset
delete_rule	DELETE /rulesets/{rulesetId}/rules/{ruleId}	Delete Rule
delete_ruleset	DELETE /rulesets/{rulesetId}	Delete Ruleset
get_rule	GET /rulesets/{rulesetId}/rules/{ruleId}	Get Rule
get_rules	GET /rulesets/{rulesetId}/rules	Get Rules
get_ruleset	GET /rulesets/{rulesetId}	Get Ruleset
get_rulesets	GET /rulesets	Get Rulesets
update_rule	PATCH /rulesets/{rulesetId}/rules/{ruleId}	Update Rule
update_ruleset	PATCH /rulesets/{rulesetId}	Update Ruleset

add_rule

AddRuleResponse add_rule(ruleset_id, add_rule_request, site_id=site_id)

Add New Rule

Creates a new rule; ONLY available with FormKiQ Enterprise

Example

import formkiq_client
from formkiq_client.models.add_rule_request import AddRuleRequest
from formkiq_client.models.add_rule_response import AddRuleResponse
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.RulesetsApi(api_client)
    ruleset_id = 'ruleset_id_example' # str | Ruleset Identifier
    add_rule_request = formkiq_client.AddRuleRequest() # AddRuleRequest | 
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Add New Rule
        api_response = api_instance.add_rule(ruleset_id, add_rule_request, site_id=site_id)
        print("The response of RulesetsApi->add_rule:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesetsApi->add_rule: %s\n" % e)

Parameters

Name	Type	Description	Notes
ruleset_id	str	Ruleset Identifier
add_rule_request	AddRuleRequest
site_id	str	Site Identifier	[optional]

Return type

AddRuleResponse

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]

add_ruleset

AddRulesetResponse add_ruleset(add_ruleset_request, site_id=site_id)

Add New Ruleset

Creates a new ruleset; ONLY available with FormKiQ Enterprise

Example

import formkiq_client
from formkiq_client.models.add_ruleset_request import AddRulesetRequest
from formkiq_client.models.add_ruleset_response import AddRulesetResponse
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.RulesetsApi(api_client)
    add_ruleset_request = formkiq_client.AddRulesetRequest() # AddRulesetRequest | 
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Add New Ruleset
        api_response = api_instance.add_ruleset(add_ruleset_request, site_id=site_id)
        print("The response of RulesetsApi->add_ruleset:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesetsApi->add_ruleset: %s\n" % e)

Parameters

Name	Type	Description	Notes
add_ruleset_request	AddRulesetRequest
site_id	str	Site Identifier	[optional]

Return type

AddRulesetResponse

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_rule

DeleteRuleResponse delete_rule(ruleset_id, rule_id, site_id=site_id)

Delete Rule

Delete Rule; ONLY available with FormKiQ Enterprise

Example

import formkiq_client
from formkiq_client.models.delete_rule_response import DeleteRuleResponse
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.RulesetsApi(api_client)
    ruleset_id = 'ruleset_id_example' # str | Ruleset Identifier
    rule_id = 'rule_id_example' # str | Rule Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Delete Rule
        api_response = api_instance.delete_rule(ruleset_id, rule_id, site_id=site_id)
        print("The response of RulesetsApi->delete_rule:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesetsApi->delete_rule: %s\n" % e)

Parameters

Name	Type	Description	Notes
ruleset_id	str	Ruleset Identifier
rule_id	str	Rule Identifier
site_id	str	Site Identifier	[optional]

Return type

DeleteRuleResponse

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_ruleset

DeleteRulesetResponse delete_ruleset(ruleset_id, site_id=site_id)

Delete Ruleset

Delete Ruleset; ONLY available with FormKiQ Enterprise

Example

import formkiq_client
from formkiq_client.models.delete_ruleset_response import DeleteRulesetResponse
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.RulesetsApi(api_client)
    ruleset_id = 'ruleset_id_example' # str | Ruleset Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Delete Ruleset
        api_response = api_instance.delete_ruleset(ruleset_id, site_id=site_id)
        print("The response of RulesetsApi->delete_ruleset:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesetsApi->delete_ruleset: %s\n" % e)

Parameters

Name	Type	Description	Notes
ruleset_id	str	Ruleset Identifier
site_id	str	Site Identifier	[optional]

Return type

DeleteRulesetResponse

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_rule

GetRuleResponse get_rule(ruleset_id, rule_id, site_id=site_id)

Get Rule

Returns a rule in a ruleset; ONLY available with FormKiQ Enterprise

Example

import formkiq_client
from formkiq_client.models.get_rule_response import GetRuleResponse
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.RulesetsApi(api_client)
    ruleset_id = 'ruleset_id_example' # str | Ruleset Identifier
    rule_id = 'rule_id_example' # str | Rule Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Get Rule
        api_response = api_instance.get_rule(ruleset_id, rule_id, site_id=site_id)
        print("The response of RulesetsApi->get_rule:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesetsApi->get_rule: %s\n" % e)

Parameters

Name	Type	Description	Notes
ruleset_id	str	Ruleset Identifier
rule_id	str	Rule Identifier
site_id	str	Site Identifier	[optional]

Return type

GetRuleResponse

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_rules

GetRulesResponse get_rules(ruleset_id, site_id=site_id, next=next, limit=limit)

Get Rules

Returns a list of rules in a ruleset; ONLY available with FormKiQ Enterprise

Example

import formkiq_client
from formkiq_client.models.get_rules_response import GetRulesResponse
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.RulesetsApi(api_client)
    ruleset_id = 'ruleset_id_example' # str | Ruleset Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)
    next = 'next_example' # str | Next page of results token (optional)
    limit = '10' # str | Limit Results (optional) (default to '10')

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

Parameters

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

Return type

GetRulesResponse

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_ruleset

GetRulesetResponse get_ruleset(ruleset_id, site_id=site_id)

Get Ruleset

Get a rule sets; ONLY available with FormKiQ Enterprise

Example

import formkiq_client
from formkiq_client.models.get_ruleset_response import GetRulesetResponse
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.RulesetsApi(api_client)
    ruleset_id = 'ruleset_id_example' # str | Ruleset Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Get Ruleset
        api_response = api_instance.get_ruleset(ruleset_id, site_id=site_id)
        print("The response of RulesetsApi->get_ruleset:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesetsApi->get_ruleset: %s\n" % e)

Parameters

Name	Type	Description	Notes
ruleset_id	str	Ruleset Identifier
site_id	str	Site Identifier	[optional]

Return type

GetRulesetResponse

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_rulesets

GetRulesetsResponse get_rulesets(site_id=site_id, next=next, limit=limit)

Get Rulesets

Returns a list of rule sets; ONLY available with FormKiQ Enterprise

Example

import formkiq_client
from formkiq_client.models.get_rulesets_response import GetRulesetsResponse
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.RulesetsApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier (optional)
    next = 'next_example' # str | Next page of results token (optional)
    limit = '10' # str | Limit Results (optional) (default to '10')

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

Parameters

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

Return type

GetRulesetsResponse

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]

update_rule

UpdateRuleResponse update_rule(ruleset_id, rule_id, update_rule_request, site_id=site_id)

Update Rule

Update Rule; ONLY available with FormKiQ Enterprise

Example

import formkiq_client
from formkiq_client.models.update_rule_request import UpdateRuleRequest
from formkiq_client.models.update_rule_response import UpdateRuleResponse
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.RulesetsApi(api_client)
    ruleset_id = 'ruleset_id_example' # str | Ruleset Identifier
    rule_id = 'rule_id_example' # str | Rule Identifier
    update_rule_request = formkiq_client.UpdateRuleRequest() # UpdateRuleRequest | 
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Update Rule
        api_response = api_instance.update_rule(ruleset_id, rule_id, update_rule_request, site_id=site_id)
        print("The response of RulesetsApi->update_rule:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesetsApi->update_rule: %s\n" % e)

Parameters

Name	Type	Description	Notes
ruleset_id	str	Ruleset Identifier
rule_id	str	Rule Identifier
update_rule_request	UpdateRuleRequest
site_id	str	Site Identifier	[optional]

Return type

UpdateRuleResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	200 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]

update_ruleset

UpdateRulesetResponse update_ruleset(ruleset_id, update_ruleset_request, site_id=site_id)

Update Ruleset

Updates an existing ruleset; ONLY available with FormKiQ Enterprise

Example

import formkiq_client
from formkiq_client.models.update_ruleset_request import UpdateRulesetRequest
from formkiq_client.models.update_ruleset_response import UpdateRulesetResponse
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.RulesetsApi(api_client)
    ruleset_id = 'ruleset_id_example' # str | Ruleset Identifier
    update_ruleset_request = formkiq_client.UpdateRulesetRequest() # UpdateRulesetRequest | 
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Update Ruleset
        api_response = api_instance.update_ruleset(ruleset_id, update_ruleset_request, site_id=site_id)
        print("The response of RulesetsApi->update_ruleset:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RulesetsApi->update_ruleset: %s\n" % e)

Parameters

Name	Type	Description	Notes
ruleset_id	str	Ruleset Identifier
update_ruleset_request	UpdateRulesetRequest
site_id	str	Site Identifier	[optional]

Return type

UpdateRulesetResponse

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]

Files

RulesetsApi.md

Latest commit

History

RulesetsApi.md

File metadata and controls

formkiq_client.RulesetsApi

add_rule

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_ruleset

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_rule

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_ruleset

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_rule

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_rules

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_ruleset

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_rulesets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_rule

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_ruleset

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details