Retrieve the status of all the device replacement workflows - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Retrieve the status of all the device replacement workflows","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":"retrieveTheStatusOfAllTheDeviceReplacementWorkflows_","tags":["Device Replacement"],"summary":"Retrieve the status of all the device replacement workflows.","deprecated":false,"description":"Retrieve the list of device replacements with replacement details. Filters can be applied based on faulty device name, faulty device platform, faulty device serial number, replacement device platform, replacement device serial number, device replacement status, device family.\n","parameters":[{"name":"family","description":"Faulty device family.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"faultyDeviceName","description":"Faulty device name.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"faultyDevicePlatform","description":"Faulty device platform.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"faultyDeviceSerialNumber","description":"Faulty device serial number.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"replacementDevicePlatform","description":"Replacement device platform.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"replacementDeviceSerialNumber","description":"Replacement device serial number.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"replacementStatus","description":"Device replacement status. Available values : MARKED_FOR_REPLACEMENT, NETWORK_READINESS_REQUESTED, NETWORK_READINESS_FAILED, READY_FOR_REPLACEMENT, REPLACEMENT_SCHEDULED, REPLACEMENT_IN_PROGRESS, REPLACED, ERROR. Replacement status: 'MARKED_FOR_REPLACEMENT' - The faulty device has been marked for replacement. 'NETWORK_READINESS_REQUESTED' - Initiated steps to shut down neighboring device interfaces and create a DHCP server on the uplink neighbor if the faulty device is part of a fabric setup. 'NETWORK_READINESS_FAILED' - Preparation of the network failed. Neighboring device interfaces were not shut down, and the DHCP server on the uplink neighbor was not created. 'READY_FOR_REPLACEMENT' - The network is prepared for the faulty device replacement. Neighboring device interfaces are shut down, and the DHCP server on the uplink neighbor is set up. 'REPLACEMENT_SCHEDULED' - Device replacement has been scheduled. 'REPLACEMENT_IN_PROGRESS' - Device replacement is currently in progress. 'REPLACED' - Device replacement was successful. 'ERROR' - Device replacement has failed.","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.","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"limit","description":"The number of records to show for this page. Maximum value can be 500.","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"sortBy","description":"A property within the response to sort by. Available values : id, creationTime, family, faultyDeviceId, fautyDeviceName, faultyDevicePlatform, faultyDeviceSerialNumber, replacementDevicePlatform, replacementDeviceSerialNumber, replacementTime.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"sortOrder","description":"Whether ascending or descending order should be used to sort the response. Available values : ASC, DESC","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"creationTime":{"type":"integer","description":"Time of marking the device for replacement in Unix epoch time in milliseconds"},"family":{"type":"string","description":"Faulty device family"},"faultyDeviceId":{"type":"string","description":"Faulty device id"},"faultyDeviceName":{"type":"string","description":"Faulty device name"},"faultyDevicePlatform":{"type":"string","description":"Faulty device platform"},"faultyDeviceSerialNumber":{"type":"string","description":"Faulty device serial number"},"id":{"type":"string","description":"Unique identifier of the device replacement resource"},"neighborDeviceId":{"type":"string","description":"Unique identifier of the neighbor device to create the DHCP server"},"replacementDevicePlatform":{"type":"string","description":"Replacement device platform"},"replacementDeviceSerialNumber":{"type":"string","description":"Replacement device serial number"},"replacementStatus":{"type":"string","enum":["MARKED_FOR_REPLACEMENT","NETWORK_READINESS_REQUESTED","NETWORK_READINESS_FAILED","READY_FOR_REPLACEMENT","REPLACEMENT_SCHEDULED","REPLACEMENT_IN_PROGRESS","REPLACED","ERROR"],"description":"Device Replacement status. 'MARKED_FOR_REPLACEMENT' - The faulty device has been marked for replacement. 'NETWORK_READINESS_REQUESTED' - Initiated steps to shut down neighboring device interfaces and create a DHCP server on the uplink neighbor if the faulty device is part of a fabric setup. 'NETWORK_READINESS_FAILED' - Preparation of the network failed. Neighboring device interfaces were not shut down, and the DHCP server on the uplink neighbor was not created. 'READY_FOR_REPLACEMENT' - The network is prepared for the faulty device replacement. Neighboring device interfaces are shut down, and the DHCP server on the uplink neighbor is set up. 'REPLACEMENT_SCHEDULED' - Device replacement has been scheduled. 'REPLACEMENT_IN_PROGRESS' - Device replacement is currently in progress. 'REPLACED' - Device replacement was successful. 'ERROR' - Device replacement has failed."},"replacementTime":{"type":"integer","description":"The Unix epoch time in milliseconds at which the device was replaced successfully"},"workflow":{"type":"object","properties":{"id":{"type":"string","description":"Workflow id"},"name":{"type":"string","description":"Name of the workflow"},"workflowStatus":{"type":"string","enum":["RUNNING","SUCCESS","FAILED"],"description":"Workflow status. 'RUNNING' - Workflow is currently in progress. 'SUCCESS' - Workflow completed successfully. 'FAILED' - Workflow completed with failure."},"startTime":{"type":"integer","description":"Start time of the workflow in Unix epoch time in milliseconds"},"endTime":{"type":"integer","description":"Completion time of the workflow in Unix epoch time in milliseconds"},"steps":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Workflow step name"},"status":{"type":"string","enum":["INIT","RUNNING","SUCCESS","FAILED","ABORTED","TIMEOUT"],"description":"Workflow step status. 'INIT' - Workflow step has not started execution. 'RUNNING' - Workflow step is currently in progress. 'SUCCESS' - Workflow step completed successfully. 'FAILED' - Workflow step completed with failure. 'ABORTED' - Workflow step aborted execution due to failure of the previous step. 'TIMEOUT' - Workflow step timedout to complete execution."},"statusMessage":{"type":"string","description":"Detailed status message for the step"},"startTime":{"type":"integer","description":"Start time of the workflow step in Unix epoch time in milliseconds"},"endTime":{"type":"integer","description":"Completion time of the workflow step in Unix epoch time in milliseconds"}}},"description":"List of steps involved in the device replacement workflow. The number of steps in the workflow depends on various parameters. Maximum number of steps in the workflow will not exceed 25."}},"description":"Device replacement workflow"}}},"description":"List of network device replacements"},"version":{"type":"string","description":"The version of the response."}},"description":"Response Body","$$ref":"#/components/schemas/RetrieveTheStatusOfAllTheDeviceReplacementWorkflowsResponse"}}}},"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":{}},"406":{"description":"The client requested a response in a content format that this server does not support. In some cases, an empty request payload may also result in this response.","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":{}},"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":"e6b8-0a1a-4929-a7a9","x-rapi-overview":"Retrieve the list of device replacements with replacement details. Filters can be applied based on faulty device name, faulty device platform, faulty device serial number, replacement device platform, replacement device serial number, device replacement status, device family.\n","x-rapi-domain":"Site Management","x-rapi-subdomain":"Device Replacement","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/networkDeviceReplacements","x-rapi-publicPath":"/dna/intent/api/v1/networkDeviceReplacements","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"retrieveTheStatusOfAllTheDeviceReplacementWorkflows.","method":"get","path":"/dna/intent/api/v1/networkDeviceReplacements"}}