{"type":"api","title":"Get AuditLog Parent Records","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/b3d6cc9fb9f506b3bc9099912aa8a6f9d87e0f0a/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"getAuditLogParentRecords","tags":["Event Management"],"summary":"Get AuditLog Parent Records","deprecated":false,"description":"Get Parent Audit Log Event instances from the Event-Hub ","parameters":[{"name":"instanceId","description":"InstanceID of the Audit Log.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"name","description":"Audit Log notification event name.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"eventId","description":"Audit Log notification's event ID. ","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"category","description":"Audit Log notification's event category. Supported values: INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"severity","description":"Audit Log notification's event severity. Supported values: 1, 2, 3, 4, 5.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"domain","description":"Audit Log notification's event domain.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"subDomain","description":"Audit Log notification's event sub-domain.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"source","description":"Audit Log notification's event source.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"userId","description":"Audit Log notification's event userId.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"context","description":"Audit Log notification's event correlationId.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"eventHierarchy","description":"Audit Log notification's event eventHierarchy. Example: \"US.CA.San Jose\" OR \"US.CA\" OR \"CA.San Jose\" - Delimiter for hierarchy separation is \".\".","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteId","description":"Audit Log notification's siteId.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"deviceId","description":"Audit Log notification's deviceId.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"isSystemEvents","description":"Parameter to filter system generated audit-logs.","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"description","description":"String full/partial search - (Provided input string is case insensitively matched for records).","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"offset","description":"Position of a particular Audit Log record in the data. ","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"limit","description":"Number of Audit Log records to be returned per page.","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"startTime","description":"Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory)","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"endTime","description":"End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory)","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"sortBy","description":"Sort the Audit Logs by certain fields. Supported values are event notification header attributes.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"order","description":"Order of the sorted Audit Log records. Default value is desc by timestamp. Supported values: asc, desc.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"version":{"type":"string","description":""},"instanceId":{"type":"string","description":""},"eventId":{"type":"string","description":""},"namespace":{"type":"string","description":""},"name":{"type":"string","description":""},"description":{"type":"string","description":""},"type":{"type":"string","description":""},"category":{"type":"string","description":""},"domain":{"type":"string","description":""},"subDomain":{"type":"string","description":""},"severity":{"type":"integer","description":""},"source":{"type":"string","description":""},"timestamp":{"type":"integer","description":""},"tags":{"type":"array","items":{"type":"object"},"description":""},"details":{"type":"object","properties":{},"description":""},"ciscoDnaEventLink":{"type":"string","description":""},"note":{"type":"string","description":""},"tntId":{"type":"string","description":""},"context":{"type":"string","description":""},"userId":{"type":"string","description":""},"i18n":{"type":"string","description":""},"eventHierarchy":{"type":"string","description":""},"message":{"type":"string","description":""},"messageParams":{"type":"string","description":""},"additionalDetails":{"type":"object","properties":{},"description":""},"parentInstanceId":{"type":"string","description":""},"network":{"type":"string","description":""},"childCount":{"type":"number","description":""},"tenantId":{"type":"string","description":""}}},"description":"","$$ref":"#/components/schemas/GetAuditLogParentRecordsResponse"}}}},"204":{"description":"The request was successful, however no content was returned.","content":{}},"206":{"description":"The GET request included a Range Header, and the server responded with the partial content matching the range.","content":{}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"401":{"description":"The client's authentication credentials included with the request are missing or invalid.","content":{}},"403":{"description":"The server recognizes the authentication credentials, but the client is not authorized to perform this request.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"409":{"description":"The target resource is in a conflicted state (for example, an edit conflict where a resource is being edited by multiple users). Retrying the request later might succeed.","content":{}},"415":{"description":"The client sent a request body in a format that the server does not support (for example, XML to a server that only accepts JSON).","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}},"501":{"description":"The server has not implemented the functionality required to fulfill the request.","content":{}},"503":{"description":"The server is (temporarily) unavailable.","content":{}},"504":{"description":"The server did not respond inside time restrictions and timed-out.","content":{}}},"x-rapi-id":"9590-7ae9-46ea-b1c6","x-rapi-overview":"Get Parent Audit Log Event instances from the Event-Hub ","x-rapi-domain":"Event Management","x-rapi-subdomain":"","x-rapi-version":"1.0.0","x-rapi-internalPath":"/dna/data/api/v1/event/event-series/audit-log/parent-records","x-rapi-publicPath":"/dna/data/api/v1/event/event-series/audit-log/parent-records","x-rapi-registerInKONG":false,"x-rapi-banner":[],"__originalOperationId":"getAuditLogParentRecords","method":"get","path":"/dna/data/api/v1/event/event-series/audit-log/parent-records"}}