| Attributes |
| Name | Required | Request-time | Type | Description |
| rootArticleTypeId | false | true | java.lang.String | No Description |
| rootArticleId | false | true | java.lang.String | No Description |
| articleType | false | true | String |
You can use the specific ArticleType name (for example "News Items") or you can use the fully
qualified ArticleType name which might look something like "All Articles.Our Company.News Items". In
order
to prevent problems when there are two ArticleTypes with the same name, the fully qualified method is
preferred.
|
| recurseTree | false | true | java.lang.String |
Includes all items under this node, as opposed to just the siblings.
|
| getChildren | false | true | java.lang.String |
Only retrieves child nodes - does not retrieve selected node.
|
| depth | false | true | java.lang.String |
The number of levels (down) that should be retrieved.
|
| onlyShowNavigationElements | false | true | java.lang.String | No Description |
| articleMetaType | false | true | java.lang.String |
Allows you to specify what type of articleTypes are returned. Valid types are Article, Email or SMS.
Default value is "Article".
|
| searchTerms | false | true | java.lang.String |
Allows you to search for ArticleTypes. All articleTypes matching the String (or space seperated Strings)
are returned.
|
| breadCrumbTrailStart | false | true | java.lang.String |
Defines the start node of the breadcrumb trail. The breadcrumb trail returns a collection of ArticleType
objects, walking from the start node to the end node.
|
| breadCrumbTrailEnd | false | true | java.lang.String |
Defines the end node of the breadcrumb trail.
|
| collectionElementIds | false | true | java.lang.String |
|
| customGroupIds | false | true | java.lang.String |
|
| page | false | true | java.lang.String |
The current page of result (ommiting this attribute returns all articleTypes)
|
| articleTypesPerPage | false | true | java.lang.String |
The number of result returned per page. Default is 10. This value is only used if a page attribute
is also provided.
|
| usePreviewTree | false | true | java.lang.String |
If set to true, will use the preview ArticleType tree (before the site is versioned, any changes to the
tree will only be updated in the preview tree).
|