Cortex API
  • Getting Started
  • Connecting to the Cortex API
  • Overview of API flow
  • Authentication
    • getCortexInfo
    • getUserLogin
    • requestAccess
    • hasAccessRight
    • authorize
    • generateNewToken
    • getUserInformation
    • getLicenseInfo
  • Headsets
    • controlDevice
    • queryHeadsets
    • updateHeadset
    • updateHeadsetCustomInfo
    • syncWithHeadsetClock
    • Headset object
  • Sessions
    • createSession
    • updateSession
    • querySessions
    • Session object
  • Data Subscription
    • subscribe
    • unsubscribe
    • Data sample object
  • Records
    • createRecord
    • stopRecord
    • updateRecord
    • deleteRecord
    • exportRecord
    • queryRecords
    • getRecordInfos
    • configOptOut
    • requestToDownloadRecordData
    • Record object
  • Markers
    • injectMarker
    • updateMarker
    • Marker object
  • Subjects
    • createSubject
    • updateSubject
    • deleteSubjects
    • querySubjects
    • getDemographicAttributes
    • Subject object
  • BCI
    • queryProfile
    • getCurrentProfile
    • setupProfile
    • loadGuestProfile
    • getDetectionInfo
    • training
    • Readonly profile
  • Advanced BCI
    • getTrainedSignatureActions
    • getTrainingTime
    • facialExpressionSignatureType
    • facialExpressionThreshold
    • mentalCommandActiveAction
    • mentalCommandBrainMap
    • mentalCommandGetSkillRating
    • mentalCommandTrainingThreshold
    • mentalCommandActionSensitivity
  • Warning Objects
  • Error Codes
  • Troubleshooting Guide
  • Release Notes
  • cortexaccess tool
Powered by GitBook
On this page
  • Parameters
  • Result
  • Examples
  1. Records

createRecord

PreviousRecordsNextstopRecord

Last updated 4 years ago

This method is to create a new record.

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

Parameters

Name

Type

Required

Description

cortexToken

string

yes

session

string

yes

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

tags

array of strings

no

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

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++"
    }
}
{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "record": {
            "uuid": "222eb845-bc44-4a01-bf28-07445a7c7e8a",
            "applicationId": "com.jon.snow.winterfell-app",
            "applicationVersion": "1.0",
            "description": "",
            "endDatetime": "",
            "experimentId": 0,
            "licenseId": "xxx",
            "licenseScope": ["pm","eeg"],
            "ownerId": "76c3468a-d9c0-428d-81b4-bdac5d63860e",
            "startDatetime": "2019-05-31T11:06:24.398560+07:00",
            "tags": [],
            "title": "Cortex Examples C++"
        },
        "sessionId": "1067dc90-eb17-489b-9514-69cb79ac696c"
    }
}

A token returned by .

A session id returned by .

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

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

A that represents the created record.

createSession
authorize
createSession
createSubject
current user
queryRecords
record object