Types returned by the the Management API
- Source:
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 |
AgilityManagement.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:
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 |
AgilityManagement.Types.ContentItem
|
The contentItem representing the content of this module. |
- Source:
MediaReturn
Defines a Content Zone on a page in the CMS.
Properties:
| Name | Type | Description |
|---|---|---|
mediaID |
number
|
The media id. |
url |
string
|
The url of the uploaded file. |
size |
number
|
The size in bytes of the uploaded file. |
contentType |
string
|
The content type of the uploaded file. |
- Source:
Page
Defines a Page in the CMS.
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
pageID |
number
|
The unique ID of the page in this language. |
|
parentPageID |
number
|
The parent page ID of this page. |
|
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 |
AgilityManagement.Types.SystemProperties
|
The system properties of this page item. |
|
zones |
Object.<string, AgilityManagement.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 |
AgilityManagement.Types.SitemapVisibility
|
Object that contains properties pertaining to the intended visibility of this page for seo and menus. |
- Source:
SEOProperties
Defines a page's seo settings.
Properties:
| Name | Type | Description |
|---|---|---|
metaDescription |
string
|
The meta description for this item. |
metaKeywords |
string
|
The meta keyworks for this item. |
metaHTML |
string
|
The raw meta html to add to this item.. |
- Source:
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:
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: