swagger_client.ProcessgroupsApi

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

Method	HTTP request	Description
copy_snippet	POST /process-groups/{id}/snippet-instance	Copies a snippet and discards it.
create_connection	POST /process-groups/{id}/connections	Creates a connection
create_controller_service	POST /process-groups/{id}/controller-services	Creates a new controller service
create_funnel	POST /process-groups/{id}/funnels	Creates a funnel
create_input_port	POST /process-groups/{id}/input-ports	Creates an input port
create_label	POST /process-groups/{id}/labels	Creates a label
create_output_port	POST /process-groups/{id}/output-ports	Creates an output port
create_process_group	POST /process-groups/{id}/process-groups	Creates a process group
create_processor	POST /process-groups/{id}/processors	Creates a new processor
create_remote_process_group	POST /process-groups/{id}/remote-process-groups	Creates a new process group
create_template	POST /process-groups/{id}/templates	Creates a template and discards the specified snippet.
delete_variable_registry_update_request	DELETE /process-groups/{groupId}/variable-registry/update-requests/{updateId}	Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.
get_connections	GET /process-groups/{id}/connections	Gets all connections
get_funnels	GET /process-groups/{id}/funnels	Gets all funnels
get_input_ports	GET /process-groups/{id}/input-ports	Gets all input ports
get_labels	GET /process-groups/{id}/labels	Gets all labels
get_local_modifications	GET /process-groups/{id}/local-modifications	Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry
get_output_ports	GET /process-groups/{id}/output-ports	Gets all output ports
get_process_group	GET /process-groups/{id}	Gets a process group
get_process_groups	GET /process-groups/{id}/process-groups	Gets all process groups
get_processors	GET /process-groups/{id}/processors	Gets all processors
get_remote_process_groups	GET /process-groups/{id}/remote-process-groups	Gets all remote process groups
get_variable_registry	GET /process-groups/{id}/variable-registry	Gets a process group's variable registry
get_variable_registry_update_request	GET /process-groups/{groupId}/variable-registry/update-requests/{updateId}	Gets a process group's variable registry
import_template	POST /process-groups/{id}/templates/import	Imports a template
instantiate_template	POST /process-groups/{id}/template-instance	Instantiates a template
remove_process_group	DELETE /process-groups/{id}	Deletes a process group
submit_update_variable_registry_request	POST /process-groups/{id}/variable-registry/update-requests	Submits a request to update a process group's variable registry
update_process_group	PUT /process-groups/{id}	Updates a process group
update_variable_registry	PUT /process-groups/{id}/variable-registry	Updates the contents of a Process Group's variable Registry
upload_template	POST /process-groups/{id}/templates/upload	Uploads a template

copy_snippet

FlowEntity copy_snippet(id, body)

Copies a snippet and discards it.

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.
body = swagger_client.CopySnippetRequestEntity() # CopySnippetRequestEntity | The copy snippet request.

try: 
    # Copies a snippet and discards it.
    api_response = api_instance.copy_snippet(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->copy_snippet: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.
body	CopySnippetRequestEntity	The copy snippet request.

Return type

FlowEntity

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]

create_connection

ConnectionEntity create_connection(id, body)

Creates a connection

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.
body = swagger_client.ConnectionEntity() # ConnectionEntity | The connection configuration details.

try: 
    # Creates a connection
    api_response = api_instance.create_connection(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->create_connection: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.
body	ConnectionEntity	The connection configuration details.

Return type

ConnectionEntity

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]

create_controller_service

ControllerServiceEntity create_controller_service(id, body)

Creates a new 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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.
body = swagger_client.ControllerServiceEntity() # ControllerServiceEntity | The controller service configuration details.

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

Parameters

Name	Type	Description	Notes
id	str	The process group 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]

create_funnel

FunnelEntity create_funnel(id, body)

Creates 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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.
body = swagger_client.FunnelEntity() # FunnelEntity | The funnel configuration details.

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

Parameters

Name	Type	Description	Notes
id	str	The process group 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]

create_input_port

PortEntity create_input_port(id, body)

Creates an input port

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.
body = swagger_client.PortEntity() # PortEntity | The input port configuration details.

try: 
    # Creates an input port
    api_response = api_instance.create_input_port(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->create_input_port: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.
body	PortEntity	The input port configuration details.

Return type

PortEntity

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]

create_label

LabelEntity create_label(id, body)

Creates a label

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.
body = swagger_client.LabelEntity() # LabelEntity | The label configuration details.

try: 
    # Creates a label
    api_response = api_instance.create_label(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->create_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.
body	LabelEntity	The label configuration details.

Return type

LabelEntity

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]

create_output_port

