automationStudio

Get a page of workflow documents

Returns a page of workflow documents.

get/automation-studio/workflows

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/automation-studio/workflows
  • Auth: none declared

Query parameters

limitinteger

Number of results to return. Used for pagination.

skipinteger

Number of results to skip. Used for pagination.

order'-1' | '1'

Sort direction, 1 for ascending and -1 for descending.

sort'name'

Field to sort by

exclude-project-membersboolean

Flag which removes workflows from the results which are members of a project

includestring

Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.

excludestring

Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.

expandstring

Sets the fields to expand. Generally, these are fields like "metrics.user", "metrics.owner", "created_by", etc

instring

Search for fields exactly matching one of the given list options

not-instring

Search for fields not exactly matching one of the given list options

equalsstring

Returns results where the specified fields exactly match the given match string(s).

containsstring

Returns results where the specified fields contain the given match string(s).

starts-withstring

Returns results where the specified fields start with the given match string(s).

ends-withstring

Returns results where the specified fields end in the given match string(s).

task-equalsstring

Returns results where one or more tasks have fields that exactly match the given match string(s).

Response

Results for the given search parameters.

totalinteger

Total number of documents matching the given query parameters.

startinteger

Search index of first document in the items array.

endinteger

Search index of the last document in the items array.

countinteger

Length of the items array.

limitinteger

Number of results to return. Used for pagination.

nextstring nullable

URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.

previousstring nullable

URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.

Changes

No recorded changes to this operation across all 1 revision of this API.