CSArticleMultiple

The CSArticleMultiple class includes methods for the retrieval of several articles' details.

Note that it is not possible to use CSArticleMultiple to create, update or delete an article. This functionality is provided by making direct iCM requests using the ColdFusion API's iCM_obj_articleUpdate. 

Unlike CSArticle, where an article or template ID must be provided, setting no properties will return all articles in the database. Setting almost any of the properties below will only return articles that have those properties. Many of the properties can be used in combination with each other to build up a filter.

Typically, only those articles that are in date and currently turned "on" will be retrieved. However, if IgnoreVisibility is set to true, any articles that have been turned "off" and/or that are not in date will also be included.

Each retrieved article is stored as a CSArticle instance within this CSArticleMultiple instance - ie as a CSArticle object in an array.

Methods

Parameters must use the get-set structure described in the introduction - Java API (CSObjects).

• get a string (comma separated) that lists the properties whose values should be returned, an asterisk to indicate that all properties should be returned, or an empty string to return nothing
• set the properties which should be set before the specified method is performed

CSArticleMultiple_get

Retrieves an array of CSArticles as objects.

Request Parameters

In this request we want to know the article headings of all of the articles beneath article 16, up to a depth of 3 (ie child articles, their child articles and their child articles)

this.callWorkerMethod("icmapi", "CSArticleMultiple_get", {
    "get": "ArticleHeading",
    "set": {
        "ParentArticleIDList":"16",
        "LevelDepth":3,
    }
});

Response

We can see the article headings of the three levels are articles requested.

{
    "result": [{
        "_ItemClass": "CSArticle",
        "ArticleHeading": "An Event"
    }, {
        "_ItemClass": "CSArticle",
        "ArticleHeading": "A Child Event"
    }, {
        "_ItemClass": "CSArticle",
        "ArticleHeading": "A location"
    }]
}

Properties

Filters

A FilterValue can be tested against the FilterColumn property using the defined FilterLogic.

The available FilterColumn properties are:

The logic operators are:

Filter Example

In this example, all articles with the letter sequence "test" anywhere in their heading will be returned.

"set": {
    "FilterColumn":"ArticleHeading",
    "FilterValue":"%test%",
    "FilterLogic":"LIKE"
}