CIViC 2 API Documentation
Documentation for the CIViC GraphQL API
API Endpoints
https://civicdb.org/api/graphql
Queries
acmgCode
Description
Find an ACMG code by CIViC ID
Example
Query
query acmgCode($id: Int!) {
acmgCode(id: $id) {
code
description
id
name
tooltip
}
}
Variables
{"id": 987}
Response
{
"data": {
"acmgCode": {
"code": "xyz789",
"description": "xyz789",
"id": 123,
"name": "abc123",
"tooltip": "xyz789"
}
}
}
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
name
tooltip
}
}
Variables
{"queryTerm": "xyz789"}
Response
{
"data": {
"acmgCodesTypeahead": [
{
"code": "xyz789",
"description": "xyz789",
"id": 123,
"name": "xyz789",
"tooltip": "xyz789"
}
]
}
}
activities
Description
List and filter activities
Response
Returns an ActivityInterfaceConnection!
Arguments
Name | Description |
---|---|
activityType - [ActivityTypeInput!]
|
|
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. |
includeAutomatedEvents - Boolean
|
|
last - Int
|
Returns the last n elements from the list. |
mode - EventFeedMode
|
|
occurredAfter - ISO8601DateTime
|
|
occurredBefore - ISO8601DateTime
|
|
organizationId - [Int!]
|
|
sortBy - DateSort
|
Sort order for the activities. Defaults to most recent. |
subject - [SubscribableQueryInput!]
|
|
subjectType - [ActivitySubjectInput!]
|
|
userId - [Int!]
|
Example
Query
query activities(
$activityType: [ActivityTypeInput!],
$after: String,
$before: String,
$first: Int,
$includeAutomatedEvents: Boolean,
$last: Int,
$mode: EventFeedMode,
$occurredAfter: ISO8601DateTime,
$occurredBefore: ISO8601DateTime,
$organizationId: [Int!],
$sortBy: DateSort,
$subject: [SubscribableQueryInput!],
$subjectType: [ActivitySubjectInput!],
$userId: [Int!]
) {
activities(
activityType: $activityType,
after: $after,
before: $before,
first: $first,
includeAutomatedEvents: $includeAutomatedEvents,
last: $last,
mode: $mode,
occurredAfter: $occurredAfter,
occurredBefore: $occurredBefore,
organizationId: $organizationId,
sortBy: $sortBy,
subject: $subject,
subjectType: $subjectType,
userId: $userId
) {
activityTypes
edges {
...ActivityInterfaceEdgeFragment
}
nodes {
...ActivityInterfaceFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
participatingOrganizations {
...OrganizationFragment
}
subjectTypes
totalCount
unfilteredCount
uniqueParticipants {
...UserFragment
}
}
}
Variables
{
"activityType": ["ACCEPT_REVISIONS"],
"after": "abc123",
"before": "xyz789",
"first": 987,
"includeAutomatedEvents": false,
"last": 123,
"mode": "ORGANIZATION",
"occurredAfter": ISO8601DateTime,
"occurredBefore": ISO8601DateTime,
"organizationId": [987],
"sortBy": DateSort,
"subject": [SubscribableQueryInput],
"subjectType": ["ASSERTION"],
"userId": [987]
}
Response
{
"data": {
"activities": {
"activityTypes": ["ACCEPT_REVISIONS"],
"edges": [ActivityInterfaceEdge],
"nodes": [ActivityInterface],
"pageCount": 987,
"pageInfo": PageInfo,
"participatingOrganizations": [Organization],
"subjectTypes": ["ASSERTION"],
"totalCount": 123,
"unfilteredCount": 123,
"uniqueParticipants": [User]
}
}
}
activity
Description
Find a CIViC activity record by CIViC ID
Response
Returns an ActivityInterface
Arguments
Name | Description |
---|---|
id - Int!
|
Example
Query
query activity($id: Int!) {
activity(id: $id) {
createdAt
events {
...EventFragment
}
id
note
organization {
...OrganizationFragment
}
parsedNote {
... on CommentTagSegment {
...CommentTagSegmentFragment
}
... on CommentTagSegmentFlagged {
...CommentTagSegmentFlaggedFragment
}
... on CommentTagSegmentFlaggedAndDeprecated {
...CommentTagSegmentFlaggedAndDeprecatedFragment
}
... on CommentTagSegmentFlaggedAndWithStatus {
...CommentTagSegmentFlaggedAndWithStatusFragment
}
... on CommentTextSegment {
...CommentTextSegmentFragment
}
... on User {
...UserFragment
}
}
subject {
...EventSubjectFragment
}
user {
...UserFragment
}
verbiage
}
}
Variables
{"id": 987}
Response
{
"data": {
"activity": {
"createdAt": ISO8601DateTime,
"events": [Event],
"id": 987,
"note": "abc123",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"subject": EventSubject,
"user": User,
"verbiage": "abc123"
}
}
}
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
openRevisionCount
phenotypes {
...PhenotypeFragment
}
regulatoryApproval
regulatoryApprovalLastUpdated
rejectionEvent {
...EventFragment
}
revisions {
...RevisionConnectionFragment
}
significance
status
submissionActivity {
...SubmitAssertionActivityFragment
}
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": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"molecularProfile": MolecularProfile,
"name": "xyz789",
"nccnGuideline": NccnGuideline,
"nccnGuidelineVersion": "xyz789",
"openRevisionCount": 987,
"phenotypes": [Phenotype],
"regulatoryApproval": true,
"regulatoryApprovalLastUpdated": ISO8601DateTime,
"rejectionEvent": Event,
"revisions": RevisionConnection,
"significance": "ADVERSE_RESPONSE",
"status": "ACCEPTED",
"submissionActivity": SubmitAssertionActivity,
"submissionEvent": Event,
"summary": "xyz789",
"therapies": [Therapy],
"therapyInteractionType": "COMBINATION",
"variantOrigin": "COMBINED"
}
}
}
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": "xyz789",
"evidenceId": 987,
"first": 987,
"id": 123,
"last": 123,
"molecularProfileId": 123,
"molecularProfileName": "abc123",
"organizationId": 987,
"phenotypeId": 123,
"significance": "ADVERSE_RESPONSE",
"sortBy": AssertionSort,
"status": "ACCEPTED",
"summary": "abc123",
"therapyId": 123,
"therapyName": "abc123",
"userId": 987,
"variantId": 123,
"variantName": "abc123"
}
Response
{
"data": {
"assertions": {
"edges": [AssertionEdge],
"nodes": [Assertion],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
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. |
diseaseAlias - String
|
|
doid - String
|
|
featureName - String
|
|
first - Int
|
Returns the first n elements from the list. |
id - Int
|
|
last - Int
|
Returns the last n elements from the list. |
name - String
|
|
sortBy - DiseasesSort
|
Example
Query
query browseDiseases(
$after: String,
$before: String,
$diseaseAlias: String,
$doid: String,
$featureName: String,
$first: Int,
$id: Int,
$last: Int,
$name: String,
$sortBy: DiseasesSort
) {
browseDiseases(
after: $after,
before: $before,
diseaseAlias: $diseaseAlias,
doid: $doid,
featureName: $featureName,
first: $first,
id: $id,
last: $last,
name: $name,
sortBy: $sortBy
) {
edges {
...BrowseDiseaseEdgeFragment
}
filteredCount
lastUpdated
nodes {
...BrowseDiseaseFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"diseaseAlias": "xyz789",
"doid": "abc123",
"featureName": "xyz789",
"first": 987,
"id": 123,
"last": 987,
"name": "abc123",
"sortBy": DiseasesSort
}
Response
{
"data": {
"browseDiseases": {
"edges": [BrowseDiseaseEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseDisease],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
browseFeatures
Response
Returns a BrowseFeatureConnection!
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
|
|
featureAlias - String
|
|
featureFullName - String
|
|
featureName - String
|
|
featureType - FeatureInstanceTypes
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
sortBy - FeaturesSort
|
|
therapyName - String
|
Example
Query
query browseFeatures(
$after: String,
$before: String,
$diseaseName: String,
$featureAlias: String,
$featureFullName: String,
$featureName: String,
$featureType: FeatureInstanceTypes,
$first: Int,
$last: Int,
$sortBy: FeaturesSort,
$therapyName: String
) {
browseFeatures(
after: $after,
before: $before,
diseaseName: $diseaseName,
featureAlias: $featureAlias,
featureFullName: $featureFullName,
featureName: $featureName,
featureType: $featureType,
first: $first,
last: $last,
sortBy: $sortBy,
therapyName: $therapyName
) {
edges {
...BrowseFeatureEdgeFragment
}
filteredCount
lastUpdated
nodes {
...BrowseFeatureFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"diseaseName": "xyz789",
"featureAlias": "xyz789",
"featureFullName": "xyz789",
"featureName": "abc123",
"featureType": "FACTOR",
"first": 123,
"last": 123,
"sortBy": FeaturesSort,
"therapyName": "xyz789"
}
Response
{
"data": {
"browseFeatures": {
"edges": [BrowseFeatureEdge],
"filteredCount": 123,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseFeature],
"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
|
|
featureName - 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,
$featureName: String,
$first: Int,
$last: Int,
$molecularProfileAlias: String,
$molecularProfileName: String,
$sortBy: MolecularProfilesSort,
$therapyName: String,
$variantId: Int,
$variantName: String
) {
browseMolecularProfiles(
after: $after,
before: $before,
diseaseName: $diseaseName,
featureName: $featureName,
first: $first,
last: $last,
molecularProfileAlias: $molecularProfileAlias,
molecularProfileName: $molecularProfileName,
sortBy: $sortBy,
therapyName: $therapyName,
variantId: $variantId,
variantName: $variantName
) {
edges {
...BrowseMolecularProfileEdgeFragment
}
filteredCount
lastUpdated
nodes {
...BrowseMolecularProfileFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"diseaseName": "xyz789",
"featureName": "abc123",
"first": 987,
"last": 123,
"molecularProfileAlias": "abc123",
"molecularProfileName": "abc123",
"sortBy": MolecularProfilesSort,
"therapyName": "xyz789",
"variantId": 987,
"variantName": "abc123"
}
Response
{
"data": {
"browseMolecularProfiles": {
"edges": [BrowseMolecularProfileEdge],
"filteredCount": 123,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseMolecularProfile],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
browsePhenotypes
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 browsePhenotypes(
$after: String,
$before: String,
$first: Int,
$hpoId: String,
$id: Int,
$last: Int,
$name: String,
$sortBy: PhenotypeSort
) {
browsePhenotypes(
after: $after,
before: $before,
first: $first,
hpoId: $hpoId,
id: $id,
last: $last,
name: $name,
sortBy: $sortBy
) {
edges {
...BrowsePhenotypeEdgeFragment
}
filteredCount
lastUpdated
nodes {
...BrowsePhenotypeFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"first": 987,
"hpoId": "xyz789",
"id": 987,
"last": 123,
"name": "abc123",
"sortBy": PhenotypeSort
}
Response
{
"data": {
"browsePhenotypes": {
"edges": [BrowsePhenotypeEdge],
"filteredCount": 123,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowsePhenotype],
"pageCount": 987,
"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
|
|
openAccess - Boolean
|
|
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,
$openAccess: Boolean,
$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,
openAccess: $openAccess,
sortBy: $sortBy,
sourceType: $sourceType,
year: $year
) {
edges {
...BrowseSourceEdgeFragment
}
filteredCount
lastUpdated
nodes {
...BrowseSourceFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"author": "xyz789",
"before": "abc123",
"citationId": 987,
"clinicalTrialId": 123,
"first": 123,
"id": 987,
"journal": "abc123",
"last": 123,
"name": "xyz789",
"openAccess": false,
"sortBy": SourcesSort,
"sourceType": "ASCO",
"year": 987
}
Response
{
"data": {
"browseSources": {
"edges": [BrowseSourceEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseSource],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
browseTherapies
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. |
therapyAlias - String
|
Example
Query
query browseTherapies(
$after: String,
$before: String,
$first: Int,
$id: Int,
$last: Int,
$name: String,
$ncitId: String,
$sortBy: TherapySort,
$therapyAlias: String
) {
browseTherapies(
after: $after,
before: $before,
first: $first,
id: $id,
last: $last,
name: $name,
ncitId: $ncitId,
sortBy: $sortBy,
therapyAlias: $therapyAlias
) {
edges {
...BrowseTherapyEdgeFragment
}
filteredCount
lastUpdated
nodes {
...BrowseTherapyFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"first": 987,
"id": 123,
"last": 123,
"name": "xyz789",
"ncitId": "abc123",
"sortBy": TherapySort,
"therapyAlias": "xyz789"
}
Response
{
"data": {
"browseTherapies": {
"edges": [BrowseTherapyEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseTherapy],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
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. |
featureNames - String
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
name - String
|
|
sortBy - VariantGroupsSort
|
|
variantNames - String
|
Example
Query
query browseVariantGroups(
$after: String,
$before: String,
$featureNames: String,
$first: Int,
$last: Int,
$name: String,
$sortBy: VariantGroupsSort,
$variantNames: String
) {
browseVariantGroups(
after: $after,
before: $before,
featureNames: $featureNames,
first: $first,
last: $last,
name: $name,
sortBy: $sortBy,
variantNames: $variantNames
) {
edges {
...BrowseVariantGroupEdgeFragment
}
filteredCount
lastUpdated
nodes {
...BrowseVariantGroupFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"featureNames": "abc123",
"first": 987,
"last": 123,
"name": "abc123",
"sortBy": VariantGroupsSort,
"variantNames": "xyz789"
}
Response
{
"data": {
"browseVariantGroups": {
"edges": [BrowseVariantGroupEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseVariantGroup],
"pageCount": 123,
"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. |
category - VariantCategories
|
|
diseaseName - String
|
|
featureName - 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,
$category: VariantCategories,
$diseaseName: String,
$featureName: 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,
category: $category,
diseaseName: $diseaseName,
featureName: $featureName,
first: $first,
hasNoVariantType: $hasNoVariantType,
last: $last,
sortBy: $sortBy,
therapyName: $therapyName,
variantAlias: $variantAlias,
variantGroupId: $variantGroupId,
variantName: $variantName,
variantTypeId: $variantTypeId,
variantTypeName: $variantTypeName
) {
edges {
...BrowseVariantEdgeFragment
}
filteredCount
lastUpdated
nodes {
...BrowseVariantFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"category": "FACTOR",
"diseaseName": "xyz789",
"featureName": "abc123",
"first": 123,
"hasNoVariantType": false,
"last": 123,
"sortBy": VariantsSort,
"therapyName": "xyz789",
"variantAlias": "abc123",
"variantGroupId": 987,
"variantName": "abc123",
"variantTypeId": 987,
"variantTypeName": "xyz789"
}
Response
{
"data": {
"browseVariants": {
"edges": [BrowseVariantEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseVariant],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
clingenCode
Description
Find a ClinGen code by CIViC ID
Response
Returns a ClingenCode
Arguments
Name | Description |
---|---|
id - Int!
|
Example
Query
query clingenCode($id: Int!) {
clingenCode(id: $id) {
code
description
exclusive
id
name
tooltip
}
}
Variables
{"id": 987}
Response
{
"data": {
"clingenCode": {
"code": "xyz789",
"description": "xyz789",
"exclusive": true,
"id": 987,
"name": "abc123",
"tooltip": "xyz789"
}
}
}
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
exclusive
id
name
tooltip
}
}
Variables
{"queryTerm": "abc123"}
Response
{
"data": {
"clingenCodesTypeahead": [
{
"code": "xyz789",
"description": "abc123",
"exclusive": true,
"id": 123,
"name": "xyz789",
"tooltip": "abc123"
}
]
}
}
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": 987}
Response
{
"data": {
"clinicalTrial": {
"description": "abc123",
"id": 123,
"link": "xyz789",
"name": "xyz789",
"nctId": "xyz789",
"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
lastUpdated
nodes {
...BrowseClinicalTrialFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"first": 123,
"id": 123,
"last": 123,
"name": "xyz789",
"nctId": "abc123",
"sortBy": ClinicalTrialSort
}
Response
{
"data": {
"clinicalTrials": {
"edges": [BrowseClinicalTrialEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseClinicalTrial],
"pageCount": 987,
"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
}
deleted
deletedAt
events {
...EventConnectionFragment
}
id
link
name
parsedComment {
... on CommentTagSegment {
...CommentTagSegmentFragment
}
... on CommentTagSegmentFlagged {
...CommentTagSegmentFlaggedFragment
}
... on CommentTagSegmentFlaggedAndDeprecated {
...CommentTagSegmentFlaggedAndDeprecatedFragment
}
... on CommentTagSegmentFlaggedAndWithStatus {
...CommentTagSegmentFlaggedAndWithStatusFragment
}
... on CommentTextSegment {
...CommentTextSegmentFragment
}
... on User {
...UserFragment
}
}
title
}
}
Variables
{"id": 123}
Response
{
"data": {
"comment": {
"comment": "abc123",
"commentable": Commentable,
"commenter": User,
"createdAt": ISO8601DateTime,
"creationEvent": Event,
"deleted": true,
"deletedAt": ISO8601DateTime,
"events": EventConnection,
"id": 987,
"link": "xyz789",
"name": "abc123",
"parsedComment": [CommentTagSegment],
"title": "xyz789"
}
}
}
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": 123,
"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
}
featureTsv {
...DownloadableFileFragment
}
molecularProfileTsv {
...DownloadableFileFragment
}
name
variantGroupTsv {
...DownloadableFileFragment
}
variantTsv {
...DownloadableFileFragment
}
}
}
Response
{
"data": {
"dataReleases": [
{
"acceptedAndSubmittedVariantsVcf": DownloadableFile,
"acceptedVariantsVcf": DownloadableFile,
"assertionTsv": DownloadableFile,
"evidenceTsv": DownloadableFile,
"featureTsv": 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) {
deprecated
diseaseAliases
diseaseUrl
displayName
doid
id
link
myDiseaseInfo {
...MyDiseaseInfoFragment
}
name
}
}
Variables
{"id": 123}
Response
{
"data": {
"disease": {
"deprecated": true,
"diseaseAliases": ["xyz789"],
"diseaseUrl": "abc123",
"displayName": "abc123",
"doid": "abc123",
"id": 987,
"link": "abc123",
"myDiseaseInfo": MyDiseaseInfo,
"name": "abc123"
}
}
}
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
deprecated
diseaseAliases
diseaseUrl
displayName
doid
evidenceItemCount
id
link
molecularProfileCount
myDiseaseInfo {
...MyDiseaseInfoFragment
}
name
}
}
Variables
{"id": 123}
Response
{
"data": {
"diseasePopover": {
"assertionCount": 123,
"deprecated": false,
"diseaseAliases": ["abc123"],
"diseaseUrl": "xyz789",
"displayName": "abc123",
"doid": "abc123",
"evidenceItemCount": 123,
"id": 123,
"link": "abc123",
"molecularProfileCount": 987,
"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) {
deprecated
diseaseAliases
diseaseUrl
displayName
doid
id
link
myDiseaseInfo {
...MyDiseaseInfoFragment
}
name
}
}
Variables
{"queryTerm": "xyz789"}
Response
{
"data": {
"diseaseTypeahead": [
{
"deprecated": true,
"diseaseAliases": ["xyz789"],
"diseaseUrl": "abc123",
"displayName": "xyz789",
"doid": "xyz789",
"id": 123,
"link": "xyz789",
"myDiseaseInfo": MyDiseaseInfo,
"name": "xyz789"
}
]
}
}
diseases
Response
Returns a DiseaseConnection!
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. |
id - Int
|
|
last - Int
|
Returns the last n elements from the list. |
name - String
|
Example
Query
query diseases(
$after: String,
$before: String,
$doid: String,
$first: Int,
$id: Int,
$last: Int,
$name: String
) {
diseases(
after: $after,
before: $before,
doid: $doid,
first: $first,
id: $id,
last: $last,
name: $name
) {
edges {
...DiseaseEdgeFragment
}
nodes {
...DiseaseFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"doid": "abc123",
"first": 123,
"id": 987,
"last": 987,
"name": "abc123"
}
Response
{
"data": {
"diseases": {
"edges": [DiseaseEdge],
"nodes": [Disease],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
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) {
displayName
entityId
feature {
...LinkableFeatureFragment
}
link
revisionSetId
tagType
}
}
Variables
{"queryTerm": "abc123"}
Response
{
"data": {
"entityTypeahead": [
{
"displayName": "xyz789",
"entityId": 987,
"feature": LinkableFeature,
"link": "xyz789",
"revisionSetId": 123,
"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": "xyz789",
"before": "abc123",
"eventType": "ACCEPTED",
"first": 123,
"includeAutomatedEvents": true,
"last": 987,
"mode": "ORGANIZATION",
"organizationId": 987,
"originatingUserId": 123,
"sortBy": DateSort,
"subject": SubscribableQueryInput
}
Response
{
"data": {
"events": {
"edges": [EventEdge],
"eventTypes": ["ACCEPTED"],
"nodes": [Event],
"pageCount": 987,
"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
openRevisionCount
phenotypes {
...PhenotypeFragment
}
rejectionEvent {
...EventFragment
}
revisions {
...RevisionConnectionFragment
}
significance
source {
...SourceFragment
}
status
submissionActivity {
...SubmitEvidenceItemActivityFragment
}
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": "abc123",
"molecularProfile": MolecularProfile,
"name": "xyz789",
"openRevisionCount": 987,
"phenotypes": [Phenotype],
"rejectionEvent": Event,
"revisions": RevisionConnection,
"significance": "ADVERSE_RESPONSE",
"source": Source,
"status": "ACCEPTED",
"submissionActivity": SubmitEvidenceItemActivity,
"submissionEvent": Event,
"therapies": [Therapy],
"therapyInteractionType": "COMBINATION",
"variantHgvs": "xyz789",
"variantOrigin": "COMBINED"
}
}
}
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. |
ids - [Int!]
|
Filter to evidence matching a list of EIDs |
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,
$ids: [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,
ids: $ids,
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": "xyz789",
"assertionId": 123,
"before": "abc123",
"clinicalTrialId": 987,
"description": "abc123",
"diseaseId": 987,
"diseaseName": "abc123",
"evidenceDirection": "DOES_NOT_SUPPORT",
"evidenceLevel": "A",
"evidenceRating": 987,
"evidenceType": "DIAGNOSTIC",
"first": 987,
"id": 987,
"ids": [123],
"last": 123,
"molecularProfileId": 123,
"molecularProfileName": "abc123",
"organizationId": 987,
"phenotypeId": 123,
"significance": "ADVERSE_RESPONSE",
"sortBy": EvidenceSort,
"sourceId": 987,
"status": "ACCEPTED",
"therapyId": 123,
"therapyName": "abc123",
"userId": 123,
"variantId": 987,
"variantOrigin": "COMBINED"
}
Response
{
"data": {
"evidenceItems": {
"edges": [EvidenceItemEdge],
"nodes": [EvidenceItem],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
factor
Description
Find a single gene by CIViC ID or NCIt ID
Example
Query
query factor(
$id: Int,
$ncitId: String
) {
factor(
id: $id,
ncitId: $ncitId
) {
comments {
...CommentConnectionFragment
}
creationActivity {
...CreateFeatureActivityFragment
}
deprecated
deprecationActivity {
...DeprecateFeatureActivityFragment
}
deprecationReason
description
events {
...EventConnectionFragment
}
featureAliases
featureInstance {
... on Factor {
...FactorFragment
}
... on Fusion {
...FusionFragment
}
... on Gene {
...GeneFragment
}
}
featureType
flagged
flags {
...FlagConnectionFragment
}
fullName
id
lastAcceptedRevisionEvent {
...EventFragment
}
lastCommentEvent {
...EventFragment
}
lastSubmittedRevisionEvent {
...EventFragment
}
link
name
ncitDetails {
...NcitDetailsFragment
}
ncitId
openRevisionCount
revisions {
...RevisionConnectionFragment
}
sources {
...SourceFragment
}
variants {
...FactorVariantConnectionFragment
}
}
}
Variables
{"id": 123, "ncitId": "xyz789"}
Response
{
"data": {
"factor": {
"comments": CommentConnection,
"creationActivity": CreateFeatureActivity,
"deprecated": false,
"deprecationActivity": DeprecateFeatureActivity,
"deprecationReason": "DUPLICATE",
"description": "abc123",
"events": EventConnection,
"featureAliases": ["abc123"],
"featureInstance": Factor,
"featureType": "FACTOR",
"flagged": true,
"flags": FlagConnection,
"fullName": "abc123",
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"name": "xyz789",
"ncitDetails": NcitDetails,
"ncitId": "xyz789",
"openRevisionCount": 123,
"revisions": RevisionConnection,
"sources": [Source],
"variants": FactorVariantConnection
}
}
}
factors
Description
List and filter factors.
Response
Returns a FactorConnection!
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 - AssociatedEvidenceStatusFilter
|
Limit factors by the status of attached evidence. |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
name - [String!]
|
List of Factor names to return |
ncitIt - [String!]
|
List of NCIt Codes to return Factors for |
Example
Query
query factors(
$after: String,
$before: String,
$evidenceStatusFilter: AssociatedEvidenceStatusFilter,
$first: Int,
$last: Int,
$name: [String!],
$ncitIt: [String!]
) {
factors(
after: $after,
before: $before,
evidenceStatusFilter: $evidenceStatusFilter,
first: $first,
last: $last,
name: $name,
ncitIt: $ncitIt
) {
edges {
...FactorEdgeFragment
}
nodes {
...FactorFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"evidenceStatusFilter": "ALL",
"first": 987,
"last": 123,
"name": ["abc123"],
"ncitIt": ["abc123"]
}
Response
{
"data": {
"factors": {
"edges": [FactorEdge],
"nodes": [Factor],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
feature
Description
Find a single feature by CIViC ID
Example
Query
query feature($id: Int) {
feature(id: $id) {
comments {
...CommentConnectionFragment
}
creationActivity {
...CreateFeatureActivityFragment
}
deprecated
deprecationActivity {
...DeprecateFeatureActivityFragment
}
deprecationReason
description
events {
...EventConnectionFragment
}
featureAliases
featureInstance {
... on Factor {
...FactorFragment
}
... on Fusion {
...FusionFragment
}
... on Gene {
...GeneFragment
}
}
featureType
flagged
flags {
...FlagConnectionFragment
}
fullName
id
lastAcceptedRevisionEvent {
...EventFragment
}
lastCommentEvent {
...EventFragment
}
lastSubmittedRevisionEvent {
...EventFragment
}
link
name
openRevisionCount
revisions {
...RevisionConnectionFragment
}
sources {
...SourceFragment
}
variants {
...VariantInterfaceConnectionFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"feature": {
"comments": CommentConnection,
"creationActivity": CreateFeatureActivity,
"deprecated": false,
"deprecationActivity": DeprecateFeatureActivity,
"deprecationReason": "DUPLICATE",
"description": "xyz789",
"events": EventConnection,
"featureAliases": ["xyz789"],
"featureInstance": Factor,
"featureType": "FACTOR",
"flagged": false,
"flags": FlagConnection,
"fullName": "abc123",
"id": 987,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"name": "abc123",
"openRevisionCount": 123,
"revisions": RevisionConnection,
"sources": [Source],
"variants": VariantInterfaceConnection
}
}
}
featureTypeahead
Description
Retrieve Features of a specific instance type for a search term.
Response
Returns [Feature!]!
Arguments
Name | Description |
---|---|
featureType - FeatureInstanceTypes
|
|
queryTerm - String!
|
Example
Query
query featureTypeahead(
$featureType: FeatureInstanceTypes,
$queryTerm: String!
) {
featureTypeahead(
featureType: $featureType,
queryTerm: $queryTerm
) {
comments {
...CommentConnectionFragment
}
creationActivity {
...CreateFeatureActivityFragment
}
deprecated
deprecationActivity {
...DeprecateFeatureActivityFragment
}
deprecationReason
description
events {
...EventConnectionFragment
}
featureAliases
featureInstance {
... on Factor {
...FactorFragment
}
... on Fusion {
...FusionFragment
}
... on Gene {
...GeneFragment
}
}
featureType
flagged
flags {
...FlagConnectionFragment
}
fullName
id
lastAcceptedRevisionEvent {
...EventFragment
}
lastCommentEvent {
...EventFragment
}
lastSubmittedRevisionEvent {
...EventFragment
}
link
name
openRevisionCount
revisions {
...RevisionConnectionFragment
}
sources {
...SourceFragment
}
variants {
...VariantInterfaceConnectionFragment
}
}
}
Variables
{
"featureType": "FACTOR",
"queryTerm": "abc123"
}
Response
{
"data": {
"featureTypeahead": [
{
"comments": CommentConnection,
"creationActivity": CreateFeatureActivity,
"deprecated": false,
"deprecationActivity": DeprecateFeatureActivity,
"deprecationReason": "DUPLICATE",
"description": "xyz789",
"events": EventConnection,
"featureAliases": ["abc123"],
"featureInstance": Factor,
"featureType": "FACTOR",
"flagged": false,
"flags": FlagConnection,
"fullName": "xyz789",
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"name": "abc123",
"openRevisionCount": 987,
"revisions": RevisionConnection,
"sources": [Source],
"variants": VariantInterfaceConnection
}
]
}
}
flag
Description
Find a flag by CIViC ID
Example
Query
query flag($id: Int!) {
flag(id: $id) {
comments {
...CommentConnectionFragment
}
createdAt
events {
...EventConnectionFragment
}
flaggable {
...FlaggableFragment
}
flaggingUser {
...UserFragment
}
id
lastCommentEvent {
...EventFragment
}
link
name
openActivity {
...FlagEntityActivityFragment
}
resolutionActivity {
...ResolveFlagActivityFragment
}
resolvingUser {
...UserFragment
}
state
}
}
Variables
{"id": 123}
Response
{
"data": {
"flag": {
"comments": CommentConnection,
"createdAt": ISO8601DateTime,
"events": EventConnection,
"flaggable": Flaggable,
"flaggingUser": User,
"id": 987,
"lastCommentEvent": Event,
"link": "xyz789",
"name": "xyz789",
"openActivity": FlagEntityActivity,
"resolutionActivity": ResolveFlagActivity,
"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": "xyz789",
"before": "abc123",
"first": 123,
"flaggable": FlaggableInput,
"flaggingUserId": 987,
"last": 123,
"resolvingUserId": 123,
"sortBy": DateSort,
"state": "OPEN"
}
Response
{
"data": {
"flags": {
"edges": [FlagEdge],
"nodes": [Flag],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123,
"unfilteredCountForSubject": 123,
"uniqueFlaggingUsers": [User],
"uniqueResolvingUsers": [User]
}
}
}
fusion
Description
Find a single gene by CIViC ID
Example
Query
query fusion($id: Int) {
fusion(id: $id) {
comments {
...CommentConnectionFragment
}
creationActivity {
...CreateFeatureActivityFragment
}
deprecated
deprecationActivity {
...DeprecateFeatureActivityFragment
}
deprecationReason
description
events {
...EventConnectionFragment
}
featureAliases
featureInstance {
... on Factor {
...FactorFragment
}
... on Fusion {
...FusionFragment
}
... on Gene {
...GeneFragment
}
}
featureType
fivePrimeGene {
...GeneFragment
}
fivePrimePartnerStatus
flagged
flags {
...FlagConnectionFragment
}
fullName
id
lastAcceptedRevisionEvent {
...EventFragment
}
lastCommentEvent {
...EventFragment
}
lastSubmittedRevisionEvent {
...EventFragment
}
link
name
openRevisionCount
revisions {
...RevisionConnectionFragment
}
sources {
...SourceFragment
}
threePrimeGene {
...GeneFragment
}
threePrimePartnerStatus
variants {
...VariantInterfaceConnectionFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"fusion": {
"comments": CommentConnection,
"creationActivity": CreateFeatureActivity,
"deprecated": false,
"deprecationActivity": DeprecateFeatureActivity,
"deprecationReason": "DUPLICATE",
"description": "xyz789",
"events": EventConnection,
"featureAliases": ["abc123"],
"featureInstance": Factor,
"featureType": "FACTOR",
"fivePrimeGene": Gene,
"fivePrimePartnerStatus": "KNOWN",
"flagged": false,
"flags": FlagConnection,
"fullName": "abc123",
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"name": "abc123",
"openRevisionCount": 123,
"revisions": RevisionConnection,
"sources": [Source],
"threePrimeGene": Gene,
"threePrimePartnerStatus": "KNOWN",
"variants": VariantInterfaceConnection
}
}
}
fusions
Description
List and filter fusions.
Response
Returns a FusionConnection!
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 - AssociatedEvidenceStatusFilter
|
Limit fusions by the status of attached evidence. |
first - Int
|
Returns the first n elements from the list. |
genePartnerId - Int
|
CIViC ID of one of the Gene partners |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query fusions(
$after: String,
$before: String,
$evidenceStatusFilter: AssociatedEvidenceStatusFilter,
$first: Int,
$genePartnerId: Int,
$last: Int
) {
fusions(
after: $after,
before: $before,
evidenceStatusFilter: $evidenceStatusFilter,
first: $first,
genePartnerId: $genePartnerId,
last: $last
) {
edges {
...FusionEdgeFragment
}
nodes {
...FusionFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"evidenceStatusFilter": "ALL",
"first": 123,
"genePartnerId": 987,
"last": 987
}
Response
{
"data": {
"fusions": {
"edges": [FusionEdge],
"nodes": [Fusion],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
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
}
creationActivity {
...CreateFeatureActivityFragment
}
deprecated
deprecationActivity {
...DeprecateFeatureActivityFragment
}
deprecationReason
description
entrezId
events {
...EventConnectionFragment
}
featureAliases
featureInstance {
... on Factor {
...FactorFragment
}
... on Fusion {
...FusionFragment
}
... on Gene {
...GeneFragment
}
}
featureType
flagged
flags {
...FlagConnectionFragment
}
fullName
id
lastAcceptedRevisionEvent {
...EventFragment
}
lastCommentEvent {
...EventFragment
}
lastSubmittedRevisionEvent {
...EventFragment
}
link
myGeneInfoDetails
name
openRevisionCount
revisions {
...RevisionConnectionFragment
}
sources {
...SourceFragment
}
variants {
...GeneVariantConnectionFragment
}
}
}
Variables
{"entrezSymbol": "xyz789", "id": 987}
Response
{
"data": {
"gene": {
"comments": CommentConnection,
"creationActivity": CreateFeatureActivity,
"deprecated": false,
"deprecationActivity": DeprecateFeatureActivity,
"deprecationReason": "DUPLICATE",
"description": "abc123",
"entrezId": 987,
"events": EventConnection,
"featureAliases": ["abc123"],
"featureInstance": Factor,
"featureType": "FACTOR",
"flagged": true,
"flags": FlagConnection,
"fullName": "xyz789",
"id": 987,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"myGeneInfoDetails": {},
"name": "abc123",
"openRevisionCount": 987,
"revisions": RevisionConnection,
"sources": [Source],
"variants": GeneVariantConnection
}
}
}
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. |
entrezIds - [Int!]
|
List of Entrez Gene IDs to return results for |
entrezSymbols - [String!]
|
List of Entrez Gene symbols to return results for |
evidenceStatusFilter - AssociatedEvidenceStatusFilter
|
Limit genes by the status of attached evidence. |
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,
$entrezIds: [Int!],
$entrezSymbols: [String!],
$evidenceStatusFilter: AssociatedEvidenceStatusFilter,
$first: Int,
$last: Int
) {
genes(
after: $after,
before: $before,
entrezIds: $entrezIds,
entrezSymbols: $entrezSymbols,
evidenceStatusFilter: $evidenceStatusFilter,
first: $first,
last: $last
) {
edges {
...GeneEdgeFragment
}
nodes {
...GeneFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"entrezIds": [123],
"entrezSymbols": ["xyz789"],
"evidenceStatusFilter": "ALL",
"first": 123,
"last": 987
}
Response
{
"data": {
"genes": {
"edges": [GeneEdge],
"nodes": [Gene],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
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
}
complexMolecularProfileCreationActivity {
...CreateComplexMolecularProfileActivityFragment
}
complexMolecularProfileDeprecationActivity {
...DeprecateComplexMolecularProfileActivityFragment
}
deprecated
deprecatedVariants {
...VariantInterfaceFragment
}
deprecationReason
description
events {
...EventConnectionFragment
}
evidenceCountsByStatus {
...EvidenceItemsByStatusFragment
}
evidenceCountsByType {
...EvidenceItemsByTypeFragment
}
evidenceItems {
...EvidenceItemConnectionFragment
}
flagged
flags {
...FlagConnectionFragment
}
id
isComplex
isMultiVariant
lastAcceptedRevisionEvent {
...EventFragment
}
lastCommentEvent {
...EventFragment
}
lastSubmittedRevisionEvent {
...EventFragment
}
link
molecularProfileAliases
molecularProfileScore
name
openRevisionCount
parsedName {
... on Feature {
...FeatureFragment
}
... on MolecularProfileTextSegment {
...MolecularProfileTextSegmentFragment
}
... on Variant {
...VariantFragment
}
}
rawName
revisions {
...RevisionConnectionFragment
}
sources {
...SourceFragment
}
variantCreationActivity {
...CreateVariantActivityFragment
}
variantDeprecationActivity {
...DeprecateVariantActivityFragment
}
variants {
...VariantInterfaceFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"molecularProfile": {
"assertions": AssertionConnection,
"comments": CommentConnection,
"complexMolecularProfileCreationActivity": CreateComplexMolecularProfileActivity,
"complexMolecularProfileDeprecationActivity": DeprecateComplexMolecularProfileActivity,
"deprecated": true,
"deprecatedVariants": [VariantInterface],
"deprecationReason": "DUPLICATE",
"description": "xyz789",
"events": EventConnection,
"evidenceCountsByStatus": EvidenceItemsByStatus,
"evidenceCountsByType": EvidenceItemsByType,
"evidenceItems": EvidenceItemConnection,
"flagged": false,
"flags": FlagConnection,
"id": 123,
"isComplex": false,
"isMultiVariant": false,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"molecularProfileAliases": ["abc123"],
"molecularProfileScore": 123.45,
"name": "xyz789",
"openRevisionCount": 123,
"parsedName": [Feature],
"rawName": "xyz789",
"revisions": RevisionConnection,
"sources": [Source],
"variantCreationActivity": CreateVariantActivity,
"variantDeprecationActivity": DeprecateVariantActivity,
"variants": [VariantInterface]
}
}
}
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. |
alleleRegistryId - String
|
Find Molecular Profiles based on the ClinGen Allele Registry ID of one of its involed Variants |
before - String
|
Returns the elements in the list that come before the specified cursor. |
evidenceStatusFilter - AssociatedEvidenceStatusFilter
|
Limit molecular profiles by the status of attached evidence. |
featureId - Int
|
Filter molecular profiles to the CIViC ID of the feature(s) involved. |
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,
$alleleRegistryId: String,
$before: String,
$evidenceStatusFilter: AssociatedEvidenceStatusFilter,
$featureId: Int,
$first: Int,
$geneId: Int,
$last: Int,
$name: String,
$variantId: Int
) {
molecularProfiles(
after: $after,
alleleRegistryId: $alleleRegistryId,
before: $before,
evidenceStatusFilter: $evidenceStatusFilter,
featureId: $featureId,
first: $first,
geneId: $geneId,
last: $last,
name: $name,
variantId: $variantId
) {
edges {
...MolecularProfileEdgeFragment
}
nodes {
...MolecularProfileFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"alleleRegistryId": "abc123",
"before": "xyz789",
"evidenceStatusFilter": "ALL",
"featureId": 123,
"first": 987,
"geneId": 123,
"last": 987,
"name": "abc123",
"variantId": 123
}
Response
{
"data": {
"molecularProfiles": {
"edges": [MolecularProfileEdge],
"nodes": [MolecularProfile],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
nccnGuideline
Description
Find a NCCN Guideline by CIViC ID
Response
Returns a NccnGuideline
Arguments
Name | Description |
---|---|
id - Int!
|
Example
Query
query nccnGuideline($id: Int!) {
nccnGuideline(id: $id) {
id
name
}
}
Variables
{"id": 987}
Response
{
"data": {
"nccnGuideline": {
"id": 123,
"name": "xyz789"
}
}
}
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": "xyz789"}
]
}
}
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": "xyz789",
"eventType": "ACCEPTED",
"first": 987,
"includeRead": false,
"last": 123,
"notificationReason": "MENTION",
"organizationId": 987,
"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
}
mostRecentActivityTimestamp
name
orgAndSuborgsStatsHash {
...StatsFragment
}
orgStatsHash {
...StatsFragment
}
profileImagePath
ranks {
...RanksFragment
}
subGroups {
...OrganizationFragment
}
url
}
}
Variables
{"id": 987}
Response
{
"data": {
"organization": {
"description": "abc123",
"eventCount": 987,
"events": EventConnection,
"id": 123,
"memberCount": 987,
"members": UserConnection,
"mostRecentActivityTimestamp": ISO8601DateTime,
"name": "abc123",
"orgAndSuborgsStatsHash": Stats,
"orgStatsHash": Stats,
"profileImagePath": "xyz789",
"ranks": Ranks,
"subGroups": [Organization],
"url": "abc123"
}
}
}
organizationLeaderboards
Response
Returns an OrganizationLeaderboards!
Example
Query
query organizationLeaderboards {
organizationLeaderboards {
commentsLeaderboard {
...LeaderboardOrganizationConnectionFragment
}
moderationLeaderboard {
...LeaderboardOrganizationConnectionFragment
}
revisionsLeaderboard {
...LeaderboardOrganizationConnectionFragment
}
submissionsLeaderboard {
...LeaderboardOrganizationConnectionFragment
}
}
}
Response
{
"data": {
"organizationLeaderboards": {
"commentsLeaderboard": LeaderboardOrganizationConnection,
"moderationLeaderboard": LeaderboardOrganizationConnection,
"revisionsLeaderboard": LeaderboardOrganizationConnection,
"submissionsLeaderboard": LeaderboardOrganizationConnection
}
}
}
organizations
Description
List and filter organizations.
Response
Returns a BrowseOrganizationConnection!
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 {
...BrowseOrganizationEdgeFragment
}
filteredCount
lastUpdated
nodes {
...BrowseOrganizationFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"first": 987,
"id": 123,
"last": 987,
"name": "xyz789",
"sortBy": OrganizationSort
}
Response
{
"data": {
"organizations": {
"edges": [BrowseOrganizationEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseOrganization],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
phenotype
Description
Find a phenotype by CIViC ID
Example
Query
query phenotype($id: Int!) {
phenotype(id: $id) {
description
hpoId
id
link
name
url
}
}
Variables
{"id": 987}
Response
{
"data": {
"phenotype": {
"description": "xyz789",
"hpoId": "abc123",
"id": 987,
"link": "xyz789",
"name": "xyz789",
"url": "xyz789"
}
}
}
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
description
evidenceItemCount
hpoId
id
link
molecularProfileCount
name
url
}
}
Variables
{"id": 123}
Response
{
"data": {
"phenotypePopover": {
"assertionCount": 123,
"description": "xyz789",
"evidenceItemCount": 123,
"hpoId": "xyz789",
"id": 987,
"link": "xyz789",
"molecularProfileCount": 123,
"name": "abc123",
"url": "xyz789"
}
}
}
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) {
description
hpoId
id
link
name
url
}
}
Variables
{"queryTerm": "xyz789"}
Response
{
"data": {
"phenotypeTypeahead": [
{
"description": "xyz789",
"hpoId": "xyz789",
"id": 123,
"link": "xyz789",
"name": "abc123",
"url": "abc123"
}
]
}
}
phenotypes
Description
List and filter Phenotypes from the Human Phenotype Ontology.
Response
Returns a PhenotypeConnection!
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) |
Example
Query
query phenotypes(
$after: String,
$before: String,
$first: Int,
$hpoId: String,
$id: Int,
$last: Int,
$name: String
) {
phenotypes(
after: $after,
before: $before,
first: $first,
hpoId: $hpoId,
id: $id,
last: $last,
name: $name
) {
edges {
...PhenotypeEdgeFragment
}
nodes {
...PhenotypeFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"first": 987,
"hpoId": "abc123",
"id": 123,
"last": 123,
"name": "xyz789"
}
Response
{
"data": {
"phenotypes": {
"edges": [PhenotypeEdge],
"nodes": [Phenotype],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
previewCommentText
Response
Returns [CommentBodySegment!]!
Arguments
Name | Description |
---|---|
commentText - String!
|
Example
Query
query previewCommentText($commentText: String!) {
previewCommentText(commentText: $commentText) {
... on CommentTagSegment {
...CommentTagSegmentFragment
}
... on CommentTagSegmentFlagged {
...CommentTagSegmentFlaggedFragment
}
... on CommentTagSegmentFlaggedAndDeprecated {
...CommentTagSegmentFlaggedAndDeprecatedFragment
}
... on CommentTagSegmentFlaggedAndWithStatus {
...CommentTagSegmentFlaggedAndWithStatusFragment
}
... 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 {
...VariantInterfaceFragment
}
existingMolecularProfile {
...MolecularProfileFragment
}
segments {
... on Feature {
...FeatureFragment
}
... on MolecularProfileTextSegment {
...MolecularProfileTextSegmentFragment
}
... on Variant {
...VariantFragment
}
}
}
}
Variables
{"structure": MolecularProfileComponentInput}
Response
{
"data": {
"previewMolecularProfileName": {
"deprecatedVariants": [VariantInterface],
"existingMolecularProfile": MolecularProfile,
"segments": [Feature]
}
}
}
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) {
acceptanceActivity {
...AcceptRevisionsActivityFragment
}
comments {
...CommentConnectionFragment
}
createdAt
creationActivity {
...SuggestRevisionSetActivityFragment
}
currentValue
events {
...EventConnectionFragment
}
fieldName
id
lastCommentEvent {
...EventFragment
}
link
linkoutData {
...LinkoutDataFragment
}
name
rejectionActivity {
...RejectRevisionsActivityFragment
}
resolutionActivity {
...ActivityInterfaceFragment
}
revisionSetId
status
subject {
...EventSubjectFragment
}
suggestedValue
supersedingActivity {
...AcceptRevisionsActivityFragment
}
updatedAt
}
}
Variables
{"id": 123}
Response
{
"data": {
"revision": {
"acceptanceActivity": AcceptRevisionsActivity,
"comments": CommentConnection,
"createdAt": ISO8601DateTime,
"creationActivity": SuggestRevisionSetActivity,
"currentValue": {},
"events": EventConnection,
"fieldName": "xyz789",
"id": 123,
"lastCommentEvent": Event,
"link": "xyz789",
"linkoutData": LinkoutData,
"name": "xyz789",
"rejectionActivity": RejectRevisionsActivity,
"resolutionActivity": ActivityInterface,
"revisionSetId": 987,
"status": "ACCEPTED",
"subject": EventSubject,
"suggestedValue": {},
"supersedingActivity": AcceptRevisionsActivity,
"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 - Int
|
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: Int,
$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": "xyz789",
"before": "xyz789",
"fieldName": "xyz789",
"first": 987,
"last": 987,
"originatingUserId": 987,
"resolvingUserId": 123,
"revisionSetId": 123,
"sortBy": DateSort,
"status": "ACCEPTED",
"subject": ModeratedInput
}
Response
{
"data": {
"revisions": {
"edges": [RevisionEdge],
"nodes": [Revision],
"pageCount": 123,
"pageInfo": PageInfo,
"revisedFieldNames": [FieldName],
"totalCount": 987,
"unfilteredCountForSubject": 987,
"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": true,
"query": "abc123",
"types": ["ASSERTION"]
}
Response
{
"data": {
"search": [
{
"id": 987,
"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": "xyz789"}
Response
{
"data": {
"searchByPermalink": {
"permalinkId": "abc123",
"resultIds": [987],
"searchEndpoint": "xyz789"
}
}
}
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": "xyz789",
"resultIds": [987],
"searchEndpoint": "abc123"
}
}
}
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
}
deprecated
displayType
events {
...EventConnectionFragment
}
fullJournalTitle
fullyCurated
id
journal
lastCommentEvent {
...EventFragment
}
link
name
openAccess
pmcId
publicationDate
publicationDay
publicationMonth
publicationYear
retracted
retractionDate
retractionNature
retractionReasons
sourceType
sourceUrl
title
}
}
Variables
{"id": 123}
Response
{
"data": {
"source": {
"abstract": "xyz789",
"ascoAbstractId": 123,
"authorString": "abc123",
"citation": "abc123",
"citationId": "xyz789",
"clinicalTrials": [ClinicalTrial],
"comments": CommentConnection,
"deprecated": false,
"displayType": "xyz789",
"events": EventConnection,
"fullJournalTitle": "abc123",
"fullyCurated": false,
"id": 987,
"journal": "abc123",
"lastCommentEvent": Event,
"link": "xyz789",
"name": "xyz789",
"openAccess": false,
"pmcId": "xyz789",
"publicationDate": "abc123",
"publicationDay": 123,
"publicationMonth": 987,
"publicationYear": 987,
"retracted": true,
"retractionDate": ISO8601DateTime,
"retractionNature": "xyz789",
"retractionReasons": "xyz789",
"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
}
deprecated
displayType
events {
...EventConnectionFragment
}
evidenceItemCount
fullJournalTitle
fullyCurated
id
journal
lastCommentEvent {
...EventFragment
}
link
name
openAccess
pmcId
publicationDate
publicationDay
publicationMonth
publicationYear
retracted
retractionDate
retractionNature
retractionReasons
sourceType
sourceUrl
title
}
}
Variables
{"id": 987}
Response
{
"data": {
"sourcePopover": {
"abstract": "abc123",
"ascoAbstractId": 123,
"authorString": "abc123",
"citation": "abc123",
"citationId": "xyz789",
"clinicalTrials": [ClinicalTrial],
"comments": CommentConnection,
"deprecated": false,
"displayType": "xyz789",
"events": EventConnection,
"evidenceItemCount": 987,
"fullJournalTitle": "xyz789",
"fullyCurated": true,
"id": 987,
"journal": "xyz789",
"lastCommentEvent": Event,
"link": "xyz789",
"name": "abc123",
"openAccess": true,
"pmcId": "xyz789",
"publicationDate": "abc123",
"publicationDay": 123,
"publicationMonth": 123,
"publicationYear": 123,
"retracted": true,
"retractionDate": ISO8601DateTime,
"retractionNature": "xyz789",
"retractionReasons": "xyz789",
"sourceType": "ASCO",
"sourceUrl": "xyz789",
"title": "xyz789"
}
}
}
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": 987}
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
lastUpdated
nodes {
...SourceSuggestionFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"citation": "xyz789",
"citationId": 123,
"comment": "abc123",
"diseaseName": "abc123",
"first": 123,
"last": 123,
"molecularProfileName": "xyz789",
"sortBy": SourceSuggestionsSort,
"sourceId": 987,
"sourceType": "ASCO",
"status": "CURATED",
"submitter": "xyz789",
"submitterId": 123
}
Response
{
"data": {
"sourceSuggestions": {
"edges": [SourceSuggestionEdge],
"filteredCount": 123,
"lastUpdated": ISO8601DateTime,
"nodes": [SourceSuggestion],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
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
}
deprecated
displayType
events {
...EventConnectionFragment
}
fullJournalTitle
fullyCurated
id
journal
lastCommentEvent {
...EventFragment
}
link
name
openAccess
pmcId
publicationDate
publicationDay
publicationMonth
publicationYear
retracted
retractionDate
retractionNature
retractionReasons
sourceType
sourceUrl
title
}
}
Variables
{
"citationId": "abc123",
"sourceType": "ASCO"
}
Response
{
"data": {
"sourceTypeahead": [
{
"abstract": "xyz789",
"ascoAbstractId": 987,
"authorString": "xyz789",
"citation": "xyz789",
"citationId": "abc123",
"clinicalTrials": [ClinicalTrial],
"comments": CommentConnection,
"deprecated": true,
"displayType": "xyz789",
"events": EventConnection,
"fullJournalTitle": "xyz789",
"fullyCurated": true,
"id": 987,
"journal": "xyz789",
"lastCommentEvent": Event,
"link": "xyz789",
"name": "abc123",
"openAccess": true,
"pmcId": "abc123",
"publicationDate": "abc123",
"publicationDay": 987,
"publicationMonth": 987,
"publicationYear": 987,
"retracted": true,
"retractionDate": ISO8601DateTime,
"retractionNature": "xyz789",
"retractionReasons": "abc123",
"sourceType": "ASCO",
"sourceUrl": "abc123",
"title": "xyz789"
}
]
}
}
sources
Description
List and filter sources.
Response
Returns a SourceConnection!
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. |
citationId - [String!]
|
List of citation IDs to return results for |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query sources(
$after: String,
$before: String,
$citationId: [String!],
$first: Int,
$last: Int
) {
sources(
after: $after,
before: $before,
citationId: $citationId,
first: $first,
last: $last
) {
edges {
...SourceEdgeFragment
}
nodes {
...SourceFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"citationId": ["abc123"],
"first": 123,
"last": 123
}
Response
{
"data": {
"sources": {
"edges": [SourceEdge],
"nodes": [Source],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
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 TherapyConnection!
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 |
therapyAlias - String
|
Example
Query
query therapies(
$after: String,
$before: String,
$first: Int,
$id: Int,
$last: Int,
$name: String,
$ncitId: String,
$therapyAlias: String
) {
therapies(
after: $after,
before: $before,
first: $first,
id: $id,
last: $last,
name: $name,
ncitId: $ncitId,
therapyAlias: $therapyAlias
) {
edges {
...TherapyEdgeFragment
}
nodes {
...TherapyFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"first": 987,
"id": 123,
"last": 987,
"name": "xyz789",
"ncitId": "xyz789",
"therapyAlias": "xyz789"
}
Response
{
"data": {
"therapies": {
"edges": [TherapyEdge],
"nodes": [Therapy],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
therapy
Description
Find a therapy by CIViC ID
Example
Query
query therapy($id: Int!) {
therapy(id: $id) {
deprecated
id
link
myChemInfo {
...MyChemInfoFragment
}
name
ncitId
therapyAliases
therapyUrl
}
}
Variables
{"id": 123}
Response
{
"data": {
"therapy": {
"deprecated": true,
"id": 987,
"link": "xyz789",
"myChemInfo": MyChemInfo,
"name": "abc123",
"ncitId": "abc123",
"therapyAliases": ["xyz789"],
"therapyUrl": "abc123"
}
}
}
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
deprecated
evidenceItemCount
id
link
molecularProfileCount
myChemInfo {
...MyChemInfoFragment
}
name
ncitId
therapyAliases
therapyUrl
}
}
Variables
{"id": 987}
Response
{
"data": {
"therapyPopover": {
"assertionCount": 123,
"deprecated": false,
"evidenceItemCount": 987,
"id": 123,
"link": "abc123",
"molecularProfileCount": 123,
"myChemInfo": MyChemInfo,
"name": "xyz789",
"ncitId": "xyz789",
"therapyAliases": ["abc123"],
"therapyUrl": "xyz789"
}
}
}
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) {
deprecated
id
link
myChemInfo {
...MyChemInfoFragment
}
name
ncitId
therapyAliases
therapyUrl
}
}
Variables
{"queryTerm": "xyz789"}
Response
{
"data": {
"therapyTypeahead": [
{
"deprecated": true,
"id": 987,
"link": "xyz789",
"myChemInfo": MyChemInfo,
"name": "abc123",
"ncitId": "abc123",
"therapyAliases": ["xyz789"],
"therapyUrl": "xyz789"
}
]
}
}
timepointStats
Response
Returns a CivicTimepointStats!
Example
Query
query timepointStats {
timepointStats {
assertions {
...TimePointCountsFragment
}
comments {
...TimePointCountsFragment
}
diseases {
...TimePointCountsFragment
}
evidenceItems {
...TimePointCountsFragment
}
features {
...TimePointCountsFragment
}
molecularProfiles {
...TimePointCountsFragment
}
revisions {
...TimePointCountsFragment
}
sources {
...TimePointCountsFragment
}
therapies {
...TimePointCountsFragment
}
users {
...TimePointCountsFragment
}
variants {
...TimePointCountsFragment
}
}
}
Response
{
"data": {
"timepointStats": {
"assertions": TimePointCounts,
"comments": TimePointCounts,
"diseases": TimePointCounts,
"evidenceItems": TimePointCounts,
"features": 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
mostRecentActivityTimestamp
mostRecentConflictOfInterestStatement {
...CoiFragment
}
mostRecentEvent {
...EventFragment
}
mostRecentOrganizationId
name
notifications {
...NotificationConnectionFragment
}
orcid
organizations {
...OrganizationFragment
}
profileImagePath
ranks {
...RanksFragment
}
role
statsHash {
...StatsFragment
}
twitterHandle
url
username
}
}
Variables
{"id": 987}
Response
{
"data": {
"user": {
"areaOfExpertise": "CLINICAL_SCIENTIST",
"bio": "abc123",
"country": Country,
"displayName": "abc123",
"email": "xyz789",
"events": EventConnection,
"facebookProfile": "abc123",
"id": 123,
"linkedinProfile": "xyz789",
"mostRecentActivityTimestamp": ISO8601DateTime,
"mostRecentConflictOfInterestStatement": Coi,
"mostRecentEvent": Event,
"mostRecentOrganizationId": 987,
"name": "abc123",
"notifications": NotificationConnection,
"orcid": "abc123",
"organizations": [Organization],
"profileImagePath": "abc123",
"ranks": Ranks,
"role": "ADMIN",
"statsHash": Stats,
"twitterHandle": "xyz789",
"url": "abc123",
"username": "abc123"
}
}
}
userLeaderboards
Response
Returns a UserLeaderboards!
Example
Query
query userLeaderboards {
userLeaderboards {
commentsLeaderboard {
...LeaderboardUserConnectionFragment
}
moderationLeaderboard {
...LeaderboardUserConnectionFragment
}
revisionsLeaderboard {
...LeaderboardUserConnectionFragment
}
submissionsLeaderboard {
...LeaderboardUserConnectionFragment
}
}
}
Response
{
"data": {
"userLeaderboards": {
"commentsLeaderboard": LeaderboardUserConnection,
"moderationLeaderboard": LeaderboardUserConnection,
"revisionsLeaderboard": LeaderboardUserConnection,
"submissionsLeaderboard": LeaderboardUserConnection
}
}
}
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
mostRecentActivityTimestamp
mostRecentConflictOfInterestStatement {
...CoiFragment
}
mostRecentEvent {
...EventFragment
}
mostRecentOrganizationId
name
notifications {
...NotificationConnectionFragment
}
orcid
organizations {
...OrganizationFragment
}
profileImagePath
ranks {
...RanksFragment
}
role
statsHash {
...StatsFragment
}
twitterHandle
url
username
}
}
Variables
{"queryTerm": "xyz789"}
Response
{
"data": {
"userTypeahead": [
{
"areaOfExpertise": "CLINICAL_SCIENTIST",
"bio": "abc123",
"country": Country,
"displayName": "xyz789",
"email": "xyz789",
"events": EventConnection,
"facebookProfile": "abc123",
"id": 123,
"linkedinProfile": "abc123",
"mostRecentActivityTimestamp": ISO8601DateTime,
"mostRecentConflictOfInterestStatement": Coi,
"mostRecentEvent": Event,
"mostRecentOrganizationId": 123,
"name": "xyz789",
"notifications": NotificationConnection,
"orcid": "abc123",
"organizations": [Organization],
"profileImagePath": "xyz789",
"ranks": Ranks,
"role": "ADMIN",
"statsHash": Stats,
"twitterHandle": "abc123",
"url": "abc123",
"username": "xyz789"
}
]
}
}
users
Description
List and filter users.
Response
Returns a BrowseUserConnection!
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 {
...BrowseUserEdgeFragment
}
filteredCount
lastUpdated
nodes {
...BrowseUserFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"first": 987,
"last": 123,
"name": "xyz789",
"organization": OrganizationFilter,
"role": "ADMIN",
"sortBy": UsersSort,
"username": "abc123"
}
Response
{
"data": {
"users": {
"edges": [BrowseUserEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseUser],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
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
Response
Returns a VariantInterface
Arguments
Name | Description |
---|---|
id - Int!
|
Example
Query
query variant($id: Int!) {
variant(id: $id) {
comments {
...CommentConnectionFragment
}
creationActivity {
...CreateVariantActivityFragment
}
deprecated
deprecationActivity {
...DeprecateVariantActivityFragment
}
deprecationReason
events {
...EventConnectionFragment
}
feature {
...FeatureFragment
}
flagged
flags {
...FlagConnectionFragment
}
id
lastAcceptedRevisionEvent {
...EventFragment
}
lastCommentEvent {
...EventFragment
}
lastSubmittedRevisionEvent {
...EventFragment
}
link
molecularProfiles {
...MolecularProfileConnectionFragment
}
name
openRevisionCount
revisions {
...RevisionConnectionFragment
}
singleVariantMolecularProfile {
...MolecularProfileFragment
}
singleVariantMolecularProfileId
variantAliases
variantTypes {
...VariantTypeFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"variant": {
"comments": CommentConnection,
"creationActivity": CreateVariantActivity,
"deprecated": true,
"deprecationActivity": DeprecateVariantActivity,
"deprecationReason": "DUPLICATE",
"events": EventConnection,
"feature": Feature,
"flagged": false,
"flags": FlagConnection,
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"molecularProfiles": MolecularProfileConnection,
"name": "xyz789",
"openRevisionCount": 987,
"revisions": RevisionConnection,
"singleVariantMolecularProfile": MolecularProfile,
"singleVariantMolecularProfileId": 987,
"variantAliases": ["xyz789"],
"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
openRevisionCount
revisions {
...RevisionConnectionFragment
}
sources {
...SourceFragment
}
variants {
...VariantInterfaceConnectionFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"variantGroup": {
"comments": CommentConnection,
"description": "xyz789",
"events": EventConnection,
"flagged": true,
"flags": FlagConnection,
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"name": "abc123",
"openRevisionCount": 987,
"revisions": RevisionConnection,
"sources": [Source],
"variants": VariantInterfaceConnection
}
}
}
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. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query variantGroups(
$after: String,
$before: String,
$first: Int,
$last: Int
) {
variantGroups(
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
...VariantGroupEdgeFragment
}
nodes {
...VariantGroupFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"first": 123,
"last": 123
}
Response
{
"data": {
"variantGroups": {
"edges": [VariantGroupEdge],
"nodes": [VariantGroup],
"pageCount": 123,
"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": 123,
"link": "xyz789",
"name": "xyz789",
"soid": "xyz789",
"url": "abc123"
}
}
}
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": 123,
"link": "abc123",
"name": "abc123",
"soid": "xyz789",
"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": "abc123"}
Response
{
"data": {
"variantTypeTypeahead": [
{
"description": "abc123",
"id": 123,
"link": "abc123",
"name": "abc123",
"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. |
featureId - Int
|
Filter variant types by internal CIViC id a feature |
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,
$featureId: Int,
$first: Int,
$geneId: Int,
$id: Int,
$last: Int,
$name: String,
$soid: String,
$sortBy: VariantTypeSort
) {
variantTypes(
after: $after,
before: $before,
featureId: $featureId,
first: $first,
geneId: $geneId,
id: $id,
last: $last,
name: $name,
soid: $soid,
sortBy: $sortBy
) {
edges {
...BrowseVariantTypeEdgeFragment
}
filteredCount
lastUpdated
nodes {
...BrowseVariantTypeFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"featureId": 987,
"first": 123,
"geneId": 987,
"id": 123,
"last": 987,
"name": "abc123",
"soid": "abc123",
"sortBy": VariantTypeSort
}
Response
{
"data": {
"variantTypes": {
"edges": [BrowseVariantTypeEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseVariantType],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
variants
Description
List and filter variants.
Response
Returns a VariantInterfaceConnection!
Arguments
Name | Description |
---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
alleleRegistryId - String
|
Find a CIViC Variant based on its ClinGen Allele Registry ID |
before - String
|
Returns the elements in the list that come before the specified cursor. |
category - VariantCategories
|
|
factorId - Int
|
Feature that the variants are associated with, limited to only Factor type features. |
featureId - Int
|
Feature that the variants are associated with. |
first - Int
|
Returns the first n elements from the list. |
geneId - Int
|
Feature that the variants are associated with, limited to only Gene type features. |
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,
$alleleRegistryId: String,
$before: String,
$category: VariantCategories,
$factorId: Int,
$featureId: Int,
$first: Int,
$geneId: Int,
$hasNoVariantType: Boolean,
$last: Int,
$name: String,
$sortBy: VariantMenuSort,
$variantTypeIds: [Int!]
) {
variants(
after: $after,
alleleRegistryId: $alleleRegistryId,
before: $before,
category: $category,
factorId: $factorId,
featureId: $featureId,
first: $first,
geneId: $geneId,
hasNoVariantType: $hasNoVariantType,
last: $last,
name: $name,
sortBy: $sortBy,
variantTypeIds: $variantTypeIds
) {
edges {
...VariantInterfaceEdgeFragment
}
nodes {
...VariantInterfaceFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"alleleRegistryId": "xyz789",
"before": "xyz789",
"category": "FACTOR",
"factorId": 123,
"featureId": 987,
"first": 123,
"geneId": 123,
"hasNoVariantType": true,
"last": 123,
"name": "xyz789",
"sortBy": VariantMenuSort,
"variantTypeIds": [123]
}
Response
{
"data": {
"variants": {
"edges": [VariantInterfaceEdge],
"nodes": [VariantInterface],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
variantsTypeahead
Response
Returns [Variant!]!
Example
Query
query variantsTypeahead(
$featureId: Int,
$queryTerm: String!
) {
variantsTypeahead(
featureId: $featureId,
queryTerm: $queryTerm
) {
comments {
...CommentConnectionFragment
}
creationActivity {
...CreateVariantActivityFragment
}
deprecated
deprecationActivity {
...DeprecateVariantActivityFragment
}
deprecationReason
events {
...EventConnectionFragment
}
feature {
...FeatureFragment
}
flagged
flags {
...FlagConnectionFragment
}
id
lastAcceptedRevisionEvent {
...EventFragment
}
lastCommentEvent {
...EventFragment
}
lastSubmittedRevisionEvent {
...EventFragment
}
link
molecularProfiles {
...MolecularProfileConnectionFragment
}
name
openRevisionCount
revisions {
...RevisionConnectionFragment
}
singleVariantMolecularProfile {
...MolecularProfileFragment
}
singleVariantMolecularProfileId
variantAliases
variantTypes {
...VariantTypeFragment
}
}
}
Variables
{"featureId": 987, "queryTerm": "xyz789"}
Response
{
"data": {
"variantsTypeahead": [
{
"comments": CommentConnection,
"creationActivity": CreateVariantActivity,
"deprecated": true,
"deprecationActivity": DeprecateVariantActivity,
"deprecationReason": "DUPLICATE",
"events": EventConnection,
"feature": Feature,
"flagged": true,
"flags": FlagConnection,
"id": 987,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"molecularProfiles": MolecularProfileConnection,
"name": "abc123",
"openRevisionCount": 123,
"revisions": RevisionConnection,
"singleVariantMolecularProfile": MolecularProfile,
"singleVariantMolecularProfileId": 987,
"variantAliases": ["abc123"],
"variantTypes": [VariantType]
}
]
}
}
viewer
Response
Returns a User
Example
Query
query viewer {
viewer {
areaOfExpertise
bio
country {
...CountryFragment
}
displayName
email
events {
...EventConnectionFragment
}
facebookProfile
id
linkedinProfile
mostRecentActivityTimestamp
mostRecentConflictOfInterestStatement {
...CoiFragment
}
mostRecentEvent {
...EventFragment
}
mostRecentOrganizationId
name
notifications {
...NotificationConnectionFragment
}
orcid
organizations {
...OrganizationFragment
}
profileImagePath
ranks {
...RanksFragment
}
role
statsHash {
...StatsFragment
}
twitterHandle
url
username
}
}
Response
{
"data": {
"viewer": {
"areaOfExpertise": "CLINICAL_SCIENTIST",
"bio": "abc123",
"country": Country,
"displayName": "abc123",
"email": "xyz789",
"events": EventConnection,
"facebookProfile": "xyz789",
"id": 123,
"linkedinProfile": "abc123",
"mostRecentActivityTimestamp": ISO8601DateTime,
"mostRecentConflictOfInterestStatement": Coi,
"mostRecentEvent": Event,
"mostRecentOrganizationId": 123,
"name": "abc123",
"notifications": NotificationConnection,
"orcid": "xyz789",
"organizations": [Organization],
"profileImagePath": "abc123",
"ranks": Ranks,
"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": "xyz789",
"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": "abc123",
"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": "abc123",
"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
}
}
}
createFeature
Description
Create a new Feature in the database.
Response
Returns a CreateFeaturePayload
Arguments
Name | Description |
---|---|
input - CreateFeatureInput!
|
Parameters for CreateFeature |
Example
Query
mutation createFeature($input: CreateFeatureInput!) {
createFeature(input: $input) {
clientMutationId
feature {
...FeatureFragment
}
new
}
}
Variables
{"input": CreateFeatureInput}
Response
{
"data": {
"createFeature": {
"clientMutationId": "abc123",
"feature": Feature,
"new": true
}
}
}
createFusionFeature
Description
Create a new Fusion Feature in the database.
Response
Returns a CreateFusionFeaturePayload
Arguments
Name | Description |
---|---|
input - CreateFusionFeatureInput!
|
Parameters for CreateFusionFeature |
Example
Query
mutation createFusionFeature($input: CreateFusionFeatureInput!) {
createFusionFeature(input: $input) {
clientMutationId
feature {
...FeatureFragment
}
new
}
}
Variables
{"input": CreateFusionFeatureInput}
Response
{
"data": {
"createFusionFeature": {
"clientMutationId": "abc123",
"feature": Feature,
"new": false
}
}
}
createFusionVariant
Description
Create a new Fusion Variant in the database.
Response
Returns a CreateFusionVariantPayload
Arguments
Name | Description |
---|---|
input - CreateFusionVariantInput!
|
Parameters for CreateFusionVariant |
Example
Query
mutation createFusionVariant($input: CreateFusionVariantInput!) {
createFusionVariant(input: $input) {
clientMutationId
molecularProfile {
...MolecularProfileFragment
}
new
variant {
...VariantInterfaceFragment
}
}
}
Variables
{"input": CreateFusionVariantInput}
Response
{
"data": {
"createFusionVariant": {
"clientMutationId": "abc123",
"molecularProfile": MolecularProfile,
"new": true,
"variant": VariantInterface
}
}
}
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": "abc123",
"molecularProfile": MolecularProfile
}
}
}
createVariant
Description
Create a new Variant to the database.
Response
Returns a CreateVariantPayload
Arguments
Name | Description |
---|---|
input - CreateVariantInput!
|
Parameters for CreateVariant |
Example
Query
mutation createVariant($input: CreateVariantInput!) {
createVariant(input: $input) {
clientMutationId
molecularProfile {
...MolecularProfileFragment
}
new
variant {
...VariantFragment
}
}
}
Variables
{"input": CreateVariantInput}
Response
{
"data": {
"createVariant": {
"clientMutationId": "xyz789",
"molecularProfile": MolecularProfile,
"new": false,
"variant": Variant
}
}
}
deleteComment
Description
Mark a comment as deleted. You can only delete your own comments.
Response
Returns a DeleteCommentPayload
Arguments
Name | Description |
---|---|
input - DeleteCommentInput!
|
Parameters for DeleteComment |
Example
Query
mutation deleteComment($input: DeleteCommentInput!) {
deleteComment(input: $input) {
clientMutationId
comment {
...CommentFragment
}
}
}
Variables
{"input": DeleteCommentInput}
Response
{
"data": {
"deleteComment": {
"clientMutationId": "xyz789",
"comment": Comment
}
}
}
deprecateComplexMolecularProfile
Description
Deprecate a complex molecular profile to prevent it from being used in the future.
Response
Returns a DeprecateComplexMolecularProfilePayload
Arguments
Name | Description |
---|---|
input - DeprecateComplexMolecularProfileInput!
|
Parameters for DeprecateComplexMolecularProfile |
Example
Query
mutation deprecateComplexMolecularProfile($input: DeprecateComplexMolecularProfileInput!) {
deprecateComplexMolecularProfile(input: $input) {
clientMutationId
molecularProfile {
...MolecularProfileFragment
}
}
}
Variables
{"input": DeprecateComplexMolecularProfileInput}
Response
{
"data": {
"deprecateComplexMolecularProfile": {
"clientMutationId": "xyz789",
"molecularProfile": MolecularProfile
}
}
}
deprecateFeature
Description
Deprecate a feature to prevent it from being used in the future and implicitly deprecate all the variants and molecular profiles linked to this feature.
Response
Returns a DeprecateFeaturePayload
Arguments
Name | Description |
---|---|
input - DeprecateFeatureInput!
|
Parameters for DeprecateFeature |
Example
Query
mutation deprecateFeature($input: DeprecateFeatureInput!) {
deprecateFeature(input: $input) {
clientMutationId
feature {
...FeatureFragment
}
newlyDeprecatedMolecularProfiles {
...MolecularProfileFragment
}
newlyDeprecatedVariants {
...VariantInterfaceFragment
}
}
}
Variables
{"input": DeprecateFeatureInput}
Response
{
"data": {
"deprecateFeature": {
"clientMutationId": "xyz789",
"feature": Feature,
"newlyDeprecatedMolecularProfiles": [
MolecularProfile
],
"newlyDeprecatedVariants": [VariantInterface]
}
}
}
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 {
...VariantInterfaceFragment
}
}
}
Variables
{"input": DeprecateVariantInput}
Response
{
"data": {
"deprecateVariant": {
"clientMutationId": "abc123",
"newlyDeprecatedMolecularProfiles": [
MolecularProfile
],
"variant": VariantInterface
}
}
}
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": "abc123",
"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": "xyz789",
"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": "abc123"
}
}
}
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": "xyz789",
"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 erroneously 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": "abc123",
"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": "abc123",
"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": "abc123",
"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]
}
}
}
suggestFactorRevision
Description
Suggest a Revision to a Feature entity of instance type "Factor".
Response
Returns a SuggestFactorRevisionPayload
Arguments
Name | Description |
---|---|
input - SuggestFactorRevisionInput!
|
Parameters for SuggestFactorRevision |
Example
Query
mutation suggestFactorRevision($input: SuggestFactorRevisionInput!) {
suggestFactorRevision(input: $input) {
clientMutationId
factor {
...FactorFragment
}
results {
...RevisionResultFragment
}
}
}
Variables
{"input": SuggestFactorRevisionInput}
Response
{
"data": {
"suggestFactorRevision": {
"clientMutationId": "xyz789",
"factor": Factor,
"results": [RevisionResult]
}
}
}
suggestFactorVariantRevision
Description
Suggest a Revision to a Variant entity.
Response
Returns a SuggestFactorVariantRevisionPayload
Arguments
Name | Description |
---|---|
input - SuggestFactorVariantRevisionInput!
|
Parameters for SuggestFactorVariantRevision |
Example
Query
mutation suggestFactorVariantRevision($input: SuggestFactorVariantRevisionInput!) {
suggestFactorVariantRevision(input: $input) {
clientMutationId
results {
...RevisionResultFragment
}
variant {
...FactorVariantFragment
}
}
}
Variables
{"input": SuggestFactorVariantRevisionInput}
Response
{
"data": {
"suggestFactorVariantRevision": {
"clientMutationId": "abc123",
"results": [RevisionResult],
"variant": FactorVariant
}
}
}
suggestFusionRevision
Description
Suggest a Revision to a Feature entity of instance type "Fusion".
Response
Returns a SuggestFusionRevisionPayload
Arguments
Name | Description |
---|---|
input - SuggestFusionRevisionInput!
|
Parameters for SuggestFusionRevision |
Example
Query
mutation suggestFusionRevision($input: SuggestFusionRevisionInput!) {
suggestFusionRevision(input: $input) {
clientMutationId
fusion {
...FusionFragment
}
results {
...RevisionResultFragment
}
}
}
Variables
{"input": SuggestFusionRevisionInput}
Response
{
"data": {
"suggestFusionRevision": {
"clientMutationId": "xyz789",
"fusion": Fusion,
"results": [RevisionResult]
}
}
}
suggestFusionVariantRevision
Description
Suggest a Revision to a Fusion entity.
Response
Returns a SuggestFusionVariantRevisionPayload
Arguments
Name | Description |
---|---|
input - SuggestFusionVariantRevisionInput!
|
Parameters for SuggestFusionVariantRevision |
Example
Query
mutation suggestFusionVariantRevision($input: SuggestFusionVariantRevisionInput!) {
suggestFusionVariantRevision(input: $input) {
clientMutationId
results {
...RevisionResultFragment
}
variant {
...FusionVariantFragment
}
}
}
Variables
{"input": SuggestFusionVariantRevisionInput}
Response
{
"data": {
"suggestFusionVariantRevision": {
"clientMutationId": "xyz789",
"results": [RevisionResult],
"variant": FusionVariant
}
}
}
suggestGeneRevision
Description
Suggest a Revision to a Feature entity of instance type "Gene".
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]
}
}
}
suggestGeneVariantRevision
Description
Suggest a Revision to a Variant entity.
Response
Returns a SuggestGeneVariantRevisionPayload
Arguments
Name | Description |
---|---|
input - SuggestGeneVariantRevisionInput!
|
Parameters for SuggestGeneVariantRevision |
Example
Query
mutation suggestGeneVariantRevision($input: SuggestGeneVariantRevisionInput!) {
suggestGeneVariantRevision(input: $input) {
clientMutationId
results {
...RevisionResultFragment
}
variant {
...GeneVariantFragment
}
}
}
Variables
{"input": SuggestGeneVariantRevisionInput}
Response
{
"data": {
"suggestGeneVariantRevision": {
"clientMutationId": "xyz789",
"results": [RevisionResult],
"variant": GeneVariant
}
}
}
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": "xyz789",
"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
}
}
}
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 currently 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": "xyz789",
"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": 987}}
subscribable
Response
Returns an EventSubject!
Example
Query
subscription subscribable {
subscribable {
events {
...EventConnectionFragment
}
id
link
name
}
}
Response
{
"data": {
"subscribable": {
"events": EventConnection,
"id": 123,
"link": "abc123",
"name": "abc123"
}
}
}
Types
AcceptRevisionsActivity
Fields
Field Name | Description |
---|---|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
id - Int!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
revisions - [Revision!]!
|
|
subject - EventSubject!
|
|
supersededRevisions - [Revision!]!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"createdAt": ISO8601DateTime,
"events": [Event],
"id": 987,
"note":