Struct GetWorkflowsPaginatedParams

pub struct GetWorkflowsPaginatedParams {
    pub start_at: Option<i64>,
    pub max_results: Option<i32>,
    pub workflow_name: Option<Vec<String>>,
    pub expand: Option<String>,
    pub query_string: Option<String>,
    pub order_by: Option<String>,
    pub is_active: Option<bool>,
}

struct for passing parameters to the method get_workflows_paginated

Fields

start_at: Option<i64>

The index of the first item to return in a page of results (page offset).

max_results: Option<i32>

The maximum number of items to return per page.

workflow_name: Option<Vec<String>>

The name of a workflow to return. To include multiple workflows, provide an ampersand-separated list. For example, workflowName=name1&workflowName=name2.

expand: Option<String>

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * transitions For each workflow, returns information about the transitions inside the workflow. * transitions.rules For each workflow transition, returns information about its rules. Transitions are included automatically if this expand is requested. * transitions.properties For each workflow transition, returns information about its properties. Transitions are included automatically if this expand is requested. * statuses For each workflow, returns information about the statuses inside the workflow. * statuses.properties For each workflow status, returns information about its properties. Statuses are included automatically if this expand is requested. * default For each workflow, returns information about whether this is the default workflow. * schemes For each workflow, returns information about the workflow schemes the workflow is assigned to. * projects For each workflow, returns information about the projects the workflow is assigned to, through workflow schemes. * hasDraftWorkflow For each workflow, returns information about whether the workflow has a draft version. * operations For each workflow, returns information about the actions that can be undertaken on the workflow.

query_string: Option<String>

String used to perform a case-insensitive partial match with workflow name.

order_by: Option<String>

Order the results by a field: * name Sorts by workflow name. * created Sorts by create time. * updated Sorts by update time.

is_active: Option<bool>

Filters active and inactive workflows.

Trait Implementations

impl Clone for GetWorkflowsPaginatedParams

fn clone(&self) -> GetWorkflowsPaginatedParams

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetWorkflowsPaginatedParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GetWorkflowsPaginatedParams

fn default() -> GetWorkflowsPaginatedParams

Returns the “default value” for a type.