{"swagger":"2.0","info":{"description":"

QIAGEN offers the API Explorer to help new developers gain access to the potential capabilities offered by the QIAGEN Clinical Insight (QCI) platform.

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).

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 here to get access to a QCI-Translational trial license.

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).

To use the API explorer as an authenticated user please use the following steps:
","title":"Datastream API","contact":{},"license":{}},"host":"api.ingenuity.com","basePath":"/","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"}],"schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/v1/clinical":{"get":{"tags":["Test Endpoints"],"summary":"Search for submitted tests satisfying user-supplied criteria.","operationId":"listDataPackagesUsingGET_1","parameters":[{"name":"endReceivedDate","in":"query","description":"End of the range of dates to search format: yyyy-mm-dd.","required":false,"type":"string","format":"date","allowEmptyValue":false},{"name":"sort","in":"query","description":"Order for the list of results. (receivedDateDesc - default)","required":false,"type":"string","allowEmptyValue":false,"enum":["receivedDateAsc","receivedDateDesc"]},{"name":"startReceivedDate","in":"query","description":"Beginning of the range of dates to search format: yyyy-mm-dd.","required":false,"type":"string","format":"date","allowEmptyValue":false},{"name":"state","in":"query","description":"Limit search results to tests in a specific state.","required":false,"type":"string","allowEmptyValue":false,"enum":["pending","in_review","needs_approval","final","cancelled"]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ApiSearchAttribute"}}},"400":{"description":"Bad request - Request Parameter value is not recognized"},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided"},"405":{"description":"Invalid input"},"406":{"description":"Not Acceptable"},"500":{"description":"An unexpected server error has occurred, please notify support"}},"security":[{"Authorization":["global"]}],"deprecated":false}},"/v2/workflow-log":{"get":{"tags":["Test Endpoints"],"summary":"Exporting the state change history in a TSV file","operationId":"getStateChangeHistoryUsingGET_1","produces":["application/octet-stream"],"parameters":[{"name":"endDate","in":"query","description":"End of the range of dates to search format: yyyy-mm-dd.","required":true,"type":"string","format":"date"},{"name":"startDate","in":"query","description":"Beginning of the range of dates to search format: yyyy-mm-dd.","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"Successful export of the state change history","examples":{"application/octet-stream":"accessionId\tdataPackageId\ttestProductProfile\tauthor\ttime\tstate\nJaneDoe123\tDP_123456789\tMy Tpp\texample@qiagen.com\t01/30/2024 01:01:51 AM\tQUEUED\nJaneDoe123\tDP_123456789\tMy Tpp\tsystem@qiagen.com\t01/30/2024 01:01:53 AM\tRUNNING\nJaneDoe123\tDP_123456789\tMy Tpp\tsystem@qiagen.com\t01/30/2024 02:00:04 AM\tFAILED"},"schema":{"type":"string"}},"400":{"description":"Bad Request - The specified time interval in larger than the max. allowed value","schema":{"$ref":"#/definitions/StateChangeHistoryErrorMessage"}},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided"},"429":{"description":"Too Many Requests - if the number of concurrent requests with the current api token exceed the 5 limit"},"500":{"description":"An unexpected server error has occurred, please notify support"}},"security":[{"Authorization":["global"]}],"deprecated":false}},"/v1/datapackages":{"post":{"tags":["Test Endpoints"],"summary":"Submit a New Test","operationId":"simpleUploadAndAnalyzeUsingPOST_1","parameters":[{"name":"file","in":"formData","description":"Zip, bz2 or gz file containing primary data and metadata files.","required":true,"type":"file"}],"responses":{"200":{"description":"OK"},"201":{"description":"Created","schema":{"$ref":"#/definitions/DataPackageMetadataDTO"}},"400":{"description":"Bad Request - The server cannot or will not process the request due to an apparent client error"},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided"},"405":{"description":"Invalid input - a request method is not supported for the requested resource"},"429":{"description":"Too Many Requests - if the number of concurrent requests with the current api token exceed the 10 limit"},"500":{"description":"An unexpected server error has occurred, please notify support "}},"security":[{"Authorization":["global"]}],"deprecated":false}},"/v2/sample":{"post":{"tags":["Test Endpoints"],"summary":"Submit a New Sample","operationId":"sampleOnlyUploadUsingPOST_1","parameters":[{"name":"file","in":"formData","description":"Zip, bz2 or gz file containing primary data and metadata files.","required":true,"type":"file"}],"responses":{"200":{"description":"OK"},"201":{"description":"Created","schema":{"$ref":"#/definitions/DataPackageMetadataDTO"}},"400":{"description":"Bad Request - if the request doesn't contain a readable file item"},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided"},"403":{"description":"Forbidden"},"405":{"description":"Invalid input - a request method is not supported for the requested resource"},"429":{"description":"Too Many Requests - if the number of concurrent requests with the current api token exceed the 10 limit"},"500":{"description":"An unexpected server error has occurred, please notify support "}},"security":[{"Authorization":["global"]}],"deprecated":false}},"/v2/variantAssessment/{id}":{"put":{"tags":["Test Endpoints"],"summary":"Update assessment for one variant in an existing QCI test.","operationId":"setVariantAssessmentUsingPUT_1","parameters":[{"name":"id","in":"path","description":"Data package ID or Accession ID","required":true,"type":"string"},{"in":"body","name":"request","required":false,"schema":{"$ref":"#/definitions/VariantAssessmentRequestV2"}}],"responses":{"200":{"description":"Variant assessment successfully updated","schema":{"$ref":"#/definitions/VariantAssessmentResponseDTOV2"}},"400":{"description":"invalid accession id\t\n\t\ninvalid variant\t\n\t\ninvalid assessment value\t\n\t\ninvalid actionability value\t\n\t\ninvalid phenotype value\t\n\t\ninvalid status value\t\n\t\ncomment size exceeds max allowable (4000 chars)\t\n\t\naccession {analysisId} status does not allow setting assessment\t\n\t\ninvalid author value","schema":{"$ref":"#/definitions/VariantAssessmentResponseDTOV2"}},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided"},"403":{"description":"author does not have access to this accession id","schema":{"$ref":"#/definitions/VariantAssessmentResponseDTOV2"}},"405":{"description":"Invalid input","schema":{"$ref":"#/definitions/VariantAssessmentResponseDTOV2"}},"500":{"description":"An unexpected server error has occurred, please notify support","schema":{"$ref":"#/definitions/VariantAssessmentResponseDTOV2"}}},"security":[{"Authorization":["global"]}],"deprecated":false}},"/v1/datapackages/{id}":{"get":{"tags":["Test Endpoints"],"summary":"Check the data processing status of an existing test","operationId":"retrieveDataPackageInfoUsingGET_3","parameters":[{"name":"id","in":"path","description":"Data package ID or Accession ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DataPackageMetadataDTO"}},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided"},"404":{"description":"Data package was not found"},"405":{"description":"Invalid input"},"429":{"description":"Too Many Requests - if the number of concurrent requests with the current api token exceed the 10 limit"},"500":{"description":"An unexpected server error has occurred, please notify support"}},"security":[{"Authorization":["global"]}],"deprecated":false}},"/v1/datapackages/{id}/users":{"post":{"tags":["Test Endpoints"],"summary":"Share a test with a group or list of users","operationId":"shareWithUsingPOST_1","parameters":[{"name":"id","in":"path","description":"Data package ID or Accession ID","required":true,"type":"string"},{"in":"body","name":"user","description":"Group or user to share datapackage","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/EmailDTO"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"Bad Request - Data package is not done processing, wait until DP status = DONE before adding additional users to the data package"},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided"},"403":{"description":"Forbidden - Requester must own the data package in order to append additional users"},"404":{"description":"Not Found - Specified Data Package ID does not exist"}},"security":[{"Authorization":["global"]}],"deprecated":false}},"/v1/export/{id}":{"get":{"tags":["Test Endpoints"],"summary":"Fetch interpreted variants, annotated with various data sources. Fetch reports of the test","operationId":"retrieveDataPackageInfoUsingGET_2","parameters":[{"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.","required":false,"type":"string"},{"name":"id","in":"path","description":"Data package ID or Accession ID","required":true,"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,"type":"string","enum":["vcf","reportXml","html","pdf"]}],"responses":{"200":{"description":"Returns HTTPS stream of annotated VCF file"},"299":{"description":"Use of deprecated view parameter: view=xml, recommended use: view=report"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided"},"403":{"description":"Forbidden - Unable to export by email"},"404":{"description":"Data Package or Accession Id was not found"},"405":{"description":"Invalid input"},"429":{"description":"Too Many Requests - if the number of concurrent requests with the current api token exceed the 10 limit"},"500":{"description":"An unexpected server error has occurred, please notify support "}},"security":[{"Authorization":["global"]}],"deprecated":false}},"/v1/testState/{id}":{"post":{"tags":["Test Endpoints"],"summary":"Change the state of an existing test","operationId":"changeTestStateUsingPOST_1","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/StateChangeBodyContent"}},{"name":"id","in":"path","description":"Data package ID or Accession ID","required":true,"type":"string"}],"responses":{"200":{"description":"Successful state change of the test\nIf there was no change applied, the following code is returned:\n\tds.api.test.state.nothing.applied","schema":{"$ref":"#/definitions/StateChangeSuccessResponse"}},"400":{"description":"Invalid input\nPossible error codes:\n\tds.api.test.state.null.state\tds.api.test.state.note.length.size.exceeded\n\tds.api.test.state.invalid.parameter","schema":{"$ref":"#/definitions/SignOutFailureResponse"}},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided","schema":{"$ref":"#/definitions/SignOutFailureResponse"}},"404":{"description":"Data package was not found","schema":{"$ref":"#/definitions/SignOutFailureResponse"}},"500":{"description":"An unexpected server error has occurred, please notify support","schema":{"$ref":"#/definitions/SignOutFailureResponse"}}},"security":[{"Authorization":["global"]}],"deprecated":false}},"/v1/signout/{id}":{"post":{"tags":["Test Endpoints"],"summary":"Signout of an existing test","operationId":"signOutAnalysisUsingPOST_1","parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SignOutBodyContent"}},{"name":"id","in":"path","description":"Data package ID or Accession ID","required":true,"type":"string"}],"responses":{"200":{"description":"Successful signout of the test","schema":{"$ref":"#/definitions/SignOutSuccessResponse"}},"400":{"description":"Invalid input","schema":{"$ref":"#/definitions/SignOutFailureResponse"}},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided","schema":{"$ref":"#/definitions/SignOutFailureResponse"}},"404":{"description":"Data package was not found","schema":{"$ref":"#/definitions/SignOutFailureResponse"}},"500":{"description":"An unexpected server error has occurred, please notify support","schema":{"$ref":"#/definitions/SignOutFailureResponse"}}},"security":[{"Authorization":["global"]}],"deprecated":false}},"/v1/testProductProfiles":{"get":{"tags":["Test Product Profile Service"],"summary":"Receive all test product profiles","operationId":"getTestProductProfilesUsingGET_1","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TppAssessmentsDTO"}},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided"},"500":{"description":"An unexpected server error has occurred, please notify support "}},"security":[{"Authorization":["global"]}],"deprecated":false}},"/v1/qciGroups/{group_name}/testProductProfiles/{tpp_name}":{"get":{"tags":["Test Product Profile Service"],"summary":"Receive one test product profile","operationId":"getTestProductProfileUsingGET_1","produces":["application/json"],"parameters":[{"name":"group_name","in":"path","description":"Group name","required":true,"type":"string"},{"name":"tpp_name","in":"path","description":"Test Product Profile","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TppAssessmentDTO"}},"401":{"description":"Unauthorized - authentication is required and has failed or has not yet been provided"},"404":{"description":"TPP not found\nUser Group not found","schema":{"$ref":"#/definitions/TppErrorMessageDTO"}},"500":{"description":"An unexpected server error has occurred, please notify support "}},"security":[{"Authorization":["global"]}],"deprecated":false}},"/v2/ping":{"get":{"tags":["Health Check"],"summary":"Ping the server to get a global status of the underlying services.","operationId":"pingUsingGET_1","produces":["application/json"],"responses":{"200":{"description":"Global information about the underlying services.","schema":{"$ref":"#/definitions/PingDTO"}},"401":{"description":"Authentication is required and has failed or has not yet been provided."},"404":{"description":"API is not available"},"500":{"description":"Something went wrong while providing information about the underlying services."}},"security":[{"Authorization":["global"]}],"deprecated":false}}},"securityDefinitions":{"Authorization":{"type":"apiKey","name":"Authorization","in":"header"}},"definitions":{"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"}},"title":"ApiSearchAttribute"},"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"}},"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":"#/definitions/WarningDTO"}}},"title":"DataPackageMetadataDTO"},"EmailDTO":{"type":"object","properties":{"email":{"type":"string","example":"john.doe@abcd.com"}},"title":"EmailDTO"},"File":{"type":"object","properties":{"absolute":{"type":"boolean"},"absoluteFile":{"$ref":"#/definitions/File"},"absolutePath":{"type":"string"},"canonicalFile":{"$ref":"#/definitions/File"},"canonicalPath":{"type":"string"},"directory":{"type":"boolean"},"file":{"type":"boolean"},"freeSpace":{"type":"integer","format":"int64"},"hidden":{"type":"boolean"},"name":{"type":"string"},"parent":{"type":"string"},"parentFile":{"$ref":"#/definitions/File"},"path":{"type":"string"},"totalSpace":{"type":"integer","format":"int64"},"usableSpace":{"type":"integer","format":"int64"}},"title":"File"},"InputStream":{"type":"object","title":"InputStream"},"InputStreamResource":{"type":"object","properties":{"description":{"type":"string"},"file":{"$ref":"#/definitions/File"},"filename":{"type":"string"},"inputStream":{"$ref":"#/definitions/InputStream"},"open":{"type":"boolean"},"readable":{"type":"boolean"},"uri":{"$ref":"#/definitions/URI"},"url":{"$ref":"#/definitions/URL"}},"title":"InputStreamResource"},"PingDTO":{"type":"object","properties":{"globalStatus":{"type":"string","example":"OK/NOT_OK","enum":["OK","NOT_OK"]},"lastUpdated":{"type":"string","format":"date-time","example":"2023-03-30 17:28:00"}},"title":"PingDTO"},"SignOutBodyContent":{"type":"object","properties":{"note":{"type":"string","example":"some note"}},"title":"SignOutBodyContent"},"SignOutFailureResponse":{"type":"object","properties":{"code":{"type":"string","example":"the.error.code"},"message":{"type":"string","example":"The error message"},"status":{"type":"string","enum":["failed"]}},"title":"SignOutFailureResponse"},"SignOutSuccessResponse":{"type":"object","properties":{"author":{"type":"string","example":"author_of_the_test"},"note":{"type":"string","example":"some note"},"signoutDate":{"type":"integer","format":"int64","example":1234567},"status":{"type":"string","enum":["success"]}},"title":"SignOutSuccessResponse"},"StateChangeBodyContent":{"type":"object","properties":{"note":{"type":"string","example":"some note (max. 4000 characters including formatting)"},"state":{"type":"string","example":"PENDING / IN_REVIEW / NEEDS_APPROVAL / CANCELLED","enum":["PENDING","IN_REVIEW","NEEDS_APPROVAL","CANCELLED"]}},"title":"StateChangeBodyContent"},"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}},"title":"StateChangeHistoryErrorMessage"},"StateChangeSuccessResponse":{"type":"object","properties":{"author":{"type":"string","example":"author_of_the_test"},"note":{"type":"string","example":"some note"},"status":{"type":"string","enum":["success"]}},"title":"StateChangeSuccessResponse"},"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"}}},"title":"TppAssessmentDTO"},"TppAssessmentsDTO":{"type":"object","properties":{"assessments":{"type":"array","items":{"$ref":"#/definitions/TppAssessmentDTO"}}},"title":"TppAssessmentsDTO"},"TppErrorMessageDTO":{"type":"object","properties":{"errorCode":{"type":"string","example":404},"message":{"type":"string","example":"Test Product Profile/User group not found: {name}"}},"title":"TppErrorMessageDTO"},"URI":{"type":"object","properties":{"absolute":{"type":"boolean"},"authority":{"type":"string"},"fragment":{"type":"string"},"host":{"type":"string"},"opaque":{"type":"boolean"},"path":{"type":"string"},"port":{"type":"integer","format":"int32"},"query":{"type":"string"},"rawAuthority":{"type":"string"},"rawFragment":{"type":"string"},"rawPath":{"type":"string"},"rawQuery":{"type":"string"},"rawSchemeSpecificPart":{"type":"string"},"rawUserInfo":{"type":"string"},"scheme":{"type":"string"},"schemeSpecificPart":{"type":"string"},"userInfo":{"type":"string"}},"title":"URI"},"URL":{"type":"object","properties":{"authority":{"type":"string"},"content":{"type":"object"},"defaultPort":{"type":"integer","format":"int32"},"file":{"type":"string"},"host":{"type":"string"},"path":{"type":"string"},"port":{"type":"integer","format":"int32"},"protocol":{"type":"string"},"query":{"type":"string"},"ref":{"type":"string"},"userInfo":{"type":"string"}},"title":"URL"},"VariantAssessmentRequestV2":{"type":"object","properties":{"actionability":{"type":"string","example":"1A"},"alternate":{"type":"string","example":"G"},"assessment":{"type":"string","example":"Likely Pathogenic"},"author":{"type":"string","example":"john.doe@abcd.com"},"chromosome":{"type":"string","example":18},"comment":{"type":"string","example":"Pathogenic   Cancers and Tumors   Reportable"},"phenotype":{"type":"string","example":"Cardiomyopathy"},"position":{"type":"integer","format":"int32","example":55238820},"reference":{"type":"string","example":"A"},"status":{"type":"string","example":"Reportable"}},"title":"VariantAssessmentRequestV2"},"VariantAssessmentResponseDTOV2":{"type":"object","properties":{"code":{"type":"string","example":"the.response.code"},"message":{"type":"string","example":"The response message"},"status":{"type":"integer","format":"int32","example":"The status code (ex. 200; 400)"},"warning":{"type":"string","example":"The warning message in case if there is any"}},"title":"VariantAssessmentResponseDTOV2"},"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":"#/definitions/WarningDetailsDTO"}},"title":"WarningDTO"},"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"}},"title":"WarningDetailsDTO"}}}