{"type":"api","title":"Get task details","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":"getTaskDetails","tags":["AI Endpoint Analytics"],"summary":"Get task details","deprecated":false,"description":"Fetches the details of backend task. Task is typically created by making call to some other API that takes longer time to execute.\n","parameters":[{"name":"taskId","description":"Unique identifier for the task.","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the task."},"name":{"type":"string","description":"Name of the task."},"status":{"type":"string","enum":["IN_PROGRESS","COMPLETED","PARTIALLY_FAILED","FAILED"],"description":"Status of the task."},"errors":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","description":"Index of the input records which had error during processing. In case the input is not an array, or the error is not record specific, this will be -1.\n"},"code":{"type":"integer","description":"Error code."},"message":{"type":"string","description":"Error message."},"details":{"type":"string","description":"Optional details about the error."}}},"description":"List of errors in case the `status` of the task is `PARTIALLY_FAILED` or `FAILED`."},"additionalInfo":{"type":"object","properties":{},"description":"Additional information about the task."},"createdBy":{"type":"string","description":"Name of the user that created the task."},"createdOn":{"type":"integer","description":"Task creation timestamp in epoch milliseconds."},"lastUpdatedOn":{"type":"integer","description":"Last update timestamp in epoch milliseconds."}},"description":"","$$ref":"#/components/schemas/GetTaskDetailsResponse"}}}},"404":{"description":"Task for the given 'taskId' not found.","content":{}},"500":{"description":"Internal server error. Check response body for more details.","content":{}}},"x-rapi-id":"2689-39c4-43fa-a2f2","x-rapi-overview":"Fetches the details of backend task. Task is typically created by making call to some other API that takes longer time to execute.\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/tasks/${taskId}","x-rapi-publicPath":"/dna/intent/api/v1/endpoint-analytics/tasks/${taskId}","x-rapi-registerInKONG":true,"x-rapi-banner":[],"__originalOperationId":"getTaskDetails","method":"get","path":"/dna/intent/api/v1/endpoint-analytics/tasks/{taskId}"}}