View as Markdown

ListWorkflowsRequest

Field	Type	Description
offset	optional uint32	Used to paginate through results. To get the next page result, set this to the desired starting offset. For example, setting to 10 will start with the 10th record. The default value is 0.
limit	optional uint32	This defines the upper bound of the number of items returned. The maximum value supported is 100, meaning that we’ll never return more than max(items.count, limit, 100).
filters	repeated bitdrift.public.unary.workflows.v1.Filter	Filter the list of workflows based on the current user's relationship to the workflow. This is a logical OR. If no filters are supplied, all workflows are returned.
platform_targets	repeated bitdrift.public.shared.platform.v1.Platform	Filter the list of workflows based on the platform(s) that that workflow targets. This is a logical OR. If no platforms are supplied, all workflows are returned.
sort	repeated bitdrift.public.unary.workflows.v1.ListWorkflowsRequest.Sort	Orders workflows by caller-visible attributes. Apply criteria in the order provided.

Example

JSON

{
  "filters": [
    {
      "owned": {}
    }
  ],
  "limit": 25,
  "offset": 1,
  "platform_targets": [
    {
      "apple": {
        "apps": [
          {
            "app_id": "com.example.app"
          }
        ]
      }
    }
  ],
  "sort": [
    {
      "direction": "DESCENDING",
      "key": "CREATION_TIME"
    }
  ]
}

ListWorkflowsRequest.Sort

Field	Type	Description
key	bitdrift.public.unary.workflows.v1.ListWorkflowsRequest.Sort.SortKey	Selects which caller-visible workflow attribute to order by.
direction	bitdrift.public.unary.common.v1.SortDirection	Selects whether results are returned in ascending or descending order.

Example

JSON

{
  "direction": "DESCENDING",
  "key": "CREATION_TIME"
}

ListWorkflowsRequest.Sort.SortKey

Name	Number	Description
SORT_KEY_UNSPECIFIED	0
DISPLAY_NAME	1
CREATION_TIME	2
STATUS	3
OWNER_NAME	4
FAVORITED	5