createRecord

This method is to create a new record.

You must create and activate a session before you call this method. See createSession for details.

Parameters

Name

Type

Required

Description

cortexToken

string

yes

A token returned by authorize.

session

string

yes

A session id returned by createSession.

title

string

yes

The title of the record. Must be 200 characters or less.

description

string

no

The description of the record.

subjectName

string

no

The name of a subject created by createSubject. The subject is the person wearing the headset during the record. If you omit this field, then Cortex assumes that the current user is using the headset.

tags

array of strings

no

A list of tags you can associate to this record. You can use queryRecords to search the records by tags.

experimentId

number (integer)

no

An experiment id you can associate to this record. If you omit this parameter then the experimentId of the record will be zero.

This parameter was added in Cortex 2.2.1

Result

The result is an object containing two fields:

Name

Type

Description

record

object

A record object that represents the created record.

sessionId

string

The id of the session this record is linked to.

Examples

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "createRecord",
    "params": {
        "cortexToken": "xxx",
        "session": "1067dc90-eb17-489b-9514-69cb79ac696c",
        "title": "Cortex Examples C++"
    }
}

Last updated