ProcessgroupsApi

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

Method	HTTP request	Description
copySnippet	POST /process-groups/{id}/snippet-instance	Copies a snippet
createConnection	POST /process-groups/{id}/connections	Creates a connection
createControllerService	POST /process-groups/{id}/controller-services	Creates a new controller service
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
getConnections	GET /process-groups/{id}/connections	Gets all connections
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
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
importTemplate	POST /process-groups/{id}/templates/import	Imports a template
instantiateTemplate	POST /process-groups/{id}/template-instance	Instantiates a template
removeProcessGroup	DELETE /process-groups/{id}	Deletes a process group
updateProcessGroup	PUT /process-groups/{id}	Updates a process group
uploadTemplate	POST /process-groups/{id}/templates/upload	Uploads a template

copySnippet

FlowSnippetEntity copySnippet(id, body)

Copies a 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.
CopySnippetRequestEntity body = new CopySnippetRequestEntity(); // CopySnippetRequestEntity | The copy snippet request.
try {
    FlowSnippetEntity 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

FlowSnippetEntity

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

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

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

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

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

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

ProcessorsEntity 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 {
    ProcessorsEntity 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

ProcessorsEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: application/json

getProcessors

ProcessorsEntity getProcessors(id)

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.
try {
    ProcessorsEntity result = apiInstance.getProcessors(id);
    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.

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

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

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

removeProcessGroup

ProcessGroupEntity removeProcessGroup(id, version, clientId)

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.
try {
    ProcessGroupEntity result = apiInstance.removeProcessGroup(id, version, clientId);
    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]

Return type

ProcessGroupEntity

Authorization

No authorization required

HTTP request headers

Content-Type: /
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

uploadTemplate

TemplateEntity uploadTemplate(id, template)

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 | 
try {
    TemplateEntity result = apiInstance.uploadTemplate(id, template);
    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		[optional]

Return type

TemplateEntity

Authorization

No authorization required

HTTP request headers

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

Files

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

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

getConnections

Example

Parameters

Return type

Authorization

HTTP request headers

getFunnels