ProcessgroupsApi

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

Method	HTTP request	Description
copySnippet	POST /process-groups/{id}/snippet-instance	Copies a snippet and discards it.
createConnection	POST /process-groups/{id}/connections	Creates a connection
createControllerService	POST /process-groups/{id}/controller-services	Creates a new controller service
createEmptyAllConnectionsRequest	POST /process-groups/{id}/empty-all-connections-requests	Creates a request to drop all flowfiles of all connection queues in this process group.
createFunnel	POST /process-groups/{id}/funnels	Creates a funnel
createInputPort	POST /process-groups/{id}/input-ports	Creates an input port
createLabel	POST /process-groups/{id}/labels	Creates a label
createOutputPort	POST /process-groups/{id}/output-ports	Creates an output port
createProcessGroup	POST /process-groups/{id}/process-groups	Creates a process group
createProcessor	POST /process-groups/{id}/processors	Creates a new processor
createRemoteProcessGroup	POST /process-groups/{id}/remote-process-groups	Creates a new process group
createTemplate	POST /process-groups/{id}/templates	Creates a template and discards the specified snippet.
deleteReplaceProcessGroupRequest	DELETE /process-groups/replace-requests/{id}	Deletes the Replace Request with the given ID
deleteVariableRegistryUpdateRequest	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.
exportProcessGroup	GET /process-groups/{id}/download	Gets a process group for download
getConnections	GET /process-groups/{id}/connections	Gets all connections
getDropAllFlowfilesRequest	GET /process-groups/{id}/empty-all-connections-requests/{drop-request-id}	Gets the current status of a drop all flowfiles request.
getFunnels	GET /process-groups/{id}/funnels	Gets all funnels
getInputPorts	GET /process-groups/{id}/input-ports	Gets all input ports
getLabels	GET /process-groups/{id}/labels	Gets all labels
getLocalModifications	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
getOutputPorts	GET /process-groups/{id}/output-ports	Gets all output ports
getProcessGroup	GET /process-groups/{id}	Gets a process group
getProcessGroups	GET /process-groups/{id}/process-groups	Gets all process groups
getProcessors	GET /process-groups/{id}/processors	Gets all processors
getRemoteProcessGroups	GET /process-groups/{id}/remote-process-groups	Gets all remote process groups
getReplaceProcessGroupRequest	GET /process-groups/replace-requests/{id}	Returns the Replace Request with the given ID
getVariableRegistry	GET /process-groups/{id}/variable-registry	Gets a process group's variable registry
getVariableRegistryUpdateRequest	GET /process-groups/{groupId}/variable-registry/update-requests/{updateId}	Gets a process group's variable registry
importProcessGroup	POST /process-groups/{id}/process-groups/import	Imports a specified process group
importTemplate	POST /process-groups/{id}/templates/import	Imports a template
initiateReplaceProcessGroup	POST /process-groups/{id}/replace-requests	Initiate the Replace Request of a Process Group with the given ID
instantiateTemplate	POST /process-groups/{id}/template-instance	Instantiates a template
removeDropRequest	DELETE /process-groups/{id}/empty-all-connections-requests/{drop-request-id}	Cancels and/or removes a request to drop all flowfiles.
removeProcessGroup	DELETE /process-groups/{id}	Deletes a process group
replaceProcessGroup	PUT /process-groups/{id}/flow-contents	Replace Process Group contents with the given ID with the specified Process Group contents
submitUpdateVariableRegistryRequest	POST /process-groups/{id}/variable-registry/update-requests	Submits a request to update a process group's variable registry
updateProcessGroup	PUT /process-groups/{id}	Updates a process group
updateVariableRegistry	PUT /process-groups/{id}/variable-registry	Updates the contents of a Process Group's variable Registry
uploadProcessGroup	POST /process-groups/{id}/process-groups/upload	Uploads a versioned flow definition and creates a process group
uploadTemplate	POST /process-groups/{id}/templates/upload	Uploads a template

copySnippet

FlowEntity copySnippet(id, body)

