\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
UpdateRunStatus	Put /reporting-tasks/{id}/run-status	Updates run status of a reporting task

ClearState

ComponentStateEntity ClearState(ctx, id).Execute()

Clears the state for a reporting task

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | The reporting task id.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ReportingTasksApi.ClearState(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ReportingTasksApi.ClearState``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ClearState`: ComponentStateEntity
    fmt.Fprintf(os.Stdout, "Response from `ReportingTasksApi.ClearState`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	The reporting task id.

Other Parameters

Other parameters are passed through a pointer to a apiClearStateRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ComponentStateEntity

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPropertyDescriptor

PropertyDescriptorEntity GetPropertyDescriptor(ctx, id).PropertyName(propertyName).Execute()

Gets a reporting task property descriptor

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | The reporting task id.
    propertyName := "propertyName_example" // string | The property name.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ReportingTasksApi.GetPropertyDescriptor(context.Background(), id).PropertyName(propertyName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ReportingTasksApi.GetPropertyDescriptor``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetPropertyDescriptor`: PropertyDescriptorEntity
    fmt.Fprintf(os.Stdout, "Response from `ReportingTasksApi.GetPropertyDescriptor`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	The reporting task id.

Other Parameters

Other parameters are passed through a pointer to a apiGetPropertyDescriptorRequest struct via the builder pattern

Name	Type	Description	Notes

propertyName | string | The property name. |

Return type

PropertyDescriptorEntity

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetReportingTask

ReportingTaskEntity GetReportingTask(ctx, id).Execute()

Gets a reporting task

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | The reporting task id.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ReportingTasksApi.GetReportingTask(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ReportingTasksApi.GetReportingTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetReportingTask`: ReportingTaskEntity
    fmt.Fprintf(os.Stdout, "Response from `ReportingTasksApi.GetReportingTask`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	The reporting task id.

Other Parameters

Other parameters are passed through a pointer to a apiGetReportingTaskRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ReportingTaskEntity

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetState

ComponentStateEntity GetState(ctx, id).Execute()

Gets the state for a reporting task

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | The reporting task id.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ReportingTasksApi.GetState(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ReportingTasksApi.GetState``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetState`: ComponentStateEntity
    fmt.Fprintf(os.Stdout, "Response from `ReportingTasksApi.GetState`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	The reporting task id.

Other Parameters

Other parameters are passed through a pointer to a apiGetStateRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ComponentStateEntity

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveReportingTask

ReportingTaskEntity RemoveReportingTask(ctx, id).Version(version).ClientId(clientId).DisconnectedNodeAcknowledged(disconnectedNodeAcknowledged).Execute()

Deletes a reporting task

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | The reporting task id.
    version := "version_example" // string | The revision is used to verify the client is working with the latest version of the flow. (optional)
    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)
    disconnectedNodeAcknowledged := true // bool | Acknowledges that this node is disconnected to allow for mutable requests to proceed. (optional) (default to false)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ReportingTasksApi.RemoveReportingTask(context.Background(), id).Version(version).ClientId(clientId).DisconnectedNodeAcknowledged(disconnectedNodeAcknowledged).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ReportingTasksApi.RemoveReportingTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RemoveReportingTask`: ReportingTaskEntity
    fmt.Fprintf(os.Stdout, "Response from `ReportingTasksApi.RemoveReportingTask`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	The reporting task id.

Other Parameters

Other parameters are passed through a pointer to a apiRemoveReportingTaskRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ReportingTaskEntity

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateReportingTask

ReportingTaskEntity UpdateReportingTask(ctx, id).Body(body).Execute()

Updates a reporting task

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | The reporting task id.
    body := *openapiclient.NewReportingTaskEntity() // ReportingTaskEntity | The reporting task configuration details.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ReportingTasksApi.UpdateReportingTask(context.Background(), id).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ReportingTasksApi.UpdateReportingTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateReportingTask`: ReportingTaskEntity
    fmt.Fprintf(os.Stdout, "Response from `ReportingTasksApi.UpdateReportingTask`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	The reporting task id.

Other Parameters

Other parameters are passed through a pointer to a apiUpdateReportingTaskRequest struct via the builder pattern

Name	Type	Description	Notes

body | ReportingTaskEntity | The reporting task configuration details. |

Return type

ReportingTaskEntity

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

ReportingTaskEntity UpdateRunStatus(ctx, id).Body(body).Execute()

Updates run status of a reporting task

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | The reporting task id.
    body := *openapiclient.NewReportingTaskRunStatusEntity() // ReportingTaskRunStatusEntity | The reporting task run status.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ReportingTasksApi.UpdateRunStatus(context.Background(), id).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ReportingTasksApi.UpdateRunStatus``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateRunStatus`: ReportingTaskEntity
    fmt.Fprintf(os.Stdout, "Response from `ReportingTasksApi.UpdateRunStatus`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	The reporting task id.

Other Parameters

Other parameters are passed through a pointer to a apiUpdateRunStatusRequest struct via the builder pattern

Name	Type	Description	Notes

body | ReportingTaskRunStatusEntity | The reporting task run status. |

Return type

ReportingTaskEntity

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

ReportingTasksApi.md

Latest commit

History

ReportingTasksApi.md

File metadata and controls

\ReportingTasksApi

ClearState

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetPropertyDescriptor

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetReportingTask

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetState

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RemoveReportingTask

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateReportingTask

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateRunStatus

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers