Get list of profiling rules - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Get list of profiling rules","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":"getListOfProfilingRules","tags":["AI Endpoint Analytics"],"summary":"Get list of profiling rules","deprecated":false,"description":"This API fetches the list of profiling rules. It can be used to show profiling rules in client applications, or export those from an environment. 'POST /profiling-rules/bulk' API can be used to import such exported rules into another environment.\nIf this API is used to export rules to be imported into another Cisco DNA Center system, then ensure that 'includeDeleted' parameter is 'true', so that deleted rules get synchronized correctly.\nUse query parameters to filter the data, as required. If no filter is provided, then it will include only rules of type 'Custom Rule' in the response. By default, the response is limited to 500 records. Use 'limit' parameter to fetch higher number of records, if required. 'GET /profiling-rules/count' API can be used to find out the total number of rules in the system.\n","parameters":[{"name":"ruleType","description":"Use comma-separated list of rule types to filter the data. Defaults to 'Custom Rule'.","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"includeDeleted","description":"Flag to indicate whether deleted rules should be part of the records fetched.","schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"limit","description":"Maximum number of records to be fetched. If not provided, 500 records will be fetched by default. To fetch all\nthe records in the system, provide a large value for this parameter.\n","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"offset","description":"Record offset to start data fetch at. Offset starts at zero.","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"sortBy","description":"Name of the column to sort the results on. Please note that fetch might take more time if sorting is requested.","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"order","description":"Order to be used for sorting.","schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"Success. In case no records are found, 'profilingRules' attribute will contain empty array.","content":{"application/json":{"schema":{"type":"object","properties":{"profilingRules":{"type":"array","items":{"type":"object","properties":{"ruleId":{"type":"string","description":"Unique identifier for the rule. This is normally generated by the system, and client does not need to provide\nit for rules that need to be newly created.\n"},"ruleName":{"type":"string","description":"Human readable name for the rule."},"ruleType":{"type":"string","enum":["Cisco Default - Static","Cisco Default - Dynamic","Custom Rule","ML Rule"],"description":"Type of the rule."},"ruleVersion":{"type":"integer","description":"Version of the rule."},"rulePriority":{"type":"integer","description":"Priority for the rule."},"sourcePriority":{"type":"integer","description":"Source priority for the rule."},"isDeleted":{"type":"boolean","description":"Flag to indicate whether the rule was deleted."},"lastModifiedBy":{"type":"string","description":"User that last modified the rule. It is read-only, and is ignored if provided as part of input request."},"lastModifiedOn":{"type":"integer","description":"Timestamp (in epoch milliseconds) of last modification. It is read-only, and is ignored if provided as part of\ninput request.\n"},"pluginId":{"type":"string","description":"Plugin for the rule. Only applicable for 'Cisco Default' rules."},"clusterId":{"type":"string","description":"Unique identifier for ML cluster. Only applicable for 'ML Rule'."},"rejected":{"type":"boolean","description":"Flag to indicate whether rule has been rejected by user or not. Only applicable for 'ML Rule'."},"result":{"type":"object","properties":{"deviceType":{"type":"array","items":{"type":"string"},"description":"List of device types determined by the current rule."},"hardwareManufacturer":{"type":"array","items":{"type":"string"},"description":"List of hardware manufacturers determined by the current rule."},"hardwareModel":{"type":"array","items":{"type":"string"},"description":"List of hardware models determined by the current rule."},"operatingSystem":{"type":"array","items":{"type":"string"},"description":"List of operating systems determined by the current rule."}},"description":"Object containing profiling result as determined by the rule."},"conditionGroups":{"type":"object","properties":{"type":{"type":"string","enum":["attr","classification"],"description":""},"condition":{"type":"object","properties":{"attribute":{"type":"string","description":""},"operator":{"type":"string","enum":["equals","contains","startswith","matches"],"description":""},"value":{"type":"string","description":""},"attributeDictionary":{"type":"string","description":""}},"description":""},"operator":{"type":"string","enum":["and","or"],"description":""},"conditionGroup":{"type":"array","items":{"type":"string"},"description":""}},"description":"Complex object that describes various conditions that should be met for the current rule to be applied."},"usedAttributes":{"type":"array","items":{"type":"string"},"description":"List of attributes used in the rule. Only applicable for 'Cisco Default' rules."}}},"description":"List of profiling rules."}},"description":"","$$ref":"#/components/schemas/GetListOfProfilingRulesResponse"}}}},"400":{"description":"Invalid request. Check response body for more details.","content":{}},"500":{"description":"Internal server error. Check response body for more details.","content":{}}},"x-rapi-id":"07b4-eb60-435a-bf90","x-rapi-overview":"This API fetches the list of profiling rules. It can be used to show profiling rules in client applications, or export those from an environment. 'POST /profiling-rules/bulk' API can be used to import such exported rules into another environment.\nIf this API is used to export rules to be imported into another Cisco DNA Center system, then ensure that 'includeDeleted' parameter is 'true', so that deleted rules get synchronized correctly.\nUse query parameters to filter the data, as required. If no filter is provided, then it will include only rules of type 'Custom Rule' in the response. By default, the response is limited to 500 records. Use 'limit' parameter to fetch higher number of records, if required. 'GET /profiling-rules/count' API can be used to find out the total number of rules in the system.\n","x-rapi-domain":"Policy","x-rapi-subdomain":"AI Endpoint Analytics","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/endpoint-analytics/v1/eps/profiling-rules","x-rapi-publicPath":"/dna/intent/api/v1/endpoint-analytics/profiling-rules","x-rapi-registerInKONG":true,"x-rapi-banner":[],"__originalOperationId":"getListOfProfilingRules","method":"get","path":"/dna/intent/api/v1/endpoint-analytics/profiling-rules"}}