{"type":"api","title":"Check if historical data exists for service","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/960a628c-2f33-3367-a4ec-faca586888c5","info":{"title":"Service Health Historical Data APIs","description":"APIs for requesting historical data recorded by the Crosswork Service Health application.","termsOfService":"terms-of-service","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"7.1.0"},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/ServiceHealth/sh_application_overview.md"}},"openapi":"3.0.1","servers":[{"url":"/crosswork/aa/aaapp/v1/"}],"securitySchemes":{"bearerAuth":{"type":"apiKey","description":"Security token for authorizing requests for these APIs.","name":"Authorization","in":"header"}}},"spec":{"tags":["AaApplication"],"summary":"Check if historical data exists for service.","operationId":"AaApplication_CheckHistoricalDataExists","requestBody":{"description":"The historicalServiceRequest parameter.","content":{"application/json":{"schema":{"type":"object","description":"Request - Historical Service","properties":{"serviceId":{"description":"Service-id","type":"string"},"eosTimestamp":{"description":"EOS timestamp","type":"string","format":"int64"},"numOfDays":{"description":"Duration - Number of days","type":"integer","format":"int32"},"serviceType":{"description":"Type of the service","type":"string"},"vpnNodeIds":{"description":"Device Ids or Endpoints of the service","type":"array","items":{"type":"string"}},"graphOnly":{"description":"When set to true will return graph minimal data for consumers like UI to render VPN graph","type":"boolean"}},"$$ref":"#/components/schemas/HistoricalServiceRequest"},"example":{"service_id":"ietf-l2vpn-ntw:l2vpn-ntw/vpn-services/vpn-service=l2nm-evpn-01_sr","num_of_days":1}}},"required":true},"responses":{"200":{"description":"OK. The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","description":"Check if historical data exists for the given Service","properties":{"archiveDataExists":{"description":"True if historical data exists for the given Service","type":"boolean"},"status":{"type":"string","description":"Request - Status mapping","default":"UNKNOWN_STATUS","enum":["UNKNOWN_STATUS","SERVICE_DOESNT_EXIST","BAD_REQUEST_SCHEMA","SUCCESS","ERROR"],"$$ref":"#/components/schemas/checkHistoricalDataExistsResponseStatus"},"error":{"type":"string","description":"Error details in case the request failed."}},"$$ref":"#/components/schemas/checkHistoricalDataExistsResponse"},"example":{"data":[{"archive_data_exists":true,"status":"SUCCESS"}]}}}},"default":{"description":"A default value response.","content":{"application/json":{"schema":{"description":"Gateway Runtime Error","type":"object","properties":{"error":{"description":"Error","type":"string"},"code":{"description":"Code","type":"integer","format":"int32"},"message":{"description":"Message","type":"string"},"details":{"description":"Details","type":"array","items":{"description":"Protobuf any","type":"object","properties":{"typeUrl":{"description":"Type URL","type":"string"},"value":{"description":"Value","pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string","format":"byte"}},"$$ref":"#/components/schemas/protobufAny"}}},"$$ref":"#/components/schemas/GatewayRuntimeError"},"example":{"data":[{"status":"SUCCESS"}]}}}}},"x-codegen-request-body-name":"body","__originalOperationId":"AaApplication_CheckHistoricalDataExists","security":[{"bearerAuth":[]}],"method":"post","path":"/historicaldatacheck"}}