{"type":"api","title":"Get view details for a given view group & view","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":"getViewDetailsForAGivenViewGroup_View","tags":["Reports"],"summary":"Get view details for a given view group & view","deprecated":false,"description":"Gives complete information of the view that is required to configure a report. Use \"Get views for a given view group\" API to get the viewIds (required as a query param for this API) for available views.","parameters":[{"name":"viewGroupId","description":"viewGroupId of viewgroup","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"},{"name":"viewId","description":"view id of view","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"deliveries":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["EMAIL","WEBHOOK","DOWNLOAD"],"description":"delivery type"},"default":{"type":"boolean","description":"true, if the delivery type is considered default"}}},"description":"Array of available delivery channels"},"description":{"type":"string","description":"view description"},"fieldGroups":{"type":"array","items":{"type":"object","properties":{"fieldGroupDisplayName":{"type":"string","description":"Field group label/displayname for user"},"fieldGroupName":{"type":"string","description":"Field group name"},"fields":{"type":"array","items":{"type":"object","properties":{"displayName":{"type":"string","description":"field label/displayname"},"name":{"type":"string","description":"field name"}}},"description":"Fields available in the fieldgroup"},"tableId":{"type":"string","description":"Table Id of the corresponding table mapped to fieldgroup"}}},"description":"Field available for specific type of reports(CSV, TDE, JSON)"},"filters":{"type":"array","items":{"type":"object","properties":{"additionalInfo":{"type":"object","properties":{},"description":"Additional info for managing filter options"},"cacheFilter":{"type":"boolean","description":""},"dataType":{"type":"string","description":"data type of filter value"},"displayName":{"type":"string","description":"filter label/displayname"},"filterSource":{"type":"object","properties":{"dataSource":{"type":"object","description":""},"displayValuePath":{"type":"string","description":"JSONPath of the label of filter option from the filter option as root"},"rootPath":{"type":"string","description":"JSONPath of the filter options array in the API response"},"valuePath":{"type":"string","description":"JSONPath of the value of filter option from the filter option as root"}},"description":"filter data source definition"},"name":{"type":"string","description":"filter name"},"required":{"type":"boolean","description":"true if the filter is required"},"timeOptions":{"type":"array","items":{"type":"object","properties":{"info":{"type":"string","description":"Time range option description"},"maxValue":{"type":"integer","description":"Maximum number of hours allowed for the time range option. (Client Validation)"},"minValue":{"type":"integer","description":"Minimum number of hours allowed for the time range option. (Client Validation)"},"name":{"type":"string","description":"Time range option label"},"value":{"type":"string","description":"Time range option value"}}},"description":""},"type":{"type":"string","description":"filter type. Used to handle filter value selection by the client for report configuration."}}},"description":"Metadata of filters for the report. Also contains information for fetching the filter options."},"formats":{"type":"array","items":{"type":"object","properties":{"format":{"type":"string","enum":["CSV","TDE","JSON","PDF"],"description":"format type"},"name":{"type":"string","description":"format name"},"default":{"type":"boolean","description":"true, if the format type is considered default"},"template":{"type":"object","properties":{"jsTemplateId":{"type":"string","description":"TemplateId of template"}},"description":"Template details for the report"}}},"description":"Array of available formats for the report"},"schedules":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["SCHEDULE_NOW","SCHEDULE_LATER","SCHEDULE_RECURRENCE"],"description":"schedule type"},"default":{"type":"boolean","description":"true, if the schedule type is default"}}},"description":"Array of available schedule types"},"viewId":{"type":"string","description":"Unique view Id"},"viewInfo":{"type":"string","description":"view filters info"},"viewName":{"type":"string","description":"view name"}},"description":"","$$ref":"#/components/schemas/GetViewDetailsForAGivenViewGroupViewResponse"}}}},"204":{"description":"The request was successful, however no content was returned.","content":{}},"206":{"description":"The GET request included a Range Header, and the server responded with the partial content matching the range.","content":{}},"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":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"409":{"description":"The target resource is in a conflicted state (for example, an edit conflict where a resource is being edited by multiple users). Retrying the request later might succeed.","content":{}},"415":{"description":"The client sent a request body in a format that the server does not support (for example, XML to a server that only accepts JSON).","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}},"501":{"description":"The server has not implemented the functionality required to fulfill the request.","content":{}},"503":{"description":"The server is (temporarily) unavailable.","content":{}},"504":{"description":"The server did not respond inside time restrictions and timed-out.","content":{}}},"x-rapi-id":"1d9a-ba2f-4f89-ae51","x-rapi-overview":"Gives complete information of the view that is required to configure a report. Use \"Get views for a given view group\" API to get the viewIds (required as a query param for this API) for available views.","x-rapi-domain":"Operational Tasks","x-rapi-subdomain":"Reports","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/dnacaap/v1/daas/core/data/view-groups/${viewGroupId}/views/${viewId}","x-rapi-publicPath":"/dna/intent/api/v1/data/view-groups/${viewGroupId}/views/${viewId}","x-rapi-registerInKONG":true,"x-rapi-banner":[],"__originalOperationId":"getViewDetailsForAGivenViewGroup&View","method":"get","path":"/dna/intent/api/v1/data/view-groups/{viewGroupId}/views/{viewId}"}}