injectMarker

This method is to create an "instance" marker to the current record of a session. Then you can call updateMarker to turn this marker into an "interval" marker.

You must call createRecord before you call this method.

Parameters

Name	Type	Required	Description
cortexToken	string	yes	A token returned by authorize.
session	string	yes	A session id returned by createSession. The marker will be added to the current record of this session.
time	number	yes	The start timestamp of the marker. It is the number of milliseconds that have elapsed since 00:00:00 Thursday, 1 January 1970 UTC.
value	string or number	yes	The value of the marker. It can be a string or an integer. If it is an integer then it must be positive or zero.
label	string	yes	The label of the marker.
port	string	no	The port of the marker, or where the marker comes from. Examples: "USB", "Serial", etc... The default value is "Software"
extras	object	no	Any extra information you want to associate with the marker.

Result

The result is an object containing these fields:

Name	Type	Description
recordId	string	The id of the record this marker was added to.
sessionId	string	The id of the session associated to the record.
marker	object	A marker object that represents the marker that was created.

Examples

Request

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "injectMarker",
    "params": {
        "cortexToken": "xxx",
        "label": "test2",
        "port": "Cortex Example",
        "session": "4cbf7554-31bd-4659-ac58-400b823503f0",
        "time": 1559811461532,
        "value": 42
    }
}

Response

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "marker": {
            "endDatetime": "2019-06-06T15:57:41.529661+07:00",
            "extras": {},
            "label": "test2",
            "port": "Cortex Example",
            "startDatetime": "2019-06-06T15:57:41.529661+07:00",
            "type": "instance",
            "uuid": "26fccfd8-e487-4623-910a-1ba8591fcdcf",
            "value": 42
        },
        "recordId": "db01c15e-d916-4a7b-9f1d-16295fd1c643",
        "sessionId": "4cbf7554-31bd-4659-ac58-400b823503f0"
    }
}