CIViC 2 API Documentation
Documentation for the CIViC GraphQL API
API Endpoints
https://civicdb.org/api/graphqlQueries
acmgCodesTypeahead
Description
Retrieve ACMG Code options as a typeahead
Response
Returns [AcmgCode!]!
Arguments
| Name | Description |
|---|---|
queryTerm - String!
|
Example
Query
query acmgCodesTypeahead($queryTerm: String!) {
acmgCodesTypeahead(queryTerm: $queryTerm) {
code
description
id
}
}
Variables
{"queryTerm": "xyz789"}
Response
{
"data": {
"acmgCodesTypeahead": [
{
"code": "xyz789",
"description": "abc123",
"id": 123
}
]
}
}
assertion
Description
Find an assertion by CIViC ID
Example
Query
query assertion($id: Int!) {
assertion(id: $id) {
acceptanceEvent {
...EventFragment
}
acmgCodes {
...AcmgCodeFragment
}
ampLevel
assertionDirection
assertionType
clingenCodes {
...ClingenCodeFragment
}
comments {
...CommentConnectionFragment
}
description
disease {
...DiseaseFragment
}
events {
...EventConnectionFragment
}
evidenceItems {
...EvidenceItemFragment
}
evidenceItemsCount
fdaCompanionTest
fdaCompanionTestLastUpdated
flagged
flags {
...FlagConnectionFragment
}
id
lastAcceptedRevisionEvent {
...EventFragment
}
lastCommentEvent {
...EventFragment
}
lastSubmittedRevisionEvent {
...EventFragment
}
link
molecularProfile {
...MolecularProfileFragment
}
name
nccnGuideline {
...NccnGuidelineFragment
}
nccnGuidelineVersion
phenotypes {
...PhenotypeFragment
}
regulatoryApproval
regulatoryApprovalLastUpdated
rejectionEvent {
...EventFragment
}
revisions {
...RevisionConnectionFragment
}
significance
status
submissionEvent {
...EventFragment
}
summary
therapies {
...TherapyFragment
}
therapyInteractionType
variantOrigin
}
}
Variables
{"id": 987}
Response
{
"data": {
"assertion": {
"acceptanceEvent": Event,
"acmgCodes": [AcmgCode],
"ampLevel": "NA",
"assertionDirection": "DOES_NOT_SUPPORT",
"assertionType": "DIAGNOSTIC",
"clingenCodes": [ClingenCode],
"comments": CommentConnection,
"description": "xyz789",
"disease": Disease,
"events": EventConnection,
"evidenceItems": [EvidenceItem],
"evidenceItemsCount": 987,
"fdaCompanionTest": false,
"fdaCompanionTestLastUpdated": ISO8601DateTime,
"flagged": true,
"flags": FlagConnection,
"id": 987,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"molecularProfile": MolecularProfile,
"name": "xyz789",
"nccnGuideline": NccnGuideline,
"nccnGuidelineVersion": "xyz789",
"phenotypes": [Phenotype],
"regulatoryApproval": true,
"regulatoryApprovalLastUpdated": ISO8601DateTime,
"rejectionEvent": Event,
"revisions": RevisionConnection,
"significance": "ADVERSE_RESPONSE",
"status": "ACCEPTED",
"submissionEvent": Event,
"summary": "xyz789",
"therapies": [Therapy],
"therapyInteractionType": "COMBINATION",
"variantOrigin": "COMMON_GERMLINE"
}
}
}
assertions
Description
List and filter assertions.
Response
Returns an AssertionConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
ampLevel - AmpLevel
|
Filtering on the AMP/ASCO/CAP category. |
assertionDirection - EvidenceDirection
|
Filtering on the assertion direction. |
assertionType - EvidenceType
|
Filtering on the assertion type. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
diseaseId - Int
|
Exact match filtering of the assertions based on the internal CIViC disease id |
diseaseName - String
|
Substring filtering on disease name. |
evidenceId - Int
|
Exact match filtering on the ID of evidence underlying the assertion. |
first - Int
|
Returns the first n elements from the list. |
id - Int
|
Exact match filtering on the ID of the assertion. |
last - Int
|
Returns the last n elements from the list. |
molecularProfileId - Int
|
Exact match filtering on the ID of the molecular_profile. |
molecularProfileName - String
|
Substring filtering on molecular profile name |
organizationId - Int
|
Exact match filtering on the ID of the organization the assertion was submitted under. |
phenotypeId - Int
|
Exact match filtering of the assertions based on the internal CIViC phenotype id |
significance - EvidenceSignificance
|
Filtering on the assertion's significance. |
sortBy - AssertionSort
|
Columm and direction to sort evidence on. |
status - EvidenceStatusFilter
|
Filtering on the status of the assertion. |
summary - String
|
Substring filtering on assertion description. |
therapyId - Int
|
Exact match filtering of the assertions based on the internal CIViC therapy id |
therapyName - String
|
Substring filtering on therapy name. |
userId - Int
|
Exact match filtering on the ID of the user who submitted the assertion. |
variantId - Int
|
Exact match filtering on the ID of the variant. |
variantName - String
|
Substring filtering on variant name. |
Example
Query
query assertions(
$after: String,
$ampLevel: AmpLevel,
$assertionDirection: EvidenceDirection,
$assertionType: EvidenceType,
$before: String,
$diseaseId: Int,
$diseaseName: String,
$evidenceId: Int,
$first: Int,
$id: Int,
$last: Int,
$molecularProfileId: Int,
$molecularProfileName: String,
$organizationId: Int,
$phenotypeId: Int,
$significance: EvidenceSignificance,
$sortBy: AssertionSort,
$status: EvidenceStatusFilter,
$summary: String,
$therapyId: Int,
$therapyName: String,
$userId: Int,
$variantId: Int,
$variantName: String
) {
assertions(
after: $after,
ampLevel: $ampLevel,
assertionDirection: $assertionDirection,
assertionType: $assertionType,
before: $before,
diseaseId: $diseaseId,
diseaseName: $diseaseName,
evidenceId: $evidenceId,
first: $first,
id: $id,
last: $last,
molecularProfileId: $molecularProfileId,
molecularProfileName: $molecularProfileName,
organizationId: $organizationId,
phenotypeId: $phenotypeId,
significance: $significance,
sortBy: $sortBy,
status: $status,
summary: $summary,
therapyId: $therapyId,
therapyName: $therapyName,
userId: $userId,
variantId: $variantId,
variantName: $variantName
) {
edges {
...AssertionEdgeFragment
}
nodes {
...AssertionFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"ampLevel": "NA",
"assertionDirection": "DOES_NOT_SUPPORT",
"assertionType": "DIAGNOSTIC",
"before": "xyz789",
"diseaseId": 987,
"diseaseName": "abc123",
"evidenceId": 123,
"first": 123,
"id": 123,
"last": 987,
"molecularProfileId": 987,
"molecularProfileName": "xyz789",
"organizationId": 123,
"phenotypeId": 987,
"significance": "ADVERSE_RESPONSE",
"sortBy": AssertionSort,
"status": "ACCEPTED",
"summary": "xyz789",
"therapyId": 123,
"therapyName": "xyz789",
"userId": 987,
"variantId": 123,
"variantName": "abc123"
}
Response
{
"data": {
"assertions": {
"edges": [AssertionEdge],
"nodes": [Assertion],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
browseDiseases
Response
Returns a BrowseDiseaseConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
doid - String
|
|
first - Int
|
Returns the first n elements from the list. |
geneNames - String
|
|
id - Int
|
|
last - Int
|
Returns the last n elements from the list. |
name - String
|
|
sortBy - DiseasesSort
|
Example
Query
query browseDiseases(
$after: String,
$before: String,
$doid: String,
$first: Int,
$geneNames: String,
$id: Int,
$last: Int,
$name: String,
$sortBy: DiseasesSort
) {
browseDiseases(
after: $after,
before: $before,
doid: $doid,
first: $first,
geneNames: $geneNames,
id: $id,
last: $last,
name: $name,
sortBy: $sortBy
) {
edges {
...BrowseDiseaseEdgeFragment
}
filteredCount
nodes {
...BrowseDiseaseFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"doid": "abc123",
"first": 987,
"geneNames": "xyz789",
"id": 123,
"last": 987,
"name": "abc123",
"sortBy": DiseasesSort
}
Response
{
"data": {
"browseDiseases": {
"edges": [BrowseDiseaseEdge],
"filteredCount": 123,
"nodes": [BrowseDisease],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
browseGenes
Response
Returns a BrowseGeneConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
diseaseName - String
|
|
entrezSymbol - String
|
|
first - Int
|
Returns the first n elements from the list. |
geneAlias - String
|
|
last - Int
|
Returns the last n elements from the list. |
sortBy - GenesSort
|
|
therapyName - String
|
Example
Query
query browseGenes(
$after: String,
$before: String,
$diseaseName: String,
$entrezSymbol: String,
$first: Int,
$geneAlias: String,
$last: Int,
$sortBy: GenesSort,
$therapyName: String
) {
browseGenes(
after: $after,
before: $before,
diseaseName: $diseaseName,
entrezSymbol: $entrezSymbol,
first: $first,
geneAlias: $geneAlias,
last: $last,
sortBy: $sortBy,
therapyName: $therapyName
) {
edges {
...BrowseGeneEdgeFragment
}
filteredCount
nodes {
...BrowseGeneFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"diseaseName": "abc123",
"entrezSymbol": "xyz789",
"first": 123,
"geneAlias": "xyz789",
"last": 987,
"sortBy": GenesSort,
"therapyName": "xyz789"
}
Response
{
"data": {
"browseGenes": {
"edges": [BrowseGeneEdge],
"filteredCount": 987,
"nodes": [BrowseGene],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
browseMolecularProfiles
Response
Returns a BrowseMolecularProfileConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
diseaseName - String
|
|
entrezSymbol - String
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
molecularProfileAlias - String
|
|
molecularProfileName - String
|
|
sortBy - MolecularProfilesSort
|
|
therapyName - String
|
|
variantId - Int
|
|
variantName - String
|
Example
Query
query browseMolecularProfiles(
$after: String,
$before: String,
$diseaseName: String,
$entrezSymbol: String,
$first: Int,
$last: Int,
$molecularProfileAlias: String,
$molecularProfileName: String,
$sortBy: MolecularProfilesSort,
$therapyName: String,
$variantId: Int,
$variantName: String
) {
browseMolecularProfiles(
after: $after,
before: $before,
diseaseName: $diseaseName,
entrezSymbol: $entrezSymbol,
first: $first,
last: $last,
molecularProfileAlias: $molecularProfileAlias,
molecularProfileName: $molecularProfileName,
sortBy: $sortBy,
therapyName: $therapyName,
variantId: $variantId,
variantName: $variantName
) {
edges {
...BrowseMolecularProfileEdgeFragment
}
filteredCount
nodes {
...BrowseMolecularProfileFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"diseaseName": "abc123",
"entrezSymbol": "abc123",
"first": 123,
"last": 987,
"molecularProfileAlias": "xyz789",
"molecularProfileName": "abc123",
"sortBy": MolecularProfilesSort,
"therapyName": "xyz789",
"variantId": 987,
"variantName": "abc123"
}
Response
{
"data": {
"browseMolecularProfiles": {
"edges": [BrowseMolecularProfileEdge],
"filteredCount": 987,
"nodes": [BrowseMolecularProfile],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
browseSources
Response
Returns a BrowseSourceConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
author - String
|
|
before - String
|
Returns the elements in the list that come before the specified cursor. |
citationId - Int
|
|
clinicalTrialId - Int
|
|
first - Int
|
Returns the first n elements from the list. |
id - Int
|
|
journal - String
|
|
last - Int
|
Returns the last n elements from the list. |
name - String
|
|
sortBy - SourcesSort
|
|
sourceType - SourceSource
|
|
year - Int
|
Example
Query
query browseSources(
$after: String,
$author: String,
$before: String,
$citationId: Int,
$clinicalTrialId: Int,
$first: Int,
$id: Int,
$journal: String,
$last: Int,
$name: String,
$sortBy: SourcesSort,
$sourceType: SourceSource,
$year: Int
) {
browseSources(
after: $after,
author: $author,
before: $before,
citationId: $citationId,
clinicalTrialId: $clinicalTrialId,
first: $first,
id: $id,
journal: $journal,
last: $last,
name: $name,
sortBy: $sortBy,
sourceType: $sourceType,
year: $year
) {
edges {
...BrowseSourceEdgeFragment
}
filteredCount
nodes {
...BrowseSourceFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"author": "xyz789",
"before": "abc123",
"citationId": 123,
"clinicalTrialId": 123,
"first": 123,
"id": 123,
"journal": "abc123",
"last": 987,
"name": "xyz789",
"sortBy": SourcesSort,
"sourceType": "ASCO",
"year": 987
}
Response
{
"data": {
"browseSources": {
"edges": [BrowseSourceEdge],
"filteredCount": 123,
"nodes": [BrowseSource],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
browseVariantGroups
Response
Returns a BrowseVariantGroupConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
geneNames - String
|
|
last - Int
|
Returns the last n elements from the list. |
name - String
|
|
sortBy - VariantGroupsSort
|
|
variantNames - String
|
Example
Query
query browseVariantGroups(
$after: String,
$before: String,
$first: Int,
$geneNames: String,
$last: Int,
$name: String,
$sortBy: VariantGroupsSort,
$variantNames: String
) {
browseVariantGroups(
after: $after,
before: $before,
first: $first,
geneNames: $geneNames,
last: $last,
name: $name,
sortBy: $sortBy,
variantNames: $variantNames
) {
edges {
...BrowseVariantGroupEdgeFragment
}
filteredCount
nodes {
...BrowseVariantGroupFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"first": 123,
"geneNames": "abc123",
"last": 987,
"name": "xyz789",
"sortBy": VariantGroupsSort,
"variantNames": "xyz789"
}
Response
{
"data": {
"browseVariantGroups": {
"edges": [BrowseVariantGroupEdge],
"filteredCount": 123,
"nodes": [BrowseVariantGroup],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
browseVariants
Response
Returns a BrowseVariantConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
diseaseName - String
|
|
entrezSymbol - String
|
|
first - Int
|
Returns the first n elements from the list. |
hasNoVariantType - Boolean
|
|
last - Int
|
Returns the last n elements from the list. |
sortBy - VariantsSort
|
|
therapyName - String
|
|
variantAlias - String
|
|
variantGroupId - Int
|
|
variantName - String
|
|
variantTypeId - Int
|
|
variantTypeName - String
|
Example
Query
query browseVariants(
$after: String,
$before: String,
$diseaseName: String,
$entrezSymbol: String,
$first: Int,
$hasNoVariantType: Boolean,
$last: Int,
$sortBy: VariantsSort,
$therapyName: String,
$variantAlias: String,
$variantGroupId: Int,
$variantName: String,
$variantTypeId: Int,
$variantTypeName: String
) {
browseVariants(
after: $after,
before: $before,
diseaseName: $diseaseName,
entrezSymbol: $entrezSymbol,
first: $first,
hasNoVariantType: $hasNoVariantType,
last: $last,
sortBy: $sortBy,
therapyName: $therapyName,
variantAlias: $variantAlias,
variantGroupId: $variantGroupId,
variantName: $variantName,
variantTypeId: $variantTypeId,
variantTypeName: $variantTypeName
) {
edges {
...BrowseVariantEdgeFragment
}
filteredCount
nodes {
...BrowseVariantFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"diseaseName": "xyz789",
"entrezSymbol": "xyz789",
"first": 123,
"hasNoVariantType": true,
"last": 123,
"sortBy": VariantsSort,
"therapyName": "abc123",
"variantAlias": "abc123",
"variantGroupId": 987,
"variantName": "abc123",
"variantTypeId": 987,
"variantTypeName": "abc123"
}
Response
{
"data": {
"browseVariants": {
"edges": [BrowseVariantEdge],
"filteredCount": 987,
"nodes": [BrowseVariant],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
clingenCodesTypeahead
Description
Retrieve Clingen Code options as a typeahead
Response
Returns [ClingenCode!]!
Arguments
| Name | Description |
|---|---|
queryTerm - String!
|
Example
Query
query clingenCodesTypeahead($queryTerm: String!) {
clingenCodesTypeahead(queryTerm: $queryTerm) {
code
description
id
}
}
Variables
{"queryTerm": "abc123"}
Response
{
"data": {
"clingenCodesTypeahead": [
{
"code": "abc123",
"description": "abc123",
"id": 987
}
]
}
}
clinicalTrial
Description
Find a clinical trial by CIViC ID
Response
Returns a ClinicalTrial
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query clinicalTrial($id: Int!) {
clinicalTrial(id: $id) {
description
id
link
name
nctId
url
}
}
Variables
{"id": 123}
Response
{
"data": {
"clinicalTrial": {
"description": "abc123",
"id": 987,
"link": "xyz789",
"name": "abc123",
"nctId": "abc123",
"url": "abc123"
}
}
}
clinicalTrials
Description
List and filter Clinical Trials from ClinicalTrials.gov.
Response
Returns a BrowseClinicalTrialConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
id - Int
|
Filter to a Clinical Trial based on its internal CIViC id |
last - Int
|
Returns the last n elements from the list. |
name - String
|
Wildcard match on clinical trial title |
nctId - String
|
Limit to clinical trials with a specific NCT ID |
sortBy - ClinicalTrialSort
|
Sort order for the clinical trials. Defaults to the highest source count. |
Example
Query
query clinicalTrials(
$after: String,
$before: String,
$first: Int,
$id: Int,
$last: Int,
$name: String,
$nctId: String,
$sortBy: ClinicalTrialSort
) {
clinicalTrials(
after: $after,
before: $before,
first: $first,
id: $id,
last: $last,
name: $name,
nctId: $nctId,
sortBy: $sortBy
) {
edges {
...BrowseClinicalTrialEdgeFragment
}
filteredCount
nodes {
...BrowseClinicalTrialFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"first": 123,
"id": 987,
"last": 123,
"name": "xyz789",
"nctId": "xyz789",
"sortBy": ClinicalTrialSort
}
Response
{
"data": {
"clinicalTrials": {
"edges": [BrowseClinicalTrialEdge],
"filteredCount": 987,
"nodes": [BrowseClinicalTrial],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
comment
Description
Find a comment by CIViC ID
Example
Query
query comment($id: Int!) {
comment(id: $id) {
comment
commentable {
...CommentableFragment
}
commenter {
...UserFragment
}
createdAt
creationEvent {
...EventFragment
}
id
link
name
parsedComment {
... on CommentTagSegment {
...CommentTagSegmentFragment
}
... on CommentTextSegment {
...CommentTextSegmentFragment
}
... on User {
...UserFragment
}
}
title
}
}
Variables
{"id": 123}
Response
{
"data": {
"comment": {
"comment": "abc123",
"commentable": Commentable,
"commenter": User,
"createdAt": ISO8601DateTime,
"creationEvent": Event,
"id": 987,
"link": "abc123",
"name": "xyz789",
"parsedComment": [CommentTagSegment],
"title": "abc123"
}
}
}
comments
Description
List and filter comments.
Response
Returns a CommentConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
mentionedEntity - TaggableEntityInput
|
Limit to comments that mention a certain entity |
mentionedRole - UserRole
|
Limit to comments that mention a certain user role |
mentionedUserId - Int
|
Limit to comments that mention a certain user |
originatingUserId - Int
|
Limit to comments by a certain user |
sortBy - DateSort
|
Sort order for the comments. Defaults to most recent. |
subject - CommentableInput
|
Limit to comments on a certain subject. |
Example
Query
query comments(
$after: String,
$before: String,
$first: Int,
$last: Int,
$mentionedEntity: TaggableEntityInput,
$mentionedRole: UserRole,
$mentionedUserId: Int,
$originatingUserId: Int,
$sortBy: DateSort,
$subject: CommentableInput
) {
comments(
after: $after,
before: $before,
first: $first,
last: $last,
mentionedEntity: $mentionedEntity,
mentionedRole: $mentionedRole,
mentionedUserId: $mentionedUserId,
originatingUserId: $originatingUserId,
sortBy: $sortBy,
subject: $subject
) {
edges {
...CommentEdgeFragment
}
mentionedEntities {
...CommentTagSegmentFragment
}
mentionedRoles {
...CommentTagSegmentFragment
}
mentionedUsers {
...UserFragment
}
nodes {
...CommentFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
unfilteredCountForSubject
uniqueCommenters {
...UserFragment
}
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"first": 987,
"last": 987,
"mentionedEntity": TaggableEntityInput,
"mentionedRole": "ADMIN",
"mentionedUserId": 987,
"originatingUserId": 123,
"sortBy": DateSort,
"subject": CommentableInput
}
Response
{
"data": {
"comments": {
"edges": [CommentEdge],
"mentionedEntities": [CommentTagSegment],
"mentionedRoles": [CommentTagSegment],
"mentionedUsers": [User],
"nodes": [Comment],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987,
"unfilteredCountForSubject": 987,
"uniqueCommenters": [User]
}
}
}
contributors
Response
Returns a ContributingUsersSummary!
Arguments
| Name | Description |
|---|---|
subscribable - SubscribableInput!
|
The entity to to return contributors for |
Example
Query
query contributors($subscribable: SubscribableInput!) {
contributors(subscribable: $subscribable) {
curators {
...ContributingUserFragment
}
editors {
...ContributingUserFragment
}
}
}
Variables
{"subscribable": SubscribableInput}
Response
{
"data": {
"contributors": {
"curators": [ContributingUser],
"editors": [ContributingUser]
}
}
}
countries
Description
Fetch a list of countries for user profiles.
Response
Returns [Country!]!
Example
Query
query countries {
countries {
id
iso
name
}
}
Response
{
"data": {
"countries": [
{
"id": 987,
"iso": "xyz789",
"name": "xyz789"
}
]
}
}
dataReleases
Response
Returns [DataRelease!]!
Example
Query
query dataReleases {
dataReleases {
acceptedAndSubmittedVariantsVcf {
...DownloadableFileFragment
}
acceptedVariantsVcf {
...DownloadableFileFragment
}
assertionTsv {
...DownloadableFileFragment
}
evidenceTsv {
...DownloadableFileFragment
}
geneTsv {
...DownloadableFileFragment
}
molecularProfileTsv {
...DownloadableFileFragment
}
name
variantGroupTsv {
...DownloadableFileFragment
}
variantTsv {
...DownloadableFileFragment
}
}
}
Response
{
"data": {
"dataReleases": [
{
"acceptedAndSubmittedVariantsVcf": DownloadableFile,
"acceptedVariantsVcf": DownloadableFile,
"assertionTsv": DownloadableFile,
"evidenceTsv": DownloadableFile,
"geneTsv": DownloadableFile,
"molecularProfileTsv": DownloadableFile,
"name": "abc123",
"variantGroupTsv": DownloadableFile,
"variantTsv": DownloadableFile
}
]
}
}
disease
Description
Find a disease by CIViC ID
Example
Query
query disease($id: Int!) {
disease(id: $id) {
diseaseAliases
diseaseUrl
displayName
doid
id
link
myDiseaseInfo {
...MyDiseaseInfoFragment
}
name
}
}
Variables
{"id": 123}
Response
{
"data": {
"disease": {
"diseaseAliases": ["abc123"],
"diseaseUrl": "xyz789",
"displayName": "xyz789",
"doid": "abc123",
"id": 123,
"link": "xyz789",
"myDiseaseInfo": MyDiseaseInfo,
"name": "xyz789"
}
}
}
diseasePopover
Description
Retrieve popover fields for a specific disease.
Response
Returns a DiseasePopover
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query diseasePopover($id: Int!) {
diseasePopover(id: $id) {
assertionCount
diseaseAliases
diseaseUrl
displayName
doid
evidenceItemCount
id
link
molecularProfileCount
myDiseaseInfo {
...MyDiseaseInfoFragment
}
name
}
}
Variables
{"id": 987}
Response
{
"data": {
"diseasePopover": {
"assertionCount": 123,
"diseaseAliases": ["abc123"],
"diseaseUrl": "xyz789",
"displayName": "xyz789",
"doid": "abc123",
"evidenceItemCount": 987,
"id": 987,
"link": "abc123",
"molecularProfileCount": 123,
"myDiseaseInfo": MyDiseaseInfo,
"name": "xyz789"
}
}
}
diseaseTypeahead
Description
Retrieve disease typeahead fields for a search term.
Response
Returns [Disease!]!
Arguments
| Name | Description |
|---|---|
queryTerm - String!
|
Example
Query
query diseaseTypeahead($queryTerm: String!) {
diseaseTypeahead(queryTerm: $queryTerm) {
diseaseAliases
diseaseUrl
displayName
doid
id
link
myDiseaseInfo {
...MyDiseaseInfoFragment
}
name
}
}
Variables
{"queryTerm": "xyz789"}
Response
{
"data": {
"diseaseTypeahead": [
{
"diseaseAliases": ["abc123"],
"diseaseUrl": "abc123",
"displayName": "abc123",
"doid": "xyz789",
"id": 987,
"link": "xyz789",
"myDiseaseInfo": MyDiseaseInfo,
"name": "abc123"
}
]
}
}
entityTypeahead
Description
Retrieve entity type typeahead fields for a entity mention search term.
Response
Returns [CommentTagSegment!]!
Arguments
| Name | Description |
|---|---|
queryTerm - String!
|
Example
Query
query entityTypeahead($queryTerm: String!) {
entityTypeahead(queryTerm: $queryTerm) {
deprecated
displayName
entityId
link
revisionsetId
status
tagType
}
}
Variables
{"queryTerm": "abc123"}
Response
{
"data": {
"entityTypeahead": [
{
"deprecated": true,
"displayName": "xyz789",
"entityId": 987,
"link": "xyz789",
"revisionsetId": "abc123",
"status": "ACCEPTED",
"tagType": "ASSERTION"
}
]
}
}
events
Description
List and filter events for an object
Response
Returns an EventConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
eventType - EventAction
|
|
first - Int
|
Returns the first n elements from the list. |
includeAutomatedEvents - Boolean
|
|
last - Int
|
Returns the last n elements from the list. |
mode - EventFeedMode
|
|
organizationId - Int
|
|
originatingUserId - Int
|
|
sortBy - DateSort
|
Sort order for the events. Defaults to most recent. |
subject - SubscribableQueryInput
|
Example
Query
query events(
$after: String,
$before: String,
$eventType: EventAction,
$first: Int,
$includeAutomatedEvents: Boolean,
$last: Int,
$mode: EventFeedMode,
$organizationId: Int,
$originatingUserId: Int,
$sortBy: DateSort,
$subject: SubscribableQueryInput
) {
events(
after: $after,
before: $before,
eventType: $eventType,
first: $first,
includeAutomatedEvents: $includeAutomatedEvents,
last: $last,
mode: $mode,
organizationId: $organizationId,
originatingUserId: $originatingUserId,
sortBy: $sortBy,
subject: $subject
) {
edges {
...EventEdgeFragment
}
eventTypes
nodes {
...EventFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
participatingOrganizations {
...OrganizationFragment
}
totalCount
unfilteredCount
uniqueParticipants {
...UserFragment
}
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"eventType": "ACCEPTED",
"first": 987,
"includeAutomatedEvents": false,
"last": 987,
"mode": "ORGANIZATION",
"organizationId": 987,
"originatingUserId": 987,
"sortBy": DateSort,
"subject": SubscribableQueryInput
}
Response
{
"data": {
"events": {
"edges": [EventEdge],
"eventTypes": ["ACCEPTED"],
"nodes": [Event],
"pageCount": 123,
"pageInfo": PageInfo,
"participatingOrganizations": [Organization],
"totalCount": 123,
"unfilteredCount": 123,
"uniqueParticipants": [User]
}
}
}
evidenceItem
Description
Find an evidence item by CIViC ID
Response
Returns an EvidenceItem
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query evidenceItem($id: Int!) {
evidenceItem(id: $id) {
acceptanceEvent {
...EventFragment
}
assertions {
...AssertionFragment
}
comments {
...CommentConnectionFragment
}
description
disease {
...DiseaseFragment
}
events {
...EventConnectionFragment
}
evidenceDirection
evidenceLevel
evidenceRating
evidenceType
flagged
flags {
...FlagConnectionFragment
}
id
lastAcceptedRevisionEvent {
...EventFragment
}
lastCommentEvent {
...EventFragment
}
lastSubmittedRevisionEvent {
...EventFragment
}
link
molecularProfile {
...MolecularProfileFragment
}
name
phenotypes {
...PhenotypeFragment
}
rejectionEvent {
...EventFragment
}
revisions {
...RevisionConnectionFragment
}
significance
source {
...SourceFragment
}
status
submissionEvent {
...EventFragment
}
therapies {
...TherapyFragment
}
therapyInteractionType
variantHgvs
variantOrigin
}
}
Variables
{"id": 987}
Response
{
"data": {
"evidenceItem": {
"acceptanceEvent": Event,
"assertions": [Assertion],
"comments": CommentConnection,
"description": "xyz789",
"disease": Disease,
"events": EventConnection,
"evidenceDirection": "DOES_NOT_SUPPORT",
"evidenceLevel": "A",
"evidenceRating": 987,
"evidenceType": "DIAGNOSTIC",
"flagged": true,
"flags": FlagConnection,
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"molecularProfile": MolecularProfile,
"name": "abc123",
"phenotypes": [Phenotype],
"rejectionEvent": Event,
"revisions": RevisionConnection,
"significance": "ADVERSE_RESPONSE",
"source": Source,
"status": "ACCEPTED",
"submissionEvent": Event,
"therapies": [Therapy],
"therapyInteractionType": "COMBINATION",
"variantHgvs": "xyz789",
"variantOrigin": "COMMON_GERMLINE"
}
}
}
evidenceItems
Description
List and filter evidence items.
Response
Returns an EvidenceItemConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
assertionId - Int
|
Exact match filtering on the ID of the assertion. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
clinicalTrialId - Int
|
Exact match filtering of the evidence items based on the CIViC clinical trial id linked to the evidence item's source |
description - String
|
Substring filtering on evidence item description. |
diseaseId - Int
|
Exact match filtering of the evidence items based on the internal CIViC disease id |
diseaseName - String
|
Substring filtering on disease name. |
evidenceDirection - EvidenceDirection
|
Filtering on the evidence direction. |
evidenceLevel - EvidenceLevel
|
Filtering on the evidence level. |
evidenceRating - Int
|
Filtering on the evidence rating. Valid values: 1, 2, 3, 4, 5 |
evidenceType - EvidenceType
|
Filtering on the evidence type. |
first - Int
|
Returns the first n elements from the list. |
id - Int
|
Exact match filtering on the ID of the evidence item. |
last - Int
|
Returns the last n elements from the list. |
molecularProfileId - Int
|
Exact match filtering on the ID of the molecular profile. |
molecularProfileName - String
|
Substring filtering on molecular profile name |
organizationId - Int
|
Exact match filtering on the ID of the organization the evidence item was submitted under. |
phenotypeId - Int
|
Exact match filtering of the evidence items based on the internal CIViC phenotype id |
significance - EvidenceSignificance
|
Filtering on the evidence significance. |
sortBy - EvidenceSort
|
Columm and direction to sort evidence on. |
sourceId - Int
|
Exact match filtering of the evidence items based on the interal CIViC source id |
status - EvidenceStatusFilter
|
Filtering on the evidence status. |
therapyId - Int
|
Exact match filtering of the evidence items based on the internal CIViC therapy id |
therapyName - String
|
Substring filtering on therapy name. |
userId - Int
|
Exact match filtering on the ID of the user who submitted the evidence item. |
variantId - Int
|
Exact match filtering on the ID of the variant. |
variantOrigin - VariantOrigin
|
Filtering on the evidence variant origin. |
Example
Query
query evidenceItems(
$after: String,
$assertionId: Int,
$before: String,
$clinicalTrialId: Int,
$description: String,
$diseaseId: Int,
$diseaseName: String,
$evidenceDirection: EvidenceDirection,
$evidenceLevel: EvidenceLevel,
$evidenceRating: Int,
$evidenceType: EvidenceType,
$first: Int,
$id: Int,
$last: Int,
$molecularProfileId: Int,
$molecularProfileName: String,
$organizationId: Int,
$phenotypeId: Int,
$significance: EvidenceSignificance,
$sortBy: EvidenceSort,
$sourceId: Int,
$status: EvidenceStatusFilter,
$therapyId: Int,
$therapyName: String,
$userId: Int,
$variantId: Int,
$variantOrigin: VariantOrigin
) {
evidenceItems(
after: $after,
assertionId: $assertionId,
before: $before,
clinicalTrialId: $clinicalTrialId,
description: $description,
diseaseId: $diseaseId,
diseaseName: $diseaseName,
evidenceDirection: $evidenceDirection,
evidenceLevel: $evidenceLevel,
evidenceRating: $evidenceRating,
evidenceType: $evidenceType,
first: $first,
id: $id,
last: $last,
molecularProfileId: $molecularProfileId,
molecularProfileName: $molecularProfileName,
organizationId: $organizationId,
phenotypeId: $phenotypeId,
significance: $significance,
sortBy: $sortBy,
sourceId: $sourceId,
status: $status,
therapyId: $therapyId,
therapyName: $therapyName,
userId: $userId,
variantId: $variantId,
variantOrigin: $variantOrigin
) {
edges {
...EvidenceItemEdgeFragment
}
nodes {
...EvidenceItemFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"assertionId": 987,
"before": "xyz789",
"clinicalTrialId": 123,
"description": "xyz789",
"diseaseId": 123,
"diseaseName": "abc123",
"evidenceDirection": "DOES_NOT_SUPPORT",
"evidenceLevel": "A",
"evidenceRating": 987,
"evidenceType": "DIAGNOSTIC",
"first": 987,
"id": 987,
"last": 123,
"molecularProfileId": 987,
"molecularProfileName": "abc123",
"organizationId": 123,
"phenotypeId": 987,
"significance": "ADVERSE_RESPONSE",
"sortBy": EvidenceSort,
"sourceId": 987,
"status": "ACCEPTED",
"therapyId": 123,
"therapyName": "xyz789",
"userId": 123,
"variantId": 987,
"variantOrigin": "COMMON_GERMLINE"
}
Response
{
"data": {
"evidenceItems": {
"edges": [EvidenceItemEdge],
"nodes": [EvidenceItem],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
flag
Description
Find a flag by CIViC ID
Example
Query
query flag($id: Int!) {
flag(id: $id) {
comments {
...CommentConnectionFragment
}
createdAt
flaggable {
...FlaggableFragment
}
flaggingUser {
...UserFragment
}
id
lastCommentEvent {
...EventFragment
}
link
name
openComment {
...CommentFragment
}
resolutionComment {
...CommentFragment
}
resolvedAt
resolvingUser {
...UserFragment
}
state
}
}
Variables
{"id": 123}
Response
{
"data": {
"flag": {
"comments": CommentConnection,
"createdAt": ISO8601DateTime,
"flaggable": Flaggable,
"flaggingUser": User,
"id": 123,
"lastCommentEvent": Event,
"link": "xyz789",
"name": "xyz789",
"openComment": Comment,
"resolutionComment": Comment,
"resolvedAt": ISO8601DateTime,
"resolvingUser": User,
"state": "OPEN"
}
}
}
flags
Description
List and filter flags.
Response
Returns a FlagConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
flaggable - FlaggableInput
|
|
flaggingUserId - Int
|
Limit to flags added by a certain user |
last - Int
|
Returns the last n elements from the list. |
resolvingUserId - Int
|
Limit to flags resolved by a certain user |
sortBy - DateSort
|
Sort order for the flags. Defaults to most recent. |
state - FlagState
|
Limit to flags in a particular state |
Example
Query
query flags(
$after: String,
$before: String,
$first: Int,
$flaggable: FlaggableInput,
$flaggingUserId: Int,
$last: Int,
$resolvingUserId: Int,
$sortBy: DateSort,
$state: FlagState
) {
flags(
after: $after,
before: $before,
first: $first,
flaggable: $flaggable,
flaggingUserId: $flaggingUserId,
last: $last,
resolvingUserId: $resolvingUserId,
sortBy: $sortBy,
state: $state
) {
edges {
...FlagEdgeFragment
}
nodes {
...FlagFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
unfilteredCountForSubject
uniqueFlaggingUsers {
...UserFragment
}
uniqueResolvingUsers {
...UserFragment
}
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"first": 123,
"flaggable": FlaggableInput,
"flaggingUserId": 123,
"last": 987,
"resolvingUserId": 987,
"sortBy": DateSort,
"state": "OPEN"
}
Response
{
"data": {
"flags": {
"edges": [FlagEdge],
"nodes": [Flag],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123,
"unfilteredCountForSubject": 123,
"uniqueFlaggingUsers": [User],
"uniqueResolvingUsers": [User]
}
}
}
gene
Description
Find a single gene by CIViC ID or Entrez symbol
Example
Query
query gene(
$entrezSymbol: String,
$id: Int
) {
gene(
entrezSymbol: $entrezSymbol,
id: $id
) {
comments {
...CommentConnectionFragment
}
description
entrezId
events {
...EventConnectionFragment
}
flagged
flags {
...FlagConnectionFragment
}
geneAliases
id
lastAcceptedRevisionEvent {
...EventFragment
}
lastCommentEvent {
...EventFragment
}
lastSubmittedRevisionEvent {
...EventFragment
}
link
myGeneInfoDetails
name
officialName
revisions {
...RevisionConnectionFragment
}
sources {
...SourceFragment
}
variants {
...VariantConnectionFragment
}
}
}
Variables
{"entrezSymbol": "xyz789", "id": 987}
Response
{
"data": {
"gene": {
"comments": CommentConnection,
"description": "xyz789",
"entrezId": 987,
"events": EventConnection,
"flagged": false,
"flags": FlagConnection,
"geneAliases": ["xyz789"],
"id": 987,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"myGeneInfoDetails": {},
"name": "abc123",
"officialName": "xyz789",
"revisions": RevisionConnection,
"sources": [Source],
"variants": VariantConnection
}
}
}
geneTypeahead
Description
Retrieve gene typeahead fields for a search term.
Example
Query
query geneTypeahead($queryTerm: String!) {
geneTypeahead(queryTerm: $queryTerm) {
comments {
...CommentConnectionFragment
}
description
entrezId
events {
...EventConnectionFragment
}
flagged
flags {
...FlagConnectionFragment
}
geneAliases
id
lastAcceptedRevisionEvent {
...EventFragment
}
lastCommentEvent {
...EventFragment
}
lastSubmittedRevisionEvent {
...EventFragment
}
link
myGeneInfoDetails
name
officialName
revisions {
...RevisionConnectionFragment
}
sources {
...SourceFragment
}
variants {
...VariantConnectionFragment
}
}
}
Variables
{"queryTerm": "xyz789"}
Response
{
"data": {
"geneTypeahead": [
{
"comments": CommentConnection,
"description": "xyz789",
"entrezId": 123,
"events": EventConnection,
"flagged": false,
"flags": FlagConnection,
"geneAliases": ["abc123"],
"id": 987,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"myGeneInfoDetails": {},
"name": "abc123",
"officialName": "abc123",
"revisions": RevisionConnection,
"sources": [Source],
"variants": VariantConnection
}
]
}
}
genes
Description
List and filter genes.
Response
Returns a GeneConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query genes(
$after: String,
$before: String,
$first: Int,
$last: Int
) {
genes(
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
...GeneEdgeFragment
}
nodes {
...GeneFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"first": 123,
"last": 987
}
Response
{
"data": {
"genes": {
"edges": [GeneEdge],
"nodes": [Gene],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
molecularProfile
Description
Find a molecular profile by CIViC ID
Response
Returns a MolecularProfile
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query molecularProfile($id: Int!) {
molecularProfile(id: $id) {
assertions {
...AssertionConnectionFragment
}
comments {
...CommentConnectionFragment
}
deprecated
deprecatedVariants {
...VariantFragment
}
deprecationEvent {
...EventFragment
}
description
events {
...EventConnectionFragment
}
evidenceCountsByStatus {
...EvidenceItemsByStatusFragment
}
evidenceItems {
...EvidenceItemConnectionFragment
}
flagged
flags {
...FlagConnectionFragment
}
id
lastAcceptedRevisionEvent {
...EventFragment
}
lastCommentEvent {
...EventFragment
}
lastSubmittedRevisionEvent {
...EventFragment
}
link
molecularProfileAliases
molecularProfileScore
name
parsedName {
... on Gene {
...GeneFragment
}
... on MolecularProfileTextSegment {
...MolecularProfileTextSegmentFragment
}
... on Variant {
...VariantFragment
}
}
rawName
revisions {
...RevisionConnectionFragment
}
sources {
...SourceFragment
}
variants {
...VariantFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"molecularProfile": {
"assertions": AssertionConnection,
"comments": CommentConnection,
"deprecated": false,
"deprecatedVariants": [Variant],
"deprecationEvent": Event,
"description": "xyz789",
"events": EventConnection,
"evidenceCountsByStatus": EvidenceItemsByStatus,
"evidenceItems": EvidenceItemConnection,
"flagged": true,
"flags": FlagConnection,
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"molecularProfileAliases": ["xyz789"],
"molecularProfileScore": 987.65,
"name": "abc123",
"parsedName": [Gene],
"rawName": "xyz789",
"revisions": RevisionConnection,
"sources": [Source],
"variants": [Variant]
}
}
}
molecularProfiles
Description
List and filter molecular profiles.
Response
Returns a MolecularProfileConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
evidenceStatusFilter - MolecularProfileDisplayFilter
|
Limit molecular profiles by the status of attached evidence. |
first - Int
|
Returns the first n elements from the list. |
geneId - Int
|
Filter molecular profiles to the CIViC id of the gene(s) involved. |
last - Int
|
Returns the last n elements from the list. |
name - String
|
Left anchored filtering for molecular profile name and aliases. |
variantId - Int
|
Filter molecular profiles by the CIViC ID of an involved variant. |
Example
Query
query molecularProfiles(
$after: String,
$before: String,
$evidenceStatusFilter: MolecularProfileDisplayFilter,
$first: Int,
$geneId: Int,
$last: Int,
$name: String,
$variantId: Int
) {
molecularProfiles(
after: $after,
before: $before,
evidenceStatusFilter: $evidenceStatusFilter,
first: $first,
geneId: $geneId,
last: $last,
name: $name,
variantId: $variantId
) {
edges {
...MolecularProfileEdgeFragment
}
nodes {
...MolecularProfileFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"evidenceStatusFilter": "ALL",
"first": 123,
"geneId": 123,
"last": 987,
"name": "abc123",
"variantId": 987
}
Response
{
"data": {
"molecularProfiles": {
"edges": [MolecularProfileEdge],
"nodes": [MolecularProfile],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
nccnGuidelinesTypeahead
Description
Retrieve NCCN Guideline options as a typeahead
Response
Returns [NccnGuideline!]!
Arguments
| Name | Description |
|---|---|
queryTerm - String!
|
Example
Query
query nccnGuidelinesTypeahead($queryTerm: String!) {
nccnGuidelinesTypeahead(queryTerm: $queryTerm) {
id
name
}
}
Variables
{"queryTerm": "abc123"}
Response
{
"data": {
"nccnGuidelinesTypeahead": [
{"id": 987, "name": "abc123"}
]
}
}
notifications
Description
List and filter notifications for the logged in user.
Response
Returns a NotificationConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
eventType - EventAction
|
|
first - Int
|
Returns the first n elements from the list. |
includeRead - Boolean
|
Default = false |
last - Int
|
Returns the last n elements from the list. |
notificationReason - NotificationReason
|
|
organizationId - Int
|
|
originatingObject - SubscribableInput
|
|
originatingUserId - Int
|
|
subscriptionId - Int
|
Example
Query
query notifications(
$after: String,
$before: String,
$eventType: EventAction,
$first: Int,
$includeRead: Boolean,
$last: Int,
$notificationReason: NotificationReason,
$organizationId: Int,
$originatingObject: SubscribableInput,
$originatingUserId: Int,
$subscriptionId: Int
) {
notifications(
after: $after,
before: $before,
eventType: $eventType,
first: $first,
includeRead: $includeRead,
last: $last,
notificationReason: $notificationReason,
organizationId: $organizationId,
originatingObject: $originatingObject,
originatingUserId: $originatingUserId,
subscriptionId: $subscriptionId
) {
edges {
...NotificationEdgeFragment
}
eventTypes
mentioningUsers {
...UserFragment
}
nodes {
...NotificationFragment
}
notificationSubjects {
...EventSubjectWithCountFragment
}
organizations {
...OrganizationFragment
}
originatingUsers {
...UserFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
unreadCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"eventType": "ACCEPTED",
"first": 987,
"includeRead": false,
"last": 123,
"notificationReason": "MENTION",
"organizationId": 123,
"originatingObject": SubscribableInput,
"originatingUserId": 987,
"subscriptionId": 987
}
Response
{
"data": {
"notifications": {
"edges": [NotificationEdge],
"eventTypes": ["ACCEPTED"],
"mentioningUsers": [User],
"nodes": [Notification],
"notificationSubjects": [EventSubjectWithCount],
"organizations": [Organization],
"originatingUsers": [User],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123,
"unreadCount": 987
}
}
}
organization
Description
Find an organization by CIViC ID
Response
Returns an Organization
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query organization($id: Int!) {
organization(id: $id) {
description
eventCount
events {
...EventConnectionFragment
}
id
memberCount
members {
...UserConnectionFragment
}
mostRecentEvent {
...EventFragment
}
name
orgAndSuborgsStatsHash {
...StatsFragment
}
orgStatsHash {
...StatsFragment
}
profileImagePath
subGroups {
...OrganizationFragment
}
url
}
}
Variables
{"id": 987}
Response
{
"data": {
"organization": {
"description": "abc123",
"eventCount": 123,
"events": EventConnection,
"id": 987,
"memberCount": 987,
"members": UserConnection,
"mostRecentEvent": Event,
"name": "abc123",
"orgAndSuborgsStatsHash": Stats,
"orgStatsHash": Stats,
"profileImagePath": "abc123",
"subGroups": [Organization],
"url": "xyz789"
}
}
}
organizations
Description
List and filter organizations.
Response
Returns an OrganizationConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
id - Int
|
Exact match filtering on the id of the organization. |
last - Int
|
Returns the last n elements from the list. |
name - String
|
Substring filtering on the name of the organization. |
sortBy - OrganizationSort
|
Columm and direction to sort evidence on. |
Example
Query
query organizations(
$after: String,
$before: String,
$first: Int,
$id: Int,
$last: Int,
$name: String,
$sortBy: OrganizationSort
) {
organizations(
after: $after,
before: $before,
first: $first,
id: $id,
last: $last,
name: $name,
sortBy: $sortBy
) {
edges {
...OrganizationEdgeFragment
}
nodes {
...OrganizationFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"first": 123,
"id": 123,
"last": 987,
"name": "xyz789",
"sortBy": OrganizationSort
}
Response
{
"data": {
"organizations": {
"edges": [OrganizationEdge],
"nodes": [Organization],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
phenotype
Description
Find a phenotype by CIViC ID
Example
Query
query phenotype($id: Int!) {
phenotype(id: $id) {
hpoId
id
link
name
url
}
}
Variables
{"id": 987}
Response
{
"data": {
"phenotype": {
"hpoId": "xyz789",
"id": 987,
"link": "abc123",
"name": "abc123",
"url": "abc123"
}
}
}
phenotypePopover
Description
Retrieve popover fields for a specific phenotype.
Response
Returns a PhenotypePopover
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query phenotypePopover($id: Int!) {
phenotypePopover(id: $id) {
assertionCount
evidenceItemCount
hpoId
id
link
molecularProfileCount
name
url
}
}
Variables
{"id": 123}
Response
{
"data": {
"phenotypePopover": {
"assertionCount": 987,
"evidenceItemCount": 987,
"hpoId": "xyz789",
"id": 123,
"link": "abc123",
"molecularProfileCount": 123,
"name": "abc123",
"url": "abc123"
}
}
}
phenotypeTypeahead
Description
Retrieve phenotype typeahead fields for a search term.
Response
Returns [Phenotype!]!
Arguments
| Name | Description |
|---|---|
queryTerm - String!
|
Example
Query
query phenotypeTypeahead($queryTerm: String!) {
phenotypeTypeahead(queryTerm: $queryTerm) {
hpoId
id
link
name
url
}
}
Variables
{"queryTerm": "abc123"}
Response
{
"data": {
"phenotypeTypeahead": [
{
"hpoId": "abc123",
"id": 123,
"link": "xyz789",
"name": "xyz789",
"url": "abc123"
}
]
}
}
phenotypes
Description
List and filter Phenotypes from the Human Phenotype Ontology.
Response
Returns a BrowsePhenotypeConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
hpoId - String
|
Limit to phenotypes with a specific HPO ID |
id - Int
|
Filter Phenotype on internal CIViC id |
last - Int
|
Returns the last n elements from the list. |
name - String
|
Wildcard match on phenotype name (class) |
sortBy - PhenotypeSort
|
Sort order for the phenotypes. Defaults to the highest evidence item count. |
Example
Query
query phenotypes(
$after: String,
$before: String,
$first: Int,
$hpoId: String,
$id: Int,
$last: Int,
$name: String,
$sortBy: PhenotypeSort
) {
phenotypes(
after: $after,
before: $before,
first: $first,
hpoId: $hpoId,
id: $id,
last: $last,
name: $name,
sortBy: $sortBy
) {
edges {
...BrowsePhenotypeEdgeFragment
}
filteredCount
nodes {
...BrowsePhenotypeFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"first": 123,
"hpoId": "abc123",
"id": 987,
"last": 987,
"name": "xyz789",
"sortBy": PhenotypeSort
}
Response
{
"data": {
"phenotypes": {
"edges": [BrowsePhenotypeEdge],
"filteredCount": 987,
"nodes": [BrowsePhenotype],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
previewCommentText
Response
Returns [CommentBodySegment!]!
Arguments
| Name | Description |
|---|---|
commentText - String!
|
Example
Query
query previewCommentText($commentText: String!) {
previewCommentText(commentText: $commentText) {
... on CommentTagSegment {
...CommentTagSegmentFragment
}
... on CommentTextSegment {
...CommentTextSegmentFragment
}
... on User {
...UserFragment
}
}
}
Variables
{"commentText": "xyz789"}
Response
{"data": {"previewCommentText": [CommentTagSegment]}}
previewMolecularProfileName
Response
Returns a MolecularProfileNamePreview!
Arguments
| Name | Description |
|---|---|
structure - MolecularProfileComponentInput
|
Example
Query
query previewMolecularProfileName($structure: MolecularProfileComponentInput) {
previewMolecularProfileName(structure: $structure) {
deprecatedVariants {
...VariantFragment
}
existingMolecularProfile {
...MolecularProfileFragment
}
segments {
... on Gene {
...GeneFragment
}
... on MolecularProfileTextSegment {
...MolecularProfileTextSegmentFragment
}
... on Variant {
...VariantFragment
}
}
}
}
Variables
{"structure": MolecularProfileComponentInput}
Response
{
"data": {
"previewMolecularProfileName": {
"deprecatedVariants": [Variant],
"existingMolecularProfile": MolecularProfile,
"segments": [Gene]
}
}
}
remoteCitation
Description
Check to see if a citation ID for a source not already in CIViC exists in an external database.
Response
Returns a String
Arguments
| Name | Description |
|---|---|
citationId - String!
|
|
sourceType - SourceSource!
|
Example
Query
query remoteCitation(
$citationId: String!,
$sourceType: SourceSource!
) {
remoteCitation(
citationId: $citationId,
sourceType: $sourceType
)
}
Variables
{
"citationId": "abc123",
"sourceType": "ASCO"
}
Response
{"data": {"remoteCitation": "xyz789"}}
revision
Description
Find a revision by CIViC ID
Example
Query
query revision($id: Int!) {
revision(id: $id) {
comments {
...CommentConnectionFragment
}
createdAt
creationComment {
...CommentFragment
}
creationEvent {
...EventFragment
}
currentValue
events {
...EventConnectionFragment
}
fieldName
id
lastCommentEvent {
...EventFragment
}
link
linkoutData {
...LinkoutDataFragment
}
name
resolutionComment {
...CommentFragment
}
resolvedAt
resolver {
...UserFragment
}
resolvingEvent {
...EventFragment
}
revisionsetId
revisor {
...UserFragment
}
status
subject {
...EventSubjectFragment
}
suggestedValue
updatedAt
}
}
Variables
{"id": 123}
Response
{
"data": {
"revision": {
"comments": CommentConnection,
"createdAt": ISO8601DateTime,
"creationComment": Comment,
"creationEvent": Event,
"currentValue": {},
"events": EventConnection,
"fieldName": "xyz789",
"id": 123,
"lastCommentEvent": Event,
"link": "xyz789",
"linkoutData": LinkoutData,
"name": "xyz789",
"resolutionComment": Comment,
"resolvedAt": ISO8601DateTime,
"resolver": User,
"resolvingEvent": Event,
"revisionsetId": "abc123",
"revisor": User,
"status": "ACCEPTED",
"subject": EventSubject,
"suggestedValue": {},
"updatedAt": ISO8601DateTime
}
}
}
revisions
Description
List and filter revisions.
Response
Returns a RevisionConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
fieldName - String
|
Limit to revisions on a particular field. |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
originatingUserId - Int
|
Limit to revisions by a certain user |
resolvingUserId - Int
|
Limit to revisions accepted, rejected, or superseded by a certain user |
revisionsetId - String
|
Limit to revisions suggested as part of a single Revision Set. |
sortBy - DateSort
|
Sort order for the comments. Defaults to most recent. |
status - RevisionStatus
|
Limit to revisions with a certain status |
subject - ModeratedInput
|
Limit to revisions of a specific CIViC entity |
Example
Query
query revisions(
$after: String,
$before: String,
$fieldName: String,
$first: Int,
$last: Int,
$originatingUserId: Int,
$resolvingUserId: Int,
$revisionsetId: String,
$sortBy: DateSort,
$status: RevisionStatus,
$subject: ModeratedInput
) {
revisions(
after: $after,
before: $before,
fieldName: $fieldName,
first: $first,
last: $last,
originatingUserId: $originatingUserId,
resolvingUserId: $resolvingUserId,
revisionsetId: $revisionsetId,
sortBy: $sortBy,
status: $status,
subject: $subject
) {
edges {
...RevisionEdgeFragment
}
nodes {
...RevisionFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
revisedFieldNames {
...FieldNameFragment
}
totalCount
unfilteredCountForSubject
uniqueResolvers {
...UserFragment
}
uniqueRevisors {
...UserFragment
}
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"fieldName": "xyz789",
"first": 987,
"last": 123,
"originatingUserId": 123,
"resolvingUserId": 987,
"revisionsetId": "abc123",
"sortBy": DateSort,
"status": "ACCEPTED",
"subject": ModeratedInput
}
Response
{
"data": {
"revisions": {
"edges": [RevisionEdge],
"nodes": [Revision],
"pageCount": 987,
"pageInfo": PageInfo,
"revisedFieldNames": [FieldName],
"totalCount": 987,
"unfilteredCountForSubject": 123,
"uniqueResolvers": [User],
"uniqueRevisors": [User]
}
}
}
search
Response
Returns [SearchResult!]!
Arguments
| Name | Description |
|---|---|
highlightMatches - Boolean
|
Should matches come back highlighted |
query - String!
|
The term to query for |
types - [SearchableEntities!]
|
The types of objects to search. Omitting this value searches all. |
Example
Query
query search(
$highlightMatches: Boolean,
$query: String!,
$types: [SearchableEntities!]
) {
search(
highlightMatches: $highlightMatches,
query: $query,
types: $types
) {
id
matchingText
name
resultType
}
}
Variables
{
"highlightMatches": false,
"query": "xyz789",
"types": ["ASSERTION"]
}
Response
{
"data": {
"search": [
{
"id": 123,
"matchingText": "abc123",
"name": "xyz789",
"resultType": "ASSERTION"
}
]
}
}
searchByPermalink
Response
Returns an AdvancedSearchResult!
Arguments
| Name | Description |
|---|---|
permalinkId - String!
|
Example
Query
query searchByPermalink($permalinkId: String!) {
searchByPermalink(permalinkId: $permalinkId) {
permalinkId
resultIds
searchEndpoint
}
}
Variables
{"permalinkId": "abc123"}
Response
{
"data": {
"searchByPermalink": {
"permalinkId": "xyz789",
"resultIds": [987],
"searchEndpoint": "abc123"
}
}
}
searchGenes
Response
Returns an AdvancedSearchResult!
Arguments
| Name | Description |
|---|---|
createPermalink - Boolean
|
Default = false |
query - GeneSearchFilter!
|
Example
Query
query searchGenes(
$createPermalink: Boolean,
$query: GeneSearchFilter!
) {
searchGenes(
createPermalink: $createPermalink,
query: $query
) {
permalinkId
resultIds
searchEndpoint
}
}
Variables
{"createPermalink": false, "query": GeneSearchFilter}
Response
{
"data": {
"searchGenes": {
"permalinkId": "abc123",
"resultIds": [987],
"searchEndpoint": "xyz789"
}
}
}
source
Description
Find a source by CIViC ID
Example
Query
query source($id: Int!) {
source(id: $id) {
abstract
ascoAbstractId
authorString
citation
citationId
clinicalTrials {
...ClinicalTrialFragment
}
comments {
...CommentConnectionFragment
}
displayType
events {
...EventConnectionFragment
}
fullJournalTitle
id
journal
lastCommentEvent {
...EventFragment
}
link
name
pmcId
publicationDate
publicationDay
publicationMonth
publicationYear
sourceType
sourceUrl
title
}
}
Variables
{"id": 123}
Response
{
"data": {
"source": {
"abstract": "abc123",
"ascoAbstractId": 987,
"authorString": "abc123",
"citation": "xyz789",
"citationId": "abc123",
"clinicalTrials": [ClinicalTrial],
"comments": CommentConnection,
"displayType": "abc123",
"events": EventConnection,
"fullJournalTitle": "xyz789",
"id": 123,
"journal": "abc123",
"lastCommentEvent": Event,
"link": "xyz789",
"name": "abc123",
"pmcId": "abc123",
"publicationDate": "abc123",
"publicationDay": 123,
"publicationMonth": 123,
"publicationYear": 123,
"sourceType": "ASCO",
"sourceUrl": "xyz789",
"title": "abc123"
}
}
}
sourcePopover
Description
Retrieve popover fields for a specific source.
Response
Returns a SourcePopover
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query sourcePopover($id: Int!) {
sourcePopover(id: $id) {
abstract
ascoAbstractId
authorString
citation
citationId
clinicalTrials {
...ClinicalTrialFragment
}
comments {
...CommentConnectionFragment
}
displayType
events {
...EventConnectionFragment
}
evidenceItemCount
fullJournalTitle
id
journal
lastCommentEvent {
...EventFragment
}
link
name
pmcId
publicationDate
publicationDay
publicationMonth
publicationYear
sourceType
sourceUrl
title
}
}
Variables
{"id": 123}
Response
{
"data": {
"sourcePopover": {
"abstract": "abc123",
"ascoAbstractId": 123,
"authorString": "xyz789",
"citation": "abc123",
"citationId": "abc123",
"clinicalTrials": [ClinicalTrial],
"comments": CommentConnection,
"displayType": "xyz789",
"events": EventConnection,
"evidenceItemCount": 987,
"fullJournalTitle": "abc123",
"id": 987,
"journal": "xyz789",
"lastCommentEvent": Event,
"link": "abc123",
"name": "abc123",
"pmcId": "abc123",
"publicationDate": "xyz789",
"publicationDay": 123,
"publicationMonth": 123,
"publicationYear": 123,
"sourceType": "ASCO",
"sourceUrl": "abc123",
"title": "abc123"
}
}
}
sourceSuggestionValues
Description
Given the parameters in a source suggestion, fetch the values to populate the add evidence form
Response
Returns a SourceSuggestionValues!
Example
Query
query sourceSuggestionValues(
$diseaseId: Int,
$molecularProfileId: Int,
$sourceId: Int
) {
sourceSuggestionValues(
diseaseId: $diseaseId,
molecularProfileId: $molecularProfileId,
sourceId: $sourceId
) {
disease {
...DiseaseFragment
}
molecularProfile {
...MolecularProfileFragment
}
source {
...SourceFragment
}
}
}
Variables
{"diseaseId": 987, "molecularProfileId": 987, "sourceId": 123}
Response
{
"data": {
"sourceSuggestionValues": {
"disease": Disease,
"molecularProfile": MolecularProfile,
"source": Source
}
}
}
sourceSuggestions
Response
Returns a SourceSuggestionConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
citation - String
|
|
citationId - Int
|
|
comment - String
|
|
diseaseName - String
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
molecularProfileName - String
|
|
sortBy - SourceSuggestionsSort
|
|
sourceId - Int
|
|
sourceType - SourceSource
|
|
status - SourceSuggestionStatus
|
|
submitter - String
|
|
submitterId - Int
|
Example
Query
query sourceSuggestions(
$after: String,
$before: String,
$citation: String,
$citationId: Int,
$comment: String,
$diseaseName: String,
$first: Int,
$last: Int,
$molecularProfileName: String,
$sortBy: SourceSuggestionsSort,
$sourceId: Int,
$sourceType: SourceSource,
$status: SourceSuggestionStatus,
$submitter: String,
$submitterId: Int
) {
sourceSuggestions(
after: $after,
before: $before,
citation: $citation,
citationId: $citationId,
comment: $comment,
diseaseName: $diseaseName,
first: $first,
last: $last,
molecularProfileName: $molecularProfileName,
sortBy: $sortBy,
sourceId: $sourceId,
sourceType: $sourceType,
status: $status,
submitter: $submitter,
submitterId: $submitterId
) {
edges {
...SourceSuggestionEdgeFragment
}
filteredCount
nodes {
...SourceSuggestionFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"citation": "xyz789",
"citationId": 123,
"comment": "abc123",
"diseaseName": "abc123",
"first": 987,
"last": 987,
"molecularProfileName": "xyz789",
"sortBy": SourceSuggestionsSort,
"sourceId": 987,
"sourceType": "ASCO",
"status": "CURATED",
"submitter": "xyz789",
"submitterId": 123
}
Response
{
"data": {
"sourceSuggestions": {
"edges": [SourceSuggestionEdge],
"filteredCount": 123,
"nodes": [SourceSuggestion],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
sourceTypeahead
Description
Provide suggestions for sources based on a partial citation ID
Response
Returns [Source!]!
Arguments
| Name | Description |
|---|---|
citationId - String!
|
|
sourceType - SourceSource!
|
Example
Query
query sourceTypeahead(
$citationId: String!,
$sourceType: SourceSource!
) {
sourceTypeahead(
citationId: $citationId,
sourceType: $sourceType
) {
abstract
ascoAbstractId
authorString
citation
citationId
clinicalTrials {
...ClinicalTrialFragment
}
comments {
...CommentConnectionFragment
}
displayType
events {
...EventConnectionFragment
}
fullJournalTitle
id
journal
lastCommentEvent {
...EventFragment
}
link
name
pmcId
publicationDate
publicationDay
publicationMonth
publicationYear
sourceType
sourceUrl
title
}
}
Variables
{
"citationId": "xyz789",
"sourceType": "ASCO"
}
Response
{
"data": {
"sourceTypeahead": [
{
"abstract": "abc123",
"ascoAbstractId": 987,
"authorString": "xyz789",
"citation": "xyz789",
"citationId": "xyz789",
"clinicalTrials": [ClinicalTrial],
"comments": CommentConnection,
"displayType": "xyz789",
"events": EventConnection,
"fullJournalTitle": "abc123",
"id": 987,
"journal": "xyz789",
"lastCommentEvent": Event,
"link": "abc123",
"name": "abc123",
"pmcId": "xyz789",
"publicationDate": "xyz789",
"publicationDay": 123,
"publicationMonth": 123,
"publicationYear": 123,
"sourceType": "ASCO",
"sourceUrl": "abc123",
"title": "xyz789"
}
]
}
}
subscriptionForEntity
Description
Get the active subscription for the entity and logged in user, if any
Response
Returns a Subscription
Arguments
| Name | Description |
|---|---|
subscribable - SubscribableInput!
|
Example
Query
query subscriptionForEntity($subscribable: SubscribableInput!) {
subscriptionForEntity(subscribable: $subscribable) {
id
subscribable {
...EventSubjectFragment
}
}
}
Variables
{"subscribable": SubscribableInput}
Response
{
"data": {
"subscriptionForEntity": {
"id": 123,
"subscribable": EventSubject
}
}
}
therapies
Description
List and filter Therapies from the NCI Thesaurus.
Response
Returns a BrowseTherapyConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
id - Int
|
Filter on a therapy's internal CIViC id |
last - Int
|
Returns the last n elements from the list. |
name - String
|
Wildcard match on therapy name |
ncitId - String
|
Limit to therapies with a specific NCIT ID |
sortBy - TherapySort
|
Sort order for the therapies. Defaults to the highest evidence item count. |
Example
Query
query therapies(
$after: String,
$before: String,
$first: Int,
$id: Int,
$last: Int,
$name: String,
$ncitId: String,
$sortBy: TherapySort
) {
therapies(
after: $after,
before: $before,
first: $first,
id: $id,
last: $last,
name: $name,
ncitId: $ncitId,
sortBy: $sortBy
) {
edges {
...BrowseTherapyEdgeFragment
}
filteredCount
nodes {
...BrowseTherapyFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"first": 987,
"id": 123,
"last": 987,
"name": "xyz789",
"ncitId": "xyz789",
"sortBy": TherapySort
}
Response
{
"data": {
"therapies": {
"edges": [BrowseTherapyEdge],
"filteredCount": 987,
"nodes": [BrowseTherapy],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
therapy
Description
Find a therapy by CIViC ID
Example
Query
query therapy($id: Int!) {
therapy(id: $id) {
id
link
myChemInfo {
...MyChemInfoFragment
}
name
ncitId
therapyAliases
therapyUrl
}
}
Variables
{"id": 123}
Response
{
"data": {
"therapy": {
"id": 123,
"link": "xyz789",
"myChemInfo": MyChemInfo,
"name": "abc123",
"ncitId": "abc123",
"therapyAliases": ["abc123"],
"therapyUrl": "xyz789"
}
}
}
therapyPopover
Description
Retrieve popover fields for a specific therapy.
Response
Returns a TherapyPopover
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query therapyPopover($id: Int!) {
therapyPopover(id: $id) {
assertionCount
evidenceItemCount
id
link
molecularProfileCount
myChemInfo {
...MyChemInfoFragment
}
name
ncitId
therapyAliases
therapyUrl
}
}
Variables
{"id": 987}
Response
{
"data": {
"therapyPopover": {
"assertionCount": 987,
"evidenceItemCount": 987,
"id": 987,
"link": "abc123",
"molecularProfileCount": 987,
"myChemInfo": MyChemInfo,
"name": "xyz789",
"ncitId": "xyz789",
"therapyAliases": ["xyz789"],
"therapyUrl": "abc123"
}
}
}
therapyTypeahead
Description
Retrieve therapy typeahead fields for a search term.
Response
Returns [Therapy!]!
Arguments
| Name | Description |
|---|---|
queryTerm - String!
|
Example
Query
query therapyTypeahead($queryTerm: String!) {
therapyTypeahead(queryTerm: $queryTerm) {
id
link
myChemInfo {
...MyChemInfoFragment
}
name
ncitId
therapyAliases
therapyUrl
}
}
Variables
{"queryTerm": "xyz789"}
Response
{
"data": {
"therapyTypeahead": [
{
"id": 123,
"link": "abc123",
"myChemInfo": MyChemInfo,
"name": "abc123",
"ncitId": "xyz789",
"therapyAliases": ["abc123"],
"therapyUrl": "abc123"
}
]
}
}
timepointStats
Response
Returns a CivicTimepointStats!
Example
Query
query timepointStats {
timepointStats {
assertions {
...TimePointCountsFragment
}
comments {
...TimePointCountsFragment
}
diseases {
...TimePointCountsFragment
}
evidenceItems {
...TimePointCountsFragment
}
genes {
...TimePointCountsFragment
}
molecularProfiles {
...TimePointCountsFragment
}
revisions {
...TimePointCountsFragment
}
sources {
...TimePointCountsFragment
}
therapies {
...TimePointCountsFragment
}
users {
...TimePointCountsFragment
}
variants {
...TimePointCountsFragment
}
}
}
Response
{
"data": {
"timepointStats": {
"assertions": TimePointCounts,
"comments": TimePointCounts,
"diseases": TimePointCounts,
"evidenceItems": TimePointCounts,
"genes": TimePointCounts,
"molecularProfiles": TimePointCounts,
"revisions": TimePointCounts,
"sources": TimePointCounts,
"therapies": TimePointCounts,
"users": TimePointCounts,
"variants": TimePointCounts
}
}
}
user
Example
Query
query user($id: Int!) {
user(id: $id) {
areaOfExpertise
bio
country {
...CountryFragment
}
displayName
email
events {
...EventConnectionFragment
}
facebookProfile
id
linkedinProfile
mostRecentActionTimestamp
mostRecentConflictOfInterestStatement {
...CoiFragment
}
mostRecentEvent {
...EventFragment
}
mostRecentOrganizationId
name
notifications {
...NotificationConnectionFragment
}
orcid
organizations {
...OrganizationFragment
}
profileImagePath
role
statsHash {
...StatsFragment
}
twitterHandle
url
username
}
}
Variables
{"id": 987}
Response
{
"data": {
"user": {
"areaOfExpertise": "CLINICAL_SCIENTIST",
"bio": "abc123",
"country": Country,
"displayName": "abc123",
"email": "abc123",
"events": EventConnection,
"facebookProfile": "abc123",
"id": 123,
"linkedinProfile": "abc123",
"mostRecentActionTimestamp": ISO8601DateTime,
"mostRecentConflictOfInterestStatement": Coi,
"mostRecentEvent": Event,
"mostRecentOrganizationId": 987,
"name": "abc123",
"notifications": NotificationConnection,
"orcid": "abc123",
"organizations": [Organization],
"profileImagePath": "abc123",
"role": "ADMIN",
"statsHash": Stats,
"twitterHandle": "xyz789",
"url": "xyz789",
"username": "xyz789"
}
}
}
userTypeahead
Description
Retrieve user type typeahead fields for a search term.
Example
Query
query userTypeahead($queryTerm: String!) {
userTypeahead(queryTerm: $queryTerm) {
areaOfExpertise
bio
country {
...CountryFragment
}
displayName
email
events {
...EventConnectionFragment
}
facebookProfile
id
linkedinProfile
mostRecentActionTimestamp
mostRecentConflictOfInterestStatement {
...CoiFragment
}
mostRecentEvent {
...EventFragment
}
mostRecentOrganizationId
name
notifications {
...NotificationConnectionFragment
}
orcid
organizations {
...OrganizationFragment
}
profileImagePath
role
statsHash {
...StatsFragment
}
twitterHandle
url
username
}
}
Variables
{"queryTerm": "abc123"}
Response
{
"data": {
"userTypeahead": [
{
"areaOfExpertise": "CLINICAL_SCIENTIST",
"bio": "abc123",
"country": Country,
"displayName": "xyz789",
"email": "xyz789",
"events": EventConnection,
"facebookProfile": "abc123",
"id": 123,
"linkedinProfile": "xyz789",
"mostRecentActionTimestamp": ISO8601DateTime,
"mostRecentConflictOfInterestStatement": Coi,
"mostRecentEvent": Event,
"mostRecentOrganizationId": 123,
"name": "abc123",
"notifications": NotificationConnection,
"orcid": "xyz789",
"organizations": [Organization],
"profileImagePath": "xyz789",
"role": "ADMIN",
"statsHash": Stats,
"twitterHandle": "xyz789",
"url": "abc123",
"username": "abc123"
}
]
}
}
users
Description
List and filter users.
Response
Returns a UserConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
name - String
|
Filtering on name |
organization - OrganizationFilter
|
Limit to users that belong to a certain organizations |
role - UserRole
|
Filtering on role. |
sortBy - UsersSort
|
Sort user columns in ascending or decending order |
username - String
|
Filtering on username |
Example
Query
query users(
$after: String,
$before: String,
$first: Int,
$last: Int,
$name: String,
$organization: OrganizationFilter,
$role: UserRole,
$sortBy: UsersSort,
$username: String
) {
users(
after: $after,
before: $before,
first: $first,
last: $last,
name: $name,
organization: $organization,
role: $role,
sortBy: $sortBy,
username: $username
) {
edges {
...UserEdgeFragment
}
nodes {
...UserFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"first": 123,
"last": 123,
"name": "abc123",
"organization": OrganizationFilter,
"role": "ADMIN",
"sortBy": UsersSort,
"username": "abc123"
}
Response
{
"data": {
"users": {
"edges": [UserEdge],
"nodes": [User],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
validateRevisionsForAcceptance
Response
Returns a ValidationErrors!
Arguments
| Name | Description |
|---|---|
revisionIds - [Int!]!
|
A list of CIViC Revisions IDs to validate |
Example
Query
query validateRevisionsForAcceptance($revisionIds: [Int!]!) {
validateRevisionsForAcceptance(revisionIds: $revisionIds) {
genericErrors
validationErrors {
...FieldValidationErrorFragment
}
}
}
Variables
{"revisionIds": [987]}
Response
{
"data": {
"validateRevisionsForAcceptance": {
"genericErrors": ["abc123"],
"validationErrors": [FieldValidationError]
}
}
}
variant
Description
Find a variant by CIViC ID
Example
Query
query variant($id: Int!) {
variant(id: $id) {
alleleRegistryId
clinvarIds
comments {
...CommentConnectionFragment
}
deprecated
deprecationComment {
...CommentFragment
}
deprecationEvent {
...EventFragment
}
deprecationReason
ensemblVersion
events {
...EventConnectionFragment
}
flagged
flags {
...FlagConnectionFragment
}
gene {
...GeneFragment
}
hgvsDescriptions
id
lastAcceptedRevisionEvent {
...EventFragment
}
lastCommentEvent {
...EventFragment
}
lastSubmittedRevisionEvent {
...EventFragment
}
link
maneSelectTranscript
molecularProfiles {
...MolecularProfileConnectionFragment
}
myVariantInfo {
...MyVariantInfoFragment
}
name
openCravatUrl
primaryCoordinates {
...CoordinateFragment
}
referenceBases
referenceBuild
revisions {
...RevisionConnectionFragment
}
secondaryCoordinates {
...CoordinateFragment
}
singleVariantMolecularProfile {
...MolecularProfileFragment
}
singleVariantMolecularProfileId
variantAliases
variantBases
variantTypes {
...VariantTypeFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"variant": {
"alleleRegistryId": "xyz789",
"clinvarIds": ["abc123"],
"comments": CommentConnection,
"deprecated": false,
"deprecationComment": Comment,
"deprecationEvent": Event,
"deprecationReason": "DUPLICATE",
"ensemblVersion": 987,
"events": EventConnection,
"flagged": false,
"flags": FlagConnection,
"gene": Gene,
"hgvsDescriptions": ["xyz789"],
"id": 987,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"maneSelectTranscript": "xyz789",
"molecularProfiles": MolecularProfileConnection,
"myVariantInfo": MyVariantInfo,
"name": "abc123",
"openCravatUrl": "xyz789",
"primaryCoordinates": Coordinate,
"referenceBases": "abc123",
"referenceBuild": "GRCH37",
"revisions": RevisionConnection,
"secondaryCoordinates": Coordinate,
"singleVariantMolecularProfile": MolecularProfile,
"singleVariantMolecularProfileId": 987,
"variantAliases": ["xyz789"],
"variantBases": "abc123",
"variantTypes": [VariantType]
}
}
}
variantGroup
Description
Find a variant group by CIViC ID
Response
Returns a VariantGroup
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query variantGroup($id: Int!) {
variantGroup(id: $id) {
comments {
...CommentConnectionFragment
}
description
events {
...EventConnectionFragment
}
flagged
flags {
...FlagConnectionFragment
}
id
lastAcceptedRevisionEvent {
...EventFragment
}
lastCommentEvent {
...EventFragment
}
lastSubmittedRevisionEvent {
...EventFragment
}
link
name
revisions {
...RevisionConnectionFragment
}
sources {
...SourceFragment
}
variants {
...VariantConnectionFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"variantGroup": {
"comments": CommentConnection,
"description": "abc123",
"events": EventConnection,
"flagged": false,
"flags": FlagConnection,
"id": 987,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"name": "abc123",
"revisions": RevisionConnection,
"sources": [Source],
"variants": VariantConnection
}
}
}
variantGroups
Description
List and filter variant groups.
Response
Returns a VariantGroupConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
geneId - Int
|
Gene that variant groups are associated with. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query variantGroups(
$after: String,
$before: String,
$first: Int,
$geneId: Int,
$last: Int
) {
variantGroups(
after: $after,
before: $before,
first: $first,
geneId: $geneId,
last: $last
) {
edges {
...VariantGroupEdgeFragment
}
nodes {
...VariantGroupFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"first": 987,
"geneId": 987,
"last": 123
}
Response
{
"data": {
"variantGroups": {
"edges": [VariantGroupEdge],
"nodes": [VariantGroup],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
variantType
Description
Find a variant type by CIViC ID
Response
Returns a VariantType
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query variantType($id: Int!) {
variantType(id: $id) {
description
id
link
name
soid
url
}
}
Variables
{"id": 987}
Response
{
"data": {
"variantType": {
"description": "xyz789",
"id": 987,
"link": "xyz789",
"name": "abc123",
"soid": "xyz789",
"url": "xyz789"
}
}
}
variantTypePopover
Description
Retrieve popover fields for a specific variant type.
Response
Returns a VariantTypePopover
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query variantTypePopover($id: Int!) {
variantTypePopover(id: $id) {
description
id
link
name
soid
url
variantCount
}
}
Variables
{"id": 987}
Response
{
"data": {
"variantTypePopover": {
"description": "xyz789",
"id": 987,
"link": "xyz789",
"name": "xyz789",
"soid": "abc123",
"url": "abc123",
"variantCount": 987
}
}
}
variantTypeTypeahead
Description
Retrieve variant type typeahead fields for a search term.
Response
Returns [VariantType!]!
Arguments
| Name | Description |
|---|---|
queryTerm - String!
|
Example
Query
query variantTypeTypeahead($queryTerm: String!) {
variantTypeTypeahead(queryTerm: $queryTerm) {
description
id
link
name
soid
url
}
}
Variables
{"queryTerm": "xyz789"}
Response
{
"data": {
"variantTypeTypeahead": [
{
"description": "xyz789",
"id": 123,
"link": "abc123",
"name": "xyz789",
"soid": "xyz789",
"url": "abc123"
}
]
}
}
variantTypes
Description
List and filter Variant Types from the Sequence Ontology.
Response
Returns a BrowseVariantTypeConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
geneId - Int
|
Filter variant types by internal CIViC id of a gene |
id - Int
|
Filter variant types by internal CIViC id |
last - Int
|
Returns the last n elements from the list. |
name - String
|
Wildcard match on variant type name |
soid - String
|
Limit to variant types with a specific Sequence Ontology ID |
sortBy - VariantTypeSort
|
Sort order for the variant type. Defaults to most recent. |
Example
Query
query variantTypes(
$after: String,
$before: String,
$first: Int,
$geneId: Int,
$id: Int,
$last: Int,
$name: String,
$soid: String,
$sortBy: VariantTypeSort
) {
variantTypes(
after: $after,
before: $before,
first: $first,
geneId: $geneId,
id: $id,
last: $last,
name: $name,
soid: $soid,
sortBy: $sortBy
) {
edges {
...BrowseVariantTypeEdgeFragment
}
filteredCount
nodes {
...BrowseVariantTypeFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"first": 987,
"geneId": 123,
"id": 987,
"last": 987,
"name": "abc123",
"soid": "xyz789",
"sortBy": VariantTypeSort
}
Response
{
"data": {
"variantTypes": {
"edges": [BrowseVariantTypeEdge],
"filteredCount": 123,
"nodes": [BrowseVariantType],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
variants
Description
List and filter variants.
Response
Returns a VariantConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
geneId - Int
|
Gene that variants are associated with. |
hasNoVariantType - Boolean
|
Return Variants lacking an assigned VariantType |
last - Int
|
Returns the last n elements from the list. |
name - String
|
Left anchored filtering for variant name and aliases. |
sortBy - VariantMenuSort
|
|
variantTypeIds - [Int!]
|
A list of CIViC identifiers for variant types |
Example
Query
query variants(
$after: String,
$before: String,
$first: Int,
$geneId: Int,
$hasNoVariantType: Boolean,
$last: Int,
$name: String,
$sortBy: VariantMenuSort,
$variantTypeIds: [Int!]
) {
variants(
after: $after,
before: $before,
first: $first,
geneId: $geneId,
hasNoVariantType: $hasNoVariantType,
last: $last,
name: $name,
sortBy: $sortBy,
variantTypeIds: $variantTypeIds
) {
edges {
...VariantEdgeFragment
}
nodes {
...VariantFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"first": 987,
"geneId": 123,
"hasNoVariantType": false,
"last": 987,
"name": "abc123",
"sortBy": VariantMenuSort,
"variantTypeIds": [987]
}
Response
{
"data": {
"variants": {
"edges": [VariantEdge],
"nodes": [Variant],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
viewer
Response
Returns a User
Example
Query
query viewer {
viewer {
areaOfExpertise
bio
country {
...CountryFragment
}
displayName
email
events {
...EventConnectionFragment
}
facebookProfile
id
linkedinProfile
mostRecentActionTimestamp
mostRecentConflictOfInterestStatement {
...CoiFragment
}
mostRecentEvent {
...EventFragment
}
mostRecentOrganizationId
name
notifications {
...NotificationConnectionFragment
}
orcid
organizations {
...OrganizationFragment
}
profileImagePath
role
statsHash {
...StatsFragment
}
twitterHandle
url
username
}
}
Response
{
"data": {
"viewer": {
"areaOfExpertise": "CLINICAL_SCIENTIST",
"bio": "abc123",
"country": Country,
"displayName": "abc123",
"email": "xyz789",
"events": EventConnection,
"facebookProfile": "abc123",
"id": 987,
"linkedinProfile": "abc123",
"mostRecentActionTimestamp": ISO8601DateTime,
"mostRecentConflictOfInterestStatement": Coi,
"mostRecentEvent": Event,
"mostRecentOrganizationId": 123,
"name": "abc123",
"notifications": NotificationConnection,
"orcid": "xyz789",
"organizations": [Organization],
"profileImagePath": "xyz789",
"role": "ADMIN",
"statsHash": Stats,
"twitterHandle": "abc123",
"url": "abc123",
"username": "xyz789"
}
}
}
Mutations
acceptRevisions
Description
Accept multiple revisions by ID. The accepting user must be an editor with a valid conflict of interest statement on file and the revisions must not be their own. The revisions must be for the same subject. The revisions may not conflict, i.e. be for the same field.
Response
Returns an AcceptRevisionsPayload
Arguments
| Name | Description |
|---|---|
input - AcceptRevisionsInput!
|
Parameters for AcceptRevisions |
Example
Query
mutation acceptRevisions($input: AcceptRevisionsInput!) {
acceptRevisions(input: $input) {
clientMutationId
revisions {
...RevisionFragment
}
supersededRevisions {
...RevisionFragment
}
}
}
Variables
{"input": AcceptRevisionsInput}
Response
{
"data": {
"acceptRevisions": {
"clientMutationId": "abc123",
"revisions": [Revision],
"supersededRevisions": [Revision]
}
}
}
addComment
Description
Add a comment to any commentable entity.
Response
Returns an AddCommentPayload
Arguments
| Name | Description |
|---|---|
input - AddCommentInput!
|
Parameters for AddComment |
Example
Query
mutation addComment($input: AddCommentInput!) {
addComment(input: $input) {
clientMutationId
comment {
...CommentFragment
}
}
}
Variables
{"input": AddCommentInput}
Response
{
"data": {
"addComment": {
"clientMutationId": "abc123",
"comment": Comment
}
}
}
addDisease
Description
Add a new disease to the database.
Response
Returns an AddDiseasePayload
Arguments
| Name | Description |
|---|---|
input - AddDiseaseInput!
|
Parameters for AddDisease |
Example
Query
mutation addDisease($input: AddDiseaseInput!) {
addDisease(input: $input) {
clientMutationId
disease {
...DiseaseFragment
}
new
}
}
Variables
{"input": AddDiseaseInput}
Response
{
"data": {
"addDisease": {
"clientMutationId": "xyz789",
"disease": Disease,
"new": true
}
}
}
addRemoteCitation
Description
Add a stub record for an external source that is not yet in CIViC. This is for adding a new Source inline while performing other curation activities such as adding new evidence items and is distinct from suggesting a source for curation.
Response
Returns an AddRemoteCitationPayload
Arguments
| Name | Description |
|---|---|
input - AddRemoteCitationInput!
|
Parameters for AddRemoteCitation |
Example
Query
mutation addRemoteCitation($input: AddRemoteCitationInput!) {
addRemoteCitation(input: $input) {
clientMutationId
newSource {
...SourceStubFragment
}
}
}
Variables
{"input": AddRemoteCitationInput}
Response
{
"data": {
"addRemoteCitation": {
"clientMutationId": "xyz789",
"newSource": SourceStub
}
}
}
addTherapy
Description
Add a new therapy to the database.
Response
Returns an AddTherapyPayload
Arguments
| Name | Description |
|---|---|
input - AddTherapyInput!
|
Parameters for AddTherapy |
Example
Query
mutation addTherapy($input: AddTherapyInput!) {
addTherapy(input: $input) {
clientMutationId
new
therapy {
...TherapyFragment
}
}
}
Variables
{"input": AddTherapyInput}
Response
{
"data": {
"addTherapy": {
"clientMutationId": "xyz789",
"new": false,
"therapy": Therapy
}
}
}
addVariant
Description
Add a new Variant to the database.
Response
Returns an AddVariantPayload
Arguments
| Name | Description |
|---|---|
input - AddVariantInput!
|
Parameters for AddVariant |
Example
Query
mutation addVariant($input: AddVariantInput!) {
addVariant(input: $input) {
clientMutationId
molecularProfile {
...MolecularProfileFragment
}
new
variant {
...VariantFragment
}
}
}
Variables
{"input": AddVariantInput}
Response
{
"data": {
"addVariant": {
"clientMutationId": "xyz789",
"molecularProfile": MolecularProfile,
"new": false,
"variant": Variant
}
}
}
createMolecularProfile
Description
Create a new Molecular Profile in order to attach Evidence Items to it.
Response
Returns a CreateMolecularProfilePayload
Arguments
| Name | Description |
|---|---|
input - CreateMolecularProfileInput!
|
Parameters for CreateMolecularProfile |
Example
Query
mutation createMolecularProfile($input: CreateMolecularProfileInput!) {
createMolecularProfile(input: $input) {
clientMutationId
molecularProfile {
...MolecularProfileFragment
}
}
}
Variables
{"input": CreateMolecularProfileInput}
Response
{
"data": {
"createMolecularProfile": {
"clientMutationId": "xyz789",
"molecularProfile": MolecularProfile
}
}
}
deprecateVariant
Description
Deprecate a variant to prevent it from being used in the future and implicitly deprecate all the molecular profiles linked to this variant.
Response
Returns a DeprecateVariantPayload
Arguments
| Name | Description |
|---|---|
input - DeprecateVariantInput!
|
Parameters for DeprecateVariant |
Example
Query
mutation deprecateVariant($input: DeprecateVariantInput!) {
deprecateVariant(input: $input) {
clientMutationId
newlyDeprecatedMolecularProfiles {
...MolecularProfileFragment
}
variant {
...VariantFragment
}
}
}
Variables
{"input": DeprecateVariantInput}
Response
{
"data": {
"deprecateVariant": {
"clientMutationId": "abc123",
"newlyDeprecatedMolecularProfiles": [
MolecularProfile
],
"variant": Variant
}
}
}
editUser
Description
Updated currently logged in Users's profile
Response
Returns an EditUserPayload
Arguments
| Name | Description |
|---|---|
input - EditUserInput!
|
Parameters for EditUser |
Example
Query
mutation editUser($input: EditUserInput!) {
editUser(input: $input) {
clientMutationId
user {
...UserFragment
}
}
}
Variables
{"input": EditUserInput}
Response
{
"data": {
"editUser": {
"clientMutationId": "xyz789",
"user": User
}
}
}
flagEntity
Description
Flag an entity to signal to the editorial team that you believe there is an issue with it.
Response
Returns a FlagEntityPayload
Arguments
| Name | Description |
|---|---|
input - FlagEntityInput!
|
Parameters for FlagEntity |
Example
Query
mutation flagEntity($input: FlagEntityInput!) {
flagEntity(input: $input) {
clientMutationId
flag {
...FlagFragment
}
}
}
Variables
{"input": FlagEntityInput}
Response
{
"data": {
"flagEntity": {
"clientMutationId": "abc123",
"flag": Flag
}
}
}
moderateAssertion
Description
Perform moderation actions on an assertion such as accepting, rejecting, or reverting.
Response
Returns a ModerateAssertionPayload
Arguments
| Name | Description |
|---|---|
input - ModerateAssertionInput!
|
Parameters for ModerateAssertion |
Example
Query
mutation moderateAssertion($input: ModerateAssertionInput!) {
moderateAssertion(input: $input) {
assertion {
...AssertionFragment
}
clientMutationId
}
}
Variables
{"input": ModerateAssertionInput}
Response
{
"data": {
"moderateAssertion": {
"assertion": Assertion,
"clientMutationId": "xyz789"
}
}
}
moderateEvidenceItem
Description
Perform moderation actions on an evidence item such as accepting, rejecting, or reverting.
Response
Returns a ModerateEvidenceItemPayload
Arguments
| Name | Description |
|---|---|
input - ModerateEvidenceItemInput!
|
Parameters for ModerateEvidenceItem |
Example
Query
mutation moderateEvidenceItem($input: ModerateEvidenceItemInput!) {
moderateEvidenceItem(input: $input) {
clientMutationId
evidenceItem {
...EvidenceItemFragment
}
}
}
Variables
{"input": ModerateEvidenceItemInput}
Response
{
"data": {
"moderateEvidenceItem": {
"clientMutationId": "abc123",
"evidenceItem": EvidenceItem
}
}
}
rejectRevisions
Description
Reject one or more revisions by ID or revision set ID. Any user may reject a Revision that they submitted themselves. Otherwise, the rejecting user must be an editor with valid conflict of interest statement on file.
Response
Returns a RejectRevisionsPayload
Arguments
| Name | Description |
|---|---|
input - RejectRevisionsInput!
|
Parameters for RejectRevisions |
Example
Query
mutation rejectRevisions($input: RejectRevisionsInput!) {
rejectRevisions(input: $input) {
clientMutationId
revisions {
...RevisionFragment
}
}
}
Variables
{"input": RejectRevisionsInput}
Response
{
"data": {
"rejectRevisions": {
"clientMutationId": "abc123",
"revisions": [Revision]
}
}
}
resolveFlag
Description
Resolve a flag on a CIViC entity indicating that it was either erronously flagged or the issue has been resolved. Any user may resolve their own flag however only editors with valid conflict of interest statements can resolve other flags.
Response
Returns a ResolveFlagPayload
Arguments
| Name | Description |
|---|---|
input - ResolveFlagInput!
|
Parameters for ResolveFlag |
Example
Query
mutation resolveFlag($input: ResolveFlagInput!) {
resolveFlag(input: $input) {
clientMutationId
flag {
...FlagFragment
}
}
}
Variables
{"input": ResolveFlagInput}
Response
{
"data": {
"resolveFlag": {
"clientMutationId": "xyz789",
"flag": Flag
}
}
}
submitAssertion
Description
Propose adding a new Assertion to the CIViC database.
Response
Returns a SubmitAssertionPayload
Arguments
| Name | Description |
|---|---|
input - SubmitAssertionInput!
|
Parameters for SubmitAssertion |
Example
Query
mutation submitAssertion($input: SubmitAssertionInput!) {
submitAssertion(input: $input) {
assertion {
...AssertionFragment
}
clientMutationId
}
}
Variables
{"input": SubmitAssertionInput}
Response
{
"data": {
"submitAssertion": {
"assertion": Assertion,
"clientMutationId": "xyz789"
}
}
}
submitEvidence
Description
Propose adding a new EvidenceItem to the CIViC database.
Response
Returns a SubmitEvidenceItemPayload
Arguments
| Name | Description |
|---|---|
input - SubmitEvidenceItemInput!
|
Parameters for SubmitEvidenceItem |
Example
Query
mutation submitEvidence($input: SubmitEvidenceItemInput!) {
submitEvidence(input: $input) {
clientMutationId
evidenceItem {
...EvidenceItemFragment
}
}
}
Variables
{"input": SubmitEvidenceItemInput}
Response
{
"data": {
"submitEvidence": {
"clientMutationId": "xyz789",
"evidenceItem": EvidenceItem
}
}
}
submitVariantGroup
Description
Create a new variant group.
Response
Returns a SubmitVariantGroupPayload
Arguments
| Name | Description |
|---|---|
input - SubmitVariantGroupInput!
|
Parameters for SubmitVariantGroup |
Example
Query
mutation submitVariantGroup($input: SubmitVariantGroupInput!) {
submitVariantGroup(input: $input) {
clientMutationId
variantGroup {
...VariantGroupFragment
}
}
}
Variables
{"input": SubmitVariantGroupInput}
Response
{
"data": {
"submitVariantGroup": {
"clientMutationId": "xyz789",
"variantGroup": VariantGroup
}
}
}
subscribe
Description
Subscribe to a CIViC entity in order to receive notifications about it.
Response
Returns a SubscribePayload
Arguments
| Name | Description |
|---|---|
input - SubscribeInput!
|
Parameters for Subscribe |
Example
Query
mutation subscribe($input: SubscribeInput!) {
subscribe(input: $input) {
clientMutationId
subscriptions {
...SubscriptionFragment
}
}
}
Variables
{"input": SubscribeInput}
Response
{
"data": {
"subscribe": {
"clientMutationId": "xyz789",
"subscriptions": [Subscription]
}
}
}
suggestAssertionRevision
Description
Suggest a Revision to an Assertion entity.
Response
Returns a SuggestAssertionRevisionPayload
Arguments
| Name | Description |
|---|---|
input - SuggestAssertionRevisionInput!
|
Parameters for SuggestAssertionRevision |
Example
Query
mutation suggestAssertionRevision($input: SuggestAssertionRevisionInput!) {
suggestAssertionRevision(input: $input) {
assertion {
...AssertionFragment
}
clientMutationId
results {
...RevisionResultFragment
}
}
}
Variables
{"input": SuggestAssertionRevisionInput}
Response
{
"data": {
"suggestAssertionRevision": {
"assertion": Assertion,
"clientMutationId": "xyz789",
"results": [RevisionResult]
}
}
}
suggestEvidenceItemRevision
Description
Suggest a Revision to an EvidenceItem entity.
Response
Returns a SuggestEvidenceItemRevisionPayload
Arguments
| Name | Description |
|---|---|
input - SuggestEvidenceItemRevisionInput!
|
Parameters for SuggestEvidenceItemRevision |
Example
Query
mutation suggestEvidenceItemRevision($input: SuggestEvidenceItemRevisionInput!) {
suggestEvidenceItemRevision(input: $input) {
clientMutationId
evidenceItem {
...EvidenceItemFragment
}
results {
...RevisionResultFragment
}
}
}
Variables
{"input": SuggestEvidenceItemRevisionInput}
Response
{
"data": {
"suggestEvidenceItemRevision": {
"clientMutationId": "xyz789",
"evidenceItem": EvidenceItem,
"results": [RevisionResult]
}
}
}
suggestGeneRevision
Description
Suggest a Revision to a Gene entity.
Response
Returns a SuggestGeneRevisionPayload
Arguments
| Name | Description |
|---|---|
input - SuggestGeneRevisionInput!
|
Parameters for SuggestGeneRevision |
Example
Query
mutation suggestGeneRevision($input: SuggestGeneRevisionInput!) {
suggestGeneRevision(input: $input) {
clientMutationId
gene {
...GeneFragment
}
results {
...RevisionResultFragment
}
}
}
Variables
{"input": SuggestGeneRevisionInput}
Response
{
"data": {
"suggestGeneRevision": {
"clientMutationId": "xyz789",
"gene": Gene,
"results": [RevisionResult]
}
}
}
suggestMolecularProfileRevision
Description
Suggest a Revision to a MolecularProfile entity.
Response
Returns a SuggestMolecularProfileRevisionPayload
Arguments
| Name | Description |
|---|---|
input - SuggestMolecularProfileRevisionInput!
|
Parameters for SuggestMolecularProfileRevision |
Example
Query
mutation suggestMolecularProfileRevision($input: SuggestMolecularProfileRevisionInput!) {
suggestMolecularProfileRevision(input: $input) {
clientMutationId
molecularProfile {
...MolecularProfileFragment
}
results {
...RevisionResultFragment
}
}
}
Variables
{"input": SuggestMolecularProfileRevisionInput}
Response
{
"data": {
"suggestMolecularProfileRevision": {
"clientMutationId": "xyz789",
"molecularProfile": MolecularProfile,
"results": [RevisionResult]
}
}
}
suggestSource
Description
Suggest a source for curation in CIViC.
Response
Returns a SuggestSourcePayload
Arguments
| Name | Description |
|---|---|
input - SuggestSourceInput!
|
Parameters for SuggestSource |
Example
Query
mutation suggestSource($input: SuggestSourceInput!) {
suggestSource(input: $input) {
clientMutationId
sourceSuggestion {
...SourceSuggestionFragment
}
}
}
Variables
{"input": SuggestSourceInput}
Response
{
"data": {
"suggestSource": {
"clientMutationId": "abc123",
"sourceSuggestion": SourceSuggestion
}
}
}
suggestVariantGroupRevision
Description
Suggested a Revision to a Variant Group entity
Response
Returns a SuggestVariantGroupRevisionPayload
Arguments
| Name | Description |
|---|---|
input - SuggestVariantGroupRevisionInput!
|
Parameters for SuggestVariantGroupRevision |
Example
Query
mutation suggestVariantGroupRevision($input: SuggestVariantGroupRevisionInput!) {
suggestVariantGroupRevision(input: $input) {
clientMutationId
results {
...RevisionResultFragment
}
variantGroup {
...VariantGroupFragment
}
}
}
Variables
{"input": SuggestVariantGroupRevisionInput}
Response
{
"data": {
"suggestVariantGroupRevision": {
"clientMutationId": "xyz789",
"results": [RevisionResult],
"variantGroup": VariantGroup
}
}
}
suggestVariantRevision
Description
Suggest a Revision to a Variant entity.
Response
Returns a SuggestVariantRevisionPayload
Arguments
| Name | Description |
|---|---|
input - SuggestVariantRevisionInput!
|
Parameters for SuggestVariantRevision |
Example
Query
mutation suggestVariantRevision($input: SuggestVariantRevisionInput!) {
suggestVariantRevision(input: $input) {
clientMutationId
results {
...RevisionResultFragment
}
variant {
...VariantFragment
}
}
}
Variables
{"input": SuggestVariantRevisionInput}
Response
{
"data": {
"suggestVariantRevision": {
"clientMutationId": "abc123",
"results": [RevisionResult],
"variant": Variant
}
}
}
unsubscribe
Description
Unsubscribe from a CIViC entity to stop receiving notifications about it.
Response
Returns an UnsubscribePayload
Arguments
| Name | Description |
|---|---|
input - UnsubscribeInput!
|
Parameters for Unsubscribe |
Example
Query
mutation unsubscribe($input: UnsubscribeInput!) {
unsubscribe(input: $input) {
clientMutationId
unsubscribedEntities {
...SubscribableFragment
}
}
}
Variables
{"input": UnsubscribeInput}
Response
{
"data": {
"unsubscribe": {
"clientMutationId": "xyz789",
"unsubscribedEntities": [Subscribable]
}
}
}
updateCoi
Description
Update the currentlly logged in User's Conflict of Interest statement
Response
Returns an UpdateCoiPayload
Arguments
| Name | Description |
|---|---|
input - UpdateCoiInput!
|
Parameters for UpdateCoi |
Example
Query
mutation updateCoi($input: UpdateCoiInput!) {
updateCoi(input: $input) {
clientMutationId
coiStatement {
...CoiFragment
}
}
}
Variables
{"input": UpdateCoiInput}
Response
{
"data": {
"updateCoi": {
"clientMutationId": "abc123",
"coiStatement": Coi
}
}
}
updateNotificationStatus
Description
Mark one or more notifications as read/unread. The notification IDs provided must belong to the requesting user.
Response
Returns an UpdateNotificationStatusPayload
Arguments
| Name | Description |
|---|---|
input - UpdateNotificationStatusInput!
|
Parameters for UpdateNotificationStatus |
Example
Query
mutation updateNotificationStatus($input: UpdateNotificationStatusInput!) {
updateNotificationStatus(input: $input) {
clientMutationId
notifications {
...NotificationFragment
}
}
}
Variables
{"input": UpdateNotificationStatusInput}
Response
{
"data": {
"updateNotificationStatus": {
"clientMutationId": "abc123",
"notifications": [Notification]
}
}
}
updateSourceSuggestionStatus
Description
Update the status of a SourceSuggestion by ID. The user updating the SourceSuggestion must be signed in.
Response
Returns an UpdateSourceSuggestionStatusPayload
Arguments
| Name | Description |
|---|---|
input - UpdateSourceSuggestionStatusInput!
|
Parameters for UpdateSourceSuggestionStatus |
Example
Query
mutation updateSourceSuggestionStatus($input: UpdateSourceSuggestionStatusInput!) {
updateSourceSuggestionStatus(input: $input) {
clientMutationId
sourceSuggestion {
...SourceSuggestionFragment
}
}
}
Variables
{"input": UpdateSourceSuggestionStatusInput}
Response
{
"data": {
"updateSourceSuggestionStatus": {
"clientMutationId": "xyz789",
"sourceSuggestion": SourceSuggestion
}
}
}
Subscriptions
id
Response
Returns an Int!
Example
Query
subscription id {
id
}
Response
{"data": {"id": 123}}
subscribable
Response
Returns an EventSubject!
Example
Query
subscription subscribable {
subscribable {
events {
...EventConnectionFragment
}
id
link
name
}
}
Response
{
"data": {
"subscribable": {
"events": EventConnection,
"id": 123,
"link": "xyz789",
"name": "abc123"
}
}
}
Types
AcceptRevisionsInput
Description
Autogenerated input type of AcceptRevisions
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String
|
Body of an optional comment to attach to the revision on acceptance. |
ids - [Int!]
|
A list of IDs of the Revisions to accept. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
revisionSetId - ID
|
The ID of a revision set. |
Example
{
"clientMutationId": "xyz789",
"comment": "abc123",
"ids": [123],
"organizationId": 987,
"revisionSetId": 4
}
AcceptRevisionsPayload
Description
Autogenerated return type of AcceptRevisions
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
revisions - [Revision!]!
|
A list of newly accepted Revisions. |
supersededRevisions - [Revision!]!
|
A list of any revisions that were superseded by the acceptance of this one. |
Example
{
"clientMutationId": "xyz789",
"revisions": [Revision],
"supersededRevisions": [Revision]
}
AcmgCode
AddCommentInput
Description
Autogenerated input type of AddComment
Fields
| Input Field | Description |
|---|---|
body - String!
|
Text of the comment. |
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
subject - CommentableInput!
|
The commentable to attach the comment to. Specified by ID and Type. |
title - String
|
Optional title for the comment. |
Example
{
"body": "abc123",
"clientMutationId": "xyz789",
"organizationId": 123,
"subject": CommentableInput,
"title": "abc123"
}
AddCommentPayload
AddDiseaseInput
Description
Autogenerated input type of AddDisease
Example
{
"clientMutationId": "xyz789",
"doid": "abc123",
"name": "abc123"
}
AddDiseasePayload
Description
Autogenerated return type of AddDisease
Example
{
"clientMutationId": "xyz789",
"disease": Disease,
"new": true
}
AddRemoteCitationInput
Description
Autogenerated input type of AddRemoteCitation
Fields
| Input Field | Description |
|---|---|
citationId - String!
|
The external id for the source to add. |
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
sourceType - SourceSource!
|
The origin of the external source. |
Example
{
"citationId": "xyz789",
"clientMutationId": "abc123",
"sourceType": "ASCO"
}
AddRemoteCitationPayload
Description
Autogenerated return type of AddRemoteCitation
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
newSource - SourceStub!
|
The stubbed in record for the newly created source. |
Example
{
"clientMutationId": "xyz789",
"newSource": SourceStub
}
AddTherapyInput
Description
Autogenerated input type of AddTherapy
Example
{
"clientMutationId": "abc123",
"name": "abc123",
"ncitId": "abc123"
}
AddTherapyPayload
Description
Autogenerated return type of AddTherapy
Example
{
"clientMutationId": "abc123",
"new": false,
"therapy": Therapy
}
AddVariantInput
Description
Autogenerated input type of AddVariant
Example
{
"clientMutationId": "abc123",
"geneId": 987,
"name": "xyz789"
}
AddVariantPayload
Description
Autogenerated return type of AddVariant
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
molecularProfile - MolecularProfile!
|
The newly created molecular profile for the new variant. |
new - Boolean!
|
True if the variant was newly created. False if the returned variant was already in the database. |
variant - Variant!
|
The newly created Variant. |
Example
{
"clientMutationId": "abc123",
"molecularProfile": MolecularProfile,
"new": true,
"variant": Variant
}
AdvancedSearchResult
AmpLevel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NA"
AreaOfExpertise
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CLINICAL_SCIENTIST"
Assertion
Fields
| Field Name | Description |
|---|---|
acceptanceEvent - Event
|
|
acmgCodes - [AcmgCode!]!
|
|
ampLevel - AmpLevel
|
|
assertionDirection - AssertionDirection!
|
|
assertionType - AssertionType!
|
|
clingenCodes - [ClingenCode!]!
|
|
comments - CommentConnection!
|
List and filter comments. |
Arguments
|
|
description - String!
|
|
disease - Disease
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
evidenceItems - [EvidenceItem!]!
|
|
evidenceItemsCount - Int!
|
|
fdaCompanionTest - Boolean
|
|
fdaCompanionTestLastUpdated - ISO8601DateTime
|
|
flagged - Boolean!
|
|
flags - FlagConnection!
|
List and filter flags. |
Arguments
|
|
id - Int!
|
|
lastAcceptedRevisionEvent - Event
|
|
lastCommentEvent - Event
|
|
lastSubmittedRevisionEvent - Event
|
|
link - String!
|
|
molecularProfile - MolecularProfile!
|
|
name - String!
|
|
nccnGuideline - NccnGuideline
|
|
nccnGuidelineVersion - String
|
|
phenotypes - [Phenotype!]!
|
|
regulatoryApproval - Boolean
|
|
regulatoryApprovalLastUpdated - ISO8601DateTime
|
|
rejectionEvent - Event
|
|
revisions - RevisionConnection!
|
List and filter revisions. |
Arguments
|
|
significance - AssertionSignificance!
|
|
status - EvidenceStatus!
|
|
submissionEvent - Event!
|
|
summary - String!
|
|
therapies - [Therapy!]!
|
|
therapyInteractionType - TherapyInteraction
|
|
variantOrigin - VariantOrigin!
|
|
Example
{
"acceptanceEvent": Event,
"acmgCodes": [AcmgCode],
"ampLevel": "NA",
"assertionDirection": "DOES_NOT_SUPPORT",
"assertionType": "DIAGNOSTIC",
"clingenCodes": [ClingenCode],
"comments": CommentConnection,
"description": "abc123",
"disease": Disease,
"events": EventConnection,
"evidenceItems": [EvidenceItem],
"evidenceItemsCount": 987,
"fdaCompanionTest": true,
"fdaCompanionTestLastUpdated": ISO8601DateTime,
"flagged": true,
"flags": FlagConnection,
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"molecularProfile": MolecularProfile,
"name": "xyz789",
"nccnGuideline": NccnGuideline,
"nccnGuidelineVersion": "abc123",
"phenotypes": [Phenotype],
"regulatoryApproval": false,
"regulatoryApprovalLastUpdated": ISO8601DateTime,
"rejectionEvent": Event,
"revisions": RevisionConnection,
"significance": "ADVERSE_RESPONSE",
"status": "ACCEPTED",
"submissionEvent": Event,
"summary": "xyz789",
"therapies": [Therapy],
"therapyInteractionType": "COMBINATION",
"variantOrigin": "COMMON_GERMLINE"
}
AssertionConnection
Description
The connection type for Assertion.
Fields
| Field Name | Description |
|---|---|
edges - [AssertionEdge!]!
|
A list of edges. |
nodes - [Assertion!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [AssertionEdge],
"nodes": [Assertion],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
AssertionDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DOES_NOT_SUPPORT"
AssertionEdge
AssertionFields
Description
Fields on an Assertion that curators may propose revisions to.
Fields
| Input Field | Description |
|---|---|
acmgCodeIds - [Int!]!
|
List of CIViC IDs for the ACMG/AMP codes associated with this Assertion |
ampLevel - NullableAmpLevelTypeInput!
|
The AMP/ASCO/CAP Category for this assertion. |
assertionDirection - AssertionDirection!
|
The evidence direction for this Assertion. |
assertionType - AssertionType!
|
The Type of the Assertion |
clingenCodeIds - [Int!]!
|
List of CIViC IDs for the ClinGen/CGC/VICC codes associated with this Assertion |
description - NullableStringInput!
|
A detailed description of the Assertion including practice guidelines and approved tests. |
diseaseId - NullableIntInput!
|
The ID of the disease (if applicable) for this Assertion |
evidenceItemIds - [Int!]!
|
IDs of evidence items that are included in this Assertion. |
fdaCompanionTest - NullableBooleanInput!
|
Is an FDA companion test available that pertains to this Assertion. |
fdaRegulatoryApproval - NullableBooleanInput!
|
Does the Assertion have FDA regulatory approval. |
molecularProfileId - Int!
|
The ID of the Molecular Profile to which this Assertion belongs |
nccnGuidelineId - NullableIntInput!
|
The internal CIViC ID of the NCCN guideline associated with this Assertion |
nccnGuidelineVersion - NullableStringInput!
|
The version of the NCCN Guideline specified |
phenotypeIds - [Int!]!
|
List of IDs of CIViC Phenotype entries for this Assertion. An empty list indicates none. |
significance - AssertionSignificance!
|
The Clinical Significance of the Assertion |
summary - NullableStringInput!
|
A brief single sentence statement summarizing the clinical significance of this Assertion. |
therapyIds - [Int!]!
|
List of IDs of CIViC Therapy entries for this Assertion. An empty list indicates none. |
therapyInteractionType - NullableTherapyInteractionTypeInput!
|
Therapy interaction type for cases where more than one therapy ID is provided. |
variantOrigin - VariantOrigin!
|
The Variant Origin for this Assertion. |
Example
{
"acmgCodeIds": [987],
"ampLevel": NullableAmpLevelTypeInput,
"assertionDirection": "DOES_NOT_SUPPORT",
"assertionType": "DIAGNOSTIC",
"clingenCodeIds": [123],
"description": NullableStringInput,
"diseaseId": NullableIntInput,
"evidenceItemIds": [987],
"fdaCompanionTest": NullableBooleanInput,
"fdaRegulatoryApproval": NullableBooleanInput,
"molecularProfileId": 987,
"nccnGuidelineId": NullableIntInput,
"nccnGuidelineVersion": NullableStringInput,
"phenotypeIds": [987],
"significance": "ADVERSE_RESPONSE",
"summary": NullableStringInput,
"therapyIds": [123],
"therapyInteractionType": NullableTherapyInteractionTypeInput,
"variantOrigin": "COMMON_GERMLINE"
}
AssertionSignificance
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADVERSE_RESPONSE"
AssertionSort
Fields
| Input Field | Description |
|---|---|
column - AssertionSortColumns!
|
Available columns for sorting |
direction - SortDirection!
|
Sort direction |
Example
{"column": "AMP_LEVEL", "direction": "ASC"}
AssertionSortColumns
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AMP_LEVEL"
AssertionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DIAGNOSTIC"
Boolean
Description
The Boolean scalar type represents true or false.
BooleanOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AND"
BooleanSearchInput
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
Example
{"value": true}
BrowseClinicalTrial
BrowseClinicalTrialConnection
Description
The connection type for BrowseClinicalTrial.
Fields
| Field Name | Description |
|---|---|
edges - [BrowseClinicalTrialEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
nodes - [BrowseClinicalTrial!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowseClinicalTrialEdge],
"filteredCount": 123,
"nodes": [BrowseClinicalTrial],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
BrowseClinicalTrialEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowseClinicalTrial
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": BrowseClinicalTrial
}
BrowseDisease
Example
{
"assertionCount": 123,
"diseaseUrl": "abc123",
"displayName": "abc123",
"doid": "xyz789",
"evidenceItemCount": 123,
"geneCount": 123,
"geneNames": ["xyz789"],
"id": 123,
"link": "xyz789",
"name": "xyz789",
"variantCount": 123
}
BrowseDiseaseConnection
Description
The connection type for BrowseDisease.
Fields
| Field Name | Description |
|---|---|
edges - [BrowseDiseaseEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
nodes - [BrowseDisease!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowseDiseaseEdge],
"filteredCount": 123,
"nodes": [BrowseDisease],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
BrowseDiseaseEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowseDisease
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": BrowseDisease
}
BrowseGene
Fields
| Field Name | Description |
|---|---|
assertionCount - Int!
|
|
description - String!
|
|
diseases - [Disease!]
|
|
entrezId - Int!
|
|
evidenceItemCount - Int!
|
|
flagged - Boolean!
|
|
flags - FlagConnection!
|
List and filter flags. |
Arguments
|
|
geneAliases - [String!]
|
|
id - Int!
|
|
link - String!
|
|
molecularProfileCount - Int!
|
|
name - String!
|
|
therapies - [Therapy!]
|
|
variantCount - Int!
|
|
Example
{
"assertionCount": 987,
"description": "xyz789",
"diseases": [Disease],
"entrezId": 987,
"evidenceItemCount": 123,
"flagged": false,
"flags": FlagConnection,
"geneAliases": ["abc123"],
"id": 987,
"link": "xyz789",
"molecularProfileCount": 123,
"name": "xyz789",
"therapies": [Therapy],
"variantCount": 987
}
BrowseGeneConnection
Description
The connection type for BrowseGene.
Fields
| Field Name | Description |
|---|---|
edges - [BrowseGeneEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
nodes - [BrowseGene!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowseGeneEdge],
"filteredCount": 987,
"nodes": [BrowseGene],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
BrowseGeneEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowseGene
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": BrowseGene
}
BrowseMolecularProfile
Fields
| Field Name | Description |
|---|---|
aliases - [MolecularProfileAlias!]!
|
|
assertionCount - Int!
|
|
diseases - [LinkableDisease!]!
|
|
evidenceItemCount - Int!
|
|
genes - [LinkableGene!]!
|
|
id - Int!
|
|
link - String!
|
|
molecularProfileScore - Float!
|
|
name - String!
|
|
therapies - [LinkableTherapy!]!
|
|
variantCount - Int!
|
|
variants - [LinkableVariant!]!
|
Example
{
"aliases": [MolecularProfileAlias],
"assertionCount": 123,
"diseases": [LinkableDisease],
"evidenceItemCount": 987,
"genes": [LinkableGene],
"id": 987,
"link": "xyz789",
"molecularProfileScore": 987.65,
"name": "abc123",
"therapies": [LinkableTherapy],
"variantCount": 123,
"variants": [LinkableVariant]
}
BrowseMolecularProfileConnection
Description
The connection type for BrowseMolecularProfile.
Fields
| Field Name | Description |
|---|---|
edges - [BrowseMolecularProfileEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
nodes - [BrowseMolecularProfile!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowseMolecularProfileEdge],
"filteredCount": 123,
"nodes": [BrowseMolecularProfile],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
BrowseMolecularProfileEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowseMolecularProfile
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": BrowseMolecularProfile
}
BrowsePhenotype
BrowsePhenotypeConnection
Description
The connection type for BrowsePhenotype.
Fields
| Field Name | Description |
|---|---|
edges - [BrowsePhenotypeEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
nodes - [BrowsePhenotype!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowsePhenotypeEdge],
"filteredCount": 123,
"nodes": [BrowsePhenotype],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
BrowsePhenotypeEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowsePhenotype
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": BrowsePhenotype
}
BrowseSource
Fields
| Field Name | Description |
|---|---|
authors - [String!]!
|
|
citation - String!
|
|
citationId - Int!
|
|
clinicalTrials - [ClinicalTrial!]!
|
|
displayType - String!
|
|
evidenceItemCount - Int!
|
|
id - Int!
|
|
journal - String
|
|
link - String!
|
|
name - String
|
|
publicationYear - Int
|
|
sourceSuggestionCount - Int!
|
|
sourceType - SourceSource!
|
|
sourceUrl - String!
|
Example
{
"authors": ["xyz789"],
"citation": "abc123",
"citationId": 123,
"clinicalTrials": [ClinicalTrial],
"displayType": "abc123",
"evidenceItemCount": 123,
"id": 987,
"journal": "xyz789",
"link": "abc123",
"name": "xyz789",
"publicationYear": 987,
"sourceSuggestionCount": 123,
"sourceType": "ASCO",
"sourceUrl": "abc123"
}
BrowseSourceConnection
Description
The connection type for BrowseSource.
Fields
| Field Name | Description |
|---|---|
edges - [BrowseSourceEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
nodes - [BrowseSource!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowseSourceEdge],
"filteredCount": 123,
"nodes": [BrowseSource],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
BrowseSourceEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowseSource
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": BrowseSource
}
BrowseTherapy
BrowseTherapyConnection
Description
The connection type for BrowseTherapy.
Fields
| Field Name | Description |
|---|---|
edges - [BrowseTherapyEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
nodes - [BrowseTherapy!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowseTherapyEdge],
"filteredCount": 123,
"nodes": [BrowseTherapy],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
BrowseTherapyEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowseTherapy
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": BrowseTherapy
}
BrowseVariant
Fields
| Field Name | Description |
|---|---|
aliases - [VariantAlias!]!
|
|
diseases - [Disease!]!
|
|
geneId - Int!
|
|
geneLink - String!
|
|
geneName - String!
|
|
id - Int!
|
|
link - String!
|
|
name - String!
|
|
therapies - [Therapy!]!
|
|
variantTypes - [LinkableVariantType!]!
|
Example
{
"aliases": [VariantAlias],
"diseases": [Disease],
"geneId": 987,
"geneLink": "abc123",
"geneName": "xyz789",
"id": 123,
"link": "abc123",
"name": "xyz789",
"therapies": [Therapy],
"variantTypes": [LinkableVariantType]
}
BrowseVariantConnection
Description
The connection type for BrowseVariant.
Fields
| Field Name | Description |
|---|---|
edges - [BrowseVariantEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
nodes - [BrowseVariant!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowseVariantEdge],
"filteredCount": 987,
"nodes": [BrowseVariant],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
BrowseVariantEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowseVariant
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": BrowseVariant
}
BrowseVariantGroup
Fields
| Field Name | Description |
|---|---|
evidenceItemCount - Int!
|
|
geneNames - [String!]!
|
|
id - Int!
|