Get devices energy - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Get devices energy","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":"getDevicesEnergy","tags":["Devices"],"summary":"Get devices energy","deprecated":false,"description":"Retrieves a list of network devices with energy data based on the specified query parameters. 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-deviceEnergy_1.0-1.0.1-resolved.yaml","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":"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 one day before `endTime`.\n","required":false,"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\nIf `endTime` is not provided, API will default to one day after `startTime`. If `startTime` is not provided either, API will default to current time.\n","required":false,"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"},{"name":"cursor","description":"It's an opaque string field that indicates the next record in the requested collection. If no records remain, the API returns a response with a count of zero. The default value is an empty string, and the initial value must be an empty string. The cursor value is populated by the API in the response page block. If the user wants more records, the cursor in the subsequent request must be updated with the value from the previous response.","schema":{"type":"string","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"},{"name":"id","description":"The list of Device Uuids (e.g., `6bef213c-19ca-4170-8375-b694e251101c`).\n\nExamples:\n\n`id=6bef213c-19ca-4170-8375-b694e251101c` (single device requested)\n\n`id=6bef213c-19ca-4170-8375-b694e251101c&id=32219612-819e-4b5e-a96b-cf22aca13dd9`\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteId","description":"The UUID of the site. (Ex. `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":"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":"deviceCategory","description":"The list of device deviceCategories. \n\nExamples:\n\n`deviceCategory=Switch` (single device family requested)\n\n`deviceCategory=Switch&deviceCategory=Router` (multiple device categories with comma separator)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"deviceSubCategory","description":"The list of device sub categories.\n\nExamples:\n\n`deviceSubCategory=Cisco Catalyst 9300 Series Switches` (single device family requested)\n\n`deviceSubCategory=Cisco Catalyst 9300 Series Switches&deviceSubCategory=Cisco Catalyst 9400 Series Switches`\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"view","description":"List of views. View and attribute work in union. Each view will include its attributes. For example, view device includes all the attributes related to device. Please refer to `NetworkDeviceEnergyView` model for supported list of views\n\nExamples:\n`view=device&view=energy`\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"attribute","description":"List of attributes. Please refer to `NetworkDeviceEnergyAttribute` for supported list of attributes \n\nExamples:\n`attribute=id&attribute=energyConsumed`\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"Devices Energy Summaries Response model on success","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":""},"deviceName":{"type":"string","description":""},"deviceCategory":{"type":"string","description":""},"deviceSubCategory":{"type":"string","description":""},"siteId":{"type":"string","description":""},"siteHierarchy":{"type":"string","description":""},"siteHierarchyId":{"type":"string","description":""},"energyConsumed":{"type":"number","description":""},"estimatedCost":{"type":"number","description":""},"estimatedEmission":{"type":"number","description":""},"carbonIntensity":{"type":"number","description":""}}},"description":""},"page":{"type":"object","properties":{"limit":{"type":"integer","description":""},"cursor":{"type":"string","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/GetDevicesEnergyResponse"}}}},"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":{}},"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":{}},"default":{"description":"Unexpected Error","content":{}}},"x-rapi-id":"60b1-394d-4438-9950","x-rapi-overview":"Retrieves a list of network devices with energy data based on the specified query parameters. 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-deviceEnergy_1.0-1.0.1-resolved.yaml","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Devices","x-rapi-version":"1.0.0","x-rapi-internalPath":"/data/api/v1/energy/networkDevices","x-rapi-publicPath":"/dna/data/api/v1/energy/networkDevices","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"getDevicesEnergy","method":"get","path":"/dna/data/api/v1/energy/networkDevices"}}