Skip to main content

TracingSession Schema

Data structure for Tracing Session objects.

Fields​

FieldTypeRequiredDescriptionNotes
namestringYes--
access_urlstringNo-API field: access_url
activebooleanYes--
deviceEntityResponseYes--
userEntityResponseYes--
duration_minutesintegerNo-API field: duration_minutes
parametersTracingParametersWrapperCollectionYes--
notification_enabledbooleanNo-API field: notification_enabled
sharedbooleanNo--
idlongYes--
statestringYes--
created_at_timestamplongYes-API field: created_at_timestamp
aborted_at_timestamplongNo-API field: aborted_at_timestamp
started_at_timestamplongNo-API field: started_at_timestamp
progress_started_atlongNo-API field: progress_started_at
completed_at_timestamplongNo-API field: completed_at_timestamp
device_initiated_at_timestamplongNo-API field: device_initiated_at_timestamp
device_started_at_timestamplongNo-API field: device_started_at_timestamp
device_completed_at_timestamplongNo-API field: device_completed_at_timestamp
create_or_updated_by_userEntityResponseNo-API field: create_or_updated_by_user
create_or_updated_by_client_appEntityResponseNo-API field: create_or_updated_by_client_app

Example​

{
"name": "string",
"access_url": "string",
"active": true,
"device": {
"id": 123,
"name": "string",
"deleted": true
},
"user": {
"id": 123,
"name": "string",
"deleted": true
},
"duration_minutes": 123,
"parameters": [
{
"type": "string"
}
],
"notification_enabled": true
}
// ... more fields