Get Data Collection Status For UUID - Cisco Catalyst SD-WAN Manager API, Release 20.16

{"type":"api","title":"Get Data Collection Status For UUID","meta":{"id":"/apps/pubhub/media/sd-wan-api-20-16/58fb893fa751949ea20a40274e9ab219a20e19fa/e77267b5-7b4b-3f93-807c-c6d1c6b41343","info":{"title":"Cisco Catalyst SD-WAN Manager API","description":"The vManage API exposes the functionality of operations maintaining devices and the overlay network","contact":{"email":"vmanage@cisco.com"},"license":{"name":"Commercial License","url":"https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html"},"version":"2.0.0"},"openapi":"3.0.1","servers":[{"url":"/dataservice"}]},"spec":{"tags":["File based RealTime Data Collection - Get Data Collection status for a Request UUID"],"description":"Get Data Collection status for given Request UUID","operationId":"getDataCollectionStatusForUUID","parameters":[{"name":"requestUUID","in":"path","description":"request UUID","required":true,"schema":{"type":"string"},"example":"c04aadac-6efb-4cfd-8cbd-0fc47e00e931"}],"responses":{"200":{"description":"Data collection status for given UUID","content":{"application/json":{"schema":{"type":"string"},"examples":{"Data collection status for given UUID":{"description":"Data collection status for given UUID","value":{"deviceUUID":"C8K-10a453ab-e30b-4476-aa98-bc5ded7298ee","deviceSystemIP":"172.16.255.15","collectionSubStatus":"file-downloaded-to-vmanage","statsCommand":"advertised-routes","requestEndTime":1661066092631,"requestUUID":"5fe0ec18-6da3-471f-aad7-03fc94b08a83","requestStartTime":"1661065501749","requestedFileFormat":"csv-file","detailedMessage":"Successfully downloaded file from device","collectionMainStatus":"success","lastStateChangedTime":1661066092544,"stateChangeLogs":[{"changeTime":1661066092544,"detailedMessage":"Successfully downloaded file from device","state":"file-downloaded-to-vmanage"},{"changeTime":1661066087249,"detailedMessage":"Published to destination vManage for Downloading generated file","state":"publised-for-file-download"},{"changeTime":1661066087031,"detailedMessage":"Device generated file","state":"file-generated"},{"changeTime":1661065506807,"detailedMessage":"RPC sent to Device for file generation","state":"device-notified"},{"changeTime":1661065501797,"detailedMessage":"Published to destination vManage for sending RPC request","state":"publised-for-rpc-request"}]},"$$ref":"#/components/examples/Status200"}}}}},"400":{"description":"Bad Request or Parameter","content":{"application/json":{"schema":{"type":"object","properties":{"errorMessage":{"type":"string","description":"Message about bad request or parameters errors"},"errorType":{"type":"string","description":"Type of error"},"operation":{"type":"string","description":"Operation title"}},"$$ref":"#/components/schemas/HttpError"},"examples":{"400 - Bad Request or Parameters":{"description":"400 - Bad Request or Parameters","value":{"operation":"Initiate file generation","errorType":"Invalid Payload or Parameter(s)","errorMessage":"Empty/Invalid Device IP"},"$$ref":"#/components/examples/Status400"}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"errorMessage":{"type":"string","description":"Message about bad request or parameters errors"},"errorType":{"type":"string","description":"Type of error"},"operation":{"type":"string","description":"Operation title"}},"$$ref":"#/components/schemas/HttpError"},"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"operation":"Download generated file for UUID : b81467bb-9827-46a0-8db8-f742d4d91c0a","errorType":"General or Internal Error","errorMessage":"Data Collection state is in-progress, Cannot download file at this moment"},"$$ref":"#/components/examples/Status500"}}}}}},"x-roles-required":"System-read,System-write","__originalOperationId":"getDataCollectionStatusForUUID","method":"get","path":"/device/file-based/data-collection/status/{requestUUID}"}}