PortEntity create_output_port(id, body)

Creates an output port

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.
body = swagger_client.PortEntity() # PortEntity | The output port configuration.

try: 
    # Creates an output port
    api_response = api_instance.create_output_port(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->create_output_port: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.
body	PortEntity	The output port configuration.

Return type

PortEntity

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]

create_process_group

ProcessGroupEntity create_process_group(id, body)

Creates a process group

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.
body = swagger_client.ProcessGroupEntity() # ProcessGroupEntity | The process group configuration details.

try: 
    # Creates a process group
    api_response = api_instance.create_process_group(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->create_process_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.
body	ProcessGroupEntity	The process group configuration details.

Return type

ProcessGroupEntity

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]

create_processor

ProcessorEntity create_processor(id, body)

Creates a new processor

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.
body = swagger_client.ProcessorEntity() # ProcessorEntity | The processor configuration details.

try: 
    # Creates a new processor
    api_response = api_instance.create_processor(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->create_processor: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.
body	ProcessorEntity	The processor configuration details.

Return type

ProcessorEntity

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]

create_remote_process_group

RemoteProcessGroupEntity create_remote_process_group(id, body)

Creates a new process group

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.
body = swagger_client.RemoteProcessGroupEntity() # RemoteProcessGroupEntity | The remote process group configuration details.

try: 
    # Creates a new process group
    api_response = api_instance.create_remote_process_group(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->create_remote_process_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.
body	RemoteProcessGroupEntity	The remote process group configuration details.

Return type

RemoteProcessGroupEntity

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]

create_template

TemplateEntity create_template(id, body)

Creates a template and discards the specified snippet.

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.
body = swagger_client.CreateTemplateRequestEntity() # CreateTemplateRequestEntity | The create template request.

try: 
    # Creates a template and discards the specified snippet.
    api_response = api_instance.create_template(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->create_template: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.
body	CreateTemplateRequestEntity	The create template request.

Return type

TemplateEntity

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]

delete_variable_registry_update_request

VariableRegistryUpdateRequestEntity delete_variable_registry_update_request(group_id, update_id)

Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.

Note: This endpoint is subject to change as NiFi and it's REST API evolve.

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.ProcessgroupsApi()
group_id = 'group_id_example' # str | The process group id.
update_id = 'update_id_example' # str | The ID of the Variable Registry Update Request

