All URIs are relative to /
| Method | HTTP request | Description |
|---|---|---|
| GetAvailableFlowFields | Get /flows/fields | Get flow fields |
| GetFlow1 | Get /flows/{flowId} | Get flow |
| GetFlowVersion1 | Get /flows/{flowId}/versions/{versionNumber} | Get flow version |
| GetFlowVersions1 | Get /flows/{flowId}/versions | Get flow versions |
| GetLatestFlowVersion1 | Get /flows/{flowId}/versions/latest | Get latest flow version |
| GetLatestFlowVersionMetadata1 | Get /flows/{flowId}/versions/latest/metadata | Get latest flow version metadata |
Fields GetAvailableFlowFields(ctx, ) Get flow fields
Retrieves the flow field names that can be used for searching or sorting on flows.
This endpoint does not need any parameter.
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VersionedFlow GetFlow1(ctx, flowId) Get flow
Gets a flow by id.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| flowId | string | The flow identifier |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VersionedFlowSnapshot GetFlowVersion1(ctx, flowId, versionNumber) Get flow version
Gets the given version of a flow, including metadata and flow content.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| flowId | string | The flow identifier | |
| versionNumber | int32 | The version number |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]VersionedFlowSnapshotMetadata GetFlowVersions1(ctx, flowId) Get flow versions
Gets summary information for all versions of a given flow. Versions are ordered newest->oldest.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| flowId | string | The flow identifier |
[]VersionedFlowSnapshotMetadata
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VersionedFlowSnapshot GetLatestFlowVersion1(ctx, flowId) Get latest flow version
Gets the latest version of a flow, including metadata and flow content.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| flowId | string | The flow identifier |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VersionedFlowSnapshotMetadata GetLatestFlowVersionMetadata1(ctx, flowId) Get latest flow version metadata
Gets the metadata for the latest version of a flow.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| flowId | string | The flow identifier |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]