Activity list preview for a preset - Cisco Cyber Vision API v3

{"type":"api","title":"Activity list preview for a preset","meta":{"id":"/apps/pubhub/media/cisco-cyber-vision/c0cd14e5fea40ab3226a4b108db61ca3f0980faf/262737b2-b3c2-32cd-b07b-fdbdcd23918f","info":{"description":"RESTful API to manage the resources of Cisco Cyber Vision centers.","title":"Cisco Cyber Vision center v3 API.","version":"3.0.0"},"security":[{"token":[]}],"tags":[{"description":"Activities are an aggregation of flows between components.","name":"Activities"},{"description":"A baseline is used for monitor mode. They represent a snapshot of the network.","name":"Baselines"},{"description":"In monitor mode, these routes allow to retrieve and review differences between the actual network activity and the baseline description.","name":"BaselineDifferences"},{"description":"Components are logical nodes of the network.","name":"Components"},{"description":"Routes to manage network organization.","name":"CustomNetwork"},{"description":"Routes to manage custom properties that can be added to components or groups.","name":"CustomProperties"},{"description":"Routes to retrieve statistics and dashboard information. ","name":"Dashboard"},{"description":"A Device is a physical device that host a software that communicates on the network","name":"Devices"},{"description":"Routes to retrieve about external communications.","name":"ExternalCommunication"},{"description":"Flows represent a network interaction between two components.","name":"Flows"},{"description":"Routes to get a graphical representation of the components, activities, etc.","name":"Graph"},{"description":"Groups are a logical way to organize components.","name":"Groups"},{"description":"Various routes to get more information about a center.","name":"Misc"},{"description":"Routes to access the application parameters such as security options and allow to manage custom parameters.","name":"Parameters"},{"description":"Routes to retrieve information about pcap files replayed.","name":"PcapReplays"},{"description":"Presets are a way to filter data and prepare visualizations.","name":"Presets"},{"description":"Preset Based Reports","name":"Reports"},{"description":"Routes to access the configuration of the risk scores.","name":"RiskScores"},{"description":"Routes to retrieve information about the enrolled sensors.","name":"Sensors"},{"description":"Routes to browse sensor folders.","name":"SensorExplorer"},{"description":"Tags are meaningful labels applied to components and activities to describe network behaviors and device properties.","name":"Tags"},{"description":"Vulnerabilities are known security threats that could allow an attacker to gain unauthorized privileges.","name":"Vulnerabilities"},{"description":"Routes to configure the Active Discovery mode.","name":"ActiveDiscovery"},{"description":"Routes to retrieve information about the global credentials.","name":"GlobalCredentials"}],"x-parser-conf":{"overview":{"markdownPath":"reference/overview.md"}},"swagger":"2.0","basePath":"/api/3.0/","schemes":["https"],"securityDefinitions":{"token":{"description":"API token created in the Cyber Vision administration UI","type":"apiKey","name":"x-token-id","in":"header"}}},"spec":{"description":"Activity list preview for a preset.","tags":["Activities"],"summary":"Activity list preview for a preset.","operationId":"getActivityListForPresetPreview","parameters":[{"description":"preview payload","name":"preview","in":"body","required":true,"schema":{"description":"PresetPayload is the structure that\ncontains every information for a request\non a Preset","type":"object","properties":{"activityTagless":{"type":"string","x-go-name":"ActivityTagless"},"category":{"type":"string","x-go-name":"Category"},"componentTagless":{"type":"string","x-go-name":"ComponentTagless"},"description":{"type":"string","x-go-name":"Description"},"filters":{"description":"contains all filters we want for the preset\ntarget by one request","type":"object","properties":{"centers":{"type":"array","items":{"description":"contains centers filters we want for the preset\ntarget by one request","type":"object","properties":{"operator":{"type":"string","x-go-name":"Operator"},"value":{"type":"object","properties":{"id":{"type":"string","x-go-name":"Id"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/preset","$$ref":"#/definitions/IdPayload"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/preset","$$ref":"#/definitions/PresetCenterFilterPayload"},"x-go-name":"Centers"},"components":{"type":"array","items":{"description":"contains components filters we want for the preset\ntarget by one request","type":"object","properties":{"operator":{"type":"string","x-go-name":"Operator"},"value":{"type":"object","properties":{"id":{"type":"string","x-go-name":"Id"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/preset","$$ref":"#/definitions/IdPayload"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/preset","$$ref":"#/definitions/PresetComponentFilterPayload"},"x-go-name":"Components"},"devices":{"type":"array","items":{"description":"contains devices filters we want for the preset\ntarget by one request","type":"object","properties":{"operator":{"type":"string","x-go-name":"Operator"},"value":{"type":"object","properties":{"id":{"type":"string","x-go-name":"Id"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/preset","$$ref":"#/definitions/IdPayload"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/preset","$$ref":"#/definitions/PresetDeviceFilterPayload"},"x-go-name":"Devices"},"groups":{"type":"array","items":{"description":"contains groups filters we want for the preset\ntarget by one request","type":"object","properties":{"operator":{"type":"string","x-go-name":"Operator"},"value":{"$ref":"#/definitions/IdPayloadForPresetGroup"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/preset","$$ref":"#/definitions/PresetGroupFilterPayload"},"x-go-name":"Groups"},"hasExternalCommunications":{"type":"object","properties":{"operator":{"type":"string","x-go-name":"Operator"},"value":{"type":"object","properties":{"id":{"type":"string","x-go-name":"Id"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/preset","$$ref":"#/definitions/IdPayload"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/preset","$$ref":"#/definitions/PresetHasExternalCommunicationsFilterPayload"},"networks":{"type":"array","items":{"description":"contains networks filters we want for the preset","type":"object","properties":{"operator":{"type":"string","x-go-name":"Operator"},"value":{"type":"object","properties":{"id":{"type":"string","x-go-name":"Id"},"subnet":{"type":"string","x-go-name":"Subnet"},"vlan":{"type":"integer","format":"int64","x-go-name":"Vlan"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/preset","$$ref":"#/definitions/IdPayloadForPresetNetwork"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/preset","$$ref":"#/definitions/PresetNetworkFilterPayload"},"x-go-name":"Networks"},"riskScores":{"type":"array","items":{"description":"contains risk scores filters we want for the preset","type":"object","properties":{"operator":{"type":"string","x-go-name":"Operator"},"value":{"type":"object","properties":{"id":{"type":"string","x-go-name":"Id"},"max":{"type":"integer","format":"int64","x-go-name":"Max"},"min":{"type":"integer","format":"int64","x-go-name":"Min"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/preset","$$ref":"#/definitions/IdPayloadForPresetRiskScore"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/preset","$$ref":"#/definitions/PresetRiskScoreFilterPayload"},"x-go-name":"RiskScores"},"sensors":{"type":"array","items":{"description":"contains sensors filters we want for the preset\ntarget by one request","type":"object","properties":{"operator":{"type":"string","x-go-name":"Operator"},"value":{"type":"object","properties":{"id":{"type":"string","x-go-name":"Id"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/preset","$$ref":"#/definitions/IdPayload"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/preset","$$ref":"#/definitions/PresetSensorFilterPayload"},"x-go-name":"Sensors"},"tags":{"type":"array","items":{"description":"contains tags filters we want for the preset\ntarget by one request","type":"object","properties":{"operator":{"type":"string","x-go-name":"Operator"},"value":{"type":"object","properties":{"id":{"type":"string","x-go-name":"Id"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/preset","$$ref":"#/definitions/IdPayload"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/preset","$$ref":"#/definitions/PresetTagFilterPayload"},"x-go-name":"Tags"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/preset","$$ref":"#/definitions/PresetFiltersPayload"},"groupless":{"type":"string","x-go-name":"Groupless"},"hasExternalCommunications":{"type":"string","x-go-name":"HasExternalCommunications"},"label":{"type":"string","x-go-name":"Label"},"search":{"type":"string","x-go-name":"FullTextSearch"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3/payload/preset","$$ref":"#/definitions/PresetPayload"}},{"type":"integer","description":"pagination - the page number","name":"page","in":"query"},{"type":"integer","description":"pagination - the number of items per page","name":"size","in":"query"},{"type":"integer","description":"start of the period to query, in ms since January 1, 1970 UTC","name":"from","in":"query"},{"type":"integer","description":"end of the period to query, in ms since January 1, 1970 UTC","name":"to","in":"query"},{"type":"string","description":"the fields to sort. Example: field1,field2:DESC","name":"sort","in":"query"},{"type":"string","description":"the language used to improve the sorting","name":"Accept-Language","in":"header"},{"type":"string","description":"the filter. Example: field1:val,field2:abc","name":"filter","in":"query"}],"responses":{"200":{"description":"object successful","schema":{"type":"array","items":{"type":"object","properties":{"bytesCount":{"type":"integer","format":"int64","x-go-name":"BytesCount"},"differences":{"type":"array","items":{"type":"object","properties":{"detection":{"type":"integer","format":"int64","x-go-name":"DetectionTime"},"id":{"description":"A UUID is a 128 bit (16 byte) Universal Unique IDentifier as defined in RFC\n4122.","type":"array","items":{"type":"integer","format":"uint8"},"x-go-package":"code.google.com/p/go-uuid/uuid","$$ref":"#/definitions/UUID"},"key":{"type":"string","x-go-name":"Key"},"oldValue":{"type":"string","x-go-name":"OldValue"},"type":{"type":"string","x-go-name":"Type"},"value":{"type":"string","x-go-name":"Value"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/Difference"},"x-go-name":"Differences"},"direction":{"type":"string","x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/TrafficDirection"},"eventsCount":{"type":"integer","format":"int64","x-go-name":"EventsCount"},"firstActivity":{"type":"integer","format":"int64","x-go-name":"CreationTime"},"flowCount":{"type":"integer","format":"int64","x-go-name":"FlowCount"},"id":{"type":"string","x-go-name":"Id"},"lastActivity":{"type":"integer","format":"int64","x-go-name":"LastActivity"},"left":{"type":"object","properties":{"customLabel":{"type":"string","x-go-name":"CustomLabel"},"group":{"description":"Group item json representation","type":"object","properties":{"centerID":{"type":"string","x-go-name":"CenterID"},"color":{"type":"string","x-go-name":"Color"},"comments":{"type":"string","x-go-name":"Comments"},"criticalness":{"type":"integer","format":"int64","x-go-name":"Criticalness"},"description":{"type":"string","x-go-name":"Description"},"groupIds":{"type":"array","items":{"type":"string"},"x-go-name":"GroupIds"},"id":{"type":"string","x-go-name":"Id"},"label":{"type":"string","x-go-name":"Label"},"locked":{"type":"boolean","x-go-name":"Locked"},"parentId":{"type":"string","x-go-name":"ParentId"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/Group"},"icon":{"type":"string","x-go-name":"Icon"},"id":{"type":"string","x-go-name":"Id"},"ip":{"type":"string","x-go-name":"IP"},"label":{"type":"string","x-go-name":"Label"},"mac":{"type":"string","x-go-name":"MAC"},"originalLabel":{"type":"string","x-go-name":"OriginalLabel"},"tags":{"type":"array","items":{"type":"object","properties":{"category":{"description":"Category json representation","type":"object","properties":{"id":{"type":"string","x-go-name":"Id"},"label":{"type":"string","x-go-name":"Label"},"priority_order":{"type":"integer","format":"int64","x-go-name":"PriorityOrder"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/Category"},"id":{"type":"string","x-go-name":"Id"},"important":{"type":"boolean","x-go-name":"Important"},"label":{"type":"string","x-go-name":"Label"},"type":{"type":"string","x-go-name":"Type"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/Tag"},"x-go-name":"Tags"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/ShortComponent"},"newVariableAccess":{"type":"integer","format":"int64","x-go-name":"NewVariableAccess"},"packetsCount":{"type":"integer","format":"int64","x-go-name":"PacketsCount"},"right":{"type":"object","properties":{"customLabel":{"type":"string","x-go-name":"CustomLabel"},"group":{"description":"Group item json representation","type":"object","properties":{"centerID":{"type":"string","x-go-name":"CenterID"},"color":{"type":"string","x-go-name":"Color"},"comments":{"type":"string","x-go-name":"Comments"},"criticalness":{"type":"integer","format":"int64","x-go-name":"Criticalness"},"description":{"type":"string","x-go-name":"Description"},"groupIds":{"type":"array","items":{"type":"string"},"x-go-name":"GroupIds"},"id":{"type":"string","x-go-name":"Id"},"label":{"type":"string","x-go-name":"Label"},"locked":{"type":"boolean","x-go-name":"Locked"},"parentId":{"type":"string","x-go-name":"ParentId"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/Group"},"icon":{"type":"string","x-go-name":"Icon"},"id":{"type":"string","x-go-name":"Id"},"ip":{"type":"string","x-go-name":"IP"},"label":{"type":"string","x-go-name":"Label"},"mac":{"type":"string","x-go-name":"MAC"},"originalLabel":{"type":"string","x-go-name":"OriginalLabel"},"tags":{"type":"array","items":{"type":"object","properties":{"category":{"description":"Category json representation","type":"object","properties":{"id":{"type":"string","x-go-name":"Id"},"label":{"type":"string","x-go-name":"Label"},"priority_order":{"type":"integer","format":"int64","x-go-name":"PriorityOrder"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/Category"},"id":{"type":"string","x-go-name":"Id"},"important":{"type":"boolean","x-go-name":"Important"},"label":{"type":"string","x-go-name":"Label"},"type":{"type":"string","x-go-name":"Type"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/Tag"},"x-go-name":"Tags"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/ShortComponent"},"status":{"type":"string","x-go-name":"Status"},"tags":{"type":"array","items":{"type":"object","properties":{"category":{"description":"Category json representation","type":"object","properties":{"id":{"type":"string","x-go-name":"Id"},"label":{"type":"string","x-go-name":"Label"},"priority_order":{"type":"integer","format":"int64","x-go-name":"PriorityOrder"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/Category"},"id":{"type":"string","x-go-name":"Id"},"important":{"type":"boolean","x-go-name":"Important"},"label":{"type":"string","x-go-name":"Label"},"type":{"type":"string","x-go-name":"Type"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/Tag"},"x-go-name":"Tags"},"variables":{"type":"array","items":{"type":"object","properties":{"accessBy":{"type":"string","x-go-name":"AccessBy"},"accessType":{"type":"string","x-go-name":"AccessTypes"},"extraField":{"description":"ExtraField json representation","type":"object","properties":{"id":{"type":"string","x-go-name":"Id"},"label":{"type":"string","x-go-name":"Label"},"value":{"type":"string","x-go-name":"Value"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/ExtraField"},"firstAccess":{"type":"string","format":"date-time","x-go-name":"FirstAccess"},"id":{"type":"string","x-go-name":"Id"},"label":{"type":"string","x-go-name":"Label"},"lastAccess":{"type":"string","format":"date-time","x-go-name":"LastAccess"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/VariableActivityMonitor"},"x-go-name":"Variables"},"variablesCount":{"type":"integer","format":"int64","x-go-name":"VariablesCount"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/Activity"}}},"400":{"description":"bad request (preview or parameters in wrong format)"},"401":{"description":"incorrect token"},"default":{"description":"unexpected error"}},"__originalOperationId":"getActivityListForPresetPreview","consumes":["application/json"],"produces":["application/json"],"security":[{"token":[]}],"method":"post","path":"/presets/preview/visualisations/activity-list"}}