LSH Download External Client API

{"swagger":"2.0","info":{"title":"lsh-download-ext-client","version":"1.0.0"},"paths":{"/download":{"post":{"description":"Initiate a download request for LSH data exports. The request will be processed asynchronously, and the client can check the status and retrieve the download link using the history endpoint.","consumes":["application/json"],"parameters":[{"name":"X-ApiKey","in":"header","required":true,"type":"string","description":"API key for authentication."},{"name":"downloadRequest","in":"body","required":true,"description":"Download request payload.","schema":{"type":"object","properties":{"notificationTypes":{"type":"array","items":{"type":"string"}},"exportName":{"type":"string"},"exportFormat":{"type":"string"},"params":{"type":"object","properties":{"notificationTypes":{"type":"array","items":{"type":"string"}}}}},"required":["notificationTypes","exportName","exportFormat","params"],"example":{"notificationTypes":["email"],"exportName":"pt_stryker_date_exportId.csv","exportFormat":"csv","params":{"notificationTypes":["email"]}}}}],"responses":{"200":{"schema":{"type":"object","properties":{"exportId":{"type":"integer"}},"example":{"exportId":34377}}}}}},"/history":{"post":{"description":"Retrieve the history of LSH data export requests. This endpoint allows clients to query past export requests and their statuses.","consumes":["application/json"],"parameters":[{"name":"X-ApiKey","in":"header","required":true,"type":"string","description":"API key for authentication."},{"name":"historyRequest","in":"body","required":true,"description":"History request payload.","schema":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"filterCriteria":{"type":"object","properties":{"jobStatus":{"type":"array","items":{"type":"string","enum":["SUCCESSFUL","FAILED","PROCESSING"]}},"expired":{"type":"boolean"},"exportFormat":{"type":"string"}}}},"required":["limit","offset","filterCriteria"],"example":{"limit":10,"offset":0,"filterCriteria":{"jobStatus":["SUCCESSFUL","FAILED","PROCESSING"],"expired":false,"exportFormat":"csv"}}}}],"responses":{"200":{"description":"History records retrieved successfully.","schema":{"type":"object","properties":{"exportHistory":{"type":"array","items":{"type":"object","properties":{"requestId":{"type":"integer"},"jobStatus":{"type":"string"},"jobRequestPayload":{"type":"string"},"s3Key":{"type":"string"},"s3SignedUrl":{"type":"string"},"s3SignedUrlExpiry":{"type":"string","format":"date-time","x-nullable":true},"exportFileName":{"type":"string"},"exportFormat":{"type":"string"},"exportFileSizeTxt":{"type":"string","x-nullable":true},"createdOnTimestampMs":{"type":"integer","format":"int64"},"modifiedOnTimestampMs":{"type":"integer","format":"int64"},"errorDetails":{"type":"string"},"userId":{"type":"string"},"isExpired":{"type":"boolean"}}}},"totalRowCount":{"type":"integer"},"moreDataAvailable":{"type":"boolean"}},"example":{"exportHistory":[{"requestId":34380,"jobStatus":"SUCCESSFUL","jobRequestPayload":"{\"tenantId\":\"pt-stryker\",\"notificationTypes\":[\"email\"],\"exportName\":\"pt_stryker_date_exportId.csv\",\"exportFormat\":\"csv\",\"params\":{\"notificationTypes\":[\"email\"]}}","s3Key":"downloads_payload/pt-stryker_34380_20260311_144100_payload.json","s3SignedUrl":"signed_url_for_the_file","s3SignedUrlExpiry":1773845065863,"exportFileName":"pt_stryker_date_exportId.csv","exportFormat":"csv","exportFileSizeTxt":"936330936","createdOnTimestampMs":1773240060264,"modifiedOnTimestampMs":1773240060401,"errorDetails":null,"userId":"user_id_for_the_file","isExpired":false}],"totalRowCount":21,"moreDataAvailable":true}}}}}}},"securityDefinitions":{"key":{"type":"apiKey","in":"header","name":"X-ApiKey"}},"security":[{"key":[]}],"host":"api.clarivate.com","basePath":"/lsh-ds","schemes":["https"]}