ConnectionsApi.md

IO.Swagger.Api.ConnectionsApi

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

Method	HTTP request	Description
DeleteConnection	DELETE /connections/{id}	Deletes a connection
GetConnection	GET /connections/{id}	Gets a connection
UpdateConnection	PUT /connections/{id}	Updates a connection

DeleteConnection

ConnectionEntity DeleteConnection (string id, string version = null, string clientId = null, bool? disconnectedNodeAcknowledged = null)

Deletes a connection

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class DeleteConnectionExample
    {
        public void main()
        {
            var apiInstance = new ConnectionsApi();
            var id = id_example;  // string | The connection id.
            var version = version_example;  // string | The revision is used to verify the client is working with the latest version of the flow. (optional) 
            var 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. (optional) 
            var disconnectedNodeAcknowledged = true;  // bool? | Acknowledges that this node is disconnected to allow for mutable requests to proceed. (optional)  (default to false)

            try
            {
                // Deletes a connection
                ConnectionEntity result = apiInstance.DeleteConnection(id, version, clientId, disconnectedNodeAcknowledged);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectionsApi.DeleteConnection: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	The connection 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	bool?	Acknowledges that this node is disconnected to allow for mutable requests to proceed.	[optional] [default to false]

Return type

ConnectionEntity

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]

GetConnection

ConnectionEntity GetConnection (string id)

Gets a connection

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class GetConnectionExample
    {
        public void main()
        {
            var apiInstance = new ConnectionsApi();
            var id = id_example;  // string | The connection id.

            try
            {
                // Gets a connection
                ConnectionEntity result = apiInstance.GetConnection(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectionsApi.GetConnection: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	The connection id.

Return type

ConnectionEntity

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]

UpdateConnection

ConnectionEntity UpdateConnection (string id, ConnectionEntity body)

Updates a connection

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class UpdateConnectionExample
    {
        public void main()
        {
            var apiInstance = new ConnectionsApi();
            var id = id_example;  // string | The connection id.
            var body = new ConnectionEntity(); // ConnectionEntity | The connection configuration details.

            try
            {
                // Updates a connection
                ConnectionEntity result = apiInstance.UpdateConnection(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectionsApi.UpdateConnection: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	The connection 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]