Copies a snippet and discards it.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
CopySnippetRequestEntity body = new CopySnippetRequestEntity(); // CopySnippetRequestEntity | The copy snippet request.
try {
    FlowEntity result = apiInstance.copySnippet(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#copySnippet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	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

createConnection

ConnectionEntity createConnection(id, body)

Creates a connection

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
ConnectionEntity body = new ConnectionEntity(); // ConnectionEntity | The connection configuration details.
try {
    ConnectionEntity result = apiInstance.createConnection(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#createConnection");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	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

createControllerService

ControllerServiceEntity createControllerService(id, body)

Creates a new controller service

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
ControllerServiceEntity body = new ControllerServiceEntity(); // ControllerServiceEntity | The controller service configuration details.
try {
    ControllerServiceEntity result = apiInstance.createControllerService(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#createControllerService");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	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

createEmptyAllConnectionsRequest

DropRequestEntity createEmptyAllConnectionsRequest(id)

Creates a request to drop all flowfiles of all connection queues in this process group.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
try {
    DropRequestEntity result = apiInstance.createEmptyAllConnectionsRequest(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#createEmptyAllConnectionsRequest");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.

Return type

DropRequestEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

createFunnel

FunnelEntity createFunnel(id, body)

Creates a funnel

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
FunnelEntity body = new FunnelEntity(); // FunnelEntity | The funnel configuration details.
try {
    FunnelEntity result = apiInstance.createFunnel(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#createFunnel");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	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

createInputPort

PortEntity createInputPort(id, body)

Creates an input port

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
PortEntity body = new PortEntity(); // PortEntity | The input port configuration details.
try {
    PortEntity result = apiInstance.createInputPort(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#createInputPort");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	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

createLabel

LabelEntity createLabel(id, body)

Creates a label

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
LabelEntity body = new LabelEntity(); // LabelEntity | The label configuration details.
try {
    LabelEntity result = apiInstance.createLabel(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#createLabel");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	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

createOutputPort

PortEntity createOutputPort(id, body)

Creates an output port

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
PortEntity body = new PortEntity(); // PortEntity | The output port configuration.
try {
    PortEntity result = apiInstance.createOutputPort(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#createOutputPort");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	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

createProcessGroup

ProcessGroupEntity createProcessGroup(id, body)

Creates a process group

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
ProcessGroupEntity body = new ProcessGroupEntity(); // ProcessGroupEntity | The process group configuration details.
try {
    ProcessGroupEntity result = apiInstance.createProcessGroup(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#createProcessGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	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

createProcessor

ProcessorEntity createProcessor(id, body)

Creates a new processor

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
ProcessorEntity body = new ProcessorEntity(); // ProcessorEntity | The processor configuration details.
try {
    ProcessorEntity result = apiInstance.createProcessor(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#createProcessor");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	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

createRemoteProcessGroup

RemoteProcessGroupEntity createRemoteProcessGroup(id, body)

Creates a new process group

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
RemoteProcessGroupEntity body = new RemoteProcessGroupEntity(); // RemoteProcessGroupEntity | The remote process group configuration details.
try {
    RemoteProcessGroupEntity result = apiInstance.createRemoteProcessGroup(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#createRemoteProcessGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	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

createTemplate

TemplateEntity createTemplate(id, body)

Creates a template and discards the specified snippet.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
CreateTemplateRequestEntity body = new CreateTemplateRequestEntity(); // CreateTemplateRequestEntity | The create template request.
try {
    TemplateEntity result = apiInstance.createTemplate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#createTemplate");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	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

deleteReplaceProcessGroupRequest

ProcessGroupReplaceRequestEntity deleteReplaceProcessGroupRequest(id, disconnectedNodeAcknowledged)

Deletes the Replace Request with the given ID

Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The ID of the Update Request
Boolean disconnectedNodeAcknowledged = false; // Boolean | Acknowledges that this node is disconnected to allow for mutable requests to proceed.
try {
    ProcessGroupReplaceRequestEntity result = apiInstance.deleteReplaceProcessGroupRequest(id, disconnectedNodeAcknowledged);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#deleteReplaceProcessGroupRequest");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The ID of the Update Request
disconnectedNodeAcknowledged	Boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.	[optional] [default to false]

Return type

ProcessGroupReplaceRequestEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

deleteVariableRegistryUpdateRequest

VariableRegistryUpdateRequestEntity deleteVariableRegistryUpdateRequest(groupId, updateId, disconnectedNodeAcknowledged)

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

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String groupId = "groupId_example"; // String | The process group id.
String updateId = "updateId_example"; // String | The ID of the Variable Registry Update Request
Boolean disconnectedNodeAcknowledged = false; // Boolean | Acknowledges that this node is disconnected to allow for mutable requests to proceed.
try {
    VariableRegistryUpdateRequestEntity result = apiInstance.deleteVariableRegistryUpdateRequest(groupId, updateId, disconnectedNodeAcknowledged);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#deleteVariableRegistryUpdateRequest");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
groupId	String	The process group id.
updateId	String	The ID of the Variable Registry Update Request
disconnectedNodeAcknowledged	Boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.	[optional] [default to false]

Return type

VariableRegistryUpdateRequestEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

exportProcessGroup

String exportProcessGroup(id, includeReferencedServices)

Gets a process group for download

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
Boolean includeReferencedServices = false; // Boolean | If referenced services from outside the target group should be included
try {
    String result = apiInstance.exportProcessGroup(id, includeReferencedServices);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#exportProcessGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.
includeReferencedServices	Boolean	If referenced services from outside the target group should be included	[optional] [default to false]

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getConnections

ConnectionsEntity getConnections(id)

Gets all connections

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
try {
    ConnectionsEntity result = apiInstance.getConnections(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#getConnections");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.

Return type

ConnectionsEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getDropAllFlowfilesRequest

DropRequestEntity getDropAllFlowfilesRequest(id, dropRequestId)

Gets the current status of a drop all flowfiles request.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
String dropRequestId = "dropRequestId_example"; // String | The drop request id.
try {
    DropRequestEntity result = apiInstance.getDropAllFlowfilesRequest(id, dropRequestId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#getDropAllFlowfilesRequest");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.
dropRequestId	String	The drop request id.

Return type

DropRequestEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getFunnels

FunnelsEntity getFunnels(id)

Gets all funnels

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
try {
    FunnelsEntity result = apiInstance.getFunnels(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#getFunnels");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.

Return type

FunnelsEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getInputPorts

InputPortsEntity getInputPorts(id)

Gets all input ports

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
try {
    InputPortsEntity result = apiInstance.getInputPorts(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#getInputPorts");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.

Return type

InputPortsEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getLabels

LabelsEntity getLabels(id)

Gets all labels

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
try {
    LabelsEntity result = apiInstance.getLabels(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#getLabels");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.

Return type

LabelsEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getLocalModifications

FlowComparisonEntity getLocalModifications(id)

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

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
try {
    FlowComparisonEntity result = apiInstance.getLocalModifications(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#getLocalModifications");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.

Return type

FlowComparisonEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getOutputPorts

OutputPortsEntity getOutputPorts(id)

Gets all output ports

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
try {
    OutputPortsEntity result = apiInstance.getOutputPorts(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#getOutputPorts");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.

Return type

OutputPortsEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getProcessGroup

ProcessGroupEntity getProcessGroup(id)

Gets a process group

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
try {
    ProcessGroupEntity result = apiInstance.getProcessGroup(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#getProcessGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.

Return type

ProcessGroupEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getProcessGroups

ProcessGroupsEntity getProcessGroups(id)

Gets all process groups

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
try {
    ProcessGroupsEntity result = apiInstance.getProcessGroups(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#getProcessGroups");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.

Return type

ProcessGroupsEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getProcessors

ProcessorsEntity getProcessors(id, includeDescendantGroups)

Gets all processors

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
Boolean includeDescendantGroups = false; // Boolean | Whether or not to include processors from descendant process groups
try {
    ProcessorsEntity result = apiInstance.getProcessors(id, includeDescendantGroups);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#getProcessors");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.
includeDescendantGroups	Boolean	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

getRemoteProcessGroups

RemoteProcessGroupsEntity getRemoteProcessGroups(id)

Gets all remote process groups

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
try {
    RemoteProcessGroupsEntity result = apiInstance.getRemoteProcessGroups(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#getRemoteProcessGroups");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.

Return type

RemoteProcessGroupsEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getReplaceProcessGroupRequest

ProcessGroupReplaceRequestEntity getReplaceProcessGroupRequest(id)

Returns the Replace Request with the given ID

Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The ID of the Replace Request
try {
    ProcessGroupReplaceRequestEntity result = apiInstance.getReplaceProcessGroupRequest(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#getReplaceProcessGroupRequest");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The ID of the Replace Request

Return type

ProcessGroupReplaceRequestEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getVariableRegistry

VariableRegistryEntity getVariableRegistry(id, includeAncestorGroups)

Gets a process group's variable registry

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

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
Boolean includeAncestorGroups = true; // Boolean | Whether or not to include ancestor groups
try {
    VariableRegistryEntity result = apiInstance.getVariableRegistry(id, includeAncestorGroups);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#getVariableRegistry");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.
includeAncestorGroups	Boolean	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

getVariableRegistryUpdateRequest

VariableRegistryUpdateRequestEntity getVariableRegistryUpdateRequest(groupId, updateId)

Gets a process group's variable registry

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

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String groupId = "groupId_example"; // String | The process group id.
String updateId = "updateId_example"; // String | The ID of the Variable Registry Update Request
try {
    VariableRegistryUpdateRequestEntity result = apiInstance.getVariableRegistryUpdateRequest(groupId, updateId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#getVariableRegistryUpdateRequest");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
groupId	String	The process group id.
updateId	String	The ID of the Variable Registry Update Request

Return type

VariableRegistryUpdateRequestEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

importProcessGroup

ProcessGroupEntity importProcessGroup(id)

Imports a specified process group

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
try {
    ProcessGroupEntity result = apiInstance.importProcessGroup(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#importProcessGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.

Return type

ProcessGroupEntity

Authorization

No authorization required

HTTP request headers

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

importTemplate

TemplateEntity importTemplate(id)

Imports a template

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
try {
    TemplateEntity result = apiInstance.importTemplate(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#importTemplate");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.

Return type

TemplateEntity

Authorization

No authorization required

HTTP request headers

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

initiateReplaceProcessGroup

ProcessGroupReplaceRequestEntity initiateReplaceProcessGroup(id, body)

Initiate the Replace Request of a Process Group with the given ID

This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
ProcessGroupImportEntity body = new ProcessGroupImportEntity(); // ProcessGroupImportEntity | The process group replace request entity
try {
    ProcessGroupReplaceRequestEntity result = apiInstance.initiateReplaceProcessGroup(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#initiateReplaceProcessGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.
body	ProcessGroupImportEntity	The process group replace request entity

Return type

ProcessGroupReplaceRequestEntity

Authorization

No authorization required

HTTP request headers

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

instantiateTemplate

FlowEntity instantiateTemplate(id, body)

Instantiates a template

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
InstantiateTemplateRequestEntity body = new InstantiateTemplateRequestEntity(); // InstantiateTemplateRequestEntity | The instantiate template request.
try {
    FlowEntity result = apiInstance.instantiateTemplate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#instantiateTemplate");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	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

removeDropRequest

DropRequestEntity removeDropRequest(id, dropRequestId)

Cancels and/or removes a request to drop all flowfiles.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
String dropRequestId = "dropRequestId_example"; // String | The drop request id.
try {
    DropRequestEntity result = apiInstance.removeDropRequest(id, dropRequestId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#removeDropRequest");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.
dropRequestId	String	The drop request id.

Return type

DropRequestEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

removeProcessGroup

ProcessGroupEntity removeProcessGroup(id, version, clientId, disconnectedNodeAcknowledged)

Deletes a process group

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
String version = "version_example"; // String | The revision is used to verify the client is working with the latest version of the flow.
String clientId = "clientId_example"; // String | If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
Boolean disconnectedNodeAcknowledged = false; // Boolean | Acknowledges that this node is disconnected to allow for mutable requests to proceed.
try {
    ProcessGroupEntity result = apiInstance.removeProcessGroup(id, version, clientId, disconnectedNodeAcknowledged);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#removeProcessGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.
version	String	The revision is used to verify the client is working with the latest version of the flow.	[optional]
clientId	String	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.	[optional]
disconnectedNodeAcknowledged	Boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.	[optional] [default to false]

Return type

ProcessGroupEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

replaceProcessGroup

ProcessGroupImportEntity replaceProcessGroup(id, body)

Replace Process Group contents with the given ID with the specified Process Group contents

This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
ProcessGroupImportEntity body = new ProcessGroupImportEntity(); // ProcessGroupImportEntity | The process group replace request entity.
try {
    ProcessGroupImportEntity result = apiInstance.replaceProcessGroup(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#replaceProcessGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.
body	ProcessGroupImportEntity	The process group replace request entity.

Return type

ProcessGroupImportEntity

Authorization

No authorization required

HTTP request headers

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

submitUpdateVariableRegistryRequest

VariableRegistryUpdateRequestEntity submitUpdateVariableRegistryRequest(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

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
VariableRegistryEntity body = new VariableRegistryEntity(); // VariableRegistryEntity | The variable registry configuration details.
try {
    VariableRegistryUpdateRequestEntity result = apiInstance.submitUpdateVariableRegistryRequest(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#submitUpdateVariableRegistryRequest");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	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

updateProcessGroup

ProcessGroupEntity updateProcessGroup(id, body)

Updates a process group

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
ProcessGroupEntity body = new ProcessGroupEntity(); // ProcessGroupEntity | The process group configuration details.
try {
    ProcessGroupEntity result = apiInstance.updateProcessGroup(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#updateProcessGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	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

updateVariableRegistry

VariableRegistryEntity updateVariableRegistry(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

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
VariableRegistryEntity body = new VariableRegistryEntity(); // VariableRegistryEntity | The variable registry configuration details.
try {
    VariableRegistryEntity result = apiInstance.updateVariableRegistry(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#updateVariableRegistry");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	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

uploadProcessGroup

ProcessGroupEntity uploadProcessGroup(id, body, body2, body3, body4, body5)

Uploads a versioned flow definition and creates a process group

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
String body = "body_example"; // String | The process group name.
Double body2 = 3.4D; // Double | The process group X position.
Double body3 = 3.4D; // Double | The process group Y position.
String body4 = "body_example"; // String | The client id.
Boolean body5 = true; // Boolean | Acknowledges that this node is disconnected to allow for mutable requests to proceed.
try {
    ProcessGroupEntity result = apiInstance.uploadProcessGroup(id, body, body2, body3, body4, body5);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#uploadProcessGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.
body	String	The process group name.
body2	Double	The process group X position.
body3	Double	The process group Y position.
body4	String	The client id.
body5	Boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.	[optional]

Return type

ProcessGroupEntity

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

uploadTemplate

TemplateEntity uploadTemplate(id, template, body)

Uploads a template

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ProcessgroupsApi;


ProcessgroupsApi apiInstance = new ProcessgroupsApi();
String id = "id_example"; // String | The process group id.
File template = new File("/path/to/file.txt"); // File | The binary content of the template file being uploaded.
Boolean body = true; // Boolean | Acknowledges that this node is disconnected to allow for mutable requests to proceed.
try {
    TemplateEntity result = apiInstance.uploadTemplate(id, template, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessgroupsApi#uploadTemplate");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String	The process group id.
template	File	The binary content of the template file being uploaded.
body	Boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.	[optional]

Return type

TemplateEntity

Authorization

No authorization required

HTTP request headers

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

FilesExpand file tree

ProcessgroupsApi.md

Latest commit

History

ProcessgroupsApi.md

File metadata and controls

ProcessgroupsApi

copySnippet

Example

Parameters

Return type

Authorization

HTTP request headers

createConnection

Example

Parameters

Return type

Authorization

HTTP request headers

createControllerService

Example

Parameters

Return type

Authorization

HTTP request headers

createEmptyAllConnectionsRequest

Example

Parameters

Return type

Authorization

HTTP request headers

createFunnel

Example

Parameters

Return type

Authorization

HTTP request headers

createInputPort

Example

Parameters

Return type

Authorization

HTTP request headers

createLabel

Example

Parameters

Return type

Authorization

HTTP request headers

createOutputPort

Example

Parameters

Return type

Authorization

HTTP request headers

createProcessGroup

Example

Parameters

Return type

Authorization

HTTP request headers

createProcessor

Example

Parameters

Return type

Authorization

HTTP request headers

createRemoteProcessGroup

Example

Parameters

Return type

Authorization

HTTP request headers

createTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

deleteReplaceProcessGroupRequest