stopRecord

This method is to stop a record that was previously started by createRecord. This will set the end date time of the record to the current date time.

Parameters

Name

Type

Required

Description

cortexToken

string

yes

A token returned by authorize.

session

string

yes

The session id you provided when you called createRecord.

A record is linked to a session. So to close a record, you need to provide the session id.

Result

The result is an object containing these fields:

Name

Type

Description

record

object

sessionId

string

The session id linked to the record.

Example

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "stopRecord",
    "params": {
        "cortexToken": "xxx",
        "session": "38fef6d7-979b-420b-aa25-dd60ef5edc02"
    }
}

Last updated