{"type":"api","title":"Get the details of issues for given set of filters","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":"getTheDetailsOfIssuesForGivenSetOfFilters_2","tags":["Issues"],"summary":"Get the details of issues for given set of filters","deprecated":false,"description":"Returns all details of each issue along with suggested actions for given set of filters specified in query parameters. If there is no start and/or end time, then end time will be defaulted to current time and start time will be defaulted to 24-hours ago from end time. All string type query parameters support wildcard search (using *). For example: siteHierarchy=Global/San Jose/* returns issues under all sites whole siteHierarchy starts with \"Global/San Jose/\". https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-IssuesList-1.0.0-resolved.yaml","parameters":[{"name":"Accept-Language","description":"This header parameter can be used to specify the language in which issue description and suggested actions need to be returned. Available options are - 'en' (English), 'ja' (Japanese), 'ko' (Korean), 'zh' (Chinese). If this parameter is not present the issue details are returned in English language.","required":false,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"X-CALLER-ID","description":"Caller ID can be used to trace the caller for queries executed on database. The caller id is like a optional attribute which can be added to API invocation like ui, python, postman, test-automation etc","required":false,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"startTime","description":"Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.\n\nIf `startTime` is not provided, API will default to current time.\n","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"endTime","description":"End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.\n","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"limit","description":"Maximum number of issues to return","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"offset","description":"Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1.","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"sortBy","description":"","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"order","description":"The sort order of the field ascending or descending.","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"isGlobal","description":"Global issues are those issues which impacts across many devices, sites. They are also displayed on Issue Dashboard in Catalyst Center UI. Non-Global issues are displayed only on Client 360 or Device 360 pages. If this flag is 'true', only global issues are returned. If it if 'false', all issues are returned.\n","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"priority","description":"Priority of the issue. Supports single priority and multiple priorities Examples: priority=P1 (single priority requested) priority=P1&priority=P2&priority=P3 (multiple priorities requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"severity","description":"Severity of the issue. Supports single severity and multiple severities.\nExamples:\nseverity=high (single severity requested)\nseverity=high&severity=medium (multiple severities requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"status","description":"Status of the issue. Supports single status and multiple statuses. Examples: status=active (single status requested) status=active&status=resolved (multiple statuses requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"entityType","description":"Entity type of the issue. Supports single entity type and multiple entity types. Examples: entityType=networkDevice (single entity type requested) entityType=network device&entityType=client (multiple entity types requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"category","description":"Categories of the issue. Supports single category and multiple categories. Examples: category=availability (single status requested) category=availability&category=onboarding (multiple categories requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"deviceType","description":"Device Type of the device to which this issue belongs to. Supports single device type and multiple device types.\nExamples: deviceType=wireless controller (single device type requested) deviceType=wireless controller&deviceType=core (multiple device types requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"name","description":"The name of the issue\nExamples:\nname=ap_down (single issue name requested)\nname=ap_down&name=wlc_monitor (multiple issue names requested)\nIssue names can be retrieved using the API - /data/api/v1/assuranceIssueConfigurations\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"issueId","description":"UUID of the issue Examples: issueId=e52aecfe-b142-4287-a587-11a16ba6dd26 (single issue id requested) issueId=e52aecfe-b142-4287-a587-11a16ba6dd26&issueId=864d0421-02c0-43a6-9c52-81cad45f66d8 (multiple issue ids requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"entityId","description":"Id of the entity for which this issue belongs to. For example, it\n could be mac address of AP or UUID of Sensor\n example: 68:ca:e4:79:3f:20 4de02167-901b-43cf-8822-cffd3caa286f\nExamples: entityId=68:ca:e4:79:3f:20 (single entity id requested) entityId=68:ca:e4:79:3f:20&entityId=864d0421-02c0-43a6-9c52-81cad45f66d8 (multiple entity ids requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"updatedBy","description":"The user who last updated this issue. Examples: updatedBy=admin (single updatedBy requested) updatedBy=admin&updatedBy=john (multiple updatedBy requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteHierarchy","description":"The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named \"Global\" (Ex. `Global/AreaName/BuildingName/FloorName`)\n\nThis field supports wildcard asterisk (*) character search support. E.g. */San*, */San, /San*\n\nExamples:\n\n`?siteHierarchy=Global/AreaName/BuildingName/FloorName` (single siteHierarchy requested)\n\n`?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/AreaName2/BuildingName2/FloorName2` (multiple siteHierarchies requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteHierarchyId","description":"The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. `globalUuid/areaUuid/buildingUuid/floorUuid`)\n\nThis field supports wildcard asterisk (*) character search support. E.g. `*uuid*, *uuid, uuid*\n\nExamples:\n\n`?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested)\n\n`?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2/floorUuid2` (multiple siteHierarchyIds requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteName","description":"The name of the site. (Ex. `FloorName`)\n\nThis field supports wildcard asterisk (*) character search support. E.g. *San*, *San, San*\n\nExamples:\n\n`?siteName=building1` (single siteName requested)\n\n`?siteName=building1&siteName=building2&siteName=building3` (multiple siteNames requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteId","description":"The UUID of the site. (Ex. `flooruuid`)\n\nThis field supports wildcard asterisk (*) character search support. E.g.*flooruuid*, *flooruuid, flooruuid*\n\nExamples:\n\n`?siteId=id1` (single id requested)\n\n`?siteId=id1&siteId=id2&siteId=id3` (multiple ids requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"fabricSiteId","description":"The UUID of the fabric site. (Ex. \"flooruuid\")\nExamples: fabricSiteId=e52aecfe-b142-4287-a587-11a16ba6dd26 (single id requested) fabricSiteId=e52aecfe-b142-4287-a587-11a16ba6dd26,864d0421-02c0-43a6-9c52-81cad45f66d8 (multiple ids requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"fabricVnName","description":"The name of the fabric virtual network\nExamples: fabricVnName=name1 (single fabric virtual network name requested) fabricVnName=name1&fabricVnName=name2&fabricVnName=name3 (multiple fabric virtual network names requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"fabricTransitSiteId","description":"The UUID of the fabric transit site. (Ex. \"flooruuid\")\nExamples: fabricTransitSiteId=e52aecfe-b142-4287-a587-11a16ba6dd26 (single id requested) fabricTransitSiteId=e52aecfe-b142-4287-a587-11a16ba6dd26&fabricTransitSiteId=864d0421-02c0-43a6-9c52-81cad45f66d8 (multiple ids requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"networkDeviceId","description":"The list of Network Device Uuids. (Ex. `6bef213c-19ca-4170-8375-b694e251101c`)\n\nExamples:\n\n`networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c` (single networkDeviceId requested)\n\n`networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c&networkDeviceId=32219612-819e-4b5e-a96b-cf22aca13dd9&networkDeviceId=2541e9a7-b80d-4955-8aa2-79b233318ba0` (multiple networkDeviceIds with & separator)\n","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"networkDeviceIpAddress","description":"The list of Network Device management IP Address. (Ex. `121.1.1.10`)\n\nThis field supports wildcard (`*`) character-based search. \nEx: `*1.1*` or `1.1*` or `*1.1`\n\nExamples:\n\n`networkDeviceIpAddress=121.1.1.10`\n\n`networkDeviceIpAddress=121.1.1.10&networkDeviceIpAddress=172.20.1.10&networkDeviceIpAddress=10.10.20.10` (multiple networkDevice IP Address with & separator)\n","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"macAddress","description":"The macAddress of the network device or client\nThis field supports wildcard (`*`) character-based search. \nEx: `*AB:AB:AB*` or `AB:AB:AB*` or `*AB:AB:AB`\nExamples:\n\n`macAddress=AB:AB:AB:CD:CD:CD` (single macAddress requested)\n\n`macAddress=AB:AB:AB:CD:CD:DC&macAddress=AB:AB:AB:CD:CD:FE` (multiple macAddress requested)\n","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"view","description":"The name of the View. Each view represents a specific data set. Please refer to the `IssuesView` Model for supported views. View is predefined set of attributes supported by the API. Only the attributes related to the given view will be part of the API response along with default attributes. If multiple views are provided, then response will contain attributes from all those views. If no views are specified, all attributes will be returned.\n\n| View Name | Included Attributes |\n| --- | --- |\n| `update` | updatedTime, updatedBy |\n| `site` | siteName, siteHierarchy, siteId, siteHierarchyId |\nExamples: `view=update` (single view requested) `view=update&view=site` (multiple views requested) \n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"attribute","description":"List of attributes related to the issue. If these are provided, then only those attributes will be part of response along with the default attributes. Please refer to the `IssuesResponseAttribute` Model for supported attributes.\nExamples: `attribute=deviceType` (single attribute requested) `attribute=deviceType&attribute=updatedBy` (multiple attributes requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"aiDriven","description":"Flag whether the issue is AI driven issue","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"fabricDriven","description":"Flag whether the issue is related to a Fabric site, a virtual network or a transit.","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"fabricSiteDriven","description":"Flag whether the issue is Fabric site driven issue","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"fabricVnDriven","description":"Flag whether the issue is Fabric Virtual Network driven issue","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"fabricTransitDriven","description":"Flag whether the issue is Fabric Transit driven issue","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"Response containing issues details for given filters","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"issueId":{"type":"string","description":""},"name":{"type":"string","description":""},"description":{"type":"string","description":""},"summary":{"type":"string","description":""},"priority":{"type":"string","description":""},"severity":{"type":"string","description":""},"deviceType":{"type":"string","description":""},"category":{"type":"string","description":""},"entityType":{"type":"string","description":""},"entityId":{"type":"string","description":""},"firstOccurredTime":{"type":"integer","description":""},"mostRecentOccurredTime":{"type":"integer","description":""},"status":{"type":"string","description":""},"isGlobal":{"type":"boolean","description":""},"updatedBy":{"type":"object","properties":{},"description":""},"updatedTime":{"type":"object","properties":{},"description":""},"notes":{"type":"object","properties":{},"description":""},"siteId":{"type":"object","properties":{},"description":""},"siteHierarchyId":{"type":"object","properties":{},"description":""},"siteName":{"type":"object","properties":{},"description":""},"siteHierarchy":{"type":"object","properties":{},"description":""},"suggestedActions":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":""},"steps":{"type":"array","items":{"type":"object"},"description":""}}},"description":""},"additionalAttributes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":""},"value":{"type":"string","description":""}}},"description":""}}},"description":""},"page":{"type":"object","properties":{"limit":{"type":"integer","description":""},"offset":{"type":"integer","description":""},"count":{"type":"integer","description":""},"sortBy":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":""},"order":{"type":"string","description":""}}},"description":""}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/GetTheDetailsOfIssuesForGivenSetOfFiltersResponse"}}}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"500":{"description":"The server could not fulfill the request due to internal server error","content":{}}},"x-rapi-id":"a991-6985-476b-b271","x-rapi-overview":"Returns all details of each issue along with suggested actions for given set of filters specified in query parameters. If there is no start and/or end time, then end time will be defaulted to current time and start time will be defaulted to 24-hours ago from end time. All string type query parameters support wildcard search (using *). For example: siteHierarchy=Global/San Jose/* returns issues under all sites whole siteHierarchy starts with \"Global/San Jose/\". https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-IssuesList-1.0.0-resolved.yaml","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Issues","x-rapi-version":"1.0.0","x-rapi-internalPath":"/data/api/v1/issues","x-rapi-publicPath":"/dna/data/api/v1/assuranceIssues","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"50~MINUTE","__originalOperationId":"getTheDetailsOfIssuesForGivenSetOfFilters-2","method":"get","path":"/dna/data/api/v1/assuranceIssues"}}