Types

AgilityFetch. Types

Types returned by the the Fetch API

Source:

Members

(static, constant) FilterLogicOperators :FilterLogicOperator

Enum of FilterLogicOperators.

Properties:
Name Type Description
AND FilterLogicOperator

And

OR FilterLogicOperator

Or

Default Value:
  • AND
Source:
Type:
  • FilterLogicOperator

(static, constant) FilterOperators :FilterOperator

Enum of FilterOperators.

Properties:
Name Type Description
EQUAL_TO FilterOperator

Equal To

NOT_EQUAL_TO FilterOperator

Not Equal To

LESS_THAN FilterOperator

Less Than

LESS_THAN_OR_EQUAL_TO FilterOperator

Less Than or Equal To

GREATER_THAN FilterOperator

Greater Than

GREATER_THAN_OR_EQUAL_TO FilterOperator

Greater Than or Equal To

LIKE FilterOperator

Like (string only)

Source:
Type:
  • FilterOperator

(static, constant) SortDirections :SortDirection

Enum of SortDirections.

Properties:
Name Type Description
ASC SortDirection

Ascending

DESC SortDirection

Descending

Default Value:
  • ASC
Source:
Type:
  • SortDirection

Type Definitions

ContentItem

Defines a Content Item in the CMS

Properties:
Name Type Attributes Description
contentID number

The unique ID of the content item in this language.

properties AgilityFetch.Types.SystemProperties

The system properties of the content item.

fields Object

A dictionary of the fields and the values of the content item.

seo Object <optional>

Any SEO related fields for the content item. This is only returned for Dynamic Page Items.

Source:

ContentList

Defines a Content List in the CMS.

Properties:
Name Type Description
items Array.<AgilityFetch.Types.ContentItem>

The paginated array of items returned by the request. Default take is 10 unless otherwise specified (Maximum allowed it 50)

totalCount number

The total amount of items in the list. Use this along with skip and take for pagination.

Source:

ContentZone

Defines a Content Zone on a page in the CMS.

Properties:
Name Type Description
module string

The reference name of the module definition of this module.

item AgilityFetch.Types.ContentItem

The contentItem representing the content of this module.

Source:

Filter

Defines a Filter for filtering lists.

Properties:
Name Type Description
property string

The property to filter the request on.

operator AgilityFetch.Types.FilterOperator

The operator to use for the filter.

value string

The value to compare for the property.

Source:

FilterLogicOperator

Defines a FilterLogicOperator - Refer to AgilityFetch.Types.FilterLogicOperators Enum for available Logic Operators.

Source:
Type:
  • string

FilterOperator

Defines a FilterOperator - Refer to AgilityFetch.Types.FilterOperators Enum for available Operators.

Source:
Type:
  • string

Gallery

Defines a Gallery in the CMS

Properties:
Name Type Description
galleryID number

The unique ID of the gallery.

name string

The name of the gallery.

description string

The description of the gallery.

count number

The count of media items in the gallery.

media Array.<AgilityFetch.Types.MediaItem>

Array of media items in the gallery.

Source:

MediaItem

Defines a MediaItem in the CMS

Properties:
Name Type Description
mediaID number

The unique ID of the media item.

fileName string

The file name of the media item.

url string

The url of the media item.

size number

The size of the media item in bytes.

modifiedOn date

The last modified date and time of the media item.

metaData AgilityFetch.Types.MediaItemMetaData

Meta data for the media item.

Source:

MediaItemMetaData

Defines a MediaItemMetaData in the CMS

Properties:
Name Type Description
Title string

The title meta data of the media item.

Description string

The description meta data of the media item.

LinkUrl string

The link url meta data of the media item.

pixelHeight string

The height in pixels of the media item.

pixelWidth string

The width in pixels of the media item.

Source:

Page

Defines a Page in the CMS.

Properties:
Name Type Attributes Description
pageID number

The unique ID of the page in this language.

name string

The friendly url slug for the page - this is used to make up the URL.

path string

The url path for this page.

title string

The page title for the page, used for SEO and appears in the browser bar/tab.

menuText string

And alternate text field, often used in dynamic menu generation.

pageType string

The type of page. Valid values include static, dynamic, dynamic_node, link, and folder.

templateName string

The name of the Page Template this page uses.

securePage boolean

This value represents whether this page should be secured within the website.

properties AgilityFetch.Types.SystemProperties

The system properties of this page item.

zones Object.<string, AgilityFetch.Types.ContentZone>