try: 
    # Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.
    api_response = api_instance.delete_variable_registry_update_request(group_id, update_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->delete_variable_registry_update_request: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_id	str	The process group id.
update_id	str	The ID of the Variable Registry Update Request

Return type

VariableRegistryUpdateRequestEntity

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_connections

ConnectionsEntity get_connections(id)

Gets all connections

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.

try: 
    # Gets all connections
    api_response = api_instance.get_connections(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->get_connections: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.

Return type

ConnectionsEntity

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_funnels

FunnelsEntity get_funnels(id)

Gets all funnels

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.

try: 
    # Gets all funnels
    api_response = api_instance.get_funnels(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->get_funnels: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.

Return type

FunnelsEntity

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_input_ports

InputPortsEntity get_input_ports(id)

Gets all input ports

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.

try: 
    # Gets all input ports
    api_response = api_instance.get_input_ports(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->get_input_ports: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.

Return type

InputPortsEntity

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_labels

LabelsEntity get_labels(id)

Gets all labels

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.

try: 
    # Gets all labels
    api_response = api_instance.get_labels(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->get_labels: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.

Return type

LabelsEntity

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_local_modifications

FlowComparisonEntity get_local_modifications(id)

Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.

try: 
    # Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry
    api_response = api_instance.get_local_modifications(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->get_local_modifications: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.

Return type

FlowComparisonEntity

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_output_ports

OutputPortsEntity get_output_ports(id)

Gets all output ports

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.

try: 
    # Gets all output ports
    api_response = api_instance.get_output_ports(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->get_output_ports: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.

Return type

OutputPortsEntity

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_process_group

ProcessGroupEntity get_process_group(id)

Gets a process group

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.

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

Parameters

Name	Type	Description	Notes
id	str	The process group id.

Return type

ProcessGroupEntity

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_process_groups

ProcessGroupsEntity get_process_groups(id)

Gets all process groups

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.

try: 
    # Gets all process groups
    api_response = api_instance.get_process_groups(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->get_process_groups: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.

Return type

ProcessGroupsEntity

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_processors

ProcessorsEntity get_processors(id, include_descendant_groups=include_descendant_groups)

Gets all processors

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.
include_descendant_groups = false # bool | Whether or not to include processors from descendant process groups (optional) (default to false)

try: 
    # Gets all processors
    api_response = api_instance.get_processors(id, include_descendant_groups=include_descendant_groups)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->get_processors: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.
include_descendant_groups	bool	Whether or not to include processors from descendant process groups	[optional] [default to false]

Return type

ProcessorsEntity

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_remote_process_groups

RemoteProcessGroupsEntity get_remote_process_groups(id)

Gets all remote process groups

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.

try: 
    # Gets all remote process groups
    api_response = api_instance.get_remote_process_groups(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->get_remote_process_groups: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.

Return type

RemoteProcessGroupsEntity

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_variable_registry

VariableRegistryEntity get_variable_registry(id, include_ancestor_groups=include_ancestor_groups)

Gets a process group's variable registry

Note: This endpoint is subject to change as NiFi and it's REST API evolve.

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.
include_ancestor_groups = true # bool | Whether or not to include ancestor groups (optional) (default to true)

try: 
    # Gets a process group's variable registry
    api_response = api_instance.get_variable_registry(id, include_ancestor_groups=include_ancestor_groups)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->get_variable_registry: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.
include_ancestor_groups	bool	Whether or not to include ancestor groups	[optional] [default to true]

Return type

VariableRegistryEntity

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_variable_registry_update_request

VariableRegistryUpdateRequestEntity get_variable_registry_update_request(group_id, update_id)

Gets a process group's variable registry

Note: This endpoint is subject to change as NiFi and it's REST API evolve.

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.ProcessgroupsApi()
group_id = 'group_id_example' # str | The process group id.
update_id = 'update_id_example' # str | The ID of the Variable Registry Update Request

try: 
    # Gets a process group's variable registry
    api_response = api_instance.get_variable_registry_update_request(group_id, update_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->get_variable_registry_update_request: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_id	str	The process group id.
update_id	str	The ID of the Variable Registry Update Request

Return type

VariableRegistryUpdateRequestEntity

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]

import_template

TemplateEntity import_template(id)

Imports a template

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.

try: 
    # Imports a template
    api_response = api_instance.import_template(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->import_template: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.

Return type

TemplateEntity

Authorization

No authorization required

HTTP request headers

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

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

instantiate_template

FlowEntity instantiate_template(id, body)

Instantiates a template

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.
body = swagger_client.InstantiateTemplateRequestEntity() # InstantiateTemplateRequestEntity | The instantiate template request.

try: 
    # Instantiates a template
    api_response = api_instance.instantiate_template(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->instantiate_template: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.
body	InstantiateTemplateRequestEntity	The instantiate template request.

Return type

FlowEntity

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]

remove_process_group

ProcessGroupEntity remove_process_group(id, version=version, client_id=client_id)

Deletes a process group

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

Parameters

Name	Type	Description	Notes
id	str	The process group 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

ProcessGroupEntity

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]

submit_update_variable_registry_request

VariableRegistryUpdateRequestEntity submit_update_variable_registry_request(id, body)

Submits a request to update a process group's variable registry

Note: This endpoint is subject to change as NiFi and it's REST API evolve.

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.
body = swagger_client.VariableRegistryEntity() # VariableRegistryEntity | The variable registry configuration details.

try: 
    # Submits a request to update a process group's variable registry
    api_response = api_instance.submit_update_variable_registry_request(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->submit_update_variable_registry_request: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.
body	VariableRegistryEntity	The variable registry configuration details.

Return type

VariableRegistryUpdateRequestEntity

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_process_group

ProcessGroupEntity update_process_group(id, body)

Updates a process group

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.
body = swagger_client.ProcessGroupEntity() # ProcessGroupEntity | The process group configuration details.

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

Parameters

Name	Type	Description	Notes
id	str	The process group id.
body	ProcessGroupEntity	The process group configuration details.

Return type

ProcessGroupEntity

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_variable_registry

VariableRegistryEntity update_variable_registry(id, body)

Updates the contents of a Process Group's variable Registry

Note: This endpoint is subject to change as NiFi and it's REST API evolve.

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.
body = swagger_client.VariableRegistryEntity() # VariableRegistryEntity | The variable registry configuration details.

try: 
    # Updates the contents of a Process Group's variable Registry
    api_response = api_instance.update_variable_registry(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->update_variable_registry: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.
body	VariableRegistryEntity	The variable registry configuration details.

Return type

VariableRegistryEntity

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]

upload_template

TemplateEntity upload_template(id)

Uploads a template

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.ProcessgroupsApi()
id = 'id_example' # str | The process group id.

try: 
    # Uploads a template
    api_response = api_instance.upload_template(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessgroupsApi->upload_template: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The process group id.

Return type

TemplateEntity

Authorization

No authorization required

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/xml

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