Handle File Generation Status Response From Device - Cisco Catalyst SD-WAN Manager API, Release 20.16

{"type":"api","title":"Handle File Generation Status Response From Device","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 - Device notification - File generation status"],"description":"Device notify when file is ready and vManage has to download them","operationId":"handleFileGenerationStatusResponseFromDevice","requestBody":{"description":"File generation status notification payload","content":{"application/json":{"schema":{"required":["detailedMessage","status","transactionId"],"type":"object","properties":{"checksum":{"type":"string","description":"MD5 checksum value of the file"},"detailedMessage":{"type":"string","description":"Success or Failure reason in detail"},"fileName":{"type":"string","description":"Full path of the generated file"},"status":{"type":"string"},"transactionId":{"type":"string","description":"Transaction Id sent in the file generation RPC"}},"$$ref":"#/components/schemas/HandleFileGenerationStatusNotificationRequest"},"examples":{"Successful file generation status payload":{"description":"Successful file generation status payload","value":{"transactionId":"94e2a016-6b21-83d2-b6163c55ccd3%3cd2a8f8-8fce-63a6894ea555","status":"success","fileName":"/tmp/json/audit/audit_advertised_2022-09-19_13:54:34.csv","checksum":"3534534563454532788799807","detailedMessage":"Successfully generated file"},"$$ref":"#/components/examples/FileGenerationSuccessReq"},"Failed file generation status payload":{"description":"Failed file generation status payload","value":{"transactionId":"94e2a016-6b21-83d2-b6163c55ccd3%3cd2a8f8-8fce-63a6894ea555","status":"failed","detailedMessage":"File generation failed due to no space left"},"$$ref":"#/components/examples/FileGenerationFailureReq"}}}}},"responses":{"200":{"description":"File generation status accepted"},"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/FileGeneration400"}}}}},"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/FileGeneration500"}}}}}},"x-roles-required":"vmanage-http-stream,System-read,System-write","__originalOperationId":"handleFileGenerationStatusResponseFromDevice","method":"post","path":"/device/file-based/data-collection/file-generation-status"}}