swagger_client.FunnelApi

All URIs are relative to http://localhost/nifi-api

Method	HTTP request	Description
get_funnel	GET /funnels/{id}	Gets a funnel
remove_funnel	DELETE /funnels/{id}	Deletes a funnel
update_funnel	PUT /funnels/{id}	Updates a funnel

get_funnel

FunnelEntity get_funnel(id)

Gets a funnel

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.FunnelApi()
id = 'id_example' # str | The funnel id.

try: 
    # Gets a funnel
    api_response = api_instance.get_funnel(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FunnelApi->get_funnel: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The funnel id.

Return type

FunnelEntity

Authorization

No authorization required

HTTP request headers

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

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

remove_funnel

FunnelEntity remove_funnel(id, version=version, client_id=client_id)

Deletes a funnel

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.FunnelApi()
id = 'id_example' # str | The funnel id.
version = 'version_example' # str | The revision is used to verify the client is working with the latest version of the flow. (optional)
client_id = 'client_id_example' # str | If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. (optional)

try: 
    # Deletes a funnel
    api_response = api_instance.remove_funnel(id, version=version, client_id=client_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FunnelApi->remove_funnel: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The funnel id.
version	str	The revision is used to verify the client is working with the latest version of the flow.	[optional]
client_id	str	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.	[optional]

Return type

FunnelEntity

Authorization

No authorization required

HTTP request headers

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

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

update_funnel

FunnelEntity update_funnel(id, body)

Updates a funnel

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.FunnelApi()
id = 'id_example' # str | The funnel id.
body = swagger_client.FunnelEntity() # FunnelEntity | The funnel configuration details.

try: 
    # Updates a funnel
    api_response = api_instance.update_funnel(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FunnelApi->update_funnel: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The funnel id.
body	FunnelEntity	The funnel configuration details.

Return type

FunnelEntity

Authorization

No authorization required

HTTP request headers

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

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