{"type":"api","title":"Initiate File Generation Request To Device","meta":{"id":"/apps/pubhub/media/sd-wan-api-20-16/bbdb16c27aa20949539a17a086b23efac32312db/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 - Initiate File Generation"],"description":"Request device to prepare realtime collection data in required file format","operationId":"initiateFileGenerationRequestToDevice","requestBody":{"description":"Initiate file generation payload","content":{"application/json":{"schema":{"required":["deviceUUID","requestedFileFormat","statsCommand"],"type":"object","properties":{"deviceUUID":{"type":"string","description":"UUID of the device"},"requestedFileFormat":{"type":"string"},"statsCommand":{"type":"string"}},"$$ref":"#/components/schemas/InitiateFileGenerationRequest"},"examples":{"Initiate File Generation - OMP Routes Advertised in CSV Format":{"description":"Initiate File Generation - OMP Routes Advertised in CSV Format","value":{"deviceUUID":"C8K-abf1808c-21c0-4612-a062-5afc29f8bc02","statsCommand":"advertised-routes","requestedFileFormat":"csv-file"},"$$ref":"#/components/examples/InitiateFilegenerationCSV"},"Initiate File Generation - OMP Routes Received in JSON Format":{"description":"Initiate File Generation - OMP Routes Received in JSON Format","value":{"deviceUUID":"C8K-abf1808c-21c0-4612-a062-5afc29f8bc02","statsCommand":"received-routes","requestedFileFormat":"json-file"},"$$ref":"#/components/examples/InitiateFilegenerationJSON"}}}}},"responses":{"200":{"description":"Response for file generation request","content":{"application/json":{"schema":{"type":"string"},"examples":{"Data Collection information":{"description":"Data Collection information","value":{"deviceUUID":"C8K-abf1808c-21c0-4612-a062-5afc29f8bc02","requestedFileFormat":"csv-file","statsCommand":"advertised-routes","uuid":"b81467bb-9827-46a0-8db8-f742d4d91c0a"},"$$ref":"#/components/examples/InitiateFilegeneration200"}}}}},"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":"Inititate file generation","errorType":"Invalid Payload or Parameter(s)","errorMessage":"Empty/Invalid Device IP"},"$$ref":"#/components/examples/InitiateFilegeneration400"}}}}},"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 momemnt"},"$$ref":"#/components/examples/InitiateFilegeneration500"}}}}}},"x-roles-required":"System-read,System-write","__originalOperationId":"initiateFileGenerationRequestToDevice","method":"post","path":"/device/file-based/data-collection/initiate-file-generation"}}