updateMarker

This method is to update a marker that was previously created by injectMarker.
This method set the end date time of a marker, turning an "instance" marker into an "interval" marker. You can also update the extras object.
The marker must belong to a record that is still in progress. You cannot update the marker if the record is already stopped.
Parameters
Name
Type
Required
Description
cortexToken
string
yes
A token returned by authorize.
session
string
yes
A session id returned by createSession.
markerId
string
yes
The id of the marker you want to update. This marker must belong to the current record of the session.
time
number
yes
The end timestamp of the marker.
It is the number of milliseconds that have elapsed since 00:00:00 Thursday, 1 January 1970 UTC.
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 belongs to.
sessionId
string
The id of the session associated to the record.
marker
object
A marker object that represents the marker that was updated.
Examples
Request
Response
{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "updateMarker",
    "params": {
        "cortexToken": "xxx",
        "session": "4cbf7554-31bd-4659-ac58-400b823503f0",
        "markerId": "26fccfd8-e487-4623-910a-1ba8591fcdcf",
        "time": 1559811469531
    }
}
{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "marker": {
            "endDatetime": "2019-06-06T15:57:49.530743+07:00",
            "extras": {},
            "label": "test2",
            "port": "Cortex Example",
            "startDatetime": "2019-06-06T15:57:41.529661+07:00",
            "type": "interval",
            "uuid": "26fccfd8-e487-4623-910a-1ba8591fcdcf",
            "value": 42
        },
        "recordId": "db01c15e-d916-4a7b-9f1d-16295fd1c643",
        "sessionId": "4cbf7554-31bd-4659-ac58-400b823503f0"
    }
}

injectMarker

Marker object

Last modified 3yr ago

Name	Type	Required	Description
cortexToken	`string`	yes	A token returned by authorize.
session	`string`	yes	A session id returned by createSession.
markerId	`string`	yes	The id of the marker you want to update. This marker must belong to the current record of the session.
time	`number`	yes	The end timestamp of the marker. It is the number of milliseconds that have elapsed since 00:00:00 Thursday, 1 January 1970 UTC.
extras	`object`	no	Any extra information you want to associate with the marker.