CSObject

The CSObject class handles the querying of an iCM object.

The CSObject class includes methods for the retrieval, update, creation and removal of a particular object's details. All such methods require that certain database and key information (ObjectID 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.

As it is possible to relate other CSObjects to a CSObject instance, this class also includes methods for the creation and removal of object relationships. Again, these methods require that certain database and key information be specified via the properties provided, prior to their invocation.

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

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

Methods

CSObject_delete 

Deletes an iCM object from the database. An object can be identified either by its ID or the combination of its Type and Label.

Any relationships with other objects will also be removed when an object is deleted.

Request Parameters

{
    "get": "",
    "set": {
        "Label": "858a50a0-55fb-11ed-a457-c3c55c762ada",
        "Type": "EXAMPLE",
        "ObjectID": 19307
    }
}

Response

{
    "id": 167,
    "result": {
        "data": {
            "itemData": {}
        },
        "success": true
    },
    "jsonrpc": "2.0"
}

Example

Request:

function(params, credentials) {
    var object = this.callWorkerMethod("icmapi", "CSObject_delete", {
        "get": "ObjectID,Label,ObjectData,Type",
        "set": {
            "ObjectID": 20068
        },
    });
    return object;
}

Response:

Note that using this.callWorkerMethod in an End Point parses the response, only returning the itemData in the result.

{
    "id": 193,
    "result": {
        "Type": "EXAMPLEHOUSE",
        "_ItemClass": "CSObject",
        "ObjectID": 20068,
        "Label": "FB88D950-55FD-11ED-A457-C3C55C762ADA",
        "ObjectData": {}
    },
    "jsonrpc": "2.0"
}

CSObject_exist

Checks to see whether a particular iCM object or relationship exists in the database.

Request Parameters

{
    "get": "",
    "set": {
        "Label": "858a50a0-55fb-11ed-a457-c3c55c762ada",
        "Type": "EXAMPLE",
        "ObjectID": 19307
    }
}

Response

The returnValue will be true if the object exists.

