{"openapi":"3.0.1","info":{"title":"Datastream API","description":"<p>QIAGEN offers the API Explorer to help new developers gain access to the potential capabilities offered by the QIAGEN Clinical Insight (QCI) platform. </p><p>QCI serves both the clinical and translational research users in two flavors of the application: QIAGEN Clinical Insight - Interpret (QCI-I) and QIAGEN Clinical Insight - Translational (QCI-T).</p><p>By logging into this tool, the API Explorer will present the specific API endpoints available to your license. If you do not already have a license, please click <a href=\"https://apps.tr.qiagenbioinformatics.com/isa/account/protected/signup/qcit\" target=\"_blank\">here</a> to get access to a QCI-Translational trial license.</p><p>It is possible to interact with this tool without logging into the platform; however, by authenticating a developer can interface with the platform through the tool (i.e. send cases directly to the platform and get real output from QCI).</p>To use the API explorer as an authenticated user please use <a id=\"collapsibleSteps\" role=\"button\">the following steps:</a><div id=\"collapseSteps\"><ul><li>Click <a href=\"https://apps.tr.qiagenbioinformatics.com/qiaoauth/tokens?client_name=QCI Oauth credential for API Explorer\" target=\"_blank\">this link</a> to open a tab into the QIAGEN OAuth 2.0 User Interface (QiaOAuth).</li><li>Log into the QiaOAuth server with your QIAGEN Digital Insights username/password.</li><li>In the My Tokens menu, click the button labeled \"Generate token\" next to the row labeled \"QCI OAuth credential for API Explorer\".</li><li>A window will pop up with a long string of letters and numbers and an expiration date at the bottom of the window. Click \"Copy to clipboard\" to copy this string to your clipboard then click the close button.</li><li>Switch back to the API Explorer tab and click the Authorize button.</li><li>Paste the Authentication token string into the text field on this page and click the Authorize button on this popup.</li><li>Note that all of the lock icons on this page are now closed/secured.</li><li>Now you can use any of the endpoints on this page to interface with the QCI Application. Samples submitted and analyses performed may count against your pre-paid license.</li></ul></div>"},"servers":[{"url":"https://api.tr.qiagenbioinformatics.com/datastream/api","description":"Generated server url"}],"security":[{"api_key":["read","write"]}],"tags":[{"name":"Test Endpoints","description":"Test Endpoints Description"},{"name":"Test Product Profile Service","description":"Available for external use of TPPs"},{"name":"Health Check","description":"Health Check Endpoint"}],"paths":{"/v2/ping":{"get":{"tags":["Health Check"],"summary":"Ping the server to get a global status of the underlying services.","operationId":"ping","responses":{"401":{"description":"Authentication is required and has failed or has not yet been provided.","content":{"application/json":{}}},"200":{"description":"Global information about the underlying services.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PingDTO"}}}},"500":{"description":"Something went wrong while providing information about the underlying services.","content":{"application/json":{}}},"404":{"description":"API is not available","content":{"application/json":{}}}}}},"/v1/clinical":{"get":{"tags":["Test Endpoints"],"summary":"Search for submitted tests satisfying user-supplied criteria.","operationId":"1","parameters":[{"name":"state","in":"query","description":"Limit search results to tests in a specific state.","required":false,"schema":{"type":"string","enum":["pending","in_review","needs_approval","final","cancelled"]}},{"name":"startReceivedDate","in":"query","description":"Beginning of the range of dates to search format: yyyy-mm-dd.","required":false,"schema":{"type":"date"}},{"name":"endReceivedDate","in":"query","description":"End of the range of dates to search format: yyyy-mm-dd.","required":false,"schema":{"type":"date"}},{"name":"sort","in":"query","description":"Order for the list of results. (receivedDateDesc - default)","required":false,"schema":{"type":"string","enum":["receivedDateAsc","receivedDateDesc"]}}],"responses":{"400":{"description":"Bad request - Request Parameter value is not recognized","content":{"application/json":{}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiSearchAttribute"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{}}},"405":{"description":"Invalid input","content":{"application/json":{}}},"500":{"description":"An unexpected server error has occurred, please notify support","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided","content":{"application/json":{}}}}}},"/v2/workflow-log":{"get":{"tags":["Test Endpoints"],"summary":"Exporting the state change history in a TSV file","operationId":"2","parameters":[{"name":"startDate","in":"query","description":"Beginning of the range of dates to search format: yyyy-mm-dd.","required":true,"schema":{"type":"string","format":"date"}},{"name":"endDate","in":"query","description":"End of the range of dates to search format: yyyy-mm-dd.","required":true,"schema":{"type":"string","format":"date"}}],"responses":{"400":{"description":"Bad Request - The specified time interval in larger than the max. allowed value","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateChangeHistoryErrorMessage"}}}},"500":{"description":"An unexpected server error has occurred, please notify support","content":{"application/json":{}}},"200":{"description":"Successful export of the state change history","content":{"application/octet-stream":{"schema":{"type":"string"}}}},"429":{"description":"Too Many Requests - if the number of concurrent requests with the current api token exceed the {definedLimit} limit","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided","content":{"application/json":{}}}}}},"/v1/datapackages":{"post":{"tags":["Test Endpoints"],"summary":"Submit a New Test","operationId":"3","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadBody"}}},"required":true},"responses":{"400":{"description":"Bad Request - The server cannot or will not process the request due to an apparent client error","content":{"application/json":{}}},"405":{"description":"Invalid input - a request method is not supported for the requested resource"},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataPackageMetadataDTO"}}}},"429":{"description":"Too Many Requests - if the number of concurrent requests with the current api token exceed the {definedLimit} limit"},"500":{"description":"An unexpected server error has occurred, please notify support "},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided"}}}},"/v2/sample":{"post":{"tags":["Test Endpoints"],"summary":"Submit a New Sample","operationId":"4","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadBody"}}},"required":true},"responses":{"400":{"description":"Bad Request - if the request doesn't contain a readable file item","content":{"application/json":{}}},"405":{"description":"Invalid input - a request method is not supported for the requested resource"},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataPackageMetadataDTO"}}}},"429":{"description":"Too Many Requests - if the number of concurrent requests with the current api token exceed the {definedLimit} limit"},"500":{"description":"An unexpected server error has occurred, please notify support "},"403":{"description":"Forbidden"},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided"}}}},"/v2/variantAssessment/{id}":{"put":{"tags":["Test Endpoints"],"summary":"Update assessment for one variant in an existing QCI test.","operationId":"5","parameters":[{"name":"id","in":"path","description":"Data package ID or Accession ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariantAssessmentRequestV2"}}},"required":true},"responses":{"403":{"description":"author does not have access to this accession id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariantAssessmentResponseDTOV2"}}}},"200":{"description":"Variant assessment successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariantAssessmentResponseDTOV2"}}}},"400":{"description":"invalid accession id<br/>invalid variant<br/>invalid assessment value<br/>invalid actionability value<br/>invalid phenotype value<br/>invalid status value<br/>comment size exceeds max allowable (4000 chars)<br/>accession {analysisId} status does not allow setting assessment<br/>invalid author value","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariantAssessmentResponseDTOV2"}}}},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided"},"405":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariantAssessmentResponseDTOV2"}}}},"500":{"description":"An unexpected server error has occurred, please notify support","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariantAssessmentResponseDTOV2"}}}}}}},"/v1/datapackages/{id}":{"get":{"tags":["Test Endpoints"],"summary":"Check the data processing status of an existing test","operationId":"6","parameters":[{"name":"id","in":"path","description":"Data package ID or Accession ID","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{}}},"404":{"description":"Data package was not found","content":{"application/json":{}}},"405":{"description":"Invalid input","content":{"application/json":{}}},"500":{"description":"An unexpected server error has occurred, please notify support","content":{"application/json":{}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataPackageMetadataDTO"}}}},"429":{"description":"Too Many Requests - if the number of concurrent requests with the current api token exceed the {definedLimit} limit","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided","content":{"application/json":{}}}}}},"/v1/datapackages/{id}/users":{"post":{"tags":["Test Endpoints"],"summary":"Share a test with a group or list of users","operationId":"7","parameters":[{"name":"id","in":"path","description":"Data package ID or Accession ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Group or user to share datapackage","items":{"$ref":"#/components/schemas/EmailDTO"}}}},"required":true},"responses":{"400":{"description":"Bad Request - Data package is not done processing, wait until DP status = DONE before adding additional users to the data package","content":{"application/json":{}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"404":{"description":"Not Found - Specified Data Package ID does not exist","content":{"application/json":{}}},"403":{"description":"Forbidden - Requester must own the data package in order to append additional users","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided","content":{"application/json":{}}}}}},"/v1/export/{id}":{"get":{"tags":["Test Endpoints"],"summary":"Fetch interpreted variants, annotated with various data sources. Fetch reports of the test","operationId":"8","parameters":[{"name":"id","in":"path","description":"Data package ID or Accession ID","required":true,"schema":{"type":"string"}},{"name":"view","in":"query","description":"Test resource to export. Can be vcf (default: variant VCF file with QIAGEN Clinical Insight Interpret annotations), reportXml (test report in XML), html (test report as a HTML file for supported report templates), or pdf (test report in PDF template).","required":false,"schema":{"type":"string","enum":["vcf","reportXml","html","pdf"]}},{"name":"email","in":"query","description":"Perform the export on behalf of this user's email account. If none provided, defaults to the first user on the user list for the data package.","schema":{"type":"string"}}],"responses":{"403":{"description":"Forbidden - Unable to export by email","content":{"application/json":{}}},"400":{"description":"Bad Request","content":{"application/json":{}}},"404":{"description":"Data Package or Accession Id was not found","content":{"application/json":{}}},"500":{"description":"An unexpected server error has occurred, please notify support ","content":{"application/json":{}}},"405":{"description":"Invalid input","content":{"application/json":{}}},"200":{"description":"Returns HTTPS stream of annotated VCF file"},"299":{"description":"Use of deprecated view parameter: view=xml, recommended use: view=report"},"429":{"description":"Too Many Requests - if the number of concurrent requests with the current api token exceed the {definedLimit} limit","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided","content":{"application/json":{}}}}}},"/v1/testState/{id}":{"post":{"tags":["Test Endpoints"],"summary":"Change the state of an existing test","operationId":"9","parameters":[{"name":"id","in":"path","description":"Data package ID or Accession ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateChangeBodyContent"}}},"required":true},"responses":{"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignOutFailureResponse"}}}},"400":{"description":"Invalid input<br/>Possible error codes:<br/>ds.api.test.state.null.state<br/>ds.api.test.state.note.length.size.exceeded<br/>ds.api.test.state.invalid.parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignOutFailureResponse"}}}},"200":{"description":"Successful state change of the test<br/>If there was no change applied, the following code is returned:<br/>ds.api.test.state.nothing.applied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateChangeSuccessResponse"}}}},"404":{"description":"Data package was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignOutFailureResponse"}}}},"500":{"description":"An unexpected server error has occurred, please notify support","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignOutFailureResponse"}}}}}}},"/v1/signout/{id}":{"post":{"tags":["Test Endpoints"],"summary":"Signout of an existing test","operationId":"10","parameters":[{"name":"id","in":"path","description":"Data package ID or Accession ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignOutBodyContent"}}},"required":true},"responses":{"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignOutFailureResponse"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignOutFailureResponse"}}}},"404":{"description":"Data package was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignOutFailureResponse"}}}},"500":{"description":"An unexpected server error has occurred, please notify support","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignOutFailureResponse"}}}},"200":{"description":"Successful signout of the test","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignOutSuccessResponse"}}}}}}},"/v1/testProductProfiles":{"get":{"tags":["Test Product Profile Service"],"summary":"Receive all test product profiles","operationId":"31","responses":{"500":{"description":"An unexpected server error has occurred, please notify support ","content":{"application/json":{}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TppAssessmentsDTO"}}}},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided","content":{"application/json":{}}}}}},"/v1/qciGroups/{group_name}/testProductProfiles/{tpp_name}":{"get":{"tags":["Test Product Profile Service"],"summary":"Receive one test product profile","operationId":"32","parameters":[{"name":"group_name","in":"path","description":"Group name","required":true,"schema":{"type":"string"}},{"name":"tpp_name","in":"path","description":"Test Product Profile","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"An unexpected server error has occurred, please notify support ","content":{"application/json":{}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TppAssessmentDTO"}}}},"404":{"description":"TPP not found\nUser Group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TppErrorMessageDTO"}}}},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided","content":{"application/json":{}}}}}}},"components":{"schemas":{"StateChangeHistoryErrorMessage":{"type":"object","properties":{"code":{"type":"string","example":"ds.error.code"},"message":{"type":"string","example":"This is the cause of the problem."},"status":{"type":"integer","format":"int32","example":400}}},"VariantAssessmentRequestV2":{"type":"object","properties":{"chromosome":{"type":"string","example":"18"},"position":{"type":"integer","format":"int32","example":55238820},"reference":{"type":"string","example":"A"},"alternate":{"type":"string","example":"G"},"assessment":{"type":"string","example":"Likely Pathogenic"},"status":{"type":"string","example":"Reportable"},"phenotype":{"type":"string","example":"Cardiomyopathy"},"actionability":{"type":"string","example":"1A"},"comment":{"type":"string","example":"Pathogenic &nbsp; Cancers and Tumors &nbsp; Reportable"},"author":{"type":"string","example":"john.doe@abcd.com"}}},"VariantAssessmentResponseDTOV2":{"type":"object","properties":{"code":{"type":"string","example":"the.response.code"},"message":{"type":"string","example":"The response message"},"status":{"type":"integer","description":"The status code (ex. 200; 400)","format":"int32","example":200},"warning":{"type":"string","example":"The warning message in case if there is any"}}},"FileUploadBody":{"type":"object","properties":{"file":{"type":"string","description":"Zip, bz2 or gz file containing primary data and metadata files.","format":"binary"}}},"DataPackageMetadataDTO":{"type":"object","properties":{"method":{"type":"string","example":"partner integration"},"creator":{"type":"string","example":"john.doe@abcd.com"},"users":{"type":"array","example":["john.doe@abcd.com"],"items":{"type":"string","example":"[\"john.doe@abcd.com\"]"}},"title":{"type":"string","example":"Demo Title"},"analysis-name":{"type":"string","example":"Demo Family Analysis v1"},"status":{"type":"string","example":"DONE"},"stage":{"type":"string","example":"Pipeline successfully completed"},"results-url":{"type":"string","example":"https://api.ingenuity.com/datastream/analysisStatus.jsp?packageId=DP_0001"},"status-url":{"type":"string","example":"https://api.ingenuity.com/v1/datapackages/DP_0001"},"pipeline-name":{"type":"string","example":"QCI Somatic Cancer Pipeline"},"precentage-complete":{"type":"integer","format":"int32","example":100},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningDTO"}}}},"WarningDTO":{"type":"object","properties":{"code":{"type":"string","example":"isatab.conditionally.recommended.field"},"message":{"type":"string","example":"s_DP_0001.txt: The characteristic Patient Name is missing."},"details":{"$ref":"#/components/schemas/WarningDetailsDTO"}}},"WarningDetailsDTO":{"type":"object","properties":{"fieldtype":{"type":"string","example":"characteristic"},"value":{"type":"string","example":"the Analysis Pipeline Name is QCI Somatic Cancer Pipeline"},"filename":{"type":"string","example":"s_DP_0001.txt"},"fieldname":{"type":"string","example":"Patient Name"}}},"StateChangeBodyContent":{"required":["state"],"type":"object","properties":{"state":{"type":"string","example":"PENDING / IN_REVIEW / NEEDS_APPROVAL / CANCELLED","enum":["PENDING","IN_REVIEW","NEEDS_APPROVAL","CANCELLED"]},"note":{"maxLength":4000,"minLength":0,"type":"string","example":"some note (max. 4000 characters including formatting)"}}},"SignOutFailureResponse":{"type":"object","properties":{"status":{"type":"string","enum":["failed"]},"code":{"type":"string","example":"the.error.code"},"message":{"type":"string","example":"The error message"}}},"StateChangeSuccessResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"author":{"type":"string","example":"author_of_the_test"},"note":{"type":"string","example":"some note"}}},"SignOutBodyContent":{"required":["note"],"type":"object","properties":{"note":{"maxLength":4000,"minLength":0,"type":"string","example":"some note"}}},"SignOutSuccessResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"author":{"type":"string","example":"author_of_the_test"},"note":{"type":"string","example":"some note"},"signout_date":{"type":"integer","format":"int64","example":1234567}}},"EmailDTO":{"type":"object","properties":{"email":{"type":"string","example":"john.doe@abcd.com"}}},"PingDTO":{"type":"object","properties":{"globalStatus":{"type":"string","example":"OK/NOT_OK","enum":["OK","NOT_OK"]},"lastUpdated":{"type":"string","format":"date-time"}}},"TppAssessmentDTO":{"type":"object","properties":{"qciGroupName":{"type":"string","example":"groupTest1"},"testProductProfile":{"type":"string","example":"productprofile.testproductprofile"},"testProductCode":{"type":"string","example":"HR_000031"},"reportTemplate":{"type":"string","example":"DemoReport"},"reportingMethod":{"type":"string","example":"T"},"indications":{"type":"string","example":"hereditary cancer-predisposing syndrome"},"workflowType":{"type":"string","example":"hereditary"},"treatmentsPolicy":{"type":"string","example":"treatmentsPolicy"},"trialsPolicy":{"type":"string","example":"trialsPolicy"},"genesTested":{"type":"array","items":{"type":"string"}},"fusionsTested":{"type":"array","items":{"type":"string"}},"cnvLossTested":{"type":"array","items":{"type":"string"}},"cnvGainTested":{"type":"array","items":{"type":"string"}},"preferredTranscripts":{"type":"array","items":{"type":"string"}}}},"TppAssessmentsDTO":{"type":"object","properties":{"assessments":{"type":"array","items":{"$ref":"#/components/schemas/TppAssessmentDTO"}}}},"TppErrorMessageDTO":{"type":"object","properties":{"code":{"type":"string","example":"404"},"message":{"type":"string","example":"Test Product Profile/User group not found: {name}"}}},"ApiSearchAttribute":{"type":"object","properties":{"dataPackageID":{"type":"string","example":"DP_0001"},"accessionID":{"type":"string","example":"CT54354"},"applicationUrl":{"type":"string","example":"https://variants.ingenuity.com/vcs/view/analysis/001"},"exportUrl":{"type":"string","example":"https://api.ingenuity.com/v1/export/DP_0001"},"state":{"type":"string","example":"IN_REVIEW"},"receivedDate":{"type":"string","example":"2018-05-17T05:17:28Z"}}}},"securitySchemes":{"api_key":{"type":"apiKey","description":"Api Key access","name":"Authorization","in":"header"}}}}