Skip to content

Latest commit

 

History

History
292 lines (198 loc) · 7.8 KB

ReportingtasksApi.md

File metadata and controls

292 lines (198 loc) · 7.8 KB
Raw

ReportingtasksApi

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

Method HTTP request Description
clearState POST /reporting-tasks/{id}/state/clear-requests Clears the state for a reporting task
getPropertyDescriptor GET /reporting-tasks/{id}/descriptors Gets a reporting task property descriptor
getReportingTask GET /reporting-tasks/{id} Gets a reporting task
getState GET /reporting-tasks/{id}/state Gets the state for a reporting task
removeReportingTask DELETE /reporting-tasks/{id} Deletes a reporting task
updateReportingTask PUT /reporting-tasks/{id} Updates a reporting task

clearState

ComponentStateDTO clearState(id)

Clears the state for a reporting task

Example

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


ReportingtasksApi apiInstance = new ReportingtasksApi();
String id = "id_example"; // String | The reporting task id.
try {
    ComponentStateDTO result = apiInstance.clearState(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ReportingtasksApi#clearState");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The reporting task id.

Return type

ComponentStateDTO

Authorization

No authorization required

HTTP request headers

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

getPropertyDescriptor

PropertyDescriptorEntity getPropertyDescriptor(id, propertyName)

Gets a reporting task property descriptor

Example

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


ReportingtasksApi apiInstance = new ReportingtasksApi();
String id = "id_example"; // String | The reporting task id.
String propertyName = "propertyName_example"; // String | The property name.
try {
    PropertyDescriptorEntity result = apiInstance.getPropertyDescriptor(id, propertyName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ReportingtasksApi#getPropertyDescriptor");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The reporting task id.
propertyName String The property name.

Return type

PropertyDescriptorEntity

Authorization

No authorization required

HTTP request headers

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

getReportingTask

ReportingTaskEntity getReportingTask(id)

Gets a reporting task

Example

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


ReportingtasksApi apiInstance = new ReportingtasksApi();
String id = "id_example"; // String | The reporting task id.
try {
    ReportingTaskEntity result = apiInstance.getReportingTask(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ReportingtasksApi#getReportingTask");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The reporting task id.

Return type

ReportingTaskEntity

Authorization

No authorization required

HTTP request headers

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

getState

ComponentStateDTO getState(id)

Gets the state for a reporting task

Example

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


ReportingtasksApi apiInstance = new ReportingtasksApi();
String id = "id_example"; // String | The reporting task id.
try {
    ComponentStateDTO result = apiInstance.getState(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ReportingtasksApi#getState");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The reporting task id.

Return type

ComponentStateDTO

Authorization

No authorization required

HTTP request headers

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

removeReportingTask

ReportingTaskEntity removeReportingTask(id, version, clientId)

Deletes a reporting task

Example

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


ReportingtasksApi apiInstance = new ReportingtasksApi();
String id = "id_example"; // String | The reporting task 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 {
    ReportingTaskEntity result = apiInstance.removeReportingTask(id, version, clientId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ReportingtasksApi#removeReportingTask");
    e.printStackTrace();
}

Parameters

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

ReportingTaskEntity

Authorization

No authorization required

HTTP request headers

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

updateReportingTask

ReportingTaskEntity updateReportingTask(id, body)

Updates a reporting task

Example

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


ReportingtasksApi apiInstance = new ReportingtasksApi();
String id = "id_example"; // String | The reporting task id.
ReportingTaskEntity body = new ReportingTaskEntity(); // ReportingTaskEntity | The reporting task configuration details.
try {
    ReportingTaskEntity result = apiInstance.updateReportingTask(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ReportingtasksApi#updateReportingTask");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The reporting task id.
body ReportingTaskEntity The reporting task configuration details.

Return type

ReportingTaskEntity

Authorization

No authorization required

HTTP request headers

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