{
    "id": 416,
    "result": {
        "data": {
            "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 itemData object.

function(params, credentials) {
    var object = this.callWorkerMethod("icmapi", "CSObject_exist", {
        "get": "",
        "set": {
            "ObjectID": 20068
        }
    }, {
        "rawMode": true
    });
    return object;
}

Response:

{
    "id": 416,
    "result": {
        "data": {
            "returnValue": true,
            "itemData": {}
        },
        "success": true
    },
    "jsonrpc": "2.0"
}

CSObject_generateXMLDocAsString

Returns a string containing a representation of the object's data as a complete XML document. The file generated has the same format as files generated by iCM's object export function.

Request Parameters

{
    "get": "",
    "set": {
        "Label": "858a50a0-55fb-11ed-a457-c3c55c762ada",
        "Type": "EXAMPLE",
        "ObjectID": 19307
    }
}

Response

"result": {
    "data": {
        "returnValue": "<objects type=\"ANOTHERTYPE\">\r\n<alldata>\r\n<properties>\r\n<lastupdatedon>13-04-2017 09:51:08</lastupdatedon>\r\n<label>EEBADF20-4A89-464F-B642-4C8FEA28EB94</label>\r\n<createdby>UNKNOWN</createdby>\r\n<createdon>13-04-2017 09:25:08</createdon>\r\n<lastupdatedby>UNKNOWN</lastupdatedby>\r\n<objectid>153</objectid>\r\n</properties>\r\n<content>\r\n<anotherproperty>tim@gossinteractive.com</anotherproperty>\r\n</content>\r\n</alldata>\r\n</objects>\r\n",
        "itemData": {}
    },
    "success": true
}

Example

Request:

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

function(params, credentials) {
    var object = this.callWorkerMethod("icmapi", "CSObject_generateXMLDocAsString", {
        "get": "ObjectID",
        "set": {
            "ObjectID": 20070
        }
    }, {
        "rawMode": true
    });
    return object;
}

Response:

{
    "id": 183,
    "result": {
        "data": {
            "returnValue": "<objects type=\"EXAMPLEHOUSE\">\n<alldata>\n<properties>\n<lastupdatedon>27-10-2022 14:48:05</lastupdatedon>\n<label>FB88D950-55FD-11ED-A457-C3C55C762ADA</label>\n<createdby>UNKNOWN</createdby>\n<createdon>27-10-2022 14:48:05</createdon>\n<lastupdatedby>UNKNOWN</lastupdatedby>\n<objectid>20070</objectid>\n</properties>\n<content>\n<road>Darklake View</road>\n<number>24</number>\n</content>\n</alldata>\n</objects>\n",
            "itemData": {}
        },
        "success": true
    },
    "jsonrpc": "2.0"
}

CSObject_get

Retrieves the details of an iCM object from the database. Either the ObjectID or Type and Label must be supplied if you want to return an existing object.

Use Type on its own to return an empty object data structure for that Type.

Request Parameters

{
    "get": "",
    "set": {
        "Label": "858a50a0-55fb-11ed-a457-c3c55c762ada",
        "Type": "EXAMPLE",
        "ObjectID": 19307
    }
}

Response

{
    "id": 51,
    "result": {
        "data": {
            "itemData": {}
        },
        "success": true
    },
    "jsonrpc": "2.0"
}

Example

Request:

function(params, credentials) {
    var object = this.callWorkerMethod("icmapi", "CSObject_get", {
        "get": "ObjectData",
        "set": {
            "ObjectID": 20071
        }
    });
    return object;
}

Response:

Note that using this.callWorkerMethod in an End Point parses the response, only returning the itemData in the result.

{
    "id": 199,
    "result": {
        "_ItemClass": "CSObject",
        "ObjectData": {
            "ROAD": "Darklake View",
            "NUMBER": "24"
        }
    },
    "jsonrpc": "2.0"
}

CSObject_update

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

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

Request Parameters

{
    "get": "",
    "set": {
        "Label": 123456789,
        "Type": "EXAMPLEHOUSE",
        "ObjectData": {
            "NUMBER": 24,
            "ROAD": "Darklake View"
        }
    }
}

Response

{
    "id": 51,
    "result": {
        "data": {
            "itemData": {}
        },
        "success": true
    },
    "jsonrpc": "2.0"
}

Example

Request:

In this example we're creating a new object. We already know the stucture of the object data. Note how a new label is being generated.

function(params, credentials) {
    var uuidv1 = require("uuid/v1");
    var object = this.callWorkerMethod("icmapi", "CSObject_update", {
        "get": "ObjectID,Label,ObjectData,Type",
        "set": {
            "Label": uuidv1(),
            "Type": "EXAMPLEHOUSE",
            "ObjectData": {
                "NUMBER": 24,
                "ROAD": "Darklake View"
            },
        },
    });
    return object;
}

Response:

Note that using this.callWorkerMethod in an End Point parses the response, only returning the itemData in the result.

{
    "id": 212,
    "result": {
        "Type": "EXAMPLEHOUSE",
        "_ItemClass": "CSObject",
        "ObjectID": 20075,
        "Label": "a4da32c0-5602-11ed-a457-c3c55c762ada",
        "ObjectData": {
            "NUMBER": 24,
            "ROAD": "Darklake View"
        }
    },
    "jsonrpc": "2.0"
}

Properties

{
    "_ItemClass": "CSObject",
    "CheckTypeExistsOnCreate": true,
    "CreatedBy": "UNKNOWN",
    "DateCreated": "2022-10-27T14:06:06Z",
    "DateLastUpdated": "2022-10-27T14:06:06Z",
    "DetailLevel": 4,
    "Label": "80114E80-5600-11ED-A457-C3C55C762ADA",
    "LastUpdatedBy": "UNKNOWN",
    "ObjectData": {
        "ROAD": "Darklake View",
        "NUMBER": 24
    },
    "ObjectID": 20071,
    "RelatedDirection": null,
    "RelatedID": 0,
    "RelatedList": "",
    "Type": "EXAMPLEHOUSE",
    "UpdateData": false,
    "UpdatedLabel": null,
    "UserProfileType": "FORM_USERPROFILE"
}