| Attributes |
| Name | Required | Request-time | Type | 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.
|
| rootArticleTypeId | false | true | java.lang.String |
Retrieve the collection of articles based on the rootArticleTypeId
|
| rootArticleId | false | true | java.lang.String |
Retrieve the collection of articles based on the rootArticleId
|
| customGroupIds | false | true | String |
If you have created and assigned Custom Groups to some article types,
you can limit the result returned to articles, the Article Type of which is assinged to these
object IDs. The list should be provided in a a comma seperated String. For example, providing the String
"4,5,78,90" will only return articles which have a type that is associated with 1 or more of these four
Custom Group IDs
|
| rootTagIds | false | true | String |
If you have created and assigned Tags to some articles,
you can limit the results returned to articles of that tag.
The list should be provided in a a comma seperated String. For example, providing the String
"4,5,78,90" will only return articles which have a tag that is associated with 1 or more of these four
Root Tag IDs
|
| tags | false | true | String |
If you have created and assigned Tags to some articles,
you can limit the results returned to articles of that tag.
The list should be provided in a a comma seperated String. For example, providing the String
"news,events,bios" will only return articles which have a tag that is associated
with 1 or more of these three tags
|
| numberOfArticles | false | true | java.lang.String | No Description |
| searchTerms | false | true | java.lang.String | No Description |
| page | false | true | java.lang.String |
The current page number (omitting this attribute will return all articles)
|
| articlesPerPage | false | true | java.lang.String |
The number of articles per page (only used if a pageNumber is specified)
|
| sessionTypeId | false | true | java.lang.String | The version type of these articles. Valid values are:
1 - Published Articles
2 - Preview Articles;
3 - Articles available for editing;
|
| articleMetaType | false | true | java.lang.String | The meta type of these articles. Valid values are:
"Article"
"Email"
"SMS"
|
| hideEditTags | false | true | java.lang.String |
Boolean true or false. If logged into WebDeck, and Editing the site, edit tags are displayed next to
articles. This can cause formatting issues especially if used within DHTML or Javascript. If menus or
other
elements are being created with the Article Tag, adding hideEditTags="true" will prevent them from ever
being displayed.
You can specify precise placement of the edit tag by calling the generateEditTag method.
|