swagger_client.ControllerservicesApi

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

Method	HTTP request	Description
clear_state	POST /controller-services/{id}/state/clear-requests	Clears the state for a controller service
get_controller_service	GET /controller-services/{id}	Gets a controller service
get_controller_service_references	GET /controller-services/{id}/references	Gets a controller service
get_property_descriptor	GET /controller-services/{id}/descriptors	Gets a controller service property descriptor
get_state	GET /controller-services/{id}/state	Gets the state for a controller service
remove_controller_service	DELETE /controller-services/{id}	Deletes a controller service
update_controller_service	PUT /controller-services/{id}	Updates a controller service
update_controller_service_references	PUT /controller-services/{id}/references	Updates a controller services references

clear_state

ComponentStateEntity clear_state(id)

Clears the state for a controller service

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.ControllerservicesApi()
id = 'id_example' # str | The controller service id.

try: 
    # Clears the state for a controller service
    api_response = api_instance.clear_state(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerservicesApi->clear_state: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The controller service id.

Return type

ComponentStateEntity

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]

get_controller_service

ControllerServiceEntity get_controller_service(id)

Gets a controller service

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.ControllerservicesApi()
id = 'id_example' # str | The controller service id.

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

Parameters

Name	Type	Description	Notes
id	str	The controller service id.

Return type

ControllerServiceEntity

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]

get_controller_service_references

ControllerServiceReferencingComponentsEntity get_controller_service_references(id)

Gets a controller service

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.ControllerservicesApi()
id = 'id_example' # str | The controller service id.

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

Parameters

Name	Type	Description	Notes
id	str	The controller service id.

Return type

ControllerServiceReferencingComponentsEntity

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]

get_property_descriptor

PropertyDescriptorEntity get_property_descriptor(id, property_name)

Gets a controller service property descriptor

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.ControllerservicesApi()
id = 'id_example' # str | The controller service id.
property_name = 'property_name_example' # str | The property name to return the descriptor for.

try: 
    # Gets a controller service property descriptor
    api_response = api_instance.get_property_descriptor(id, property_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerservicesApi->get_property_descriptor: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The controller service id.
property_name	str	The property name to return the descriptor for.

Return type

PropertyDescriptorEntity

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]

get_state

ComponentStateEntity get_state(id)

Gets the state for a controller service

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.ControllerservicesApi()
id = 'id_example' # str | The controller service id.

try: 
    # Gets the state for a controller service
    api_response = api_instance.get_state(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerservicesApi->get_state: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The controller service id.

Return type

ComponentStateEntity

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_controller_service

ControllerServiceEntity remove_controller_service(id, version=version, client_id=client_id)

Deletes a controller service

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.ControllerservicesApi()
id = 'id_example' # str | The controller service 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 controller service
    api_response = api_instance.remove_controller_service(id, version=version, client_id=client_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerservicesApi->remove_controller_service: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The controller service 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

ControllerServiceEntity

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_controller_service

ControllerServiceEntity update_controller_service(id, body)

Updates a controller service

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.ControllerservicesApi()
id = 'id_example' # str | The controller service id.
body = swagger_client.ControllerServiceEntity() # ControllerServiceEntity | The controller service configuration details.

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

Parameters

Name	Type	Description	Notes
id	str	The controller service id.
body	ControllerServiceEntity	The controller service configuration details.

Return type

ControllerServiceEntity

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]

update_controller_service_references

ControllerServiceReferencingComponentsEntity update_controller_service_references(id, body)

Updates a controller services references

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.ControllerservicesApi()
id = 'id_example' # str | The controller service id.
body = swagger_client.UpdateControllerServiceReferenceRequestEntity() # UpdateControllerServiceReferenceRequestEntity | The controller service request update request.

try: 
    # Updates a controller services references
    api_response = api_instance.update_controller_service_references(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControllerservicesApi->update_controller_service_references: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The controller service id.
body	UpdateControllerServiceReferenceRequestEntity	The controller service request update request.

Return type

ControllerServiceReferencingComponentsEntity

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]