{"type":"api","title":"Retrieves diagnostic task by ID","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":"retrievesDiagnosticTaskByID","tags":["Health and Performance"],"summary":"Retrieves diagnostic task by ID","deprecated":false,"description":"This API retrieves the diagnostic task identified by the specified `id`.","parameters":[{"name":"id","description":"The `id` of the diagnostic task to be retrieved","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"id":{"type":"string","description":"The ID of this task"},"rootId":{"type":"string","description":"The ID of the task representing the root node of the tree which this task belongs to. In some cases, this may be the same as the ID or null, which indicates that this task is the root task"},"parentId":{"type":"string","description":"The ID of the parent task if this happens to be a subtask. In case this task is not a subtask, then the parentId is expected to be null. To construct a task tree, this task will be the child of the task with the ID listed here, or the root of the tree if this task has no parentId"},"startTime":{"type":"integer","description":"An approximate time of when the task creation was triggered; as measured in Unix epoch time in milliseconds"},"resultLocation":{"type":"string","description":"A server-relative URL indicating where additional task-specific details may be found"},"status":{"type":"string","enum":["PENDING","FAILURE","SUCCESS"],"description":"Summarizes the status of a task"},"updatedTime":{"type":"integer","description":"The last modification date and time of this task, expressed in Unix epoch time format to the millisecond precision. "},"endTime":{"type":"integer","description":"An approximate time of when this task has been marked completed; as measured in Unix epoch time in milliseconds"}},"description":"An asynchronous task"},"version":{"type":"string","description":"The version of the response"}},"description":"","$$ref":"#/components/schemas/RetrievesDiagnosticTaskByIDResponse"}}}},"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 task that does not exist.","content":{}},"500":{"description":"The server could not fulfill the request.","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":{}}},"x-rapi-id":"0086-59cc-4338-ae89","x-rapi-overview":"This API retrieves the diagnostic task identified by the specified `id`.","x-rapi-domain":"System","x-rapi-subdomain":"Health and Performance","x-rapi-version":"1.0.0","x-rapi-internalPath":"/intent/api/v1/diagnosticTasks/${id}","x-rapi-publicPath":"/dna/intent/api/v1/diagnosticTasks/${id}","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"retrievesDiagnosticTaskByID","method":"get","path":"/dna/intent/api/v1/diagnosticTasks/{id}"}}