FlowHistory
Download OpenAPI Specification: Download
Retrieves the change history list for a specific flow
Returns chronological list of changes including creation, modifications, and status updates for the specified flow. Requires flow history read permissions.
Authorizations:
query Parameters
| flowId | integer <int32> The unique identifier of the flow to retrieve history for |
Responses
Response Schema:
| id | integer <int64> |
| area | string or null |
| modifiedDate | string <date-time> |
| modifiedBy | string or null |
Response samples
- 200
- 401
- 403
- 500
Compares changes between flow versions to show modifications
Provides side-by-side comparison of flow configuration changes, highlighting additions, modifications, and deletions. Requires flow history read permissions.
Authorizations:
query Parameters
| auditLogId | integer <int32> The unique identifier of the audit log entry to compare changes for |
Responses
Response Schema:
| auditLogId | integer <int32> |
| modifiedDate | string or null |
| _ctx | integer <int32> |
object (thruStatus) | |
Array of objects or null (CompareChangeItem) |
Response samples
- 200
- 401
- 403
- 500
Rolls back a flow configuration to a previous version
Reverts the flow configuration to the state recorded in the specified audit log entry. This operation creates a new audit entry documenting the rollback action. Requires flow history rollback permissions.
Authorizations:
query Parameters
| auditLogId | integer <int32> The unique identifier of the audit log entry to rollback to |
Responses
Response Schema:
| isRolledBack | boolean |
| message | string or null |
Response samples
- 200
- 401
- 403
- 500
Retrieves pending changes for a specific flow that have not yet been committed
Shows changes that have been made to a flow configuration but are not yet committed to the active configuration. Requires flow history read permissions.
Authorizations:
query Parameters
| flowId | integer <int32> The unique identifier of the flow to check for pending changes |
Responses
Response Schema:
| auditLogId | integer <int32> |
| modifiedDate | string or null |
| _ctx | integer <int32> |
object (thruStatus) | |
Array of objects or null (CompareChangeItem) |
Response samples
- 200
- 401
- 403
- 500
Rolls back pending changes for a specific flow, discarding uncommitted modifications
Discards all pending changes for the specified flow, reverting to the last committed configuration. This operation cannot be undone and all uncommitted changes will be permanently lost. Requires flow history rollback permissions.
Authorizations:
query Parameters
| flowId | integer <int32> The unique identifier of the flow to rollback pending changes for |
Responses
Response Schema:
| isRolledBack | boolean |
| message | string or null |
Response samples
- 200
- 401
- 403
- 500
