iCM_obj_articleUpdate

All articles in iCM are identified by a unique ID. When using iCM_obj_articleUpdate, if the supplied ArticleID already exists, that article will be updated. If the ArticleID is blank (or set as zero) a new article will be created.

When creating a new article, you can either provide the ArticleStruct, or use iCM_obj_articleGet with ArticleTemplateID to return an empty ArticleStruct which you will then have to merge with your new article data.

ArticleStruct.ArticleID, ArticleStruct.ArticleHeading, ArticleStruct.ArticleParentID and ArticleStruct.ArticleTemplateID must be set. Other elements must be provided, but if left blank will assume sensible defaults.

Both the username and password should be provided using the default credentials of an API Key. See "Supplying Default Credentials" in URLs, Keys and Authentication.

Properties

Required ArticleStruct Properties

The following properties must be defined in the ArticleStruct object. Those marked as required must have a value. Others are required, but their values may be an empty string.

Optional ArticleStruct Properties

All of the following properties can be optionally included in the ArticleStruct object.

Returns

If the request was successful the result data object will contain an object called CONTENT which includes the article ID and another called STATE indicating the article was created/updated successfully.

{
    "id": 106,
    "result": {
        "CONTENT": {
            "Status": "Live",
            "ArticleID": 3424
        },
        "STATE": {
            "Status": "ACCESS GRANTED"
        }
    },
    "jsonrpc": "2.0"
}

Example 1

In this example the core properties are provided in the ArticleStruct. ArticleID is 0 because we are creating a new article. Setting the ArticleID of an existing article would update that article. As with all iCM_ requests, the parameters are provided in the "attributes" object and the user details by the apiKey.

Make a call to iCM_obj_articleGet with the desired ArticleTemplateID to return a default structure for that template type.

function(params, credentials) {
    let createArticle = this.callWorkerMethod("icmapi", "iCM_obj_articleUpdate", {
        "attributes": {
            "ArticleStruct": {
                "ArticleDate": "",
                "ArticleID": 0,
                "ArticleHeading": "My New Article",
                "ArticleTemplateID": 1,
                "ArticleParentID": 3424,
                "ArticleIntroText": "",
                "ArticleDisplay": "",
                "ArticleDisplayDate": "",
                "ArticleDisplayEDate": "",
                "Archiveable": "",
                "ArchiveDate": "",
                "ArchiveParentID": "",
                "ArticleText": "",
                "ArticleReviewDate": "",
                "ArticleReviewInterval": ""
            }
        }
    }, {
        "options": {
            "apiKey": "<Your API Key>"
        }
    });
    return createArticle;
}

Example 2

When updating an existing article you can either supply the ArticleStruct as in example 1, or call iCM_obj_articleGet and an ArticleID to return the content of an existing article.

In this example we are fetching article ID 25 and updating its heading text.

function(params, credentials) {
    let articleData = this.callWorkerMethod("icmapi", "iCM_obj_articleGet", {
        "attributes": {
            "ArticleID": 25,
            "GetExtensionData": true
        }
    });
    articleData.CONTENT.ArticleHeading = "Here's my new heading";
    let createArticle = this.callWorkerMethod("icmapi", "iCM_obj_articleUpdate", {
        "attributes": {
            "ArticleStruct": articleData.CONTENT
        }
    }, {
        "options": {
            "apiKey": "<Your API Key>"
        }
    });
    return createArticle;
}