| clientId | query | string | If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. |
| grouped | query | boolean | Whether to return the users in their respective groups. |
| Status Code | Type | Description |
|---|---|---|
| 200 | UsersEntity | successful operation |
| 400 | string | NiFi was unable to complete the request because it was invalid. The request should not be retried without modification. |
| 401 | string | Client could not be authenticated. |
| 403 | string | Client is not authorized to make this request. |
| 409 | string | The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful. |
| Name | Location | Type | Description |
|---|---|---|---|
| q | query | string | The search terms. |
| Status Code | Type | Description |
|---|---|---|
| 200 | UserSearchResultsEntity | successful operation |
| 400 | string | NiFi was unable to complete the request because it was invalid. The request should not be retried without modification. |
| 401 | string | Client could not be authenticated. |
| 403 | string | Client is not authorized to make this request. |
| 409 | string | The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful. |
| Name | Location | Type | Description |
|---|---|---|---|
| clientId | query | string | If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. |
| id | path | string | The user id. |
| Status Code | Type | Description |
|---|---|---|
| 200 | UserEntity | successful operation |
| 400 | string | NiFi was unable to complete the request because it was invalid. The request should not be retried without modification. |
| 401 | string | Client could not be authenticated. |
| 403 | string | Client is not authorized to make this request. |
| 404 | string | The specified resource could not be found. |
| 409 | string | The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful. |
| Name | Location | Type | Description |
|---|---|---|---|
| id | path | string | The user id. |
| body | UserEntity | The user configuration details. |
| Status Code | Type | Description |
|---|---|---|
| 200 | UserEntity | successful operation |
| 400 | string | NiFi was unable to complete the request because it was invalid. The request should not be retried without modification. |
| 401 | string | Client could not be authenticated. |
| 403 | string | Client is not authorized to make this request. |
| 404 | string | The specified resource could not be found. |
| 409 | string | The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful. |
| Name | Location | Type | Description |
|---|---|---|---|
| id | path | string | The user id. |
| clientId | query | string | If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. |
| Status Code | Type | Description |
|---|---|---|
| 200 | UserEntity | successful operation |
| 400 | string | NiFi was unable to complete the request because it was invalid. The request should not be retried without modification. |
| 401 | string | Client could not be authenticated. |
| 403 | string | Client is not authorized to make this request. |
| 404 | string | The specified resource could not be found. |
| 409 | string | The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful. |
| Name | Location | Type | Description |
|---|---|---|---|
| clientId | query | string | If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. |
| Status Code | Type | Description |
|---|---|---|
| 200 | SystemDiagnosticsEntity | successful operation |
| 401 | string | Client could not be authenticated. |
| 403 | string | Client is not authorized to make this request. |
| Name | Type | Required | Description |
|---|---|---|---|
| title | string | optional | The title to be used on the page and in the about dialog. |
| version | string | optional | The version of this NiFi. |
{
"title": "value",
"version": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| about | AboutDTO | optional |
{
"revision": RevisionDTO{…},
"about": AboutDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| supportsLogin | boolean | optional | Indicates whether or not this NiFi supports user login. |
| supportsAnonymous | boolean | optional | Indicates whether or not this NiFi supports anonymous. |
{
"supportsLogin": true,
"supportsAnonymous": true,
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| config | AccessConfigurationDTO | optional |
{
"revision": RevisionDTO{…},
"config": AccessConfigurationDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| identity | string | optional | The user identity. |
| username | string | optional | The username. |
| status | string | optional | The user access status. |
| message | string | optional | Additional details about the user access status. |
{
"identity": "value",
"username": "value",
"status": "value",
"message": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| accessStatus | AccessStatusDTO | optional |
{
"revision": RevisionDTO{…},
"accessStatus": AccessStatusDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer (int32) | optional | The action id. |
| userDn | string | optional | The dn of the user that performed the action. |
| userName | string | optional | The name of the user that performed the action. |
| timestamp | string (date-time) | optional | The timestamp of the action. |
| sourceId | string | optional | The id of the source component. |
| sourceName | string | optional | The name of the source component. |
| sourceType | string | optional | The type of the source component. |
| componentDetails | ComponentDetailsDTO | optional | The details of the source component. |
| operation | string | optional | The operation that was performed. |
| actionDetails | ActionDetailsDTO | optional | The details of the action. |
{
"id": 0,
"userDn": "value",
"userName": "value",
"timestamp": "value",
"sourceId": "value",
"sourceName": "value",
"sourceType": "value",
"componentDetails": ComponentDetailsDTO{…},
"operation": "value",
"actionDetails": ActionDetailsDTO{…},
}
| Name | Type | Required | Description |
|---|
{
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| action | ActionDTO | optional |
{
"revision": RevisionDTO{…},
"action": ActionDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| displayName | string | optional | A human readable value that is allowed for the property descriptor. |
| value | string | optional | A value that is allowed for the property descriptor. |
| description | string | optional | A description for this allowable value. |
{
"displayName": "value",
"value": "value",
"description": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | optional | The attribute name. |
| value | string | optional | The attribute value. |
| previousValue | string | optional | The value of the attribute before the event took place. |
{
"name": "value",
"value": "value",
"previousValue": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| userId | string | optional | |
| authorities | array[string] | optional |
{
"revision": RevisionDTO{…},
"userId": "value",
"authorities": ["value"],
}
| Name | Type | Required | Description |
|---|---|---|---|
| headerText | string | optional | The header text. |
| footerText | string | optional | The footer text. |
{
"headerText": "value",
"footerText": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| banners | BannerDTO | optional |
{
"revision": RevisionDTO{…},
"banners": BannerDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| bulletins | array[BulletinDTO] | optional | The bulletins in the bulletin board, that matches the supplied request. |
| generated | string (date-time) | optional | The timestamp when this report was generated. |
{
"bulletins": [BulletinDTO{…}],
"generated": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| bulletinBoard | BulletinBoardDTO | optional |
{
"revision": RevisionDTO{…},
"bulletinBoard": BulletinBoardDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer (int64) | optional | The id of the bulletin. |
| nodeAddress | string | optional | If clustered, the address of the node from whicih the bulletin originated. |
| category | string | optional | The catagory of this bulletin. |
| groupId | string | optional | The group id of the source component. |
| sourceId | string | optional | The id of the source component. |
| sourceName | string | optional | The name of the source component. |
| level | string | optional | The level of the bulletin. |
| message | string | optional | The bulletin message. |
| timestamp | string (date-time) | optional | When this bulletin was generated. |
{
"id": 0,
"nodeAddress": "value",
"category": "value",
"groupId": "value",
"sourceId": "value",
"sourceName": "value",
"level": "value",
"message": "value",
"timestamp": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| nodeConnectionStatus | array[NodeConnectionStatusDTO] | optional | The connection status for each node. |
| statsLastRefreshed | string (date-time) | optional | The time the status was last refreshed. |
| connectionId | string | optional | The id of the connection. |
| connectionName | string | optional | The name of the connection. |
{
"nodeConnectionStatus": [NodeConnectionStatusDTO{…}],
"statsLastRefreshed": "value",
"connectionId": "value",
"connectionName": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| clusterConnectionStatus | ClusterConnectionStatusDTO | optional |
{
"revision": RevisionDTO{…},
"clusterConnectionStatus": ClusterConnectionStatusDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| nodes | array[NodeDTO] | optional | The collection of nodes that are part of the cluster. |
| generated | string (date-time) | optional | The timestamp the report was generated. |
{
"nodes": [NodeDTO{…}],
"generated": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| cluster | ClusterDTO | optional |
{
"revision": RevisionDTO{…},
"cluster": ClusterDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| nodePortStatus | array[NodePortStatusDTO] | optional | The port status for each node. |
| statsLastRefreshed | string (date-time) | optional | The time the status was last refreshed. |
| portId | string | optional | The id of the port. |
| portName | string | optional | The name of the port. |
{
"nodePortStatus": [NodePortStatusDTO{…}],
"statsLastRefreshed": "value",
"portId": "value",
"portName": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| clusterPortStatus | ClusterPortStatusDTO | optional |
{
"revision": RevisionDTO{…},
"clusterPortStatus": ClusterPortStatusDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| nodeProcessGroupStatus | array[NodeProcessGroupStatusDTO] | optional | The process groups status for each node. |
| statsLastRefreshed | string (date-time) | optional | The time when the stats was last refreshed. |
| processGroupId | string | optional | The id of the process group. |
| processGroupName | string | optional | The name of the process group. |
{
"nodeProcessGroupStatus": [NodeProcessGroupStatusDTO{…}],
"statsLastRefreshed": "value",
"processGroupId": "value",
"processGroupName": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| clusterProcessGroupStatus | ClusterProcessGroupStatusDTO | optional |
{
"revision": RevisionDTO{…},
"clusterProcessGroupStatus": ClusterProcessGroupStatusDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| nodeProcessorStatus | array[NodeProcessorStatusDTO] | optional | The processor status for each node. |
| statsLastRefreshed | string (date-time) | optional | The time when the status was last refreshed. |
| processorId | string | optional | The processor id. |
| processorName | string | optional | The processor name. |
| processorType | string | optional | The processor type. |
| processorRunStatus | string | optional | The processor state. Allowable values: RUNNING, STOPPED, DISABLED, INVALID |
{
"nodeProcessorStatus": [NodeProcessorStatusDTO{…}],
"statsLastRefreshed": "value",
"processorId": "value",
"processorName": "value",
"processorType": "value",
"processorRunStatus": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| clusterProcessorStatus | ClusterProcessorStatusDTO | optional |
{
"revision": RevisionDTO{…},
"clusterProcessorStatus": ClusterProcessorStatusDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| nodeRemoteProcessGroupStatus | array[NodeRemoteProcessGroupStatusDTO] | optional | The remote process group status from each node in the cluster. |
| statsLastRefreshed | string (date-time) | optional | The time when the remote process group status was last refreshed. |
| remoteProcessGroupId | string | optional | The id of the remote process group. |
| remoteProcessGroupName | string | optional | The name of the remote process group. |
{
"nodeRemoteProcessGroupStatus": [NodeRemoteProcessGroupStatusDTO{…}],
"statsLastRefreshed": "value",
"remoteProcessGroupId": "value",
"remoteProcessGroupName": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| clusterRemoteProcessGroupStatus | ClusterRemoteProcessGroupStatusDTO | optional |
{
"revision": RevisionDTO{…},
"clusterRemoteProcessGroupStatus": ClusterRemoteProcessGroupStatusDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| nodeResults | array[NodeSearchResultDTO] | optional |
{
"nodeResults": [NodeSearchResultDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| nodeStatus | array[NodeStatusDTO] | optional | The status of each node. |
{
"nodeStatus": [NodeStatusDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| clusterStatus | ClusterStatusDTO | optional |
{
"revision": RevisionDTO{…},
"clusterStatus": ClusterStatusDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| nodeStatusHistory | array[NodeStatusHistoryDTO] | optional | The status history from each node. |
| clusterStatusHistory | StatusHistoryDTO | optional | The status history for the entire cluster. |
| generated | string (date-time) | optional | When the status history was generated. |
{
"nodeStatusHistory": [NodeStatusHistoryDTO{…}],
"clusterStatusHistory": StatusHistoryDTO{…},
"generated": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| clusterStatusHistory | ClusterStatusHistoryDTO | optional |
{
"revision": RevisionDTO{…},
"clusterStatusHistory": ClusterStatusHistoryDTO{…},
}
| Name | Type | Required | Description |
|---|
{
}
| Name | Type | Required | Description |
|---|---|---|---|
| componentId | string | optional | The component id. |
| propertyHistory | object | optional | The history for the properties of the component. |
{
"componentId": "value",
"propertyHistory": {
"name": PropertyHistoryDTO{…}
},
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| componentHistory | ComponentHistoryDTO | optional |
{
"revision": RevisionDTO{…},
"componentHistory": ComponentHistoryDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the component that matched the search. |
| groupId | string | optional | The group id of the component that matched the search. |
| name | string | optional | The name of the component that matched the search. |
| matches | array[string] | optional | What matched the search from the component. |
{
"id": "value",
"groupId": "value",
"name": "value",
"matches": ["value"],
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | required | The id of the connectable component. |
| type | string | required | The type of component the connectable is. Allowable values: PROCESSOR, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, INPUT_PORT, OUTPUT_PORT, FUNNEL |
| groupId | string | required | The id of the group that the connectable component resides in |
| name | string | optional | The name of the connectable component |
| running | boolean | optional | Reflects the current state of the connectable component. |
| transmitting | boolean | optional | If the connectable component represents a remote port, indicates if the target is configured to transmit. |
| exists | boolean | optional | If the connectable component represents a remote port, indicates if the target exists. |
| comments | string | optional | The comments for the connectable component. |
{
"id": "value",
"type": "value",
"groupId": "value",
"name": "value",
"running": true,
"transmitting": true,
"exists": true,
"comments": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the component. |
| uri | string | optional | The URI for futures requests to the component. |
| position | PositionDTO | optional | The position of this component in the UI if applicable. |
| parentGroupId | string | optional | The id of parent process group of this component if applicable. |
| source | ConnectableDTO | optional | The source of the connection. |
| destination | ConnectableDTO | optional | The destination of the connection. |
| name | string | optional | The name of the connection. |
| labelIndex | integer (int32) | optional | The index of the bend point where to place the connection label. |
| getzIndex | integer (int64) | optional | The z index of the connection. |
| selectedRelationships | array[string] | optional | The selected relationship that comprise the connection. |
| availableRelationships | array[string] | optional | The relationships that the source of the connection currently supports. This property is read only. |
| backPressureObjectThreshold | integer (int64) | optional | The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. |
| backPressureDataSizeThreshold | string | optional | The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue. |
| flowFileExpiration | string | optional | The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it. |
| prioritizers | array[string] | optional | The comparators used to prioritize the queue. |
| bends | array[PositionDTO] | optional | The bend points on the connection. |
{
"id": "value",
"uri": "value",
"position": PositionDTO{…},
"parentGroupId": "value",
"source": ConnectableDTO{…},
"destination": ConnectableDTO{…},
"name": "value",
"labelIndex": 0,
"getzIndex": 0,
"selectedRelationships": ["value"],
"availableRelationships": ["value"],
"backPressureObjectThreshold": 0,
"backPressureDataSizeThreshold": "value",
"flowFileExpiration": "value",
"prioritizers": ["value"],
"bends": [PositionDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| connection | ConnectionDTO | optional |
{
"revision": RevisionDTO{…},
"connection": ConnectionDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the connection. |
| groupId | string | optional | The id of the process group the connection belongs to. |
| name | string | optional | The name of the connection. |
| input | string | optional | The input count/size for the connection in the last 5 minutes. |
| queuedCount | string | optional | The number of flowfiles that are queued. |
| queuedSize | string | optional | The total size of flowfiles that are queued formatted. |
| queued | string | optional | The total count and size of queued flowfiles formatted. |
| output | string | optional | The output count/sie for the connection in the last 5 minutes. |
| sourceId | string | optional | The id of the source of the connection. |
| sourceName | string | optional | The name of the source of the connection. |
| destinationId | string | optional | The id of the destination of the connection. |
| destinationName | string | optional | The name of the destination of the connection. |
{
"id": "value",
"groupId": "value",
"name": "value",
"input": "value",
"queuedCount": "value",
"queuedSize": "value",
"queued": "value",
"output": "value",
"sourceId": "value",
"sourceName": "value",
"destinationId": "value",
"destinationName": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| connections | array[ConnectionDTO] | optional |
{
"revision": RevisionDTO{…},
"connections": [ConnectionDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | optional | The name of this NiFi. |
| comments | string | optional | The comments for this NiFi. |
| maxTimerDrivenThreadCount | integer (int32) | optional | The maimum number of timer driven threads the NiFi has available. |
| maxEventDrivenThreadCount | integer (int32) | optional | The maximum number of event driven threads the NiFi has avaiable. |
| autoRefreshIntervalSeconds | integer (int64) | optional | The interval in seconds between the automatic NiFi refresh requests. |
| siteToSiteSecure | boolean | optional | Indicates whether site to site communication with the NiFi is secure (requires 2-way authenticiation). |
| currentTime | string (date-time) | optional | The current time on the system. |
| timeOffset | integer (int32) | optional | The time offset of the system. |
| contentViewerUrl | string | optional | The URL for the content viewer if configured. |
| uri | string | optional | The URI for the NiFi. |
{
"name": "value",
"comments": "value",
"maxTimerDrivenThreadCount": 0,
"maxEventDrivenThreadCount": 0,
"autoRefreshIntervalSeconds": 0,
"siteToSiteSecure": true,
"currentTime": "value",
"timeOffset": 0,
"contentViewerUrl": "value",
"uri": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| config | ControllerConfigurationDTO | optional |
{
"revision": RevisionDTO{…},
"config": ControllerConfigurationDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the NiFi. |
| name | string | optional | The name of the NiFi. |
| comments | string | optional | The comments for the NiFi. |
| runningCount | integer (int32) | optional | The number of running components in the NiFi. |
| stoppedCount | integer (int32) | optional | The number of stopped components in the NiFi. |
| invalidCount | integer (int32) | optional | The number of invalid components in the NiFi. |
| disabledCount | integer (int32) | optional | The number of disabled components in the NiFi. |
| activeRemotePortCount | integer (int32) | optional | The number of active remote ports contained in the NiFi. |
| inactiveRemotePortCount | integer (int32) | optional | The number of inactive remote porst contained in the NiFi. |
| inputPortCount | integer (int32) | optional | The number of input ports contained in the NiFi. |
| outputPortCount | integer (int32) | optional | The number of output ports in the NiFi. |
| remoteSiteListeningPort | integer (int32) | optional | The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null. |
| siteToSiteSecure | boolean | optional | Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication). |
| instanceId | string | optional | If clustered, the id of the Cluster Manager, otherwise the id of the NiFi. |
| inputPorts | array[PortDTO] | optional | The input ports available to send data to for the NiFi. |
| outputPorts | array[PortDTO] | optional | The output ports available to received data from the NiFi. |
{
"id": "value",
"name": "value",
"comments": "value",
"runningCount": 0,
"stoppedCount": 0,
"invalidCount": 0,
"disabledCount": 0,
"activeRemotePortCount": 0,
"inactiveRemotePortCount": 0,
"inputPortCount": 0,
"outputPortCount": 0,
"remoteSiteListeningPort": 0,
"siteToSiteSecure": true,
"instanceId": "value",
"inputPorts": [PortDTO{…}],
"outputPorts": [PortDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| controller | ControllerDTO | optional |
{
"revision": RevisionDTO{…},
"controller": ControllerDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the component. |
| uri | string | optional | The URI for futures requests to the component. |
| position | PositionDTO | optional | The position of this component in the UI if applicable. |
| parentGroupId | string | optional | The id of parent process group of this component if applicable. |
| name | string | optional | The name of the controller service. |
| type | string | optional | The type of the controller service. |
| comments | string | optional | The comments for the controller service. |
| availability | string | optional | Where the servcie is available. Allowable values: NCM, NODE |
| state | string | optional | The state of the controller service. Allowable values: ENABLED, ENABLING, DISABLED, DISABLING |
| properties | object | optional | The properties of the controller service. |
| descriptors | object | optional | The descriptors for the controller service properties. |
| customUiUrl | string | optional | The URL for the controller services custom configuration UI if applicable. |
| annotationData | string | optional | The annontation for the controller service. This is how the custom UI relays configuration to the controller service. |
| referencingComponents | array[ControllerServiceReferencingComponentDTO] | optional | All components referencing this controller service. |
| validationErrors | array[string] | optional | The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled. |
{
"id": "value",
"uri": "value",
"position": PositionDTO{…},
"parentGroupId": "value",
"name": "value",
"type": "value",
"comments": "value",
"availability": "value",
"state": "value",
"properties": {
"name": "value"
},
"descriptors": {
"name": PropertyDescriptorDTO{…}
},
"customUiUrl": "value",
"annotationData": "value",
"referencingComponents": [ControllerServiceReferencingComponentDTO{…}],
"validationErrors": ["value"],
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| controllerService | ControllerServiceDTO | optional |
{
"revision": RevisionDTO{…},
"controllerService": ControllerServiceDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| groupId | string | optional | The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank. |
| id | string | optional | The id of the component referencing a controller service. |
| name | string | optional | The name of the component referencing a controller service. |
| type | string | optional | The type of the component referencing a controller service. |
| state | string | optional | The state of a processor or reporting task referencing a controller service. If this component is another controller service, this field is blank. |
| properties | object | optional | The properties for the component. |
| descriptors | object | optional | The descriptors for the componet properties. |
| validationErrors | array[string] | optional | The validation errors for the component. |
| referenceType | string | optional | The type of reference this is. Allowable values: Processor, ControllerService, or ReportingTask |
| activeThreadCount | integer (int32) | optional | The number of active threads for the referencing component. |
| referenceCycle | boolean | optional | If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy. |
| referencingComponents | Set | optional | If the referencing component represents a controller service, these are the components that referenc it. |
{
"groupId": "value",
"id": "value",
"name": "value",
"type": "value",
"state": "value",
"properties": {
"name": "value"
},
"descriptors": {
"name": PropertyDescriptorDTO{…}
},
"validationErrors": ["value"],
"referenceType": "value",
"activeThreadCount": 0,
"referenceCycle": true,
"referencingComponents": Set{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| controllerServiceTypes | array[DocumentedTypeDTO] | optional |
{
"revision": RevisionDTO{…},
"controllerServiceTypes": [DocumentedTypeDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| controllerServices | array[ControllerServiceDTO] | optional |
{
"revision": RevisionDTO{…},
"controllerServices": [ControllerServiceDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the counter. |
| context | string | optional | The context of the counter. |
| name | string | optional | The name of the counter. |
| valueCount | integer (int64) | optional | The value count. |
| value | string | optional | The value of the counter. |
{
"id": "value",
"context": "value",
"name": "value",
"valueCount": 0,
"value": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| counter | CounterDTO | optional |
{
"revision": RevisionDTO{…},
"counter": CounterDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| type | string | optional | The fulley qualified name of the type. |
| description | string | optional | The description of the type. |
| tags | array[string] | optional | The tags associated with this type. |
{
"type": "value",
"description": "value",
"tags": ["value"],
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the component. |
| uri | string | optional | The URI for futures requests to the component. |
| submissionTime | string (date-time) | optional | The timestamp when the query was submitted. |
| lastUpdated | string (date-time) | optional | The last time this drop request was updated. |
| percentCompleted | integer (int32) | optional | The current percent complete. |
| finished | boolean | optional | Whether the query has finished. |
| failureReason | string | optional | |
| currentCount | integer (int32) | optional | The number of flow files currently queued. |
| currentSize | integer (int64) | optional | The size of flow files currently queued in bytes. |
| current | string | optional | The count and size of flow files currently queued. |
| originalCount | integer (int32) | optional | The number of flow files to be dropped as a result of this request. |
| originalSize | integer (int64) | optional | The size of flow files to be dropped as a result of this request in bytes. |
| original | string | optional | The count and size of flow files to be dropped as a result of this request. |
| droppedCount | integer (int32) | optional | The number of flow files that have been dropped thus far. |
| droppedSize | integer (int64) | optional | The size of flow files that have been dropped thus far in bytes. |
| dropped | string | optional | The count and size of flow files that have been dropped thus far. |
| state | string | optional | The current state of the drop request. |
{
"id": "value",
"uri": "value",
"submissionTime": "value",
"lastUpdated": "value",
"percentCompleted": 0,
"finished": true,
"failureReason": "value",
"currentCount": 0,
"currentSize": 0,
"current": "value",
"originalCount": 0,
"originalSize": 0,
"original": "value",
"droppedCount": 0,
"droppedSize": 0,
"dropped": "value",
"state": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| dropRequest | DropRequestDTO | optional |
{
"revision": RevisionDTO{…},
"dropRequest": DropRequestDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
{
"revision": RevisionDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| processGroups | Set | optional | The process groups in this flow snippet. |
| remoteProcessGroups | array[RemoteProcessGroupDTO] | optional | The remote process groups in this flow snippet. |
| processors | array[ProcessorDTO] | optional | The processors in this flow snippet. |
| inputPorts | array[PortDTO] | optional | The input ports in this flow snippet. |
| outputPorts | array[PortDTO] | optional | The output ports in this flow snippet. |
| connections | array[ConnectionDTO] | optional | The connections in this flow snippet. |
| labels | array[LabelDTO] | optional | The labels in this flow snippet. |
| funnels | array[FunnelDTO] | optional | The funnels in this flow snippet. |
| controllerServices | array[ControllerServiceDTO] | optional | The controller services in this flow snippet. |
{
"processGroups": Set{…},
"remoteProcessGroups": [RemoteProcessGroupDTO{…}],
"processors": [ProcessorDTO{…}],
"inputPorts": [PortDTO{…}],
"outputPorts": [PortDTO{…}],
"connections": [ConnectionDTO{…}],
"labels": [LabelDTO{…}],
"funnels": [FunnelDTO{…}],
"controllerServices": [ControllerServiceDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| contents | FlowSnippetDTO | optional |
{
"revision": RevisionDTO{…},
"contents": FlowSnippetDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the component. |
| uri | string | optional | The URI for futures requests to the component. |
| position | PositionDTO | optional | The position of this component in the UI if applicable. |
| parentGroupId | string | optional | The id of parent process group of this component if applicable. |
{
"id": "value",
"uri": "value",
"position": PositionDTO{…},
"parentGroupId": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| funnel | FunnelDTO | optional |
{
"revision": RevisionDTO{…},
"funnel": FunnelDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| funnels | array[FunnelDTO] | optional |
{
"revision": RevisionDTO{…},
"funnels": [FunnelDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | optional | The name of the garbage collector. |
| collectionCount | integer (int64) | optional | The number of times garbage collection has run. |
| collectionTime | string | optional | The total amount of time spent garbage collecting. |
{
"name": "value",
"collectionCount": 0,
"collectionTime": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| total | integer (int32) | optional | The number of number of actions that matched the search criteria.. |
| lastRefreshed | string (date-time) | optional | The timestamp when the report was generated. |
| actions | array[ActionDTO] | optional | The actions. |
{
"total": 0,
"lastRefreshed": "value",
"actions": [ActionDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| history | HistoryDTO | optional |
{
"revision": RevisionDTO{…},
"history": HistoryDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| userId | string | optional | |
| identity | string | optional |
{
"revision": RevisionDTO{…},
"userId": "value",
"identity": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| inputPort | PortDTO | optional |
{
"revision": RevisionDTO{…},
"inputPort": PortDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| inputPorts | array[PortDTO] | optional |
{
"revision": RevisionDTO{…},
"inputPorts": [PortDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the component. |
| uri | string | optional | The URI for futures requests to the component. |
| position | PositionDTO | optional | The position of this component in the UI if applicable. |
| parentGroupId | string | optional | The id of parent process group of this component if applicable. |
| label | string | optional | The text that appears in the label. |
| width | number (double) | optional | The width of the label in pixels when at a 1:1 scale. |
| height | number (double) | optional | The height of the label in pixels when at a 1:1 scale. |
| style | object | optional | The styles for this label (font-size => 12px, background-color => #eee, etc). |
{
"id": "value",
"uri": "value",
"position": PositionDTO{…},
"parentGroupId": "value",
"label": "value",
"width": 0.0,
"height": 0.0,
"style": {
"name": "value"
},
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| label | LabelDTO | optional |
{
"revision": RevisionDTO{…},
"label": LabelDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| labels | array[LabelDTO] | optional |
{
"revision": RevisionDTO{…},
"labels": [LabelDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of this lineage query. |
| uri | string | optional | The URI for this lineage query for later retrieval and deletion. |
| clusterNodeId | string | optional | The id of the node where this lineage originated if clustered. |
| submissionTime | string (date-time) | optional | When the lineage query was submitted. |
| expiration | string (date-time) | optional | When the lineage query will expire. |
| percentCompleted | integer (int32) | optional | The percent complete for the lineage query. |
| finished | boolean | optional | Whether the lineage query has finished. |
| request | LineageRequestDTO | optional | The initial lineage result. |
| results | LineageResultsDTO | optional | The results of the lineage query. |
{
"id": "value",
"uri": "value",
"clusterNodeId": "value",
"submissionTime": "value",
"expiration": "value",
"percentCompleted": 0,
"finished": true,
"request": LineageRequestDTO{…},
"results": LineageResultsDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| lineage | LineageDTO | optional |
{
"revision": RevisionDTO{…},
"lineage": LineageDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| eventId | integer (int64) | optional | |
| lineageRequestType | string | optional | The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile. Allowable values: PARENTS, CHILDREN, FLOWFILE, and FLOWFILE |
| uuid | string | optional | The uuid that was used to generate the lineage. |
{
"eventId": 0,
"lineageRequestType": "value",
"uuid": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| errors | array[string] | optional | Any errors that occurred while generating the lineage. |
| nodes | array[ProvenanceNodeDTO] | optional | The nodes in the lineage. |
| links | array[ProvenanceLinkDTO] | optional | The links between the nodes in the lineage. |
{
"errors": ["value"],
"nodes": [ProvenanceNodeDTO{…}],
"links": [ProvenanceLinkDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| empty | boolean | optional |
{
"empty": true,
}
| Name | Type | Required | Description |
|---|---|---|---|
| node | NodeDTO | optional | The node. |
| connectionStatus | ConnectionStatusDTO | optional | The connection status from the node. |
{
"node": NodeDTO{…},
"connectionStatus": ConnectionStatusDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| nodeId | string | optional | The id of the node. |
| address | string | optional | The node's host/ip address. |
| apiPort | integer (int32) | optional | The port the node is listening for API requests. |
| status | string | optional | The node's status. |
| heartbeat | string (date-time) | optional | the time of the nodes's last heartbeat. |
| connectionRequested | string (date-time) | optional | The time of the node's last connection request. |
| primary | boolean | optional | Whether the node is the primary node within the cluster. |
| activeThreadCount | integer (int32) | optional | The active threads for the NiFi on the node. |
| queued | string | optional | The queue the NiFi on the node. |
| events | array[NodeEventDTO] | optional | The node's events. |
| nodeStartTime | string (date-time) | optional | The time at which this Node was last refreshed. |
{
"nodeId": "value",
"address": "value",
"apiPort": 0,
"status": "value",
"heartbeat": "value",
"connectionRequested": "value",
"primary": true,
"activeThreadCount": 0,
"queued": "value",
"events": [NodeEventDTO{…}],
"nodeStartTime": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| node | NodeDTO | optional |
{
"revision": RevisionDTO{…},
"node": NodeDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| timestamp | string (date-time) | optional | The timestamp of the node event. |
| category | string | optional | The category of the node event. |
| message | string | optional | The message in the node event. |
{
"timestamp": "value",
"category": "value",
"message": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| node | NodeDTO | optional | The node. |
| portStatus | PortStatusDTO | optional | The port status from the node. |
{
"node": NodeDTO{…},
"portStatus": PortStatusDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| node | NodeDTO | optional | The node. |
| processGroupStatus | ProcessGroupStatusDTO | optional | The process group status from the node. |
{
"node": NodeDTO{…},
"processGroupStatus": ProcessGroupStatusDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| node | NodeDTO | optional | The node. |
| processorStatus | ProcessorStatusDTO | optional | The processor status from the node. |
{
"node": NodeDTO{…},
"processorStatus": ProcessorStatusDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| node | NodeDTO | optional | The node. |
| remoteProcessGroupStatus | RemoteProcessGroupStatusDTO | optional | The remote process group status from the node. |
{
"node": NodeDTO{…},
"remoteProcessGroupStatus": RemoteProcessGroupStatusDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the node that matched the search. |
| address | string | optional | The address of the node that matched the search. |
{
"id": "value",
"address": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| node | NodeDTO | optional | The node. |
| controllerStatus | ProcessGroupStatusDTO | optional | The controller status for each node. |
{
"node": NodeDTO{…},
"controllerStatus": ProcessGroupStatusDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| node | NodeDTO | optional | The node. |
| statusHistory | StatusHistoryDTO | optional | The processor status for each node. |
{
"node": NodeDTO{…},
"statusHistory": StatusHistoryDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| outputPort | PortDTO | optional |
{
"revision": RevisionDTO{…},
"outputPort": PortDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| outputPorts | array[PortDTO] | optional |
{
"revision": RevisionDTO{…},
"outputPorts": [PortDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the component. |
| uri | string | optional | The URI for futures requests to the component. |
| position | PositionDTO | optional | The position of this component in the UI if applicable. |
| parentGroupId | string | optional | The id of parent process group of this component if applicable. |
| name | string | optional | The name of the port. |
| comments | string | optional | The comments for the port. |
| state | string | optional | The state of the port. Allowable values: RUNNING, STOPPED, DISABLED |
| type | string | optional | The type of port. Allowable values: INPUT_PORT, OUTPUT_PORT |
| transmitting | boolean | optional | Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is running in the root group. |
| concurrentlySchedulableTaskCount | integer (int32) | optional | The number of tasks that should be concurrently scheduled for the port. |
| userAccessControl | array[string] | optional | The users that are allowed to access the port. |
| groupAccessControl | array[string] | optional | The user groups that are allowed to access the port. |
| validationErrors | array[string] | optional | Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started. |
{
"id": "value",
"uri": "value",
"position": PositionDTO{…},
"parentGroupId": "value",
"name": "value",
"comments": "value",
"state": "value",
"type": "value",
"transmitting": true,
"concurrentlySchedulableTaskCount": 0,
"userAccessControl": ["value"],
"groupAccessControl": ["value"],
"validationErrors": ["value"],
}
| Name | Type | Required | Description |
|---|---|---|---|
| bulletins | array[BulletinDTO] | optional | The current bulletins for the component. |
| id | string | optional | The id of the port. |
| groupId | string | optional | The id of the parent process group of the port. |
| name | string | optional | The name of the port. |
| activeThreadCount | integer (int32) | optional | The active thread count for the port. |
| input | string | optional | The count/size of flowfiles that have been accepted in the last 5 minutes. |
| output | string | optional | The count/size of flowfiles that have been processed in the last 5 minutes. |
| transmitting | boolean | optional | Whether the port has incoming or outgoing connections to a remote NiFi. |
| runStatus | string | optional | The run status of the port. |
{
"bulletins": [BulletinDTO{…}],
"id": "value",
"groupId": "value",
"name": "value",
"activeThreadCount": 0,
"input": "value",
"output": "value",
"transmitting": true,
"runStatus": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| x | number (double) | optional | The x coordinate. |
| y | number (double) | optional | The y coordinate. |
{
"x": 0.0,
"y": 0.0,
}
| Name | Type | Required | Description |
|---|---|---|---|
| previousValue | string | optional | The previous value. |
| timestamp | string (date-time) | optional | The timestamp when the value was modified. |
| userName | string | optional | The user who changed the previous value. |
{
"previousValue": "value",
"timestamp": "value",
"userName": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| prioritizerTypes | array[DocumentedTypeDTO] | optional |
{
"revision": RevisionDTO{…},
"prioritizerTypes": [DocumentedTypeDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the component. |
| uri | string | optional | The URI for futures requests to the component. |
| position | PositionDTO | optional | The position of this component in the UI if applicable. |
| parentGroupId | string | optional | The id of parent process group of this component if applicable. |
| name | string | optional | The name of the process group. |
| comments | string | optional | The comments for the process group. |
| running | boolean | optional | Used in requests, indicates whether the process group should be running. |
| runningCount | integer (int32) | optional | The number of running componetns in this process group. |
| stoppedCount | integer (int32) | optional | The number of stopped components in the process group. |
| invalidCount | integer (int32) | optional | The number of invalid components in the process group. |
| disabledCount | integer (int32) | optional | The number of disabled components in the process group. |
| activeRemotePortCount | integer (int32) | optional | The number of active remote ports in the process group. |
| inactiveRemotePortCount | integer (int32) | optional | The number of inactive remote ports in the process group. |
| inputPortCount | integer (int32) | optional | The number of input ports in the process group. |
| outputPortCount | integer (int32) | optional | The number of output ports in the process group. |
| contents | FlowSnippetDTO | optional | The contents of this process group. This field will be populated if the request is marked verbose. |
{
"id": "value",
"uri": "value",
"position": PositionDTO{…},
"parentGroupId": "value",
"name": "value",
"comments": "value",
"running": true,
"runningCount": 0,
"stoppedCount": 0,
"invalidCount": 0,
"disabledCount": 0,
"activeRemotePortCount": 0,
"inactiveRemotePortCount": 0,
"inputPortCount": 0,
"outputPortCount": 0,
"contents": FlowSnippetDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| processGroup | ProcessGroupDTO | optional |
{
"revision": RevisionDTO{…},
"processGroup": ProcessGroupDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| bulletins | array[BulletinDTO] | optional | The current bulletins for the component. |
| id | string | optional | The id of the process group. |
| name | string | optional | The name of this process group. |
| connectionStatus | array[ConnectionStatusDTO] | optional | The status of all conenctions in the process group. |
| processorStatus | array[ProcessorStatusDTO] | optional | The status of all processors in the process group. |
| processGroupStatus | List | optional | The status of all process groups in the process group. |
| remoteProcessGroupStatus | array[RemoteProcessGroupStatusDTO] | optional | The status of all remote process groups in the process group.. |
| inputPortStatus | array[PortStatusDTO] | optional | The status of all input ports in the process group. |
| outputPortStatus | array[PortStatusDTO] | optional | The status of all output ports in the process group. |
| input | string | optional | The input count/size for the process group in the last 5 minutes. |
| queuedCount | string | optional | The count that is queued for the process group. |
| queuedSize | string | optional | The size that is queued for the process group. |
| queued | string | optional | The count/size that is queued in the the process group. |
| read | string | optional | The number of bytes read in the last 5 minutes. |
| written | string | optional | The number of bytes written in the last 5 minutes. |
| output | string | optional | The output count/size for the process group in the last 5 minutes. |
| transferred | string | optional | The count/size transferred to/frome queues in the process group in the last 5 minutes. |
| received | string | optional | The count/size sent to the process group in the last 5 minutes. |
| sent | string | optional | The count/size sent from this process group in the last 5 minutes. |
| activeThreadCount | integer (int32) | optional | The active thread count for this process group. |
| statsLastRefreshed | string (date-time) | optional | The time the status for the process group was last refreshed. |
{
"bulletins": [BulletinDTO{…}],
"id": "value",
"name": "value",
"connectionStatus": [ConnectionStatusDTO{…}],
"processorStatus": [ProcessorStatusDTO{…}],
"processGroupStatus": List{…},
"remoteProcessGroupStatus": [RemoteProcessGroupStatusDTO{…}],
"inputPortStatus": [PortStatusDTO{…}],
"outputPortStatus": [PortStatusDTO{…}],
"input": "value",
"queuedCount": "value",
"queuedSize": "value",
"queued": "value",
"read": "value",
"written": "value",
"output": "value",
"transferred": "value",
"received": "value",
"sent": "value",
"activeThreadCount": 0,
"statsLastRefreshed": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| processGroupStatus | ProcessGroupStatusDTO | optional |
{
"revision": RevisionDTO{…},
"processGroupStatus": ProcessGroupStatusDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| processGroups | array[ProcessGroupDTO] | optional |
{
"revision": RevisionDTO{…},
"processGroups": [ProcessGroupDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| properties | object | optional | The properties for the processor. Properties whose value is not set will only contain the property name. |
| descriptors | object | optional | Descriptors for the processor's properties. |
| schedulingPeriod | string | optional | The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy. |
| schedulingStrategy | string | optional | Indcates whether the prcessor should be scheduled to run in event or timer driven mode. |
| penaltyDuration | string | optional | The amout of time that is used when the process penalizes a flowfile. |
| yieldDuration | string | optional | The amount of time that must elapse before this processor is scheduled again after yielding. |
| bulletinLevel | string | optional | The level at which the processor will report bulletins. |
| runDurationMillis | integer (int64) | optional | The run duration for the processor in milliseconds. |
| concurrentlySchedulableTaskCount | integer (int32) | optional | The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored. |
| autoTerminatedRelationships | array[string] | optional | The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. |
| comments | string | optional | The comments for the processor. |
| customUiUrl | string | optional | The URL for the processor's custom configuration UI if applicable. |
| lossTolerant | boolean | optional | Whether the processor is loss tolerant. |
| annotationData | string | optional | The annotation data for the processor used to relay configuration between a custom UI and the procesosr. |
| defaultConcurrentTasks | object | optional | Maps default values for concurrent tasks for each applicable scheduling strategy. |
| defaultSchedulingPeriod | object | optional | Maps default values for scheduling period for each applicable scheduling strategy. |
{
"properties": {
"name": "value"
},
"descriptors": {
"name": PropertyDescriptorDTO{…}
},
"schedulingPeriod": "value",
"schedulingStrategy": "value",
"penaltyDuration": "value",
"yieldDuration": "value",
"bulletinLevel": "value",
"runDurationMillis": 0,
"concurrentlySchedulableTaskCount": 0,
"autoTerminatedRelationships": ["value"],
"comments": "value",
"customUiUrl": "value",
"lossTolerant": true,
"annotationData": "value",
"defaultConcurrentTasks": {
"name": "value"
},
"defaultSchedulingPeriod": {
"name": "value"
},
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the component. |
| uri | string | optional | The URI for futures requests to the component. |
| position | PositionDTO | optional | The position of this component in the UI if applicable. |
| parentGroupId | string | optional | The id of parent process group of this component if applicable. |
| name | string | optional | The name of the processor. |
| type | string | optional | The type of the processor. |
| state | string | optional | The state of the processor Allowable values: RUNNING, STOPPED, DISABLED |
| style | object | optional | Styles for the processor (background-color => #eee). |
| relationships | array[RelationshipDTO] | optional | The available relationships that the processor currently supports. |
| description | string | optional | The description of the processor. |
| supportsParallelProcessing | boolean | optional | Whether the processor supports parallel processing. |
| supportsEventDriven | boolean | optional | Whether the processor supports event driven scheduling. |
| supportsBatching | boolean | optional | Whether the processor supports batching. This makes the run duration settings available. |
| inputRequirement | string | optional | The input requirement for this processor. |
| config | ProcessorConfigDTO | optional | The configuration details for the processor. These details will be included in a resopnse if the verbose flag is included in a request. |
| validationErrors | array[string] | optional | The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started. |
{
"id": "value",
"uri": "value",
"position": PositionDTO{…},
"parentGroupId": "value",
"name": "value",
"type": "value",
"state": "value",
"style": {
"name": "value"
},
"relationships": [RelationshipDTO{…}],
"description": "value",
"supportsParallelProcessing": true,
"supportsEventDriven": true,
"supportsBatching": true,
"inputRequirement": "value",
"config": ProcessorConfigDTO{…},
"validationErrors": ["value"],
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| processor | ProcessorDTO | optional |
{
"revision": RevisionDTO{…},
"processor": ProcessorDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| bulletins | array[BulletinDTO] | optional | The current bulletins for the component. |
| id | string | optional | The id of the processor. |
| groupId | string | optional | The id of the parent process group to which the processor belongs. |
| name | string | optional | The name of the prcessor. |
| type | string | optional | The type of the processor. |
| runStatus | string | optional | The state of the processor. Allowable values: RUNNING, STOPPED, DISABLED, INVALID |
| read | string | optional | The number of bytes read in the last 5 minutes. |
| written | string | optional | The number of bytes written in the last 5 minutes. |
| input | string | optional | The count/size of flowfiles that have been accepted in the last 5 minutes. |
| output | string | optional | The count/size of flowfiles that have been processed in the last 5 minutes. |
| tasks | string | optional | The total number of task this connectable has completed over the last 5 minutes. |
| tasksDuration | string | optional | The total duration of all tasks for this connectable over the last 5 minutes. |
| activeThreadCount | integer (int32) | optional | The number of threads currently executing in the processor. |
{
"bulletins": [BulletinDTO{…}],
"id": "value",
"groupId": "value",
"name": "value",
"type": "value",
"runStatus": "value",
"read": "value",
"written": "value",
"input": "value",
"output": "value",
"tasks": "value",
"tasksDuration": "value",
"activeThreadCount": 0,
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| processorTypes | array[DocumentedTypeDTO] | optional |
{
"revision": RevisionDTO{…},
"processorTypes": [DocumentedTypeDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| processors | array[ProcessorDTO] | optional |
{
"revision": RevisionDTO{…},
"processors": [ProcessorDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | optional | The name for the property. |
| displayName | string | optional | The human readable name for the property. |
| description | string | optional | The descriptoin for the property. Used to relay additional details to a user or provide a mechanism of documenting intent. |
| defaultValue | string | optional | The default value for the property. |
| allowableValues | array[AllowableValueDTO] | optional | Allowable values for the property. If empty then the allowed values are not constrained. |
| required | boolean | optional | Whether the property is required. |
| sensitive | boolean | optional | Whether the property is sensitive and protected whenever stored or represented. |
| dynamic | boolean | optional | Whether the property is dynamic (user-defined). |
| supportsEl | boolean | optional | Whether the property supports expression language. |
| identifiesControllerService | string | optional | If the property identifies a controller service, this returns the fully qualified type. |
{
"name": "value",
"displayName": "value",
"description": "value",
"defaultValue": "value",
"allowableValues": [AllowableValueDTO{…}],
"required": true,
"sensitive": true,
"dynamic": true,
"supportsEl": true,
"identifiesControllerService": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| propertyDescriptor | PropertyDescriptorDTO | optional |
{
"revision": RevisionDTO{…},
"propertyDescriptor": PropertyDescriptorDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| previousValues | array[PreviousValueDTO] | optional | Previous values for a given property. |
{
"previousValues": [PreviousValueDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the provenance query. |
| uri | string | optional | The URI for this query. Used for obtaining/deleting the request at a later time |
| clusterNodeId | string | optional | The id of the node in the cluster where this provenance originated. |
| submissionTime | string (date-time) | optional | The timestamp when the query was submitted. |
| expiration | string (date-time) | optional | The timestamp when the query will expire. |
| percentCompleted | integer (int32) | optional | The current percent complete. |
| finished | boolean | optional | Whether the query has finished. |
| request | ProvenanceRequestDTO | optional | The provenance request. |
| results | ProvenanceResultsDTO | optional | The provenance results. |
{
"id": "value",
"uri": "value",
"clusterNodeId": "value",
"submissionTime": "value",
"expiration": "value",
"percentCompleted": 0,
"finished": true,
"request": ProvenanceRequestDTO{…},
"results": ProvenanceResultsDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| provenance | ProvenanceDTO | optional |
{
"revision": RevisionDTO{…},
"provenance": ProvenanceDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The event uuid. |
| eventId | integer (int64) | optional | The event id. This is a one up number thats unique per node. |
| eventTime | string (date-time) | optional | The timestamp of the event. |
| eventDuration | integer (int64) | optional | The event duration in milliseconds. |
| lineageDuration | integer (int64) | optional | The duration since the lineage began, in milliseconds. |
| eventType | string | optional | The type of the event. |
| flowFileUuid | string | optional | The uuid of the flowfile for the event. |
| fileSize | string | optional | The size of the flowfile for the event. |
| fileSizeBytes | integer (int64) | optional | The size of the flowfile in bytes for the event. |
| clusterNodeId | string | optional | The identifier for the node where the event originated. |
| clusterNodeAddress | string | optional | The label for the node where the event originated. |
| groupId | string | optional | The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set. |
| componentId | string | optional | The id of the component that generated the event. |
| componentType | string | optional | The type of the component that generated the event. |
| componentName | string | optional | The name of the component that generated the event. |
| sourceSystemFlowFileId | string | optional | The source system flowfile id. |
| alternateIdentifierUri | string | optional | The alternate identifier uri for the fileflow for the event. |
| attributes | array[AttributeDTO] | optional | The attributes of the flowfile for the event. |
| parentUuids | array[string] | optional | The parent uuids for the event. |
| childUuids | array[string] | optional | The child uuids for the event. |
| transitUri | string | optional | The source/destination system uri if the event was a RECEIVE/SEND. |
| relationship | string | optional | The relationship to which the flowfile was routed if the event is of type ROUTE. |
| details | string | optional | The event details. |
| contentEqual | boolean | optional | Whether the input and output content claim is the same. |
| inputContentAvailable | boolean | optional | Whether the input content is still available. |
| inputContentClaimSection | string | optional | The section in which the input content claim lives. |
| inputContentClaimContainer | string | optional | The container in which the input content claim lives. |
| inputContentClaimIdentifier | string | optional | The identifier of the input content claim. |
| inputContentClaimOffset | integer (int64) | optional | The offset into the input content claim where the flowfiles content begins. |
| inputContentClaimFileSize | string | optional | The file size of the input content claim formatted. |
| inputContentClaimFileSizeBytes | integer (int64) | optional | The file size of the intput content claim in bytes. |
| outputContentAvailable | boolean | optional | Whether the output content is still available. |
| outputContentClaimSection | string | optional | The section in which the output content claim lives. |
| outputContentClaimContainer | string | optional | The container in which the output content claim lives. |
| outputContentClaimIdentifier | string | optional | The identifier of the output content claim. |
| outputContentClaimOffset | integer (int64) | optional | The offset into the output content claim where the flowfiles content begins. |
| outputContentClaimFileSize | string | optional | The file size of the output content claim formatted. |
| outputContentClaimFileSizeBytes | integer (int64) | optional | The file size of the output content claim in bytes. |
| replayAvailable | boolean | optional | Whether or not replay is available. |
| replayExplanation | string | optional | Explanation as to why replay is unavailable. |
| sourceConnectionIdentifier | string | optional | The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event. |
{
"id": "value",
"eventId": 0,
"eventTime": "value",
"eventDuration": 0,
"lineageDuration": 0,
"eventType": "value",
"flowFileUuid": "value",
"fileSize": "value",
"fileSizeBytes": 0,
"clusterNodeId": "value",
"clusterNodeAddress": "value",
"groupId": "value",
"componentId": "value",
"componentType": "value",
"componentName": "value",
"sourceSystemFlowFileId": "value",
"alternateIdentifierUri": "value",
"attributes": [AttributeDTO{…}],
"parentUuids": ["value"],
"childUuids": ["value"],
"transitUri": "value",
"relationship": "value",
"details": "value",
"contentEqual": true,
"inputContentAvailable": true,
"inputContentClaimSection": "value",
"inputContentClaimContainer": "value",
"inputContentClaimIdentifier": "value",
"inputContentClaimOffset": 0,
"inputContentClaimFileSize": "value",
"inputContentClaimFileSizeBytes": 0,
"outputContentAvailable": true,
"outputContentClaimSection": "value",
"outputContentClaimContainer": "value",
"outputContentClaimIdentifier": "value",
"outputContentClaimOffset": 0,
"outputContentClaimFileSize": "value",
"outputContentClaimFileSizeBytes": 0,
"replayAvailable": true,
"replayExplanation": "value",
"sourceConnectionIdentifier": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| provenanceEvent | ProvenanceEventDTO | optional |
{
"revision": RevisionDTO{…},
"provenanceEvent": ProvenanceEventDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| sourceId | string | optional | The source node id of the link. |
| targetId | string | optional | The target node id of the link. |
| flowFileUuid | string | optional | The flowfile uuid that traversed the link. |
| timestamp | string (date-time) | optional | The timestamp of the link (based on the destination). |
| millis | integer (int64) | optional | The timestamp of this link in milliseconds. |
{
"sourceId": "value",
"targetId": "value",
"flowFileUuid": "value",
"timestamp": "value",
"millis": 0,
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the node. |
| flowFileUuid | string | optional | The uuid of the flowfile associated with the provenance event. |
| parentUuids | array[string] | optional | The uuid of the parent flowfiles of the provenance event. |
| childUuids | array[string] | optional | The uuid of the childrent flowfiles of the provenance event. |
| clusterNodeIdentifier | string | optional | The identifier of the node that this event/flowfile originated from. |
| type | string | optional | The type of the node. Allowable values: FLOWFILE, EVENT |
| eventType | string | optional | If the type is EVENT, this is the type of event. |
| millis | integer (int64) | optional | The timestamp of the node in milliseconds. |
| timestamp | string (date-time) | optional | The timestamp of the node formatted. |
{
"id": "value",
"flowFileUuid": "value",
"parentUuids": ["value"],
"childUuids": ["value"],
"clusterNodeIdentifier": "value",
"type": "value",
"eventType": "value",
"millis": 0,
"timestamp": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| searchableFields | array[ProvenanceSearchableFieldDTO] | optional | The available searchable field for the NiFi. |
{
"searchableFields": [ProvenanceSearchableFieldDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| provenanceOptions | ProvenanceOptionsDTO | optional |
{
"revision": RevisionDTO{…},
"provenanceOptions": ProvenanceOptionsDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| searchTerms | object | optional | The search terms used to perform the search. |
| startDate | string (date-time) | optional | The earliest event time to include in the query. |
| endDate | string (date-time) | optional | The latest event time to include in the query. |
| minimumFileSize | string | optional | The minimum file size to include in the query. |
| maximumFileSize | string | optional | The maximum file size to include in the query. |
| maxResults | integer (int32) | optional | The maximum number of results to include. |
{
"searchTerms": {
"name": "value"
},
"startDate": "value",
"endDate": "value",
"minimumFileSize": "value",
"maximumFileSize": "value",
"maxResults": 0,
}
| Name | Type | Required | Description |
|---|---|---|---|
| provenanceEvents | array[ProvenanceEventDTO] | optional | The provenance events that matched the search criteria. |
| total | string | optional | The total number of results formatted. |
| totalCount | integer (int64) | optional | The total number of results. |
| generated | string (date-time) | optional | Then the search was performed. |
| oldestEvent | string (date-time) | optional | The oldest event available in the provenance repository. |
| timeOffset | integer (int32) | optional | The time offset of the server that's used for event time. |
| errors | array[string] | optional | Any errors that occurred while performing the provenance request. |
{
"provenanceEvents": [ProvenanceEventDTO{…}],
"total": "value",
"totalCount": 0,
"generated": "value",
"oldestEvent": "value",
"timeOffset": 0,
"errors": ["value"],
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the searchable field. |
| field | string | optional | The searchable field. |
| label | string | optional | The label for the searchable field. |
| type | string | optional | The type of the searchable field. |
{
"id": "value",
"field": "value",
"label": "value",
"type": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | optional | The relationship name. |
| description | string | optional | The relationship description. |
| autoTerminate | boolean | optional | Whether or not flowfiles sent to this relationship should auto terminate. |
{
"name": "value",
"description": "value",
"autoTerminate": true,
}
| Name | Type | Required | Description |
|---|---|---|---|
| inputPorts | array[RemoteProcessGroupPortDTO] | optional | The input ports to which data can be sent. |
| outputPorts | array[RemoteProcessGroupPortDTO] | optional | The output ports from which data can be retrieved. |
{
"inputPorts": [RemoteProcessGroupPortDTO{…}],
"outputPorts": [RemoteProcessGroupPortDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the component. |
| uri | string | optional | The URI for futures requests to the component. |
| position | PositionDTO | optional | The position of this component in the UI if applicable. |
| parentGroupId | string | optional | The id of parent process group of this component if applicable. |
| targetUri | string | optional | The target URI of the remote process group. |
| targetSecure | boolean | optional | Whether the target is running securely. |
| name | string | optional | The name of the remote process group. |
| comments | string | optional | The comments for the remote process group. |
| communicationsTimeout | string | optional | The time period used for the timeout when commicating with the target. |
| yieldDuration | string | optional | When yielding, this amount of time must elapse before the remote process group is scheduled again. |
| authorizationIssues | array[string] | optional | Any remote authorization issues for the remote process group. |
| transmitting | boolean | optional | Whether the remote process group is actively transmitting. |
| inputPortCount | integer (int32) | optional | The number of remote input ports currently available on the target. |
| outputPortCount | integer (int32) | optional | The number of remote output ports currently available on the target. |
| activeRemoteInputPortCount | integer (int32) | optional | The number of active remote input ports. |
| inactiveRemoteInputPortCount | integer (int32) | optional | The number of inactive remote input ports. |
| activeRemoteOutputPortCount | integer (int32) | optional | The number of acitve remote output ports. |
| inactiveRemoteOutputPortCount | integer (int32) | optional | The number of inactive remote output ports. |
| flowRefreshed | string (date-time) | optional | The timestamp when this remote process group was last refreshed. |
| contents | RemoteProcessGroupContentsDTO | optional | The contents of the remote process group. Will contain available input/output ports. |
{
"id": "value",
"uri": "value",
"position": PositionDTO{…},
"parentGroupId": "value",
"targetUri": "value",
"targetSecure": true,
"name": "value",
"comments": "value",
"communicationsTimeout": "value",
"yieldDuration": "value",
"authorizationIssues": ["value"],
"transmitting": true,
"inputPortCount": 0,
"outputPortCount": 0,
"activeRemoteInputPortCount": 0,
"inactiveRemoteInputPortCount": 0,
"activeRemoteOutputPortCount": 0,
"inactiveRemoteOutputPortCount": 0,
"flowRefreshed": "value",
"contents": RemoteProcessGroupContentsDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| remoteProcessGroup | RemoteProcessGroupDTO | optional |
{
"revision": RevisionDTO{…},
"remoteProcessGroup": RemoteProcessGroupDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the target port. |
| groupId | string | optional | The id of the remote process group that the port resides in. |
| name | string | optional | The name of the target port. |
| comments | string | optional | The comments as configured on the target port. |
| concurrentlySchedulableTaskCount | integer (int32) | optional | The number of task that may transmit flowfiles to the target port concurrently. |
| transmitting | boolean | optional | Whether the remote port is configured for transmission. |
| useCompression | boolean | optional | Whether the flowfiles are compressed when sent to the target port. |
| exists | boolean | optional | Whether the target port exists. |
| targetRunning | boolean | optional | Whether the target port is running. |
| connected | boolean | optional | Whether the port has either an incoming or outgoing connection. |
{
"id": "value",
"groupId": "value",
"name": "value",
"comments": "value",
"concurrentlySchedulableTaskCount": 0,
"transmitting": true,
"useCompression": true,
"exists": true,
"targetRunning": true,
"connected": true,
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| remoteProcessGroupPort | RemoteProcessGroupPortDTO | optional |
{
"revision": RevisionDTO{…},
"remoteProcessGroupPort": RemoteProcessGroupPortDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| bulletins | array[BulletinDTO] | optional | The current bulletins for the component. |
| id | string | optional | The id of the remote process group. |
| groupId | string | optional | The id of the parent process group the remote process group resides in. |
| name | string | optional | The name of the remote process group. |
| targetUri | string | optional | The URI of the target system. |
| transmissionStatus | string | optional | The transmission status of the remote process group. |
| activeThreadCount | integer (int32) | optional | The number of active threads for the remote process group. |
| authorizationIssues | array[string] | optional | Any remote authorization issues for the remote process group. |
| sent | string | optional | The count/size of the flowfiles sent to the remote process group in the last 5 minutes. |
| received | string | optional | The count/size of the flowfiles received from the remote process group in the last 5 minutes. |
{
"bulletins": [BulletinDTO{…}],
"id": "value",
"groupId": "value",
"name": "value",
"targetUri": "value",
"transmissionStatus": "value",
"activeThreadCount": 0,
"authorizationIssues": ["value"],
"sent": "value",
"received": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the component. |
| uri | string | optional | The URI for futures requests to the component. |
| position | PositionDTO | optional | The position of this component in the UI if applicable. |
| parentGroupId | string | optional | The id of parent process group of this component if applicable. |
| name | string | optional | The name of the reporting task. |
| type | string | optional | The fully qualified type of the reporting task. |
| state | string | optional | The state of the reporting task. Allowable values: RUNNING, STOPPED, DISABLED |
| availability | string | optional | Where the reporting task is available. Allowable values: NCM, NODE |
| comments | string | optional | The comments of the reporting task. |
| schedulingPeriod | string | optional | The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy. |
| schedulingStrategy | string | optional | The scheduling strategy that determines how the schedulingPeriod value should be interpreted. |
| defaultSchedulingPeriod | object | optional | The default scheduling period for the different scheduling strategies. |
| properties | object | optional | The properties of the reporting task. |
| descriptors | object | optional | The descriptors for the reporting tasks properties. |
| customUiUrl | string | optional | The URL for the custom configuration UI for the reporting task. |
| annotationData | string | optional | The anntation data for the repoting task. This is how the custom UI relays configuration to the reporting task. |
| validationErrors | array[string] | optional | Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run. |
| activeThreadCount | integer (int32) | optional | The number of active threads for the reporting task. |
{
"id": "value",
"uri": "value",
"position": PositionDTO{…},
"parentGroupId": "value",
"name": "value",
"type": "value",
"state": "value",
"availability": "value",
"comments": "value",
"schedulingPeriod": "value",
"schedulingStrategy": "value",
"defaultSchedulingPeriod": {
"name": "value"
},
"properties": {
"name": "value"
},
"descriptors": {
"name": PropertyDescriptorDTO{…}
},
"customUiUrl": "value",
"annotationData": "value",
"validationErrors": ["value"],
"activeThreadCount": 0,
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| reportingTask | ReportingTaskDTO | optional |
{
"revision": RevisionDTO{…},
"reportingTask": ReportingTaskDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| reportingTaskTypes | array[DocumentedTypeDTO] | optional |
{
"revision": RevisionDTO{…},
"reportingTaskTypes": [DocumentedTypeDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| reportingTasks | array[ReportingTaskDTO] | optional |
{
"revision": RevisionDTO{…},
"reportingTasks": [ReportingTaskDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| clientId | string | optional | A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back |
| version | integer (int64) | optional | NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version. |
| lastModifier | string | optional | The user that last modified the flow. |
{
"clientId": "value",
"version": 0,
"lastModifier": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| processorResults | array[ComponentSearchResultDTO] | optional | The processors that matched the search. |
| connectionResults | array[ComponentSearchResultDTO] | optional | The connections that matched the search. |
| processGroupResults | array[ComponentSearchResultDTO] | optional | The process groups that matched the search. |
| inputPortResults | array[ComponentSearchResultDTO] | optional | The input ports that matched the search. |
| outputPortResults | array[ComponentSearchResultDTO] | optional | The output ports that matched the search. |
| remoteProcessGroupResults | array[ComponentSearchResultDTO] | optional | The remote process groups that matched the search. |
| funnelResults | array[ComponentSearchResultDTO] | optional | The funnels that matched the search. |
{
"processorResults": [ComponentSearchResultDTO{…}],
"connectionResults": [ComponentSearchResultDTO{…}],
"processGroupResults": [ComponentSearchResultDTO{…}],
"inputPortResults": [ComponentSearchResultDTO{…}],
"outputPortResults": [ComponentSearchResultDTO{…}],
"remoteProcessGroupResults": [ComponentSearchResultDTO{…}],
"funnelResults": [ComponentSearchResultDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| searchResultsDTO | SearchResultsDTO | optional |
{
"searchResultsDTO": SearchResultsDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| empty | boolean | optional |
{
"empty": true,
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the snippet. |
| uri | string | optional | The URI of the snippet. |
| parentGroupId | string | optional | The group id for the components in the snippet. |
| linked | boolean | optional | Whether or not the snippet is linked to the underlying data flow. For instance if linked was set to true and the snippet was deleted it would also deleted the components in the snippet. If the snippet was not linked, deleting the snippet would only remove the snippet and leave the component intact. |
| processGroups | array[string] | optional | The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). |
| remoteProcessGroups | array[string] | optional | The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). |
| processors | array[string] | optional | The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). |
| inputPorts | array[string] | optional | The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). |
| outputPorts | array[string] | optional | The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). |
| connections | array[string] | optional | The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). |
| labels | array[string] | optional | The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). |
| funnels | array[string] | optional | The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests). |
| contents | FlowSnippetDTO | optional | The contents of the configuration for the snippet. |
{
"id": "value",
"uri": "value",
"parentGroupId": "value",
"linked": true,
"processGroups": ["value"],
"remoteProcessGroups": ["value"],
"processors": ["value"],
"inputPorts": ["value"],
"outputPorts": ["value"],
"connections": ["value"],
"labels": ["value"],
"funnels": ["value"],
"contents": FlowSnippetDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| snippet | SnippetDTO | optional |
{
"revision": RevisionDTO{…},
"snippet": SnippetDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| field | string | optional | The name of the status field. |
| label | string | optional | The label for the status field. |
| description | string | optional | The description of the status field. |
| formatter | string | optional | The formatter for the status descriptor. |
{
"field": "value",
"label": "value",
"description": "value",
"formatter": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| generated | string (date-time) | optional | The timestamp when the status history was generated. |
| details | object | optional | The component details for the status history. |
| fieldDescriptors | array[StatusDescriptorDTO] | optional | The descriptor for each support status field. |
| statusSnapshots | array[StatusSnapshotDTO] | optional | The status snapshots. |
{
"generated": "value",
"details": {
"name": "value"
},
"fieldDescriptors": [StatusDescriptorDTO{…}],
"statusSnapshots": [StatusSnapshotDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| statusHistory | StatusHistoryDTO | optional |
{
"revision": RevisionDTO{…},
"statusHistory": StatusHistoryDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| timestamp | string (date-time) | optional | The timestamp of the snapshot. |
| statusMetrics | object | optional | The status metrics. |
{
"timestamp": "value",
"statusMetrics": {
"name": 0
},
}
| Name | Type | Required | Description |
|---|---|---|---|
| identifier | string | optional | The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration. |
| freeSpace | string | optional | Amount of free space. |
| totalSpace | string | optional | Amount of total space. |
| usedSpace | string | optional | Amount of used space. |
| freeSpaceBytes | integer (int64) | optional | The number of bytes of free space. |
| totalSpaceBytes | integer (int64) | optional | The number of bytes of total space. |
| usedSpaceBytes | integer (int64) | optional | The number of bytes of used space. |
| utilization | string | optional | Utilization of this storage location. |
{
"identifier": "value",
"freeSpace": "value",
"totalSpace": "value",
"usedSpace": "value",
"freeSpaceBytes": 0,
"totalSpaceBytes": 0,
"usedSpaceBytes": 0,
"utilization": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| totalNonHeap | string | optional | Total size of non heap. |
| usedNonHeap | string | optional | Amount of use non heap. |
| freeNonHeap | string | optional | Amount of free non heap. |
| maxNonHeap | string | optional | Maximum size of non heap. |
| nonHeapUtilization | string | optional | Utilization of non heap. |
| totalHeap | string | optional | Total size of heap. |
| usedHeap | string | optional | Amount of used heap. |
| freeHeap | string | optional | Amount of free heap. |
| maxHeap | string | optional | Maximum size of heap. |
| heapUtilization | string | optional | Utilization of heap. |
| availableProcessors | integer (int32) | optional | Number of available processors if supported by the underlying system. |
| processorLoadAverage | number (double) | optional | The processor load average if supported by the underlying system. |
| totalThreads | integer (int32) | optional | Total number of threads. |
| daemonThreads | integer (int32) | optional | Number of daemon threads. |
| flowFileRepositoryStorageUsage | StorageUsageDTO | optional | The flowfile repository storage usage. |
| contentRepositoryStorageUsage | array[StorageUsageDTO] | optional | The content repository storage usage. |
| garbageCollection | array[GarbageCollectionDTO] | optional | The garbage collection details. |
| statsLastRefreshed | string (date-time) | optional | When the diagnostics were generated. |
{
"totalNonHeap": "value",
"usedNonHeap": "value",
"freeNonHeap": "value",
"maxNonHeap": "value",
"nonHeapUtilization": "value",
"totalHeap": "value",
"usedHeap": "value",
"freeHeap": "value",
"maxHeap": "value",
"heapUtilization": "value",
"availableProcessors": 0,
"processorLoadAverage": 0.0,
"totalThreads": 0,
"daemonThreads": 0,
"flowFileRepositoryStorageUsage": StorageUsageDTO{…},
"contentRepositoryStorageUsage": [StorageUsageDTO{…}],
"garbageCollection": [GarbageCollectionDTO{…}],
"statsLastRefreshed": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| systemDiagnostics | SystemDiagnosticsDTO | optional |
{
"revision": RevisionDTO{…},
"systemDiagnostics": SystemDiagnosticsDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| uri | string | optional | The URI for the template. |
| id | string | optional | The id of the template. |
| name | string | optional | The name of the template. |
| description | string | optional | The description of the template. |
| timestamp | string (date-time) | optional | The timestamp when this template was created. |
| snippet | FlowSnippetDTO | optional | The contents of the template. |
{
"uri": "value",
"id": "value",
"name": "value",
"description": "value",
"timestamp": "value",
"snippet": FlowSnippetDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| template | TemplateDTO | optional |
{
"revision": RevisionDTO{…},
"template": TemplateDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| templates | array[TemplateDTO] | optional | |
| generated | string (date-time) | optional |
{
"revision": RevisionDTO{…},
"templates": [TemplateDTO{…}],
"generated": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | optional | The id of the user. |
| dn | string | optional | The dn of the user. |
| userName | string | optional | The username. If it could not be extracted from the DN, this value will be the entire DN. |
| userGroup | string | optional | The group this user belongs to. |
| justification | string | optional | The justification for the user account. |
| creation | string (date-time) | optional | The timestamp when the user was created. |
| status | string | optional | The user status. |
| lastVerified | string (date-time) | optional | The timestamp the user authorities were verified. |
| lastAccessed | string (date-time) | optional | The timestamp the user last accessed the system. |
| authorities | array[string] | optional | The users authorities. |
{
"id": "value",
"dn": "value",
"userName": "value",
"userGroup": "value",
"justification": "value",
"creation": "value",
"status": "value",
"lastVerified": "value",
"lastAccessed": "value",
"authorities": ["value"],
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| user | UserDTO | optional |
{
"revision": RevisionDTO{…},
"user": UserDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| group | string | optional | The user group. |
| userIds | array[string] | optional | The users that belong to the group. |
| authorities | array[string] | optional | The authorities of the users. |
| status | string | optional | The status of the users accounts. |
{
"group": "value",
"userIds": ["value"],
"authorities": ["value"],
"status": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| userGroup | UserGroupDTO | optional |
{
"revision": RevisionDTO{…},
"userGroup": UserGroupDTO{…},
}
| Name | Type | Required | Description |
|---|---|---|---|
| group | string | optional | The name of the group that matched the search. |
{
"group": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| userName | string | optional | The name of the user that matched the search. |
| userDn | string | optional | The dn of the user that matched the search. |
{
"userName": "value",
"userDn": "value",
}
| Name | Type | Required | Description |
|---|---|---|---|
| userResults | array[UserSearchResultDTO] | optional | |
| userGroupResults | array[UserGroupSearchResultDTO] | optional |
{
"userResults": [UserSearchResultDTO{…}],
"userGroupResults": [UserGroupSearchResultDTO{…}],
}
| Name | Type | Required | Description |
|---|---|---|---|
| revision | RevisionDTO | optional | The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. |
| users | array[UserDTO] | optional | |
| generated | string (date-time) | optional |
{
"revision": RevisionDTO{…},
"users": [UserDTO{…}],
"generated": "value",
}