Skip to content

Latest commit

 

History

History
152 lines (103 loc) · 4.03 KB

OutputportsApi.md

File metadata and controls

152 lines (103 loc) · 4.03 KB
Raw

OutputportsApi

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

Method HTTP request Description
getOutputPort GET /output-ports/{id} Gets an output port
removeOutputPort DELETE /output-ports/{id} Deletes an output port
updateOutputPort PUT /output-ports/{id} Updates an output port

getOutputPort

PortEntity getOutputPort(id)

Gets an output port

Example

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


OutputportsApi apiInstance = new OutputportsApi();
String id = "id_example"; // String | The output port id.
try {
    PortEntity result = apiInstance.getOutputPort(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OutputportsApi#getOutputPort");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The output port id.

Return type

PortEntity

Authorization

No authorization required

HTTP request headers

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

removeOutputPort

PortEntity removeOutputPort(id, version, clientId)

Deletes an output port

Example

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


OutputportsApi apiInstance = new OutputportsApi();
String id = "id_example"; // String | The output port 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 {
    PortEntity result = apiInstance.removeOutputPort(id, version, clientId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OutputportsApi#removeOutputPort");
    e.printStackTrace();
}

Parameters

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

PortEntity

Authorization

No authorization required

HTTP request headers

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

updateOutputPort

PortEntity updateOutputPort(id, body)

Updates an output port

Example

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


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

Parameters

Name Type Description Notes
id String The output port id.
body PortEntity The output port configuration details.

Return type

PortEntity

Authorization

No authorization required

HTTP request headers

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