{"type":"api","title":"Return list of replacement devices with replacement details","meta":{"id":"/apps/pubhub/media/dna-center-235/0e427c513038595590fc5a0593cb0e208dd78571/2192edf3-d24e-3461-ab8c-12a97b547df4","swagger":"2.0","info":{"description":"Cisco DNA Center Platform v. 2.3.5","version":"2.3.5","title":"Intent API"},"schemes":["https"],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}}},"spec":{"operationId":"returnListOfReplacementDevicesWithReplacementDetails","tags":["Device Replacement"],"summary":"Return list of replacement devices with replacement details","description":"Get list of replacement devices with replacement details and it can filter replacement devices based on Faulty Device Name,Faulty Device Platform, Replacement Device Platform, Faulty Device Serial Number,Replacement Device Serial Number, Device Replacement status, Product Family.","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"faultyDeviceName","description":"Faulty Device Name","required":false,"type":"string","in":"query"},{"name":"faultyDevicePlatform","description":"Faulty Device Platform","required":false,"type":"string","in":"query"},{"name":"replacementDevicePlatform","description":"Replacement Device Platform","required":false,"type":"string","in":"query"},{"name":"faultyDeviceSerialNumber","description":"Faulty Device Serial Number","required":false,"type":"string","in":"query"},{"name":"replacementDeviceSerialNumber","description":"Replacement Device Serial Number","required":false,"type":"string","in":"query"},{"name":"replacementStatus","description":"Device Replacement status [READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR, NETWORK_READINESS_REQUESTED, NETWORK_READINESS_FAILED]","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"family","description":"List of families[Routers, Switches and Hubs, AP]","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"sortBy","description":"SortBy this field. SortBy is mandatory when order is used.","required":false,"type":"string","in":"query"},{"name":"sortOrder","description":"Order on displayName[ASC,DESC]","required":false,"type":"string","in":"query"},{"name":"offset","description":"offset","required":false,"type":"integer","in":"query"},{"name":"limit","description":"limit","required":false,"type":"integer","in":"query"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"creationTime":{"type":"integer"},"family":{"type":"string"},"faultyDeviceId":{"type":"string"},"faultyDeviceName":{"type":"string"},"faultyDevicePlatform":{"type":"string"},"faultyDeviceSerialNumber":{"type":"string"},"id":{"type":"string"},"neighbourDeviceId":{"type":"string"},"networkReadinessTaskId":{"type":"string"},"replacementDevicePlatform":{"type":"string"},"replacementDeviceSerialNumber":{"type":"string"},"replacementStatus":{"type":"string"},"replacementTime":{"type":"integer"},"workflowId":{"type":"string"}}}},"version":{"type":"string"}},"$$ref":"#/definitions/DeviceReplacementResult"}},"204":{"description":"The request was successful, however no content was returned."},"206":{"description":"The GET request included a Range Header, and the server responded with the partial content matching the range."},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect)."},"401":{"description":"The client's authentication credentials included with the request are missing or invalid."},"403":{"description":"The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"404":{"description":"The client made a request for a resource that does not exist."},"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."},"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)."},"500":{"description":"The server could not fulfill the request."},"501":{"description":"The server has not implemented the functionality required to fulfill the request."},"503":{"description":"The server is (temporarily) unavailable."},"504":{"description":"The server did not respond inside time restrictions and timed-out."}},"__originalOperationId":"returnListOfReplacementDevicesWithReplacementDetails","method":"get","path":"/dna/intent/api/v1/device-replacement"}}