{"type":"api","title":"Initiate File Generation Request To Device","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/744a8207-9965-344e-aed3-d3ef846a4950","info":{"title":"Others","description":"Other APIs\n- Include APIs that do not belong to other categories\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","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/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiRequestExampleInitiatefilegenerationcsv"},"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/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiRequestExampleInitiatefilegenerationjson"}}}},"required":true},"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/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiResponseExampleInitiatefilegeneration200"}}}}},"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/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiResponseExampleInitiatefilegeneration400"}}}}},"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/ComViptelaVmanageServerFilebasedRealtimeDatacollectionDatacollectionapiResponseExampleInitiatefilegeneration500"}}}}}},"x-roles-required":"System-read,System-write","method":"post","path":"/device/file-based/data-collection/initiate-file-generation"}}