Get all health score definitions for given filters - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Get all health score definitions for given 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":"getAllHealthScoreDefinitionsForGivenFilters_","tags":["Devices"],"summary":"Get all health score definitions for given filters.","deprecated":false,"description":"Get all health score defintions.\n\nSupported filters are id, name and overall health include status. A health score definition can be different across device type. So, deviceType in the query param is important and default is all device types.\n\nBy default all supported attributes are listed in response. 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-issueAndHealthDefinitions-1.0.0-resolved.yaml\n","parameters":[{"name":"X-CALLER-ID","description":"Caller ID is used to trace the origin of API calls and their associated queries executed on the database. It's an optional header parameter that can be added to an API request.\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"deviceType","description":"These are the device families supported for health score definitions. If no input is made on device family, all device families are considered.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"id","description":"The definition identifier.\n\nExamples:\n\nid=015d9cba-4f53-4087-8317-7e49e5ffef46 (single entity id request)\n\nid=015d9cba-4f53-4087-8317-7e49e5ffef46&id=015d9cba-4f53-4087-8317-7e49e5ffef47 (multiple ids in the query param)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"includeForOverallHealth","description":"The inclusion status of the issue definition, either true or false. true indicates that particular health metric is included in overall health computation, otherwise false. By default it's set to true. ","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"attribute","description":"These are the attributes supported in health score definitions response. By default, all properties are sent in response.\n","required":false,"schema":{"type":"string","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":"limit","description":"Maximum number of records to return","schema":{"type":"number","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"Response object for the list of health score definitions.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":""},"name":{"type":"string","description":""},"displayName":{"type":"string","description":""},"deviceFamily":{"type":"string","description":""},"description":{"type":"string","description":""},"includeForOverallHealth":{"type":"boolean","description":""},"definitionStatus":{"type":"string","description":""},"thresholdValue":{"type":"number","description":""},"synchronizeToIssueThreshold":{"type":"boolean","description":""},"lastModified":{"type":"string","description":""}}},"description":""}},"description":"","$$ref":"#/components/schemas/GetAllHealthScoreDefinitionsForGivenFiltersResponse"}}}},"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":{}},"406":{"description":"The client requested a response in a content format that this server does not support.","content":{}},"500":{"description":"The server could not fulfill the request due to internal server error","content":{}},"502":{"description":"There is a bad gateway connection from the client to the server.","content":{}},"503":{"description":"The server is (temporarily) unavailable.","content":{}},"504":{"description":"The server did not respond inside time restrictions and time-out.","content":{}},"1XX":{"description":"Informational Responses - The server received the request and sent an informational response.","content":{}},"2XX":{"description":"Successful Responses - The server received the client request, understood it, and accepted it.","content":{}},"3XX":{"description":"Redirection Messages - The client must take additional action to complete the request.","content":{}},"4XX":{"description":"Client Error Responses - The client request caused the error.","content":{}},"5XX":{"description":"Server Error Responses - The server failed to fulfill the request.","content":{}}},"x-rapi-id":"9bb6-ea87-4ffb-b492","x-rapi-overview":"Get all health score defintions.\n\nSupported filters are id, name and overall health include status. A health score definition can be different across device type. So, deviceType in the query param is important and default is all device types.\n\nBy default all supported attributes are listed in response. 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-issueAndHealthDefinitions-1.0.0-resolved.yaml\n","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Devices","x-rapi-version":"1.0.0","x-rapi-internalPath":"/intent/api/v1/healthScoreDefinitions","x-rapi-publicPath":"/dna/intent/api/v1/healthScoreDefinitions","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"25~MINUTE","__originalOperationId":"getAllHealthScoreDefinitionsForGivenFilters.","method":"get","path":"/dna/intent/api/v1/healthScoreDefinitions"}}