Contains a dictionary of content zones for this page and the modules in each zone.

redirectUrl string <optional>

If this page is a link, then this property will show the intended destination redirect.

dynamicItemContentID number <optional>

If this page is a dynamic page, then this property will show the associated contentID of the dynamic content item.

visible AgilityFetch.Types.SitemapVisibility

Object that contains properties pertaining to the intended visibility of this page for seo and menus.

Source:

SitemapFlat

A dictionary/map of all page routes. The key of this dictionary is the page path for a page.

Source:
Type:

SitemapFlatItem

Represents an item in a sitemap response

Properties:
Name Type Attributes Description
pageID number

The unique ID of the page in Agility in this language.

title string

A human-friendly title for the page, typically used for SEO and displayed in the browser tab/bar.

name string

The URL friendly name of the page.

path string

The URL path of the page.

menuText string

An alternate page title, often used when generating dynamic menus.

pageType string

Describes what type of page this is - values include static, dynamic, dynamic_node, folder, and link

properties AgilityFetch.Types.SystemProperties

The system properties of this page item.

redirectUrl string <optional>

If this page is a link, then this property will show the intended destination redirect.

dynamicItemContentID number <optional>

If this page is a dynamic page, then this property will show the associated contentID of the dynamic content item.

visible AgilityFetch.Types.SitemapVisibility

Object that contains properties pertaining to the intended visibility of this page for seo and menus.

Source:
Type:
  • Object

SitemapNested

A dictionary/map of all page routes. The key of this dictionary is the page path for a page.

Source:
Type:

SitemapNestedItem

Represents an item in a sitemap response

Properties:
Name Type Attributes Description
pageID number

The unique ID of the page in Agility in this language.

title string

A human-friendly title for the page, typically used for SEO and displayed in the browser tab/bar.

name string

The URL friendly name of the page.

menuText string

An alternate page title, often used when generating dynamic menus.

pageType string

Describes what type of page this is - values include static, dynamic, dynamic_node, folder, and link

properties AgilityFetch.Types.SystemProperties

The system properties of this page item.

children Array.<AgilityFetch.Types.SitemapNestedItem> <optional>

The children of this page

redirectUrl string <optional>

If this page is a link, then this property will show the intended destination redirect.

dynamicItemContentID number <optional>

If this page is a dynamic page, then this property will show the associated contentID of the dynamic content item.

visible AgilityFetch.Types.SitemapVisibility

Object that contains properties pertaining to the intended visibility of this page for seo and menus.

Source:
Type:
  • Object

SitemapVisibility

Defines a page's visibility.

Properties:
Name Type Description
menu boolean

If set to true, this page should be hidden from menus.

sitemap boolean

If set to true, this page should be hidden from the sitemap and not accessible by robots.

Source:

SortDirection

Defines a Sort Direction - Refer to AgilityFetch.Types.SortDirections Enum for available Sort Directions.

Source:
Type:
  • string

SyncContent

Defines Sync Content response.

Properties:
Name Type Description
syncToken number

The sync token to be used in the next call as a continuation token for syncing content. If this is empty, you are up to date.

items Array.<AgilityFetch.Types.ContentItem>

The paginated array of items returned by the request.

Source:

SyncPages

Defines Sync Pages response.

Properties:
Name Type Description
syncToken number

The sync token to be used in the next call as a continuation token for syncing content. If this is empty, you are up to date.

items Array.<AgilityFetch.Types.Page>

The paginated array of items returned by the request.

Source:

SystemProperties

Defines the common System Properties of pages and content items in the CMS.

Properties:
Name Type Description
created datetime

The date/time this item was created.

modified datetime

The date/time this item was last modified.

state number

The state of this content item. 1 = Staging, 2 = Published, 3 = Deleted, 4 = Approved, 5 = AwaitingApproval, 6 = Declined, 7 = Unpublished

versionID number

The unique versionID of this content item.

Source:

URLRedirection

Defines URL Redirection .

Properties:
Name Type Description
id Number

The id of this URL Redirection

originUrl String

The URL to redirect from

destinationUrl String

The URL to redirect to

statusCode Number

Either a 301 or 302 status code for the redirect

Source:

URLRedirectionResponse

Defines URL Redirection response.

Properties:
Name Type Description
syncToken Array

The sync token to be used in the next call as a continuation token for syncing content. If this is empty, you are up to date.

items Array.<AgilityFetch.Types.Page>

The paginated array of items returned by the request.

Source: