{"type":"api","title":"Get all the custom issue definitions based on the given filters","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/a58b8872fdc3116cb1a0478252ee81e8011d37c2/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":"getAllTheCustomIssueDefinitionsBasedOnTheGivenFilters_","tags":["Issues"],"summary":"Get all the custom issue definitions based on the given filters.","deprecated":false,"description":"Retrieve the existing syslog-based custom issue definitions. The supported filters are id, name, profileId, definition enable status, priority, severity, facility and mnemonic. The issue definition configurations may vary across profiles, hence specifying the profile Id in the query parameter is important and the default profile is global.\n\n The assurance profile definitions can be obtain via the API endpoint: /api/v1/siteprofile?namespace=assurance. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceUserDefinedIssueAPIs-1.0.0-resolved.yaml","parameters":[{"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":"id","description":"The custom issue definition identifier and unique identifier across the profile.Examples: id=6bef213c-19ca-4170-8375-b694e251101c (single entity uuid requested) id=6bef213c-19ca-4170-8375-b694e251101c&id=19ca-4170-8375-b694e251101c-6bef213c (multiple Id request in the query param)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"profileId","description":"The profile identifier to fetch the profile associated custom issue definitions. The default is global. For the custom profile, it is profile UUID. Example : 3fa85f64-5717-4562-b3fc-2c963f66afa6\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"name","description":"The list of UDI issue names","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"priority","description":"The Issue priority value, possible values are P1, P2, P3, P4. P1: A critical issue that needs immediate attention and can have a wide impact on network operations. P2: A major issue that can potentially impact multiple devices or clients. P3: A minor issue that has a localized or minimal impact. P4: A warning issue that may not be an immediate problem but addressing it can optimize the network performance","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"isEnabled","description":"The enable status of the custom issue definition, either true or false.","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"severity","description":"The syslog severity level. 0: Emergency 1: Alert, 2: Critical. 3: Error, 4: Warning, 5: Notice, 6: Info. Examples:severity=1&severity=2 (multi value support with & separator)\n","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"facility","description":"The syslog facility name","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"mnemonic","description":"The syslog mnemonic name","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"limit","description":"The maximum number of records 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":"A field within the response to sort by.","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"}],"responses":{"200":{"description":"The response object for the custom issues definition.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":""},"name":{"type":"string","description":""},"description":{"type":"string","description":""},"profileId":{"type":"string","description":""},"triggerId":{"type":"string","description":""},"rules":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":""},"severity":{"type":"integer","description":""},"facility":{"type":"string","description":""},"mnemonic":{"type":"string","description":""},"pattern":{"type":"string","description":""},"occurrences":{"type":"integer","description":""},"durationInMinutes":{"type":"integer","description":""}}},"description":""},"isEnabled":{"type":"boolean","description":""},"priority":{"type":"string","description":""},"isDeletable":{"type":"boolean","description":""},"isNotificationEnabled":{"type":"boolean","description":""},"createdTime":{"type":"integer","description":""},"lastUpdatedTime":{"type":"integer","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/GetAllTheCustomIssueDefinitionsBasedOnTheGivenFiltersResponse"}}}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"500":{"description":"The server could not fulfill the request due to internal server error","content":{}}},"x-rapi-id":"1bb9-bb87-4efa-afd2","x-rapi-overview":"Retrieve the existing syslog-based custom issue definitions. The supported filters are id, name, profileId, definition enable status, priority, severity, facility and mnemonic. The issue definition configurations may vary across profiles, hence specifying the profile Id in the query parameter is important and the default profile is global.\n\n The assurance profile definitions can be obtain via the API endpoint: /api/v1/siteprofile?namespace=assurance. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceUserDefinedIssueAPIs-1.0.0-resolved.yaml","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Issues","x-rapi-version":"1.0.0","x-rapi-internalPath":"/intent/api/v1/customIssueDefinitions","x-rapi-publicPath":"/dna/intent/api/v1/customIssueDefinitions","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"25~MINUTE","__originalOperationId":"getAllTheCustomIssueDefinitionsBasedOnTheGivenFilters.","method":"get","path":"/dna/intent/api/v1/customIssueDefinitions"}}