Filter Articles / FilterArticles (internally is.workflow.actions.filter.articles)

This action is not yet complete. Some arguments may be missing.

usage

FilterArticles filter=:filter{...} sortby=("Name" | "Title" | "Published Date" | "Author" | "Number of Words" | "Main Image URL" | "URL" | "Excerpt" | "Random") order=("Oldest First" | "Newest First" | "Latest First" | "Smallest First" | "Biggest First" | "Ascending" | "Descending" | "Shortest First" | "Longest First" | "A to Z" | "Z to A") limit=(true | false | variable) getItems=number

arguments

filter: Filter (Docs)

Accepts a :filter{} of filters. This filter supports:

Example: :filter{name is testname}

sortby: Enumeration (Docs)

Allows Variables: true

Accepts a string or variable containing one of the options:

  • Name
  • Title
  • Published Date
  • Author
  • Number of Words
  • Main Image URL
  • URL
  • Excerpt
  • Random

order: Enumeration (Docs)

Allows Variables: true

Only enabled if: argument WFContentItemSortProperty != Random

Accepts a string or variable containing one of the options:

  • Oldest First
  • Newest First
  • Latest First
  • Smallest First
  • Biggest First
  • Ascending
  • Descending
  • Shortest First
  • Longest First
  • A to Z
  • Z to A

limit: Switch (Docs)

Allows Variables: true

Accepts a boolean or a variable.

getItems: Stepper Number (Docs)

Allows Variables: true

Only enabled if: argument WFSwitchParameter == true

	Accepts a number 
	or variable
	with a number.

source json (for developers)

{
	"ActionClass": "WFContentItemFilterAction",
	"Category": "Web",
	"CreationDate": "2015-02-13T08:00:00.000Z",
	"IconName": "RichText.png",
	"Name": "Filter Articles",
	"Subcategory": "Articles",
	"WFContentItemClass": "WFArticleContentItem",
	"Parameters": [
		{
			"Class": "WFFilterParameter",
			"Key": "WFContentItemFilter",
			"Label": "Filter",
			"ContentItemClass": "WFArticleContentItem"
		},
		{
			"Class": "WFEnumerationParameter",
			"Key": "WFContentItemSortProperty",
			"Label": "Sort by",
			"Items": [
				"Name",
				"Title",
				"Published Date",
				"Author",
				"Number of Words",
				"Main Image URL",
				"URL",
				"Excerpt",
				"Random"
			]
		},
		{
			"Class": "WFEnumerationParameter",
			"Key": "WFContentItemSortOrder",
			"Label": "Order",
			"Items": [
				"Oldest First",
				"Newest First",
				"Latest First",
				"Smallest First",
				"Biggest First",
				"Ascending",
				"Descending",
				"Shortest First",
				"Longest First",
				"A to Z",
				"Z to A"
			],
			"RequiredResources": [
				{
					"WFParameterKey": "WFContentItemSortProperty",
					"WFParameterValues": [
						"Random"
					],
					"WFResourceClass": "WFParameterRelationResource",
					"WFParameterRelation": "!="
				}
			]
		},
		{
			"Class": "WFSwitchParameter",
			"Key": "WFContentItemLimitEnabled",
			"Label": "Limit"
		},
		{
			"Class": "WFStepperParameter",
			"Key": "WFContentItemLimitNumber",
			"Label": "Get Items",
			"RequiredResources": [
				{
					"WFParameterKey": "WFSwitchParameter",
					"WFParameterValues": [
						true
					],
					"WFResourceClass": "WFParameterRelationResource"
				}
			]
		}
	]
}