IO.Swagger.Api.ControllerServicesApi

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

Method	HTTP request	Description
ClearState	POST /controller-services/{id}/state/clear-requests	Clears the state for a controller service
GetControllerService	GET /controller-services/{id}	Gets a controller service
GetControllerServiceReferences	GET /controller-services/{id}/references	Gets a controller service
GetPropertyDescriptor	GET /controller-services/{id}/descriptors	Gets a controller service property descriptor
GetState	GET /controller-services/{id}/state	Gets the state for a controller service
RemoveControllerService	DELETE /controller-services/{id}	Deletes a controller service
UpdateControllerService	PUT /controller-services/{id}	Updates a controller service
UpdateControllerServiceReferences	PUT /controller-services/{id}/references	Updates a controller services references
UpdateRunStatus	PUT /controller-services/{id}/run-status	Updates run status of a controller service

ClearState

ComponentStateEntity ClearState (string id)

Clears the state for a controller service

Example

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

namespace Example
{
    public class ClearStateExample
    {
        public void main()
        {
            var apiInstance = new ControllerServicesApi();
            var id = id_example;  // string | The controller service id.

            try
            {
                // Clears the state for a controller service
                ComponentStateEntity result = apiInstance.ClearState(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ControllerServicesApi.ClearState: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	The controller service id.

Return type

ComponentStateEntity

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]

GetControllerService

ControllerServiceEntity GetControllerService (string id)

Gets a controller service

Example

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

namespace Example
{
    public class GetControllerServiceExample
    {
        public void main()
        {
            var apiInstance = new ControllerServicesApi();
            var id = id_example;  // string | The controller service id.

            try
            {
                // Gets a controller service
                ControllerServiceEntity result = apiInstance.GetControllerService(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ControllerServicesApi.GetControllerService: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	The controller service id.

Return type

ControllerServiceEntity

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]

GetControllerServiceReferences

ControllerServiceReferencingComponentsEntity GetControllerServiceReferences (string id)

Gets a controller service

Example

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

namespace Example
{
    public class GetControllerServiceReferencesExample
    {
        public void main()
        {
            var apiInstance = new ControllerServicesApi();
            var id = id_example;  // string | The controller service id.

            try
            {
                // Gets a controller service
                ControllerServiceReferencingComponentsEntity result = apiInstance.GetControllerServiceReferences(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ControllerServicesApi.GetControllerServiceReferences: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	The controller service id.

Return type

ControllerServiceReferencingComponentsEntity

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]

GetPropertyDescriptor

PropertyDescriptorEntity GetPropertyDescriptor (string id, string propertyName)

Gets a controller service property descriptor

Example

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

namespace Example
{
    public class GetPropertyDescriptorExample
    {
        public void main()
        {
            var apiInstance = new ControllerServicesApi();
            var id = id_example;  // string | The controller service id.
            var propertyName = propertyName_example;  // string | The property name to return the descriptor for.

            try
            {
                // Gets a controller service property descriptor
                PropertyDescriptorEntity result = apiInstance.GetPropertyDescriptor(id, propertyName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ControllerServicesApi.GetPropertyDescriptor: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	The controller service id.
propertyName	string	The property name to return the descriptor for.

Return type

PropertyDescriptorEntity

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]

GetState

ComponentStateEntity GetState (string id)

Gets the state for a controller service

Example

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

namespace Example
{
    public class GetStateExample
    {
        public void main()
        {
            var apiInstance = new ControllerServicesApi();
            var id = id_example;  // string | The controller service id.

            try
            {
                // Gets the state for a controller service
                ComponentStateEntity result = apiInstance.GetState(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ControllerServicesApi.GetState: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	The controller service id.

Return type

ComponentStateEntity

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]

RemoveControllerService

ControllerServiceEntity RemoveControllerService (string id, string version = null, string clientId = null, bool? disconnectedNodeAcknowledged = null)

Deletes a controller service

Example

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

namespace Example
{
    public class RemoveControllerServiceExample
    {
        public void main()
        {
            var apiInstance = new ControllerServicesApi();
            var id = id_example;  // string | The controller service 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 controller service
                ControllerServiceEntity result = apiInstance.RemoveControllerService(id, version, clientId, disconnectedNodeAcknowledged);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ControllerServicesApi.RemoveControllerService: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	The controller service 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

ControllerServiceEntity

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]

UpdateControllerService

ControllerServiceEntity UpdateControllerService (string id, ControllerServiceEntity body)

Updates a controller service

Example

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

namespace Example
{
    public class UpdateControllerServiceExample
    {
        public void main()
        {
            var apiInstance = new ControllerServicesApi();
            var id = id_example;  // string | The controller service id.
            var body = new ControllerServiceEntity(); // ControllerServiceEntity | The controller service configuration details.

            try
            {
                // Updates a controller service
                ControllerServiceEntity result = apiInstance.UpdateControllerService(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ControllerServicesApi.UpdateControllerService: " + e.Message );
            }
        }
    }
}

Parameters

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

UpdateControllerServiceReferences

ControllerServiceReferencingComponentsEntity UpdateControllerServiceReferences (string id, UpdateControllerServiceReferenceRequestEntity body)

Updates a controller services references

Example

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

namespace Example
{
    public class UpdateControllerServiceReferencesExample
    {
        public void main()
        {
            var apiInstance = new ControllerServicesApi();
            var id = id_example;  // string | The controller service id.
            var body = new UpdateControllerServiceReferenceRequestEntity(); // UpdateControllerServiceReferenceRequestEntity | The controller service request update request.

            try
            {
                // Updates a controller services references
                ControllerServiceReferencingComponentsEntity result = apiInstance.UpdateControllerServiceReferences(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ControllerServicesApi.UpdateControllerServiceReferences: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	The controller service id.
body	UpdateControllerServiceReferenceRequestEntity	The controller service request update request.

Return type

ControllerServiceReferencingComponentsEntity

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]

UpdateRunStatus

ControllerServiceEntity UpdateRunStatus (string id, ControllerServiceRunStatusEntity body)

Updates run status of a controller service

Example

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

namespace Example
{
    public class UpdateRunStatusExample
    {
        public void main()
        {
            var apiInstance = new ControllerServicesApi();
            var id = id_example;  // string | The controller service id.
            var body = new ControllerServiceRunStatusEntity(); // ControllerServiceRunStatusEntity | The controller service run status.

            try
            {
                // Updates run status of a controller service
                ControllerServiceEntity result = apiInstance.UpdateRunStatus(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ControllerServicesApi.UpdateRunStatus: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	string	The controller service id.
body	ControllerServiceRunStatusEntity	The controller service run status.

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]

Files

ControllerServicesApi.md

Latest commit

History

ControllerServicesApi.md

File metadata and controls

IO.Swagger.Api.ControllerServicesApi

ClearState

Example

Parameters

Return type

Authorization

HTTP request headers

GetControllerService

Example

Parameters

Return type

Authorization

HTTP request headers

GetControllerServiceReferences

Example

Parameters

Return type

Authorization

HTTP request headers

GetPropertyDescriptor

Example

Parameters

Return type

Authorization

HTTP request headers

GetState

Example

Parameters

Return type

Authorization

HTTP request headers

RemoveControllerService

Example

Parameters

Return type

Authorization

HTTP request headers

UpdateControllerService

Example

Parameters

Return type

Authorization

HTTP request headers

UpdateControllerServiceReferences

Example

Parameters

Return type

Authorization

HTTP request headers

UpdateRunStatus

Example

Parameters

Return type

Authorization

HTTP request headers