CSObjectMultiple

The CSObjectMultiple class handles the querying of several iCM objects.

The CSObjectMultiple class includes methods for the retrieval, update and removal of several objects. All such methods require that certain database and key information (ObjectList for example) be specified via the properties provided, prior to their invocation.

iCM Objects are identified either by their unique ID or their Type and Label used in combination.

The ability to search object data for specific information is also handled by this class. Values of all elements that have been flagged as searchable within the Object Types section of iCM Management can be searched using this class.

All database access/connectivity is handled internally by the CSObjectMultiple class. 

For a general overview of iCM objects, see Object Types.

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

CSObjectMultiple_delete

Deletes the set objects from the database.

Request Parameters

{
    "get": "",
    "set": {
        "ObjectList": "1,2,3",
        "LabelList": "label1,label2,label3",
        "Type": "MYOBJECT"
    }
}

Response

{
    "id": 13,
    "result": {
        "data": {
            "multipleItemData": [{}, {}],
            "itemData": {}
        },
        "success": true
    },
    "jsonrpc": "2.0"
}

Example

Request:

function(params, credentials) {
    var object = this.callWorkerMethod("icmapi", "CSObjectMultiple_delete", {
        "get": "",
        "set": {
            "ObjectList": "20079,20080,20081"
        }
    });
    return object;
}

CSObjectMultiple_exist

Checks to see whether iCM objects exist in the database.

Request Parameters

{
    "get": "",
    "set": {
        "ObjectList": "1,2,3",
        "LabelList": "label1,label2,label3",
        "Type": "MYOBJECT"
    }
}

Response

{
    "id": 33,
    "result": {
        "data": {
            "multipleItemData": [{}, {}, {}],
            "returnValue": true,
            "itemData": {}
        },
        "success": true
    },
    "jsonrpc": "2.0"
}

Example

Request:

Note the use of rawMode: true when working with this.callWorkerMethod so that the full response can be seen, not just the multipleItemData array.

function(params, credentials) {
    var object = this.callWorkerMethod("icmapi", "CSObjectMultiple_exist", {
        "get": "",
        "set": {
            "ObjectList": "20087,20088,20089"
        }
    }, {
        "rawMode": true
    });
    return object;
}

Response:

{
    "id": 33,
    "result": {
        "data": {
            "multipleItemData": [{}, {}, {}],
            "returnValue": false,
            "itemData": {}
        },
        "success": true
    },
    "jsonrpc": "2.0"
}

CSObjectMultiple_get

Retrieves the details of several iCM objects from the database. The amount of information returned is set by the DetailLevel property.

Request Parameters

{
    "get":"",
    "set":{
        "DetailLevel": 2,
        "ObjectList": "1,2,3",
        "LabelList": "label1,label2,label3",
        "MaxRows": 3,
        "SortOrder": "DATETIMECREATED ASC",
        "StartRow": 5,
        "Type": "MYOBJECT"
        "UseSearchables": false,
        "DateAction": 1,
        "StartDate": "2022-10-28T09:30:00Z",
        "EndDate": "2022-10-28T10:30:00Z"
    }
}

Response

"result": {
    "data": {
        "multipleItemData": [{},{},{}],
        "itemData": {
            "_ItemClass": "CSObjectMultiple"
        }
    },
    "success": true
}

Example

Request:

function(params, credentials) {
    var object = this.callWorkerMethod("icmapi", "CSObjectMultiple_get", {
        "get": "ObjectData,ObjectID",
        "set": {
            "Type": "EXAMPLEHOUSE",
            "DateAction": 1,
            "StartDate": "2022-10-28T09:30:00Z",
            "EndDate": "2022-10-28T10:30:00Z"
        }
    });
    return object;
}

Response:

{
    "id": 82,
    "result": [{
        "_ItemClass": "CSObject",
        "ObjectID": 20092,
        "ObjectData": {
            "NUMBER": 1,
            "ROAD": "Darklake View"
        }
    }, {
        "_ItemClass": "CSObject",
        "ObjectID": 20091,
        "ObjectData": {
            "NUMBER": 2,
            "ROAD": "Darklake View"
        }
    }, {
        "_ItemClass": "CSObject",
        "ObjectID": 20090,
        "ObjectData": {
            "NUMBER": 3,
            "ROAD": "Darklake View"
        }
    }, {
        "_ItemClass": "CSObject",
        "ObjectID": 20083,
        "ObjectData": {
            "NUMBER": 4,
            "ROAD": "Darklake View"
        }
    }, {
        "_ItemClass": "CSObject",
        "ObjectID": 20082,
        "ObjectData": {
            "NUMBER": 5,
            "ROAD": "Darklake View"
        }
    }],
    "jsonrpc": "2.0"
}

CSObjectMultiple_update

Update is used to update existing, or create new, objects of a defined type. To update existing objects either the ObjectID or Type and Label must be supplied.

To create new objects the Type must already exist and a new unique Label should be supplied for each.

Request Parameters

{
    "get": "",
    "set": {
        "itemData": {},
        "multipleItemData": [{
            "Label": generateUUID(),
            "Type": "ANOTHERTYPE",
            "ObjectData": {
                "ANOTHERPROPERTY": "Tim"
            }
        }, {
            "Label": generateUUID(),
            "Type": "ANOTHERTYPE",
            "ObjectData": {
                "ANOTHERPROPERTY": "Tim"
            }
        }]
    }
}

Properties

Comparing Labels

Object labels are strings. When comparing labels using the LableGreaterThan and LabelLessThan properties, they are compared lexicographically (ie using alphabetical ordering).

Assume objects exist with the labels "MyNewerLabel", "MyNewLabel" and "MyNewLabels".

"MyNewLabels" is greater than "MyNewLabel" because it comes after it alphabetically. "MyNewerLabel" is less than "MyNewLabel" because it comes before it alphabetically.

UseSearchables

The properties within an Object Type Definition can be set as searchable. If true the values of those properties are indexed by the iCM search provider and can be queried using the UseSearchables property. UseSearchables can only be used with get.

When using UseSearchables, SolrURL, Logic, Var and Value are required. Either Type (the object type within which to search) or VarType are also required.

VarType is one of CHAR, LONGCHAR, INTEGER, NUMERIC or DATETIME.

Logic

The logic operators when using UseSearchables are:

Example

In this example, the search is restricted to objects of the EXAMPLEHOUSE type. We are looking for all objects that have a value of "Darklake View" in their ROAD property.

function(params, credentials) {
    var object = this.callWorkerMethod("icmapi", "CSObjectMultiple_get", {
        "get": "ObjectData,ObjectID",
        "set": {
            "UseSearchables": true,
            "SolrURL": "http://localhost:5506/solricm",
            "Logic": "=",
            "Type": "EXAMPLEHOUSE",
            "Var": "ROAD",
            "Value": "Darklake View"
        }
    });
    return object;
}