formkiq_client.MappingsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
add_mapping	POST /mappings	Add New Mapping
delete_mapping	DELETE /mappings/{mappingId}	Delete Mapping
get_mapping	GET /mappings/{mappingId}	Get Mapping
get_mappings	GET /mappings	Get Mappings
set_mapping	PUT /mappings/{mappingId}	Set Mapping

add_mapping

AddMappingResponse add_mapping(add_mapping_request, site_id=site_id)

Add New Mapping

Creates a new mapping; ONLY available with FormKiQ Enterprise

Example

import formkiq_client
from formkiq_client.models.add_mapping_request import AddMappingRequest
from formkiq_client.models.add_mapping_response import AddMappingResponse
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.MappingsApi(api_client)
    add_mapping_request = formkiq_client.AddMappingRequest() # AddMappingRequest | 
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Add New Mapping
        api_response = api_instance.add_mapping(add_mapping_request, site_id=site_id)
        print("The response of MappingsApi->add_mapping:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MappingsApi->add_mapping: %s\n" % e)

Parameters

Name	Type	Description	Notes
add_mapping_request	AddMappingRequest
site_id	str	Site Identifier	[optional]

Return type

AddMappingResponse

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_mapping

DeleteResponse delete_mapping(mapping_id, site_id=site_id)

Delete Mapping

Delete Mapping; ONLY available with FormKiQ Enterprise

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.MappingsApi(api_client)
    mapping_id = 'mapping_id_example' # str | Mapping Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Delete Mapping
        api_response = api_instance.delete_mapping(mapping_id, site_id=site_id)
        print("The response of MappingsApi->delete_mapping:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MappingsApi->delete_mapping: %s\n" % e)

Parameters

Name	Type	Description	Notes
mapping_id	str	Mapping Identifier
site_id	str	Site Identifier	[optional]

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_mapping

GetMappingResponse get_mapping(mapping_id, site_id=site_id)

Get Mapping

Get a mapping; ONLY available with FormKiQ Enterprise

Example

import formkiq_client
from formkiq_client.models.get_mapping_response import GetMappingResponse
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.MappingsApi(api_client)
    mapping_id = 'mapping_id_example' # str | Mapping Identifier
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Get Mapping
        api_response = api_instance.get_mapping(mapping_id, site_id=site_id)
        print("The response of MappingsApi->get_mapping:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MappingsApi->get_mapping: %s\n" % e)

Parameters

Name	Type	Description	Notes
mapping_id	str	Mapping Identifier
site_id	str	Site Identifier	[optional]

Return type

GetMappingResponse

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_mappings

GetMappingsResponse get_mappings(site_id=site_id, limit=limit, next=next)

Get Mappings

Returns a list of mappings; ONLY available with FormKiQ Enterprise

Example

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

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

Parameters

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

Return type

GetMappingsResponse

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_mapping

SetResponse set_mapping(mapping_id, set_mapping_request, site_id=site_id)

Set Mapping

Sets an mapping; ONLY available with FormKiQ Enterprise

Example

import formkiq_client
from formkiq_client.models.set_mapping_request import SetMappingRequest
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.MappingsApi(api_client)
    mapping_id = 'mapping_id_example' # str | Mapping Identifier
    set_mapping_request = formkiq_client.SetMappingRequest() # SetMappingRequest | 
    site_id = 'site_id_example' # str | Site Identifier (optional)

    try:
        # Set Mapping
        api_response = api_instance.set_mapping(mapping_id, set_mapping_request, site_id=site_id)
        print("The response of MappingsApi->set_mapping:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MappingsApi->set_mapping: %s\n" % e)

Parameters

Name	Type	Description	Notes
mapping_id	str	Mapping Identifier
set_mapping_request	SetMappingRequest
site_id	str	Site Identifier	[optional]

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 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]

Files

MappingsApi.md

Latest commit

History

MappingsApi.md

File metadata and controls

formkiq_client.MappingsApi

add_mapping

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_mapping

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_mapping

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_mappings

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

set_mapping

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details