Skip to content

Latest commit

 

History

History
433 lines (276 loc) · 15.5 KB

BucketFlowsApi.md

File metadata and controls

433 lines (276 loc) · 15.5 KB

{{classname}}

All URIs are relative to /

Method HTTP request Description
CreateFlow Post /buckets/{bucketId}/flows Create flow
CreateFlowVersion Post /buckets/{bucketId}/flows/{flowId}/versions Create flow version
DeleteFlow Delete /buckets/{bucketId}/flows/{flowId} Delete bucket flow
ExportVersionedFlow Get /buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}/export Exports specified bucket flow version content
GetFlow Get /buckets/{bucketId}/flows/{flowId} Get bucket flow
GetFlowDiff Get /buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB} Get bucket flow diff
GetFlowVersion Get /buckets/{bucketId}/flows/{flowId}/versions/{versionNumber} Get bucket flow version
GetFlowVersions Get /buckets/{bucketId}/flows/{flowId}/versions Get bucket flow versions
GetFlows Get /buckets/{bucketId}/flows Get bucket flows
GetLatestFlowVersion Get /buckets/{bucketId}/flows/{flowId}/versions/latest Get latest bucket flow version content
GetLatestFlowVersionMetadata Get /buckets/{bucketId}/flows/{flowId}/versions/latest/metadata Get latest bucket flow version metadata
ImportVersionedFlow Post /buckets/{bucketId}/flows/{flowId}/versions/import Import flow version
UpdateFlow Put /buckets/{bucketId}/flows/{flowId} Update bucket flow

CreateFlow

VersionedFlow CreateFlow(ctx, body, bucketId) Create flow

Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body VersionedFlow The details of the flow to create.
bucketId string The bucket identifier

Return type

VersionedFlow

Authorization

No authorization required

HTTP request headers

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

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

CreateFlowVersion

VersionedFlowSnapshot CreateFlowVersion(ctx, body, bucketId, flowId, optional) Create flow version

Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body VersionedFlowSnapshot The new versioned flow snapshot.
bucketId string The bucket identifier
flowId string The flow identifier
optional *BucketFlowsApiCreateFlowVersionOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a BucketFlowsApiCreateFlowVersionOpts struct

Name Type Description Notes

preserveSourceProperties | optional.bool| Whether source properties like author should be kept |

Return type

VersionedFlowSnapshot

Authorization

No authorization required

HTTP request headers

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

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

DeleteFlow

VersionedFlow DeleteFlow(ctx, version, bucketId, flowId, optional) Delete bucket flow

Deletes a flow, including all saved versions of that flow.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
version LongParameter The version is used to verify the client is working with the latest version of the entity.
bucketId string The bucket identifier
flowId string The flow identifier
optional *BucketFlowsApiDeleteFlowOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a BucketFlowsApiDeleteFlowOpts struct

Name Type Description Notes

clientId | optional.Interface of ClientIdParameter| If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. |

Return type

VersionedFlow

Authorization

No authorization required

HTTP request headers

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

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

ExportVersionedFlow

VersionedFlowSnapshot ExportVersionedFlow(ctx, bucketId, flowId, versionNumber) Exports specified bucket flow version content

Exports the specified version of a flow, including the metadata and content of the flow.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucketId string The bucket identifier
flowId string The flow identifier
versionNumber int32 The version number

Return type

VersionedFlowSnapshot

Authorization

No authorization required

HTTP request headers

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

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

GetFlow

VersionedFlow GetFlow(ctx, bucketId, flowId) Get bucket flow

Retrieves the flow with the given id in the given bucket.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucketId string The bucket identifier
flowId string The flow identifier

Return type

VersionedFlow

Authorization

No authorization required

HTTP request headers

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

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

GetFlowDiff

VersionedFlowDifference GetFlowDiff(ctx, bucketId, flowId, versionA, versionB) Get bucket flow diff

Computes the differences between two given versions of a flow.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucketId string The bucket identifier
flowId string The flow identifier
versionA int32 The first version number
versionB int32 The second version number

Return type

VersionedFlowDifference

Authorization

No authorization required

HTTP request headers

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

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

GetFlowVersion

VersionedFlowSnapshot GetFlowVersion(ctx, bucketId, flowId, versionNumber) Get bucket flow version

Gets the given version of a flow, including the metadata and content for the version.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucketId string The bucket identifier
flowId string The flow identifier
versionNumber int32 The version number

Return type

VersionedFlowSnapshot

Authorization

No authorization required

HTTP request headers

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

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

GetFlowVersions

[]VersionedFlowSnapshotMetadata GetFlowVersions(ctx, bucketId, flowId) Get bucket flow versions

Gets summary information for all versions of a flow. Versions are ordered newest->oldest.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucketId string The bucket identifier
flowId string The flow identifier

Return type

[]VersionedFlowSnapshotMetadata

Authorization

No authorization required

HTTP request headers

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

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

GetFlows

[]VersionedFlow GetFlows(ctx, bucketId) Get bucket flows

Retrieves all flows in the given bucket.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucketId string The bucket identifier

Return type

[]VersionedFlow

Authorization

No authorization required

HTTP request headers

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

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

GetLatestFlowVersion

VersionedFlowSnapshot GetLatestFlowVersion(ctx, bucketId, flowId) Get latest bucket flow version content

Gets the latest version of a flow, including the metadata and content of the flow.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucketId string The bucket identifier
flowId string The flow identifier

Return type

VersionedFlowSnapshot

Authorization

No authorization required

HTTP request headers

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

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

GetLatestFlowVersionMetadata

VersionedFlowSnapshotMetadata GetLatestFlowVersionMetadata(ctx, bucketId, flowId) Get latest bucket flow version metadata

Gets the metadata for the latest version of a flow.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucketId string The bucket identifier
flowId string The flow identifier

Return type

VersionedFlowSnapshotMetadata

Authorization

No authorization required

HTTP request headers

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

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

ImportVersionedFlow

ImportVersionedFlow(ctx, bucketId, flowId, optional) Import flow version

Import the next version of a flow. The version number of the object being created will be the next available version integer. Flow versions are immutable after they are created.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
bucketId string The bucket identifier
flowId string The flow identifier
optional *BucketFlowsApiImportVersionedFlowOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a BucketFlowsApiImportVersionedFlowOpts struct

Name Type Description Notes

body | optional.Interface of VersionedFlowSnapshot| file | comments | optional.string| |

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

UpdateFlow

VersionedFlow UpdateFlow(ctx, body, bucketId, flowId) Update bucket flow

Updates the flow with the given id in the given bucket.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body VersionedFlow The updated flow
bucketId string The bucket identifier
flowId string The flow identifier

Return type

VersionedFlow

Authorization

No authorization required

HTTP request headers

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

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