{"type":"api","title":"Get tasks","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":"getTasks_2","tags":["Task"],"summary":"Get tasks","deprecated":false,"description":"Returns task(s) based on filter criteria","parameters":[{"name":"startTime","description":"This is the epoch start time from which tasks need to be fetched","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"endTime","description":"This is the epoch end time upto which audit records need to be fetched","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"data","description":"Fetch tasks that contains this data","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"errorCode","description":"Fetch tasks that have this error code","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"serviceType","description":"Fetch tasks with this service type","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"username","description":"Fetch tasks with this username","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"progress","description":"Fetch tasks that contains this progress","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"isError","description":"Fetch tasks ended as success or failure. Valid values: true, false","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"failureReason","description":"Fetch tasks that contains this failure reason","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"parentId","description":"Fetch tasks that have this parent Id","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"offset","description":"The first record to show for this page; the first record is numbered 1.","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"limit","description":"The number of records to show for this page;The minimum is 1, and the maximum is 500.","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"sortBy","description":"Sort results by this field","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"order","description":"Sort order - asc or dsc","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"additionalStatusURL":{"type":"string","description":""},"data":{"type":"string","description":""},"endTime":{"type":"integer","description":""},"errorCode":{"type":"string","description":""},"errorKey":{"type":"string","description":""},"failureReason":{"type":"string","description":""},"id":{"type":"string","description":""},"instanceTenantId":{"type":"string","description":""},"isError":{"type":"boolean","description":""},"lastUpdate":{"type":"integer","description":""},"operationIdList":{"type":"object","description":""},"parentId":{"type":"string","description":""},"progress":{"type":"string","description":""},"rootId":{"type":"string","description":""},"serviceType":{"type":"string","description":""},"startTime":{"type":"integer","description":""},"username":{"type":"string","description":""},"version":{"type":"integer","description":""}}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/GetTasksResponse"}}}},"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":"e78b-b8a2-449b-9eed","x-rapi-overview":"Returns task(s) based on filter criteria","x-rapi-domain":"Operational Tasks","x-rapi-subdomain":"Task","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/task","x-rapi-publicPath":"/dna/intent/api/v1/task","x-rapi-registerInKONG":true,"x-rapi-banner":["Sunset"],"__originalOperationId":"getTasks-2","method":"get","path":"/dna/intent/api/v1/task"}}