{"type":"api","title":"Get Compliance Requirement Count By Type","meta":{"id":"/apps/pubhub/media/nexus-dashboard-api-v1/86cc2501c92a7370499e3d537496e5c722396afb/65a171d6-461c-341f-833b-8723fe3ac65c","info":{"contact":{"name":"API Support","url":"https://devnetapps.cisco.com/docs/nexus-dashboard/api-v1/developer-support/"},"description":"Nexus Dashboard Insights API Documentation","title":"Nexus Dashboard Insights API","version":"6.8.0"},"tags":[{"name":"Cloud"},{"name":"Anomaly Threshold settings"},{"name":"Cluster level settings"},{"name":"Config - NI"},{"name":"NI Systems Settings"},{"name":"Site - Alert Rules"},{"name":"Site - Collection"},{"name":"Site - Compliance Requirements"},{"name":"Site - Configuration Import Export"},{"name":"Site - Entity Settings, Offline / Epoch-Delta Jobs & Site Management"},{"name":"Site - Export Kafka Fast Settings"},{"name":"Site - Export Nas Settings"},{"name":"Site - Export Settings"},{"name":"Site - FileUpload"},{"name":"Site - Flow Rules"},{"name":"Site - Integrations"},{"name":"Site - Offline Data Collection"},{"name":"Site - PDU integration"},{"name":"Site - Pre-Change Analysis"},{"name":"Site - Purge Epoch & Anomaly DB"},{"name":"Site - Syslog Export Settings"},{"name":"Site Group"},{"name":"Site Groups"},{"name":"Traffic Analytics Rules settings"},{"name":"User Settings"}],"x-parser-conf":{"overview":{"markdownPath":"reference/overview-legacy-insights.md"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}}},"openapi":"3.0.3","servers":[{"url":"/"}]},"spec":{"operationId":"getComplianceRequirementCountByType","parameters":[{"description":"Name of insight group","in":"path","name":"igName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"success":true,"messages":[{"severity":"INFO","code":0,"message":"message","properties":{"key":"properties"}},{"severity":"INFO","code":0,"message":"message","properties":{"key":"properties"}}],"value":{"totalResultsCount":1,"totalItemsCount":5,"dataSummary":{"pageNumber":2,"currentPageNumber":5,"hasMoreData":true,"pageSize":1,"totalPageCount":5,"links":[{"hreflang":"hreflang","profile":"profile","rel":"{}","name":"name","href":"href","media":"media","title":"title","type":"type","deprecation":"deprecation"},{"hreflang":"hreflang","profile":"profile","rel":"{}","name":"name","href":"href","media":"media","title":"title","type":"type","deprecation":"deprecation"}],"sortFields":["sortFields","sortFields"],"totalCount":6,"extraInfo":{"key":"{}"}},"data":{"configurationCount":0,"communicationCount":6},"offset":5,"namespaces":{"key":"namespaces"}}},"properties":{"success":{"type":"boolean"},"messages":{"items":{"example":{"severity":"INFO","code":0,"message":"message","properties":{"key":"properties"}},"properties":{"code":{"format":"int32","type":"integer"},"severity":{"enum":["INFO","WARNING","ERROR"],"type":"string"},"message":{"type":"string"},"properties":{"additionalProperties":{"type":"string"},"type":"object"}},"type":"object","$$ref":"#/components/schemas/Message"},"type":"array"},"value":{"example":{"totalResultsCount":1,"totalItemsCount":5,"dataSummary":{"pageNumber":2,"currentPageNumber":5,"hasMoreData":true,"pageSize":1,"totalPageCount":5,"links":[{"hreflang":"hreflang","profile":"profile","rel":"{}","name":"name","href":"href","media":"media","title":"title","type":"type","deprecation":"deprecation"},{"hreflang":"hreflang","profile":"profile","rel":"{}","name":"name","href":"href","media":"media","title":"title","type":"type","deprecation":"deprecation"}],"sortFields":["sortFields","sortFields"],"totalCount":6,"extraInfo":{"key":"{}"}},"data":{"configurationCount":0,"communicationCount":6},"offset":5,"namespaces":{"key":"namespaces"}},"properties":{"namespaces":{"additionalProperties":{"type":"string"},"type":"object"},"dataSummary":{"example":{"pageNumber":2,"currentPageNumber":5,"hasMoreData":true,"pageSize":1,"totalPageCount":5,"links":[{"hreflang":"hreflang","profile":"profile","rel":"{}","name":"name","href":"href","media":"media","title":"title","type":"type","deprecation":"deprecation"},{"hreflang":"hreflang","profile":"profile","rel":"{}","name":"name","href":"href","media":"media","title":"title","type":"type","deprecation":"deprecation"}],"sortFields":["sortFields","sortFields"],"totalCount":6,"extraInfo":{"key":"{}"}},"properties":{"links":{"items":{"example":{"hreflang":"hreflang","profile":"profile","rel":"{}","name":"name","href":"href","media":"media","title":"title","type":"type","deprecation":"deprecation"},"properties":{"rel":{"type":"object"},"href":{"readOnly":true,"type":"string"},"hreflang":{"readOnly":true,"type":"string"},"media":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"deprecation":{"readOnly":true,"type":"string"},"profile":{"readOnly":true,"type":"string"},"name":{"readOnly":true,"type":"string"}},"type":"object","$$ref":"#/components/schemas/Link"},"type":"array"},"totalCount":{"format":"int64","type":"integer"},"hasMoreData":{"type":"boolean"},"pageSize":{"format":"int32","type":"integer"},"currentPageNumber":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"sortFields":{"items":{"type":"string"},"type":"array"},"extraInfo":{"additionalProperties":{"properties":{},"type":"object"},"type":"object"},"pageNumber":{"format":"int32","type":"integer"}},"type":"object","$$ref":"#/components/schemas/DataSummary"},"data":{"example":{"configurationCount":0,"communicationCount":6},"properties":{"configurationCount":{"format":"int32","type":"integer"},"communicationCount":{"format":"int32","type":"integer"}},"type":"object","$$ref":"#/components/schemas/ComplianceCountDto"},"totalResultsCount":{"format":"int64","type":"integer"},"totalItemsCount":{"format":"int64","type":"integer"},"offset":{"format":"int64","type":"integer"}},"type":"object","$$ref":"#/components/schemas/EntityComplianceCountDto"}},"type":"object","xml":{"name":"response","namespace":"https://www.cisco.com/candid/xsd/v1"},"$$ref":"#/components/schemas/ResponseBeanComplianceCountDto"}},"application/xml":{"schema":{"example":{"success":true,"messages":[{"severity":"INFO","code":0,"message":"message","properties":{"key":"properties"}},{"severity":"INFO","code":0,"message":"message","properties":{"key":"properties"}}],"value":{"totalResultsCount":1,"totalItemsCount":5,"dataSummary":{"pageNumber":2,"currentPageNumber":5,"hasMoreData":true,"pageSize":1,"totalPageCount":5,"links":[{"hreflang":"hreflang","profile":"profile","rel":"{}","name":"name","href":"href","media":"media","title":"title","type":"type","deprecation":"deprecation"},{"hreflang":"hreflang","profile":"profile","rel":"{}","name":"name","href":"href","media":"media","title":"title","type":"type","deprecation":"deprecation"}],"sortFields":["sortFields","sortFields"],"totalCount":6,"extraInfo":{"key":"{}"}},"data":{"configurationCount":0,"communicationCount":6},"offset":5,"namespaces":{"key":"namespaces"}}},"properties":{"success":{"type":"boolean"},"messages":{"items":{"example":{"severity":"INFO","code":0,"message":"message","properties":{"key":"properties"}},"properties":{"code":{"format":"int32","type":"integer"},"severity":{"enum":["INFO","WARNING","ERROR"],"type":"string"},"message":{"type":"string"},"properties":{"additionalProperties":{"type":"string"},"type":"object"}},"type":"object","$$ref":"#/components/schemas/Message"},"type":"array"},"value":{"example":{"totalResultsCount":1,"totalItemsCount":5,"dataSummary":{"pageNumber":2,"currentPageNumber":5,"hasMoreData":true,"pageSize":1,"totalPageCount":5,"links":[{"hreflang":"hreflang","profile":"profile","rel":"{}","name":"name","href":"href","media":"media","title":"title","type":"type","deprecation":"deprecation"},{"hreflang":"hreflang","profile":"profile","rel":"{}","name":"name","href":"href","media":"media","title":"title","type":"type","deprecation":"deprecation"}],"sortFields":["sortFields","sortFields"],"totalCount":6,"extraInfo":{"key":"{}"}},"data":{"configurationCount":0,"communicationCount":6},"offset":5,"namespaces":{"key":"namespaces"}},"properties":{"namespaces":{"additionalProperties":{"type":"string"},"type":"object"},"dataSummary":{"example":{"pageNumber":2,"currentPageNumber":5,"hasMoreData":true,"pageSize":1,"totalPageCount":5,"links":[{"hreflang":"hreflang","profile":"profile","rel":"{}","name":"name","href":"href","media":"media","title":"title","type":"type","deprecation":"deprecation"},{"hreflang":"hreflang","profile":"profile","rel":"{}","name":"name","href":"href","media":"media","title":"title","type":"type","deprecation":"deprecation"}],"sortFields":["sortFields","sortFields"],"totalCount":6,"extraInfo":{"key":"{}"}},"properties":{"links":{"items":{"example":{"hreflang":"hreflang","profile":"profile","rel":"{}","name":"name","href":"href","media":"media","title":"title","type":"type","deprecation":"deprecation"},"properties":{"rel":{"type":"object"},"href":{"readOnly":true,"type":"string"},"hreflang":{"readOnly":true,"type":"string"},"media":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"deprecation":{"readOnly":true,"type":"string"},"profile":{"readOnly":true,"type":"string"},"name":{"readOnly":true,"type":"string"}},"type":"object","$$ref":"#/components/schemas/Link"},"type":"array"},"totalCount":{"format":"int64","type":"integer"},"hasMoreData":{"type":"boolean"},"pageSize":{"format":"int32","type":"integer"},"currentPageNumber":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"sortFields":{"items":{"type":"string"},"type":"array"},"extraInfo":{"additionalProperties":{"properties":{},"type":"object"},"type":"object"},"pageNumber":{"format":"int32","type":"integer"}},"type":"object","$$ref":"#/components/schemas/DataSummary"},"data":{"example":{"configurationCount":0,"communicationCount":6},"properties":{"configurationCount":{"format":"int32","type":"integer"},"communicationCount":{"format":"int32","type":"integer"}},"type":"object","$$ref":"#/components/schemas/ComplianceCountDto"},"totalResultsCount":{"format":"int64","type":"integer"},"totalItemsCount":{"format":"int64","type":"integer"},"offset":{"format":"int64","type":"integer"}},"type":"object","$$ref":"#/components/schemas/EntityComplianceCountDto"}},"type":"object","xml":{"name":"response","namespace":"https://www.cisco.com/candid/xsd/v1"},"$$ref":"#/components/schemas/ResponseBeanComplianceCountDto"}}},"description":"successful operation"}},"summary":"API to fetch compliance count by type","tags":["Site - Compliance Requirements"],"__originalOperationId":"getComplianceRequirementCountByType","method":"get","path":"/sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/requirements/count"}}