docs/flow.md in losant_rest-1.12.0 vs docs/flow.md in losant_rest-1.13.0

- old
+ new

@@ -10,10 +10,11 @@ * [Delete](#delete) * [Errors](#errors) * [Get](#get) * [Get Log Entries](#get-log-entries) * [Get Storage Entries](#get-storage-entries) +* [Get Storage Entries Metadata](#get-storage-entries-metadata) * [Patch](#patch) * [Press Virtual Button](#press-virtual-button) * [Set Storage Entry](#set-storage-entry) * [Stats](#stats) @@ -256,9 +257,49 @@ #### Successful Responses | Code | Type | Description | | ---- | ---- | ----------- | | 200 | [Workflow Storage Entries](_schemas.md#workflow-storage-entries) | The current storage entries | + +#### Error Responses + +| Code | Type | Description | +| ---- | ---- | ----------- | +| 400 | [Error](_schemas.md#error) | Error if malformed request | +| 404 | [Error](_schemas.md#error) | Error if flow was not found | + +<br/> + +## Get Storage Entries Metadata + +Gets metadata about storage for this flow + +```ruby +result = client.flow.get_storage_entries_metadata( + applicationId: my_application_id, + flowId: my_flow_id) + +puts result +``` + +#### Authentication +The client must be configured with a valid api access token to call this +action. The token must include at least one of the following scopes: +all.Application, all.Organization, all.User, flow.*, or flow.getStorageEntriesMetadata. + +#### Available Parameters + +| Name | Type | Required | Description | Default | Example | +| ---- | ---- | -------- | ----------- | ------- | ------- | +| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 | +| flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 | +| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com | + +#### Successful Responses + +| Code | Type | Description | +| ---- | ---- | ----------- | +| 200 | [Get Workflow Storage Entries Metadata](_schemas.md#get-workflow-storage-entries-metadata) | The meta data for the current storage entries | #### Error Responses | Code | Type | Description | | ---- | ---- | ----------- |