Flow

Query flows by usage

Changed on

Used to query flows by usage using flow references for most recent main version

post/flows/references/usage

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/flows/references/usage
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Query parameters

workspace_idstring required

The workspace associated with this query

Request body

application_idstring

Restricts the query to entities of a given application ID

database_connection_idstring

Restricts the query to entities with the given database connection ID (only used for Snippet queries)

flow_type'validate_page' | 'login' | 'verify_url' | 'mablscript' | 'check_links' | 'visual_page_validation' | 'api' | 'mobile'

the type of flow

limitinteger required

The max results to return

mobile_platform'android' | 'ios'

The mobile platform associated with this object

reusableboolean

If specified, will only return entities with the given reusable flag

snippet_typesSnippetTypeEnum[]

Restricts the query to entities with the given snippet type (only used for Snippet queries)

Response

Array of flows matching the query

cursorstring

Cursor used for pagination

Changes

  • d0a5100df4c1Revision changes
    • breaking

      the /////// response's property type changed from string to no type for status

    • info

      added to the /////// response property allOf list for the response status

    • info

      removed the api enum value from the /////// response property for the response status

    • info

      removed the check_links enum value from the /////// response property for the response status

    • info

      removed the login enum value from the /////// response property for the response status

    • info

      removed the mablscript enum value from the /////// response property for the response status

    • info

      removed the mobile enum value from the /////// response property for the response status

    • info

      removed the validate_page enum value from the /////// response property for the response status

    • info

      removed the verify_url enum value from the /////// response property for the response status

    • info

      removed the visual_page_validation enum value from the /////// response property for the response status

  • 213a66c2bc25Revision changes
    • info

      added the optional property /////// to the response with the status