CIViC 2 API Documentation
Documentation for the CIViC GraphQL API
API Endpoints
https://civicdb.org/api/graphqlQueries
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": 123}
Response
{
"data": {
"acmgCode": {
"code": "abc123",
"description": "xyz789",
"id": 987,
"name": "abc123",
"tooltip": "abc123"
}
}
}
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": "abc123",
"description": "abc123",
"id": 123,
"name": "abc123",
"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. |
linkedEndorsementId - Int
|
Filter activities on being linked to the endorsement with the given CIViC ID. |
mode - EventFeedMode
|
|
occurredAfter - ISO8601DateTime
|
|
occurredBefore - ISO8601DateTime
|
|
organization - OrganizationFilter
|
Filter EIDs on the organization the evidence item was submitted under. |
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,
$linkedEndorsementId: Int,
$mode: EventFeedMode,
$occurredAfter: ISO8601DateTime,
$occurredBefore: ISO8601DateTime,
$organization: OrganizationFilter,
$sortBy: DateSort,
$subject: [SubscribableQueryInput!],
$subjectType: [ActivitySubjectInput!],
$userId: [Int!]
) {
activities(
activityType: $activityType,
after: $after,
before: $before,
first: $first,
includeAutomatedEvents: $includeAutomatedEvents,
last: $last,
linkedEndorsementId: $linkedEndorsementId,
mode: $mode,
occurredAfter: $occurredAfter,
occurredBefore: $occurredBefore,
organization: $organization,
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": "abc123",
"first": 987,
"includeAutomatedEvents": true,
"last": 123,
"linkedEndorsementId": 987,
"mode": "ORGANIZATION",
"occurredAfter": ISO8601DateTime,
"occurredBefore": ISO8601DateTime,
"organization": OrganizationFilter,
"sortBy": DateSort,
"subject": [SubscribableQueryInput],
"subjectType": ["ASSERTION"],
"userId": [123]
}
Response
{
"data": {
"activities": {
"activityTypes": ["ACCEPT_REVISIONS"],
"edges": [ActivityInterfaceEdge],
"nodes": [ActivityInterface],
"pageCount": 987,
"pageInfo": PageInfo,
"participatingOrganizations": [Organization],
"subjectTypes": ["ASSERTION"],
"totalCount": 987,
"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": 123,
"note": "xyz789",
"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
}
endorsements {
...EndorsementConnectionFragment
}
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": "abc123",
"disease": Disease,
"endorsements": EndorsementConnection,
"events": EventConnection,
"evidenceItems": [EvidenceItem],
"evidenceItemsCount": 987,
"fdaCompanionTest": false,
"fdaCompanionTestLastUpdated": ISO8601DateTime,
"flagged": true,
"flags": FlagConnection,
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"molecularProfile": MolecularProfile,
"name": "xyz789",
"nccnGuideline": NccnGuideline,
"nccnGuidelineVersion": "xyz789",
"openRevisionCount": 123,
"phenotypes": [Phenotype],
"regulatoryApproval": false,
"regulatoryApprovalLastUpdated": ISO8601DateTime,
"rejectionEvent": Event,
"revisions": RevisionConnection,
"significance": "ADVERSE_RESPONSE",
"status": "ACCEPTED",
"submissionActivity": SubmitAssertionActivity,
"submissionEvent": Event,
"summary": "abc123",
"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. |
endorsingOrganizations - OrganizationFilter
|
Filter AIDs by Organziations that have endorsed them. Specifying multiple IDs will return Assertions endorsed by any of the Organizations. |
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. |
ids - [Int!]
|
Filter by internal CIViC ids |
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 |
organization - OrganizationFilter
|
Filter AIDs on the organization the evidence item 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,
$endorsingOrganizations: OrganizationFilter,
$evidenceId: Int,
$first: Int,
$id: Int,
$ids: [Int!],
$last: Int,
$molecularProfileId: Int,
$molecularProfileName: String,
$organization: OrganizationFilter,
$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,
endorsingOrganizations: $endorsingOrganizations,
evidenceId: $evidenceId,
first: $first,
id: $id,
ids: $ids,
last: $last,
molecularProfileId: $molecularProfileId,
molecularProfileName: $molecularProfileName,
organization: $organization,
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": "abc123",
"diseaseId": 123,
"diseaseName": "xyz789",
"endorsingOrganizations": OrganizationFilter,
"evidenceId": 987,
"first": 123,
"id": 123,
"ids": [123],
"last": 987,
"molecularProfileId": 123,
"molecularProfileName": "abc123",
"organization": OrganizationFilter,
"phenotypeId": 987,
"significance": "ADVERSE_RESPONSE",
"sortBy": AssertionSort,
"status": "ACCEPTED",
"summary": "abc123",
"therapyId": 123,
"therapyName": "xyz789",
"userId": 987,
"variantId": 987,
"variantName": "xyz789"
}
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
|
|
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [Int!],
$last: Int,
$name: String,
$sortBy: DiseasesSort
) {
browseDiseases(
after: $after,
before: $before,
diseaseAlias: $diseaseAlias,
doid: $doid,
featureName: $featureName,
first: $first,
id: $id,
ids: $ids,
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": "abc123",
"first": 123,
"id": 123,
"ids": [123],
"last": 987,
"name": "abc123",
"sortBy": DiseasesSort
}
Response
{
"data": {
"browseDiseases": {
"edges": [BrowseDiseaseEdge],
"filteredCount": 123,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseDisease],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
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. |
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [Int!],
$last: Int,
$sortBy: FeaturesSort,
$therapyName: String
) {
browseFeatures(
after: $after,
before: $before,
diseaseName: $diseaseName,
featureAlias: $featureAlias,
featureFullName: $featureFullName,
featureName: $featureName,
featureType: $featureType,
first: $first,
ids: $ids,
last: $last,
sortBy: $sortBy,
therapyName: $therapyName
) {
edges {
...BrowseFeatureEdgeFragment
}
filteredCount
lastUpdated
nodes {
...BrowseFeatureFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"diseaseName": "xyz789",
"featureAlias": "xyz789",
"featureFullName": "abc123",
"featureName": "xyz789",
"featureType": "FACTOR",
"first": 123,
"ids": [123],
"last": 123,
"sortBy": FeaturesSort,
"therapyName": "abc123"
}
Response
{
"data": {
"browseFeatures": {
"edges": [BrowseFeatureEdge],
"filteredCount": 123,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseFeature],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
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. |
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [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,
ids: $ids,
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": "abc123",
"before": "abc123",
"diseaseName": "abc123",
"featureName": "xyz789",
"first": 987,
"ids": [987],
"last": 123,
"molecularProfileAlias": "abc123",
"molecularProfileName": "xyz789",
"sortBy": MolecularProfilesSort,
"therapyName": "abc123",
"variantId": 987,
"variantName": "abc123"
}
Response
{
"data": {
"browseMolecularProfiles": {
"edges": [BrowseMolecularProfileEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseMolecularProfile],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
browseOrganizations
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. |
ids - [Int!]
|
Filter by internal CIViC ids |
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 browseOrganizations(
$after: String,
$before: String,
$first: Int,
$id: Int,
$ids: [Int!],
$last: Int,
$name: String,
$sortBy: OrganizationSort
) {
browseOrganizations(
after: $after,
before: $before,
first: $first,
id: $id,
ids: $ids,
last: $last,
name: $name,
sortBy: $sortBy
) {
edges {
...BrowseOrganizationEdgeFragment
}
filteredCount
lastUpdated
nodes {
...BrowseOrganizationFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"first": 123,
"id": 123,
"ids": [987],
"last": 123,
"name": "abc123",
"sortBy": OrganizationSort
}
Response
{
"data": {
"browseOrganizations": {
"edges": [BrowseOrganizationEdge],
"filteredCount": 123,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseOrganization],
"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 |
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [Int!],
$last: Int,
$name: String,
$sortBy: PhenotypeSort
) {
browsePhenotypes(
after: $after,
before: $before,
first: $first,
hpoId: $hpoId,
id: $id,
ids: $ids,
last: $last,
name: $name,
sortBy: $sortBy
) {
edges {
...BrowsePhenotypeEdgeFragment
}
filteredCount
lastUpdated
nodes {
...BrowsePhenotypeFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"first": 987,
"hpoId": "xyz789",
"id": 123,
"ids": [987],
"last": 987,
"name": "abc123",
"sortBy": PhenotypeSort
}
Response
{
"data": {
"browsePhenotypes": {
"edges": [BrowsePhenotypeEdge],
"filteredCount": 987,
"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
|
|
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [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,
ids: $ids,
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": "xyz789",
"author": "xyz789",
"before": "abc123",
"citationId": 987,
"clinicalTrialId": 987,
"first": 123,
"id": 987,
"ids": [987],
"journal": "xyz789",
"last": 123,
"name": "xyz789",
"openAccess": true,
"sortBy": SourcesSort,
"sourceType": "ASCO",
"year": 123
}
Response
{
"data": {
"browseSources": {
"edges": [BrowseSourceEdge],
"filteredCount": 123,
"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 |
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [Int!],
$last: Int,
$name: String,
$ncitId: String,
$sortBy: TherapySort,
$therapyAlias: String
) {
browseTherapies(
after: $after,
before: $before,
first: $first,
id: $id,
ids: $ids,
last: $last,
name: $name,
ncitId: $ncitId,
sortBy: $sortBy,
therapyAlias: $therapyAlias
) {
edges {
...BrowseTherapyEdgeFragment
}
filteredCount
lastUpdated
nodes {
...BrowseTherapyFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"first": 123,
"id": 123,
"ids": [123],
"last": 123,
"name": "xyz789",
"ncitId": "xyz789",
"sortBy": TherapySort,
"therapyAlias": "abc123"
}
Response
{
"data": {
"browseTherapies": {
"edges": [BrowseTherapyEdge],
"filteredCount": 123,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseTherapy],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
browseUsers
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. |
ids - [Int!]
|
Filter by internal CIViC ids |
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 browseUsers(
$after: String,
$before: String,
$first: Int,
$ids: [Int!],
$last: Int,
$name: String,
$organization: OrganizationFilter,
$role: UserRole,
$sortBy: UsersSort,
$username: String
) {
browseUsers(
after: $after,
before: $before,
first: $first,
ids: $ids,
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": "xyz789",
"first": 123,
"ids": [987],
"last": 123,
"name": "xyz789",
"organization": OrganizationFilter,
"role": "ADMIN",
"sortBy": UsersSort,
"username": "abc123"
}
Response
{
"data": {
"browseUsers": {
"edges": [BrowseUserEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseUser],
"pageCount": 123,
"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. |
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [Int!],
$last: Int,
$name: String,
$sortBy: VariantGroupsSort,
$variantNames: String
) {
browseVariantGroups(
after: $after,
before: $before,
featureNames: $featureNames,
first: $first,
ids: $ids,
last: $last,
name: $name,
sortBy: $sortBy,
variantNames: $variantNames
) {
edges {
...BrowseVariantGroupEdgeFragment
}
filteredCount
lastUpdated
nodes {
...BrowseVariantGroupFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"featureNames": "abc123",
"first": 987,
"ids": [987],
"last": 987,
"name": "abc123",
"sortBy": VariantGroupsSort,
"variantNames": "abc123"
}
Response
{
"data": {
"browseVariantGroups": {
"edges": [BrowseVariantGroupEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseVariantGroup],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
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
|
|
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [Int!],
$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,
ids: $ids,
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": "abc123",
"category": "FACTOR",
"diseaseName": "xyz789",
"featureName": "xyz789",
"first": 123,
"hasNoVariantType": true,
"ids": [123],
"last": 123,
"sortBy": VariantsSort,
"therapyName": "xyz789",
"variantAlias": "abc123",
"variantGroupId": 123,
"variantName": "xyz789",
"variantTypeId": 123,
"variantTypeName": "xyz789"
}
Response
{
"data": {
"browseVariants": {
"edges": [BrowseVariantEdge],
"filteredCount": 123,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseVariant],
"pageCount": 123,
"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": "abc123",
"exclusive": true,
"id": 987,
"name": "xyz789",
"tooltip": "abc123"
}
}
}
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": "abc123",
"description": "xyz789",
"exclusive": false,
"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": 987,
"link": "abc123",
"name": "abc123",
"nctId": "xyz789",
"url": "xyz789"
}
}
}
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 |
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [Int!],
$last: Int,
$name: String,
$nctId: String,
$sortBy: ClinicalTrialSort
) {
clinicalTrials(
after: $after,
before: $before,
first: $first,
id: $id,
ids: $ids,
last: $last,
name: $name,
nctId: $nctId,
sortBy: $sortBy
) {
edges {
...BrowseClinicalTrialEdgeFragment
}
filteredCount
lastUpdated
nodes {
...BrowseClinicalTrialFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"first": 987,
"id": 123,
"ids": [987],
"last": 123,
"name": "xyz789",
"nctId": "abc123",
"sortBy": ClinicalTrialSort
}
Response
{
"data": {
"clinicalTrials": {
"edges": [BrowseClinicalTrialEdge],
"filteredCount": 123,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseClinicalTrial],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
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": "xyz789",
"commentable": Commentable,
"commenter": User,
"createdAt": ISO8601DateTime,
"creationEvent": Event,
"deleted": false,
"deletedAt": ISO8601DateTime,
"events": EventConnection,
"id": 123,
"link": "xyz789",
"name": "abc123",
"parsedComment": [CommentTagSegment],
"title": "abc123"
}
}
}
comments
Description
List and filter comments.
Response
Returns a CommentConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [Int!],
$last: Int,
$mentionedEntity: TaggableEntityInput,
$mentionedRole: UserRole,
$mentionedUserId: Int,
$originatingUserId: Int,
$sortBy: DateSort,
$subject: CommentableInput
) {
comments(
after: $after,
before: $before,
first: $first,
ids: $ids,
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": 123,
"ids": [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": 123,
"unfilteredCountForSubject": 987,
"uniqueCommenters": [User]
}
}
}
contributors
Response
Returns a ContributingUsersSummary!
Arguments
| Name | Description |
|---|---|
subscribable - SubscribableInput!
|
The entity to to return contributors for |
Example
Query
query contributors($subscribable: SubscribableInput!) {
contributors(subscribable: $subscribable) {
curators {
...ContributingUserFragment
}
editors {
...ContributingUserFragment
}
}
}
Variables
{"subscribable": SubscribableInput}
Response
{
"data": {
"contributors": {
"curators": [ContributingUser],
"editors": [ContributingUser]
}
}
}
countries
Description
Fetch a list of countries for user profiles.
Response
Returns [Country!]!
Example
Query
query countries {
countries {
id
iso
name
}
}
Response
{
"data": {
"countries": [
{
"id": 987,
"iso": "abc123",
"name": "abc123"
}
]
}
}
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": ["abc123"],
"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": 987,
"deprecated": true,
"diseaseAliases": ["abc123"],
"diseaseUrl": "abc123",
"displayName": "xyz789",
"doid": "abc123",
"evidenceItemCount": 123,
"id": 987,
"link": "xyz789",
"molecularProfileCount": 987,
"myDiseaseInfo": MyDiseaseInfo,
"name": "abc123"
}
}
}
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": "abc123"}
Response
{
"data": {
"diseaseTypeahead": [
{
"deprecated": false,
"diseaseAliases": ["abc123"],
"diseaseUrl": "xyz789",
"displayName": "xyz789",
"doid": "abc123",
"id": 123,
"link": "xyz789",
"myDiseaseInfo": MyDiseaseInfo,
"name": "abc123"
}
]
}
}
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
|
|
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [Int!],
$last: Int,
$name: String
) {
diseases(
after: $after,
before: $before,
doid: $doid,
first: $first,
id: $id,
ids: $ids,
last: $last,
name: $name
) {
edges {
...DiseaseEdgeFragment
}
nodes {
...DiseaseFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"doid": "xyz789",
"first": 123,
"id": 987,
"ids": [123],
"last": 123,
"name": "abc123"
}
Response
{
"data": {
"diseases": {
"edges": [DiseaseEdge],
"nodes": [Disease],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
endorsements
Description
List and filter endorsements.
Response
Returns an EndorsementConnection!
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. |
endorsedAssertionId - Int
|
CIViC Assertion ID that is being endorsed. |
endorsingOrganizationId - Int
|
CIViC Organization ID of the organization endorsing the assertion. |
endorsingOrganizationIsApprovedVcep - Boolean
|
Limit to endorsements from a FDA-approved ClinGen SC-VCEPs. |
endorsingUserId - Int
|
CIViC User ID of the user endorsing the assertion. |
first - Int
|
Returns the first n elements from the list. |
ids - [Int!]
|
Filter by internal CIViC ids |
last - Int
|
Returns the last n elements from the list. |
sortBy - DateSort
|
Sort order for the endorsements. Defaults to most recent. |
status - EndorsementStatus
|
Limit to endorsements of a particular status |
Example
Query
query endorsements(
$after: String,
$before: String,
$endorsedAssertionId: Int,
$endorsingOrganizationId: Int,
$endorsingOrganizationIsApprovedVcep: Boolean,
$endorsingUserId: Int,
$first: Int,
$ids: [Int!],
$last: Int,
$sortBy: DateSort,
$status: EndorsementStatus
) {
endorsements(
after: $after,
before: $before,
endorsedAssertionId: $endorsedAssertionId,
endorsingOrganizationId: $endorsingOrganizationId,
endorsingOrganizationIsApprovedVcep: $endorsingOrganizationIsApprovedVcep,
endorsingUserId: $endorsingUserId,
first: $first,
ids: $ids,
last: $last,
sortBy: $sortBy,
status: $status
) {
edges {
...EndorsementEdgeFragment
}
nodes {
...EndorsementFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"endorsedAssertionId": 987,
"endorsingOrganizationId": 987,
"endorsingOrganizationIsApprovedVcep": true,
"endorsingUserId": 123,
"first": 987,
"ids": [123],
"last": 987,
"sortBy": DateSort,
"status": "ACTIVE"
}
Response
{
"data": {
"endorsements": {
"edges": [EndorsementEdge],
"nodes": [Endorsement],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
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": "abc123",
"entityId": 987,
"feature": LinkableFeature,
"link": "abc123",
"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. |
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [Int!],
$includeAutomatedEvents: Boolean,
$last: Int,
$mode: EventFeedMode,
$organizationId: Int,
$originatingUserId: Int,
$sortBy: DateSort,
$subject: SubscribableQueryInput
) {
events(
after: $after,
before: $before,
eventType: $eventType,
first: $first,
ids: $ids,
includeAutomatedEvents: $includeAutomatedEvents,
last: $last,
mode: $mode,
organizationId: $organizationId,
originatingUserId: $originatingUserId,
sortBy: $sortBy,
subject: $subject
) {
edges {
...EventEdgeFragment
}
eventTypes
nodes {
...EventFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
participatingOrganizations {
...OrganizationFragment
}
totalCount
unfilteredCount
uniqueParticipants {
...UserFragment
}
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"eventType": "ACCEPTED",
"first": 987,
"ids": [123],
"includeAutomatedEvents": false,
"last": 123,
"mode": "ORGANIZATION",
"organizationId": 123,
"originatingUserId": 987,
"sortBy": DateSort,
"subject": SubscribableQueryInput
}
Response
{
"data": {
"events": {
"edges": [EventEdge],
"eventTypes": ["ACCEPTED"],
"nodes": [Event],
"pageCount": 123,
"pageInfo": PageInfo,
"participatingOrganizations": [Organization],
"totalCount": 987,
"unfilteredCount": 987,
"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": 123}
Response
{
"data": {
"evidenceItem": {
"acceptanceEvent": Event,
"assertions": [Assertion],
"comments": CommentConnection,
"description": "xyz789",
"disease": Disease,
"events": EventConnection,
"evidenceDirection": "DOES_NOT_SUPPORT",
"evidenceLevel": "A",
"evidenceRating": 123,
"evidenceType": "DIAGNOSTIC",
"flagged": true,
"flags": FlagConnection,
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"molecularProfile": MolecularProfile,
"name": "xyz789",
"openRevisionCount": 123,
"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 |
organization - OrganizationFilter
|
Filter EIDs on 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,
$organization: OrganizationFilter,
$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,
organization: $organization,
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": 987,
"before": "abc123",
"clinicalTrialId": 987,
"description": "xyz789",
"diseaseId": 123,
"diseaseName": "xyz789",
"evidenceDirection": "DOES_NOT_SUPPORT",
"evidenceLevel": "A",
"evidenceRating": 123,
"evidenceType": "DIAGNOSTIC",
"first": 987,
"id": 987,
"ids": [123],
"last": 987,
"molecularProfileId": 987,
"molecularProfileName": "xyz789",
"organization": OrganizationFilter,
"phenotypeId": 987,
"significance": "ADVERSE_RESPONSE",
"sortBy": EvidenceSort,
"sourceId": 123,
"status": "ACCEPTED",
"therapyId": 123,
"therapyName": "xyz789",
"userId": 987,
"variantId": 123,
"variantOrigin": "COMBINED"
}
Response
{
"data": {
"evidenceItems": {
"edges": [EvidenceItemEdge],
"nodes": [EvidenceItem],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
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": 987, "ncitId": "abc123"}
Response
{
"data": {
"factor": {
"comments": CommentConnection,
"creationActivity": CreateFeatureActivity,
"deprecated": false,
"deprecationActivity": DeprecateFeatureActivity,
"deprecationReason": "DUPLICATE",
"description": "abc123",
"events": EventConnection,
"featureAliases": ["xyz789"],
"featureInstance": Factor,
"featureType": "FACTOR",
"flagged": false,
"flags": FlagConnection,
"fullName": "xyz789",
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"name": "abc123",
"ncitDetails": NcitDetails,
"ncitId": "xyz789",
"openRevisionCount": 987,
"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. |
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [Int!],
$last: Int,
$name: [String!],
$ncitIt: [String!]
) {
factors(
after: $after,
before: $before,
evidenceStatusFilter: $evidenceStatusFilter,
first: $first,
ids: $ids,
last: $last,
name: $name,
ncitIt: $ncitIt
) {
edges {
...FactorEdgeFragment
}
nodes {
...FactorFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"evidenceStatusFilter": "ALL",
"first": 123,
"ids": [987],
"last": 123,
"name": ["abc123"],
"ncitIt": ["abc123"]
}
Response
{
"data": {
"factors": {
"edges": [FactorEdge],
"nodes": [Factor],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
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": true,
"deprecationActivity": DeprecateFeatureActivity,
"deprecationReason": "DUPLICATE",
"description": "xyz789",
"events": EventConnection,
"featureAliases": ["abc123"],
"featureInstance": Factor,
"featureType": "FACTOR",
"flagged": false,
"flags": FlagConnection,
"fullName": "abc123",
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"name": "abc123",
"openRevisionCount": 987,
"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": ["xyz789"],
"featureInstance": Factor,
"featureType": "FACTOR",
"flagged": false,
"flags": FlagConnection,
"fullName": "xyz789",
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"name": "xyz789",
"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": 123,
"lastCommentEvent": Event,
"link": "xyz789",
"name": "abc123",
"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 |
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [Int!],
$last: Int,
$resolvingUserId: Int,
$sortBy: DateSort,
$state: FlagState
) {
flags(
after: $after,
before: $before,
first: $first,
flaggable: $flaggable,
flaggingUserId: $flaggingUserId,
ids: $ids,
last: $last,
resolvingUserId: $resolvingUserId,
sortBy: $sortBy,
state: $state
) {
edges {
...FlagEdgeFragment
}
nodes {
...FlagFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
unfilteredCountForSubject
uniqueFlaggingUsers {
...UserFragment
}
uniqueResolvingUsers {
...UserFragment
}
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"first": 123,
"flaggable": FlaggableInput,
"flaggingUserId": 123,
"ids": [123],
"last": 123,
"resolvingUserId": 123,
"sortBy": DateSort,
"state": "OPEN"
}
Response
{
"data": {
"flags": {
"edges": [FlagEdge],
"nodes": [Flag],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987,
"unfilteredCountForSubject": 987,
"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": 123}
Response
{
"data": {
"fusion": {
"comments": CommentConnection,
"creationActivity": CreateFeatureActivity,
"deprecated": true,
"deprecationActivity": DeprecateFeatureActivity,
"deprecationReason": "DUPLICATE",
"description": "xyz789",
"events": EventConnection,
"featureAliases": ["abc123"],
"featureInstance": Factor,
"featureType": "FACTOR",
"fivePrimeGene": Gene,
"fivePrimePartnerStatus": "KNOWN",
"flagged": false,
"flags": FlagConnection,
"fullName": "xyz789",
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"name": "xyz789",
"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 |
ids - [Int!]
|
Filter by internal CIViC ids |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query fusions(
$after: String,
$before: String,
$evidenceStatusFilter: AssociatedEvidenceStatusFilter,
$first: Int,
$genePartnerId: Int,
$ids: [Int!],
$last: Int
) {
fusions(
after: $after,
before: $before,
evidenceStatusFilter: $evidenceStatusFilter,
first: $first,
genePartnerId: $genePartnerId,
ids: $ids,
last: $last
) {
edges {
...FusionEdgeFragment
}
nodes {
...FusionFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"evidenceStatusFilter": "ALL",
"first": 987,
"genePartnerId": 123,
"ids": [987],
"last": 987
}
Response
{
"data": {
"fusions": {
"edges": [FusionEdge],
"nodes": [Fusion],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
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": 123}
Response
{
"data": {
"gene": {
"comments": CommentConnection,
"creationActivity": CreateFeatureActivity,
"deprecated": false,
"deprecationActivity": DeprecateFeatureActivity,
"deprecationReason": "DUPLICATE",
"description": "xyz789",
"entrezId": 123,
"events": EventConnection,
"featureAliases": ["abc123"],
"featureInstance": Factor,
"featureType": "FACTOR",
"flagged": true,
"flags": FlagConnection,
"fullName": "abc123",
"id": 987,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"myGeneInfoDetails": {},
"name": "xyz789",
"openRevisionCount": 123,
"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. |
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [Int!],
$last: Int
) {
genes(
after: $after,
before: $before,
entrezIds: $entrezIds,
entrezSymbols: $entrezSymbols,
evidenceStatusFilter: $evidenceStatusFilter,
first: $first,
ids: $ids,
last: $last
) {
edges {
...GeneEdgeFragment
}
nodes {
...GeneFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"entrezIds": [123],
"entrezSymbols": ["xyz789"],
"evidenceStatusFilter": "ALL",
"first": 123,
"ids": [987],
"last": 123
}
Response
{
"data": {
"genes": {
"edges": [GeneEdge],
"nodes": [Gene],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
molecularProfile
Description
Find a molecular profile by CIViC ID
Response
Returns a MolecularProfile
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query molecularProfile($id: Int!) {
molecularProfile(id: $id) {
assertions {
...AssertionConnectionFragment
}
comments {
...CommentConnectionFragment
}
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": 123}
Response
{
"data": {
"molecularProfile": {
"assertions": AssertionConnection,
"comments": CommentConnection,
"complexMolecularProfileCreationActivity": CreateComplexMolecularProfileActivity,
"complexMolecularProfileDeprecationActivity": DeprecateComplexMolecularProfileActivity,
"deprecated": false,
"deprecatedVariants": [VariantInterface],
"deprecationReason": "DUPLICATE",
"description": "abc123",
"events": EventConnection,
"evidenceCountsByStatus": EvidenceItemsByStatus,
"evidenceCountsByType": EvidenceItemsByType,
"evidenceItems": EvidenceItemConnection,
"flagged": true,
"flags": FlagConnection,
"id": 987,
"isComplex": false,
"isMultiVariant": true,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"molecularProfileAliases": ["abc123"],
"molecularProfileScore": 123.45,
"name": "xyz789",
"openRevisionCount": 123,
"parsedName": [Feature],
"rawName": "abc123",
"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. |
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [Int!],
$last: Int,
$name: String,
$variantId: Int
) {
molecularProfiles(
after: $after,
alleleRegistryId: $alleleRegistryId,
before: $before,
evidenceStatusFilter: $evidenceStatusFilter,
featureId: $featureId,
first: $first,
geneId: $geneId,
ids: $ids,
last: $last,
name: $name,
variantId: $variantId
) {
edges {
...MolecularProfileEdgeFragment
}
nodes {
...MolecularProfileFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"alleleRegistryId": "xyz789",
"before": "xyz789",
"evidenceStatusFilter": "ALL",
"featureId": 987,
"first": 123,
"geneId": 123,
"ids": [987],
"last": 123,
"name": "xyz789",
"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": 123}
Response
{
"data": {
"nccnGuideline": {
"id": 987,
"name": "abc123"
}
}
}
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": "xyz789"}
Response
{
"data": {
"nccnGuidelinesTypeahead": [
{"id": 987, "name": "abc123"}
]
}
}
newsItems
Response
Returns [NewsItem!]!
Example
Query
query newsItems {
newsItems {
contentHtml
id
publishedAt
title
}
}
Response
{
"data": {
"newsItems": [
{
"contentHtml": "xyz789",
"id": 987,
"publishedAt": ISO8601DateTime,
"title": "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": 123,
"includeRead": false,
"last": 123,
"notificationReason": "MENTION",
"organizationId": 987,
"originatingObject": SubscribableInput,
"originatingUserId": 123,
"subscriptionId": 123
}
Response
{
"data": {
"notifications": {
"edges": [NotificationEdge],
"eventTypes": ["ACCEPTED"],
"mentioningUsers": [User],
"nodes": [Notification],
"notificationSubjects": [EventSubjectWithCount],
"organizations": [Organization],
"originatingUsers": [User],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123,
"unreadCount": 123
}
}
}
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) {
canEndorse
description
eventCount
events {
...EventConnectionFragment
}
hasEndorsingSubgroups
id
isApprovedVcep
memberCount
members {
...UserConnectionFragment
}
mostRecentActivityTimestamp
name
orgAndSuborgsStatsHash {
...StatsFragment
}
orgStatsHash {
...StatsFragment
}
profileImagePath
ranks {
...RanksFragment
}
subGroups {
...OrganizationFragment
}
url
}
}
Variables
{"id": 123}
Response
{
"data": {
"organization": {
"canEndorse": false,
"description": "abc123",
"eventCount": 123,
"events": EventConnection,
"hasEndorsingSubgroups": false,
"id": 123,
"isApprovedVcep": true,
"memberCount": 987,
"members": UserConnection,
"mostRecentActivityTimestamp": ISO8601DateTime,
"name": "xyz789",
"orgAndSuborgsStatsHash": Stats,
"orgStatsHash": Stats,
"profileImagePath": "abc123",
"ranks": Ranks,
"subGroups": [Organization],
"url": "xyz789"
}
}
}
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 an OrganizationConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
id - Int
|
Exact match filtering on the id of the organization. |
ids - [Int!]
|
Filter by internal CIViC ids |
last - Int
|
Returns the last n elements from the list. |
name - String
|
Substring filtering on the name of the organization. |
Example
Query
query organizations(
$after: String,
$before: String,
$first: Int,
$id: Int,
$ids: [Int!],
$last: Int,
$name: String
) {
organizations(
after: $after,
before: $before,
first: $first,
id: $id,
ids: $ids,
last: $last,
name: $name
) {
edges {
...OrganizationEdgeFragment
}
nodes {
...OrganizationFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"first": 123,
"id": 123,
"ids": [987],
"last": 123,
"name": "xyz789"
}
Response
{
"data": {
"organizations": {
"edges": [OrganizationEdge],
"nodes": [Organization],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
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": "abc123",
"hpoId": "xyz789",
"id": 123,
"link": "xyz789",
"name": "xyz789",
"url": "abc123"
}
}
}
phenotypePopover
Description
Retrieve popover fields for a specific phenotype.
Response
Returns a PhenotypePopover
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query phenotypePopover($id: Int!) {
phenotypePopover(id: $id) {
assertionCount
description
evidenceItemCount
hpoId
id
link
molecularProfileCount
name
url
}
}
Variables
{"id": 123}
Response
{
"data": {
"phenotypePopover": {
"assertionCount": 123,
"description": "xyz789",
"evidenceItemCount": 123,
"hpoId": "xyz789",
"id": 123,
"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": "abc123"}
Response
{
"data": {
"phenotypeTypeahead": [
{
"description": "abc123",
"hpoId": "abc123",
"id": 123,
"link": "abc123",
"name": "xyz789",
"url": "xyz789"
}
]
}
}
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 |
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [Int!],
$last: Int,
$name: String
) {
phenotypes(
after: $after,
before: $before,
first: $first,
hpoId: $hpoId,
id: $id,
ids: $ids,
last: $last,
name: $name
) {
edges {
...PhenotypeEdgeFragment
}
nodes {
...PhenotypeFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"first": 987,
"hpoId": "xyz789",
"id": 123,
"ids": [123],
"last": 987,
"name": "abc123"
}
Response
{
"data": {
"phenotypes": {
"edges": [PhenotypeEdge],
"nodes": [Phenotype],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
previewCommentText
Response
Returns [CommentBodySegment!]!
Arguments
| Name | Description |
|---|---|
commentText - String!
|
Example
Query
query previewCommentText($commentText: String!) {
previewCommentText(commentText: $commentText) {
... on CommentTagSegment {
...CommentTagSegmentFragment
}
... on 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": 987}
Response
{
"data": {
"revision": {
"acceptanceActivity": AcceptRevisionsActivity,
"comments": CommentConnection,
"createdAt": ISO8601DateTime,
"creationActivity": SuggestRevisionSetActivity,
"currentValue": {},
"events": EventConnection,
"fieldName": "xyz789",
"id": 123,
"lastCommentEvent": Event,
"link": "abc123",
"linkoutData": LinkoutData,
"name": "abc123",
"rejectionActivity": RejectRevisionsActivity,
"resolutionActivity": ActivityInterface,
"revisionSetId": 123,
"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. |
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [Int!],
$last: Int,
$originatingUserId: Int,
$resolvingUserId: Int,
$revisionSetId: Int,
$sortBy: DateSort,
$status: RevisionStatus,
$subject: ModeratedInput
) {
revisions(
after: $after,
before: $before,
fieldName: $fieldName,
first: $first,
ids: $ids,
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": "abc123",
"fieldName": "xyz789",
"first": 987,
"ids": [123],
"last": 123,
"originatingUserId": 123,
"resolvingUserId": 123,
"revisionSetId": 123,
"sortBy": DateSort,
"status": "ACCEPTED",
"subject": ModeratedInput
}
Response
{
"data": {
"revisions": {
"edges": [RevisionEdge],
"nodes": [Revision],
"pageCount": 987,
"pageInfo": PageInfo,
"revisedFieldNames": [FieldName],
"totalCount": 987,
"unfilteredCountForSubject": 123,
"uniqueResolvers": [User],
"uniqueRevisors": [User]
}
}
}
search
Response
Returns [SearchResult!]!
Arguments
| Name | Description |
|---|---|
highlightMatches - Boolean
|
Should matches come back highlighted |
query - String!
|
The term to query for |
types - [SearchableEntities!]
|
The types of objects to search. Omitting this value searches all. |
Example
Query
query search(
$highlightMatches: Boolean,
$query: String!,
$types: [SearchableEntities!]
) {
search(
highlightMatches: $highlightMatches,
query: $query,
types: $types
) {
id
matchingText
name
resultType
}
}
Variables
{
"highlightMatches": false,
"query": "xyz789",
"types": ["ASSERTION"]
}
Response
{
"data": {
"search": [
{
"id": 987,
"matchingText": "xyz789",
"name": "abc123",
"resultType": "ASSERTION"
}
]
}
}
searchAssertions
Response
Returns an AdvancedSearchResult!
Arguments
| Name | Description |
|---|---|
createPermalink - Boolean
|
Default = false |
query - AssertionSearchFilter!
|
Example
Query
query searchAssertions(
$createPermalink: Boolean,
$query: AssertionSearchFilter!
) {
searchAssertions(
createPermalink: $createPermalink,
query: $query
) {
permalinkId
resultIds
searchEndpoint
}
}
Variables
{"createPermalink": false, "query": AssertionSearchFilter}
Response
{
"data": {
"searchAssertions": {
"permalinkId": "xyz789",
"resultIds": [123],
"searchEndpoint": "xyz789"
}
}
}
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": "xyz789",
"resultIds": [123],
"searchEndpoint": "abc123"
}
}
}
searchDiseases
Response
Returns an AdvancedSearchResult!
Arguments
| Name | Description |
|---|---|
createPermalink - Boolean
|
Default = false |
query - DiseaseSearchFilter!
|
Example
Query
query searchDiseases(
$createPermalink: Boolean,
$query: DiseaseSearchFilter!
) {
searchDiseases(
createPermalink: $createPermalink,
query: $query
) {
permalinkId
resultIds
searchEndpoint
}
}
Variables
{"createPermalink": false, "query": DiseaseSearchFilter}
Response
{
"data": {
"searchDiseases": {
"permalinkId": "abc123",
"resultIds": [987],
"searchEndpoint": "abc123"
}
}
}
searchEvidenceItems
Response
Returns an AdvancedSearchResult!
Arguments
| Name | Description |
|---|---|
createPermalink - Boolean
|
Default = false |
query - EvidenceItemSearchFilter!
|
Example
Query
query searchEvidenceItems(
$createPermalink: Boolean,
$query: EvidenceItemSearchFilter!
) {
searchEvidenceItems(
createPermalink: $createPermalink,
query: $query
) {
permalinkId
resultIds
searchEndpoint
}
}
Variables
{
"createPermalink": false,
"query": EvidenceItemSearchFilter
}
Response
{
"data": {
"searchEvidenceItems": {
"permalinkId": "xyz789",
"resultIds": [123],
"searchEndpoint": "xyz789"
}
}
}
searchFeatures
Response
Returns an AdvancedSearchResult!
Arguments
| Name | Description |
|---|---|
createPermalink - Boolean
|
Default = false |
query - FeatureSearchFilter!
|
Example
Query
query searchFeatures(
$createPermalink: Boolean,
$query: FeatureSearchFilter!
) {
searchFeatures(
createPermalink: $createPermalink,
query: $query
) {
permalinkId
resultIds
searchEndpoint
}
}
Variables
{"createPermalink": false, "query": FeatureSearchFilter}
Response
{
"data": {
"searchFeatures": {
"permalinkId": "abc123",
"resultIds": [123],
"searchEndpoint": "abc123"
}
}
}
searchMolecularProfiles
Response
Returns an AdvancedSearchResult!
Arguments
| Name | Description |
|---|---|
createPermalink - Boolean
|
Default = false |
query - MolecularProfileSearchFilter!
|
Example
Query
query searchMolecularProfiles(
$createPermalink: Boolean,
$query: MolecularProfileSearchFilter!
) {
searchMolecularProfiles(
createPermalink: $createPermalink,
query: $query
) {
permalinkId
resultIds
searchEndpoint
}
}
Variables
{
"createPermalink": false,
"query": MolecularProfileSearchFilter
}
Response
{
"data": {
"searchMolecularProfiles": {
"permalinkId": "abc123",
"resultIds": [123],
"searchEndpoint": "xyz789"
}
}
}
searchPhenotypes
Response
Returns an AdvancedSearchResult!
Arguments
| Name | Description |
|---|---|
createPermalink - Boolean
|
Default = false |
query - PhenotypeSearchFilter!
|
Example
Query
query searchPhenotypes(
$createPermalink: Boolean,
$query: PhenotypeSearchFilter!
) {
searchPhenotypes(
createPermalink: $createPermalink,
query: $query
) {
permalinkId
resultIds
searchEndpoint
}
}
Variables
{"createPermalink": false, "query": PhenotypeSearchFilter}
Response
{
"data": {
"searchPhenotypes": {
"permalinkId": "xyz789",
"resultIds": [123],
"searchEndpoint": "abc123"
}
}
}
searchSources
Response
Returns an AdvancedSearchResult!
Arguments
| Name | Description |
|---|---|
createPermalink - Boolean
|
Default = false |
query - SourceSearchFilter!
|
Example
Query
query searchSources(
$createPermalink: Boolean,
$query: SourceSearchFilter!
) {
searchSources(
createPermalink: $createPermalink,
query: $query
) {
permalinkId
resultIds
searchEndpoint
}
}
Variables
{"createPermalink": false, "query": SourceSearchFilter}
Response
{
"data": {
"searchSources": {
"permalinkId": "xyz789",
"resultIds": [123],
"searchEndpoint": "xyz789"
}
}
}
searchTherapies
Response
Returns an AdvancedSearchResult!
Arguments
| Name | Description |
|---|---|
createPermalink - Boolean
|
Default = false |
query - TherapySearchFilter!
|
Example
Query
query searchTherapies(
$createPermalink: Boolean,
$query: TherapySearchFilter!
) {
searchTherapies(
createPermalink: $createPermalink,
query: $query
) {
permalinkId
resultIds
searchEndpoint
}
}
Variables
{"createPermalink": false, "query": TherapySearchFilter}
Response
{
"data": {
"searchTherapies": {
"permalinkId": "abc123",
"resultIds": [123],
"searchEndpoint": "abc123"
}
}
}
searchUsers
Response
Returns an AdvancedSearchResult!
Arguments
| Name | Description |
|---|---|
createPermalink - Boolean
|
Default = false |
query - UserSearchFilter!
|
Example
Query
query searchUsers(
$createPermalink: Boolean,
$query: UserSearchFilter!
) {
searchUsers(
createPermalink: $createPermalink,
query: $query
) {
permalinkId
resultIds
searchEndpoint
}
}
Variables
{"createPermalink": false, "query": UserSearchFilter}
Response
{
"data": {
"searchUsers": {
"permalinkId": "xyz789",
"resultIds": [987],
"searchEndpoint": "abc123"
}
}
}
searchVariantTypes
Response
Returns an AdvancedSearchResult!
Arguments
| Name | Description |
|---|---|
createPermalink - Boolean
|
Default = false |
query - VariantTypeSearchFilter!
|
Example
Query
query searchVariantTypes(
$createPermalink: Boolean,
$query: VariantTypeSearchFilter!
) {
searchVariantTypes(
createPermalink: $createPermalink,
query: $query
) {
permalinkId
resultIds
searchEndpoint
}
}
Variables
{
"createPermalink": false,
"query": VariantTypeSearchFilter
}
Response
{
"data": {
"searchVariantTypes": {
"permalinkId": "abc123",
"resultIds": [987],
"searchEndpoint": "abc123"
}
}
}
searchVariants
Response
Returns an AdvancedSearchResult!
Arguments
| Name | Description |
|---|---|
createPermalink - Boolean
|
Default = false |
query - VariantSearchFilter!
|
Example
Query
query searchVariants(
$createPermalink: Boolean,
$query: VariantSearchFilter!
) {
searchVariants(
createPermalink: $createPermalink,
query: $query
) {
permalinkId
resultIds
searchEndpoint
}
}
Variables
{"createPermalink": false, "query": VariantSearchFilter}
Response
{
"data": {
"searchVariants": {
"permalinkId": "abc123",
"resultIds": [123],
"searchEndpoint": "xyz789"
}
}
}
source
Description
Find a source by CIViC ID
Example
Query
query source($id: Int!) {
source(id: $id) {
abstract
ascoAbstractId
authorString
citation
citationId
clinicalTrials {
...ClinicalTrialFragment
}
comments {
...CommentConnectionFragment
}
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": 987,
"authorString": "abc123",
"citation": "xyz789",
"citationId": "xyz789",
"clinicalTrials": [ClinicalTrial],
"comments": CommentConnection,
"deprecated": false,
"displayType": "abc123",
"events": EventConnection,
"fullJournalTitle": "xyz789",
"fullyCurated": false,
"id": 987,
"journal": "xyz789",
"lastCommentEvent": Event,
"link": "xyz789",
"name": "abc123",
"openAccess": false,
"pmcId": "abc123",
"publicationDate": "xyz789",
"publicationDay": 987,
"publicationMonth": 987,
"publicationYear": 123,
"retracted": false,
"retractionDate": ISO8601DateTime,
"retractionNature": "xyz789",
"retractionReasons": "abc123",
"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": 987,
"authorString": "abc123",
"citation": "xyz789",
"citationId": "abc123",
"clinicalTrials": [ClinicalTrial],
"comments": CommentConnection,
"deprecated": true,
"displayType": "xyz789",
"events": EventConnection,
"evidenceItemCount": 123,
"fullJournalTitle": "xyz789",
"fullyCurated": false,
"id": 123,
"journal": "abc123",
"lastCommentEvent": Event,
"link": "abc123",
"name": "xyz789",
"openAccess": true,
"pmcId": "xyz789",
"publicationDate": "abc123",
"publicationDay": 987,
"publicationMonth": 123,
"publicationYear": 123,
"retracted": false,
"retractionDate": ISO8601DateTime,
"retractionNature": "xyz789",
"retractionReasons": "abc123",
"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": 123, "sourceId": 123}
Response
{
"data": {
"sourceSuggestionValues": {
"disease": Disease,
"molecularProfile": MolecularProfile,
"source": Source
}
}
}
sourceSuggestions
Response
Returns a SourceSuggestionConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
citation - String
|
|
citationId - Int
|
|
comment - String
|
|
diseaseName - String
|
|
first - Int
|
Returns the first n elements from the list. |
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [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,
ids: $ids,
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": "abc123",
"citation": "xyz789",
"citationId": 987,
"comment": "abc123",
"diseaseName": "abc123",
"first": 123,
"ids": [123],
"last": 987,
"molecularProfileName": "xyz789",
"sortBy": SourceSuggestionsSort,
"sourceId": 987,
"sourceType": "ASCO",
"status": "CURATED",
"submitter": "xyz789",
"submitterId": 987
}
Response
{
"data": {
"sourceSuggestions": {
"edges": [SourceSuggestionEdge],
"filteredCount": 987,
"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": 123,
"authorString": "abc123",
"citation": "abc123",
"citationId": "xyz789",
"clinicalTrials": [ClinicalTrial],
"comments": CommentConnection,
"deprecated": true,
"displayType": "abc123",
"events": EventConnection,
"fullJournalTitle": "xyz789",
"fullyCurated": true,
"id": 123,
"journal": "abc123",
"lastCommentEvent": Event,
"link": "xyz789",
"name": "abc123",
"openAccess": true,
"pmcId": "xyz789",
"publicationDate": "xyz789",
"publicationDay": 987,
"publicationMonth": 123,
"publicationYear": 987,
"retracted": false,
"retractionDate": ISO8601DateTime,
"retractionNature": "xyz789",
"retractionReasons": "xyz789",
"sourceType": "ASCO",
"sourceUrl": "abc123",
"title": "abc123"
}
]
}
}
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. |
ids - [Int!]
|
Filter by internal CIViC ids |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query sources(
$after: String,
$before: String,
$citationId: [String!],
$first: Int,
$ids: [Int!],
$last: Int
) {
sources(
after: $after,
before: $before,
citationId: $citationId,
first: $first,
ids: $ids,
last: $last
) {
edges {
...SourceEdgeFragment
}
nodes {
...SourceFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"citationId": ["abc123"],
"first": 987,
"ids": [123],
"last": 123
}
Response
{
"data": {
"sources": {
"edges": [SourceEdge],
"nodes": [Source],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
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": 987,
"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. |
hasLinkedEvidence - Boolean
|
Limit to therapies that are linked to at least one non-rejected Evidence Item or Assertion |
id - Int
|
Filter on a therapy's internal CIViC id |
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$hasLinkedEvidence: Boolean,
$id: Int,
$ids: [Int!],
$last: Int,
$name: String,
$ncitId: String,
$therapyAlias: String
) {
therapies(
after: $after,
before: $before,
first: $first,
hasLinkedEvidence: $hasLinkedEvidence,
id: $id,
ids: $ids,
last: $last,
name: $name,
ncitId: $ncitId,
therapyAlias: $therapyAlias
) {
edges {
...TherapyEdgeFragment
}
nodes {
...TherapyFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"first": 123,
"hasLinkedEvidence": false,
"id": 123,
"ids": [123],
"last": 987,
"name": "abc123",
"ncitId": "abc123",
"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": 987}
Response
{
"data": {
"therapy": {
"deprecated": true,
"id": 123,
"link": "abc123",
"myChemInfo": MyChemInfo,
"name": "abc123",
"ncitId": "xyz789",
"therapyAliases": ["xyz789"],
"therapyUrl": "xyz789"
}
}
}
therapyPopover
Description
Retrieve popover fields for a specific therapy.
Response
Returns a TherapyPopover
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query therapyPopover($id: Int!) {
therapyPopover(id: $id) {
assertionCount
deprecated
evidenceItemCount
id
link
molecularProfileCount
myChemInfo {
...MyChemInfoFragment
}
name
ncitId
therapyAliases
therapyUrl
}
}
Variables
{"id": 987}
Response
{
"data": {
"therapyPopover": {
"assertionCount": 123,
"deprecated": true,
"evidenceItemCount": 123,
"id": 123,
"link": "xyz789",
"molecularProfileCount": 123,
"myChemInfo": MyChemInfo,
"name": "abc123",
"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": "abc123"}
Response
{
"data": {
"therapyTypeahead": [
{
"deprecated": true,
"id": 123,
"link": "abc123",
"myChemInfo": MyChemInfo,
"name": "abc123",
"ncitId": "xyz789",
"therapyAliases": ["abc123"],
"therapyUrl": "abc123"
}
]
}
}
timepointStats
Response
Returns a CivicTimepointStats!
Example
Query
query timepointStats {
timepointStats {
assertions {
...TimePointCountsFragment
}
comments {
...TimePointCountsFragment
}
diseases {
...TimePointCountsFragment
}
evidenceItems {
...TimePointCountsFragment
}
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) {
apiKeys {
...ApiKeyFragment
}
areaOfExpertise
bio
country {
...CountryFragment
}
displayName
email
events {
...EventConnectionFragment
}
facebookProfile
id
joinDate
linkedinProfile
mostRecentActivityTimestamp
mostRecentConflictOfInterestStatement {
...CoiFragment
}
mostRecentEvent {
...EventFragment
}
mostRecentOrganizationId
name
notifications {
...NotificationConnectionFragment
}
orcid
organizations {
...OrganizationFragment
}
organizationsWithEndorsementPrivileges {
...OrganizationFragment
}
profileImagePath
ranks {
...RanksFragment
}
role
statsHash {
...StatsFragment
}
twitterHandle
url
username
}
}
Variables
{"id": 987}
Response
{
"data": {
"user": {
"apiKeys": [ApiKey],
"areaOfExpertise": "CLINICAL_SCIENTIST",
"bio": "abc123",
"country": Country,
"displayName": "abc123",
"email": "xyz789",
"events": EventConnection,
"facebookProfile": "xyz789",
"id": 123,
"joinDate": ISO8601DateTime,
"linkedinProfile": "abc123",
"mostRecentActivityTimestamp": ISO8601DateTime,
"mostRecentConflictOfInterestStatement": Coi,
"mostRecentEvent": Event,
"mostRecentOrganizationId": 987,
"name": "abc123",
"notifications": NotificationConnection,
"orcid": "abc123",
"organizations": [Organization],
"organizationsWithEndorsementPrivileges": [
Organization
],
"profileImagePath": "xyz789",
"ranks": Ranks,
"role": "ADMIN",
"statsHash": Stats,
"twitterHandle": "abc123",
"url": "abc123",
"username": "xyz789"
}
}
}
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) {
apiKeys {
...ApiKeyFragment
}
areaOfExpertise
bio
country {
...CountryFragment
}
displayName
email
events {
...EventConnectionFragment
}
facebookProfile
id
joinDate
linkedinProfile
mostRecentActivityTimestamp
mostRecentConflictOfInterestStatement {
...CoiFragment
}
mostRecentEvent {
...EventFragment
}
mostRecentOrganizationId
name
notifications {
...NotificationConnectionFragment
}
orcid
organizations {
...OrganizationFragment
}
organizationsWithEndorsementPrivileges {
...OrganizationFragment
}
profileImagePath
ranks {
...RanksFragment
}
role
statsHash {
...StatsFragment
}
twitterHandle
url
username
}
}
Variables
{"queryTerm": "abc123"}
Response
{
"data": {
"userTypeahead": [
{
"apiKeys": [ApiKey],
"areaOfExpertise": "CLINICAL_SCIENTIST",
"bio": "abc123",
"country": Country,
"displayName": "xyz789",
"email": "xyz789",
"events": EventConnection,
"facebookProfile": "abc123",
"id": 123,
"joinDate": ISO8601DateTime,
"linkedinProfile": "xyz789",
"mostRecentActivityTimestamp": ISO8601DateTime,
"mostRecentConflictOfInterestStatement": Coi,
"mostRecentEvent": Event,
"mostRecentOrganizationId": 987,
"name": "abc123",
"notifications": NotificationConnection,
"orcid": "abc123",
"organizations": [Organization],
"organizationsWithEndorsementPrivileges": [
Organization
],
"profileImagePath": "abc123",
"ranks": Ranks,
"role": "ADMIN",
"statsHash": Stats,
"twitterHandle": "xyz789",
"url": "xyz789",
"username": "xyz789"
}
]
}
}
users
Description
List and filter users.
Response
Returns a UserConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
ids - [Int!]
|
Filter by internal CIViC ids |
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. |
username - String
|
Filtering on username |
Example
Query
query users(
$after: String,
$before: String,
$first: Int,
$ids: [Int!],
$last: Int,
$name: String,
$organization: OrganizationFilter,
$role: UserRole,
$username: String
) {
users(
after: $after,
before: $before,
first: $first,
ids: $ids,
last: $last,
name: $name,
organization: $organization,
role: $role,
username: $username
) {
edges {
...UserEdgeFragment
}
nodes {
...UserFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"first": 123,
"ids": [987],
"last": 123,
"name": "xyz789",
"organization": OrganizationFilter,
"role": "ADMIN",
"username": "abc123"
}
Response
{
"data": {
"users": {
"edges": [UserEdge],
"nodes": [User],
"pageCount": 987,
"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": [123]}
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": 123}
Response
{
"data": {
"variant": {
"comments": CommentConnection,
"creationActivity": CreateVariantActivity,
"deprecated": false,
"deprecationActivity": DeprecateVariantActivity,
"deprecationReason": "DUPLICATE",
"events": EventConnection,
"feature": Feature,
"flagged": false,
"flags": FlagConnection,
"id": 987,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"molecularProfiles": MolecularProfileConnection,
"name": "xyz789",
"openRevisionCount": 987,
"revisions": RevisionConnection,
"singleVariantMolecularProfile": MolecularProfile,
"singleVariantMolecularProfileId": 123,
"variantAliases": ["abc123"],
"variantTypes": [VariantType]
}
}
}
variantGroup
Description
Find a variant group by CIViC ID
Response
Returns a VariantGroup
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query variantGroup($id: Int!) {
variantGroup(id: $id) {
comments {
...CommentConnectionFragment
}
description
events {
...EventConnectionFragment
}
flagged
flags {
...FlagConnectionFragment
}
id
lastAcceptedRevisionEvent {
...EventFragment
}
lastCommentEvent {
...EventFragment
}
lastSubmittedRevisionEvent {
...EventFragment
}
link
name
openRevisionCount
revisions {
...RevisionConnectionFragment
}
sources {
...SourceFragment
}
variants {
...VariantInterfaceConnectionFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"variantGroup": {
"comments": CommentConnection,
"description": "abc123",
"events": EventConnection,
"flagged": true,
"flags": FlagConnection,
"id": 987,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"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. |
ids - [Int!]
|
Filter by internal CIViC ids |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query variantGroups(
$after: String,
$before: String,
$first: Int,
$ids: [Int!],
$last: Int
) {
variantGroups(
after: $after,
before: $before,
first: $first,
ids: $ids,
last: $last
) {
edges {
...VariantGroupEdgeFragment
}
nodes {
...VariantGroupFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"first": 123,
"ids": [123],
"last": 987
}
Response
{
"data": {
"variantGroups": {
"edges": [VariantGroupEdge],
"nodes": [VariantGroup],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
variantType
Description
Find a variant type by CIViC ID
Response
Returns a VariantType
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query variantType($id: Int!) {
variantType(id: $id) {
description
id
link
name
soid
url
}
}
Variables
{"id": 987}
Response
{
"data": {
"variantType": {
"description": "xyz789",
"id": 987,
"link": "xyz789",
"name": "abc123",
"soid": "xyz789",
"url": "xyz789"
}
}
}
variantTypePopover
Description
Retrieve popover fields for a specific variant type.
Response
Returns a VariantTypePopover
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
query variantTypePopover($id: Int!) {
variantTypePopover(id: $id) {
description
id
link
name
soid
url
variantCount
}
}
Variables
{"id": 123}
Response
{
"data": {
"variantTypePopover": {
"description": "xyz789",
"id": 987,
"link": "abc123",
"name": "abc123",
"soid": "abc123",
"url": "abc123",
"variantCount": 123
}
}
}
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": 987,
"link": "abc123",
"name": "abc123",
"soid": "xyz789",
"url": "xyz789"
}
]
}
}
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 |
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [Int!],
$last: Int,
$name: String,
$soid: String,
$sortBy: VariantTypeSort
) {
variantTypes(
after: $after,
before: $before,
featureId: $featureId,
first: $first,
geneId: $geneId,
id: $id,
ids: $ids,
last: $last,
name: $name,
soid: $soid,
sortBy: $sortBy
) {
edges {
...BrowseVariantTypeEdgeFragment
}
filteredCount
lastUpdated
nodes {
...BrowseVariantTypeFragment
}
pageCount
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"featureId": 987,
"first": 987,
"geneId": 987,
"id": 987,
"ids": [123],
"last": 987,
"name": "abc123",
"soid": "xyz789",
"sortBy": VariantTypeSort
}
Response
{
"data": {
"variantTypes": {
"edges": [BrowseVariantTypeEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseVariantType],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
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 |
ids - [Int!]
|
Filter by internal CIViC ids |
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,
$ids: [Int!],
$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,
ids: $ids,
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,
"ids": [987],
"last": 123,
"name": "abc123",
"sortBy": VariantMenuSort,
"variantTypeIds": [123]
}
Response
{
"data": {
"variants": {
"edges": [VariantInterfaceEdge],
"nodes": [VariantInterface],
"pageCount": 987,
"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": "abc123"}
Response
{
"data": {
"variantsTypeahead": [
{
"comments": CommentConnection,
"creationActivity": CreateVariantActivity,
"deprecated": true,
"deprecationActivity": DeprecateVariantActivity,
"deprecationReason": "DUPLICATE",
"events": EventConnection,
"feature": Feature,
"flagged": true,
"flags": FlagConnection,
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"molecularProfiles": MolecularProfileConnection,
"name": "abc123",
"openRevisionCount": 987,
"revisions": RevisionConnection,
"singleVariantMolecularProfile": MolecularProfile,
"singleVariantMolecularProfileId": 123,
"variantAliases": ["xyz789"],
"variantTypes": [VariantType]
}
]
}
}
viewer
Response
Returns a User
Example
Query
query viewer {
viewer {
apiKeys {
...ApiKeyFragment
}
areaOfExpertise
bio
country {
...CountryFragment
}
displayName
email
events {
...EventConnectionFragment
}
facebookProfile
id
joinDate
linkedinProfile
mostRecentActivityTimestamp
mostRecentConflictOfInterestStatement {
...CoiFragment
}
mostRecentEvent {
...EventFragment
}
mostRecentOrganizationId
name
notifications {
...NotificationConnectionFragment
}
orcid
organizations {
...OrganizationFragment
}
organizationsWithEndorsementPrivileges {
...OrganizationFragment
}
profileImagePath
ranks {
...RanksFragment
}
role
statsHash {
...StatsFragment
}
twitterHandle
url
username
}
}
Response
{
"data": {
"viewer": {
"apiKeys": [ApiKey],
"areaOfExpertise": "CLINICAL_SCIENTIST",
"bio": "xyz789",
"country": Country,
"displayName": "xyz789",
"email": "xyz789",
"events": EventConnection,
"facebookProfile": "xyz789",
"id": 123,
"joinDate": ISO8601DateTime,
"linkedinProfile": "abc123",
"mostRecentActivityTimestamp": ISO8601DateTime,
"mostRecentConflictOfInterestStatement": Coi,
"mostRecentEvent": Event,
"mostRecentOrganizationId": 987,
"name": "xyz789",
"notifications": NotificationConnection,
"orcid": "abc123",
"organizations": [Organization],
"organizationsWithEndorsementPrivileges": [
Organization
],
"profileImagePath": "xyz789",
"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": "xyz789",
"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": false
}
}
}
addRemoteCitation
Description
Add a stub record for an external source that is not yet in CIViC. This is for adding a new Source inline while performing other curation activities such as adding new evidence items and is distinct from suggesting a source for curation.
Response
Returns an AddRemoteCitationPayload
Arguments
| Name | Description |
|---|---|
input - AddRemoteCitationInput!
|
Parameters for AddRemoteCitation |
Example
Query
mutation addRemoteCitation($input: AddRemoteCitationInput!) {
addRemoteCitation(input: $input) {
clientMutationId
newSource {
...SourceStubFragment
}
}
}
Variables
{"input": AddRemoteCitationInput}
Response
{
"data": {
"addRemoteCitation": {
"clientMutationId": "xyz789",
"newSource": SourceStub
}
}
}
addTherapy
Description
Add a new therapy to the database.
Response
Returns an AddTherapyPayload
Arguments
| Name | Description |
|---|---|
input - AddTherapyInput!
|
Parameters for AddTherapy |
Example
Query
mutation addTherapy($input: AddTherapyInput!) {
addTherapy(input: $input) {
clientMutationId
new
therapy {
...TherapyFragment
}
}
}
Variables
{"input": AddTherapyInput}
Response
{
"data": {
"addTherapy": {
"clientMutationId": "abc123",
"new": true,
"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": false
}
}
}
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": "xyz789",
"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": false,
"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": "xyz789",
"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": true,
"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": "abc123",
"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": "xyz789",
"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": "xyz789",
"user": User
}
}
}
endorseAssertion
Description
Endorse an Assertion on behalf of an Organization
Response
Returns an EndorseAssertionPayload
Arguments
| Name | Description |
|---|---|
input - EndorseAssertionInput!
|
Parameters for EndorseAssertion |
Example
Query
mutation endorseAssertion($input: EndorseAssertionInput!) {
endorseAssertion(input: $input) {
assertion {
...AssertionFragment
}
clientMutationId
}
}
Variables
{"input": EndorseAssertionInput}
Response
{
"data": {
"endorseAssertion": {
"assertion": Assertion,
"clientMutationId": "abc123"
}
}
}
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
}
}
}
generateApiKey
Description
Generate a new API key for the current user.
Response
Returns a GenerateApiKeyPayload
Arguments
| Name | Description |
|---|---|
input - GenerateApiKeyInput!
|
Parameters for GenerateApiKey |
Example
Query
mutation generateApiKey($input: GenerateApiKeyInput!) {
generateApiKey(input: $input) {
apiKey {
...ApiKeyFragment
}
clientMutationId
user {
...UserFragment
}
}
}
Variables
{"input": GenerateApiKeyInput}
Response
{
"data": {
"generateApiKey": {
"apiKey": ApiKey,
"clientMutationId": "abc123",
"user": User
}
}
}
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": "abc123",
"evidenceItem": EvidenceItem
}
}
}
rejectRevisions
Description
Reject one or more revisions by ID or revision set ID. Any user may reject a Revision that they submitted themselves. Otherwise, the rejecting user must be an editor with valid conflict of interest statement on file.
Response
Returns a RejectRevisionsPayload
Arguments
| Name | Description |
|---|---|
input - RejectRevisionsInput!
|
Parameters for RejectRevisions |
Example
Query
mutation rejectRevisions($input: RejectRevisionsInput!) {
rejectRevisions(input: $input) {
clientMutationId
revisions {
...RevisionFragment
}
}
}
Variables
{"input": RejectRevisionsInput}
Response
{
"data": {
"rejectRevisions": {
"clientMutationId": "abc123",
"revisions": [Revision]
}
}
}
resolveFlag
Description
Resolve a flag on a CIViC entity indicating that it was either 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
}
}
}
revokeApiKey
Description
Revoke an API key for the current user.
Response
Returns a RevokeApiKeyPayload
Arguments
| Name | Description |
|---|---|
input - RevokeApiKeyInput!
|
Parameters for RevokeApiKey |
Example
Query
mutation revokeApiKey($input: RevokeApiKeyInput!) {
revokeApiKey(input: $input) {
clientMutationId
success
}
}
Variables
{"input": RevokeApiKeyInput}
Response
{
"data": {
"revokeApiKey": {
"clientMutationId": "xyz789",
"success": true
}
}
}
revokeEndorsement
Description
Revoke an endorsement of an Assertion on behalf of an Organization
Response
Returns a RevokeEndorsementPayload
Arguments
| Name | Description |
|---|---|
input - RevokeEndorsementInput!
|
Parameters for RevokeEndorsement |
Example
Query
mutation revokeEndorsement($input: RevokeEndorsementInput!) {
revokeEndorsement(input: $input) {
assertion {
...AssertionFragment
}
clientMutationId
}
}
Variables
{"input": RevokeEndorsementInput}
Response
{
"data": {
"revokeEndorsement": {
"assertion": Assertion,
"clientMutationId": "xyz789"
}
}
}
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": "abc123",
"evidenceItem": EvidenceItem
}
}
}
submitVariantGroup
Description
Create a new variant group.
Response
Returns a SubmitVariantGroupPayload
Arguments
| Name | Description |
|---|---|
input - SubmitVariantGroupInput!
|
Parameters for SubmitVariantGroup |
Example
Query
mutation submitVariantGroup($input: SubmitVariantGroupInput!) {
submitVariantGroup(input: $input) {
clientMutationId
variantGroup {
...VariantGroupFragment
}
}
}
Variables
{"input": SubmitVariantGroupInput}
Response
{
"data": {
"submitVariantGroup": {
"clientMutationId": "xyz789",
"variantGroup": VariantGroup
}
}
}
subscribe
Description
Subscribe to a CIViC entity in order to receive notifications about it.
Response
Returns a SubscribePayload
Arguments
| Name | Description |
|---|---|
input - SubscribeInput!
|
Parameters for Subscribe |
Example
Query
mutation subscribe($input: SubscribeInput!) {
subscribe(input: $input) {
clientMutationId
subscriptions {
...SubscriptionFragment
}
}
}
Variables
{"input": SubscribeInput}
Response
{
"data": {
"subscribe": {
"clientMutationId": "xyz789",
"subscriptions": [Subscription]
}
}
}
suggestAssertionRevision
Description
Suggest a Revision to an Assertion entity.
Response
Returns a SuggestAssertionRevisionPayload
Arguments
| Name | Description |
|---|---|
input - SuggestAssertionRevisionInput!
|
Parameters for SuggestAssertionRevision |
Example
Query
mutation suggestAssertionRevision($input: SuggestAssertionRevisionInput!) {
suggestAssertionRevision(input: $input) {
assertion {
...AssertionFragment
}
clientMutationId
results {
...RevisionResultFragment
}
}
}
Variables
{"input": SuggestAssertionRevisionInput}
Response
{
"data": {
"suggestAssertionRevision": {
"assertion": Assertion,
"clientMutationId": "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": "abc123",
"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": "abc123",
"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": "xyz789",
"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": "abc123",
"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": "abc123",
"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": "abc123",
"sourceSuggestion": SourceSuggestion
}
}
}
suggestVariantGroupRevision
Description
Suggested a Revision to a Variant Group entity
Response
Returns a SuggestVariantGroupRevisionPayload
Arguments
| Name | Description |
|---|---|
input - SuggestVariantGroupRevisionInput!
|
Parameters for SuggestVariantGroupRevision |
Example
Query
mutation suggestVariantGroupRevision($input: SuggestVariantGroupRevisionInput!) {
suggestVariantGroupRevision(input: $input) {
clientMutationId
results {
...RevisionResultFragment
}
variantGroup {
...VariantGroupFragment
}
}
}
Variables
{"input": SuggestVariantGroupRevisionInput}
Response
{
"data": {
"suggestVariantGroupRevision": {
"clientMutationId": "xyz789",
"results": [RevisionResult],
"variantGroup": VariantGroup
}
}
}
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": "abc123",
"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": 987,
"link": "xyz789",
"name": "xyz789"
}
}
}
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": "xyz789",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"revisions": [Revision],
"subject": EventSubject,
"supersededRevisions": [Revision],
"user": User,
"verbiage": "abc123"
}
AcceptRevisionsInput
Description
Autogenerated input type of AcceptRevisions
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String
|
Body of an optional comment to attach to the revision on acceptance. |
ids - [Int!]
|
A list of IDs of the Revisions to accept. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
revisionSetId - Int
|
The ID of a revision set. |
Example
{
"clientMutationId": "xyz789",
"comment": "abc123",
"ids": [987],
"organizationId": 123,
"revisionSetId": 987
}
AcceptRevisionsPayload
Description
Autogenerated return type of AcceptRevisions.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
revisions - [Revision!]!
|
A list of newly accepted Revisions. |
supersededRevisions - [Revision!]!
|
A list of any revisions that were superseded by the acceptance of this one. |
Example
{
"clientMutationId": "abc123",
"revisions": [Revision],
"supersededRevisions": [Revision]
}
AcmgCode
ActivityInterface
Description
An activity done by a curator or editor
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
id - Int!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Possible Types
| ActivityInterface Types |
|---|
Example
{
"createdAt": ISO8601DateTime,
"events": [Event],
"id": 123,
"note": "xyz789",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"subject": EventSubject,
"user": User,
"verbiage": "abc123"
}
ActivityInterfaceConnection
Description
The connection type for ActivityInterface.
Fields
| Field Name | Description |
|---|---|
activityTypes - [ActivityTypeInput!]!
|
List of activity types that have occurred on this entity. |
edges - [ActivityInterfaceEdge!]!
|
A list of edges. |
nodes - [ActivityInterface!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
participatingOrganizations - [Organization!]!
|
List of all organizations who are involved in this activity stream. |
subjectTypes - [ActivitySubjectInput!]!
|
|
totalCount - Int!
|
The total number of records in this filtered collection. |
unfilteredCount - Int!
|
When filtered on a subject, user, or organization, the total number of events for that subject/user/organization, irregardless of other filters. |
uniqueParticipants - [User!]!
|
List of all users that have performed an activity on the subject entity. |
Example
{
"activityTypes": ["ACCEPT_REVISIONS"],
"edges": [ActivityInterfaceEdge],
"nodes": [ActivityInterface],
"pageCount": 987,
"pageInfo": PageInfo,
"participatingOrganizations": [Organization],
"subjectTypes": ["ASSERTION"],
"totalCount": 987,
"unfilteredCount": 987,
"uniqueParticipants": [User]
}
ActivityInterfaceEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - ActivityInterface
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": ActivityInterface
}
ActivitySubjectInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSERTION"
ActivityTypeInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCEPT_REVISIONS"
AddCommentInput
Description
Autogenerated input type of AddComment
Fields
| Input Field | Description |
|---|---|
body - String!
|
Text of the comment. |
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
subject - CommentableInput!
|
The commentable to attach the comment to. Specified by ID and Type. |
title - String
|
Optional title for the comment. |
Example
{
"body": "xyz789",
"clientMutationId": "xyz789",
"organizationId": 123,
"subject": CommentableInput,
"title": "abc123"
}
AddCommentPayload
AddDiseaseInput
Description
Autogenerated input type of AddDisease
Example
{
"clientMutationId": "abc123",
"doid": "abc123",
"name": "xyz789"
}
AddDiseasePayload
Description
Autogenerated return type of AddDisease.
Example
{
"clientMutationId": "abc123",
"disease": Disease,
"new": true
}
AddRemoteCitationInput
Description
Autogenerated input type of AddRemoteCitation
Fields
| Input Field | Description |
|---|---|
citationId - String!
|
The external id for the source to add. |
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
sourceType - SourceSource!
|
The origin of the external source. |
Example
{
"citationId": "abc123",
"clientMutationId": "abc123",
"sourceType": "ASCO"
}
AddRemoteCitationPayload
Description
Autogenerated return type of AddRemoteCitation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
newSource - SourceStub!
|
The stubbed in record for the newly created source. |
Example
{
"clientMutationId": "xyz789",
"newSource": SourceStub
}
AddTherapyInput
Description
Autogenerated input type of AddTherapy
Example
{
"clientMutationId": "xyz789",
"name": "xyz789",
"ncitId": "abc123"
}
AddTherapyPayload
Description
Autogenerated return type of AddTherapy.
Example
{
"clientMutationId": "xyz789",
"new": false,
"therapy": Therapy
}
AdvancedSearchResult
AmpLevel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NA"
AmpLevelTypeSearchInput
Fields
| Input Field | Description |
|---|---|
operator - EnumSearchOperator!
|
|
value - AmpLevel!
|
Example
{"operator": "EQ", "value": "NA"}
ApiKey
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime
|
|
id - Int!
|
|
reminder - String!
|
|
token - String
|
Example
{
"createdAt": ISO8601DateTime,
"id": 123,
"reminder": "abc123",
"token": "abc123"
}
AreaOfExpertise
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CLINICAL_SCIENTIST"
Assertion
Fields
| Field Name | Description |
|---|---|
acceptanceEvent - Event
|
|
acmgCodes - [AcmgCode!]!
|
|
ampLevel - AmpLevel
|
|
assertionDirection - AssertionDirection!
|
|
assertionType - AssertionType!
|
|
clingenCodes - [ClingenCode!]!
|
|
comments - CommentConnection!
|
List and filter comments. |
Arguments
|
|
description - String!
|
|
disease - Disease
|
|
endorsements - EndorsementConnection!
|
List and filter endorsements. |
Arguments
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
evidenceItems - [EvidenceItem!]!
|
|
evidenceItemsCount - Int!
|
|
fdaCompanionTest - Boolean
|
|
fdaCompanionTestLastUpdated - ISO8601DateTime
|
|
flagged - Boolean!
|
|
flags - FlagConnection!
|
List and filter flags. |
Arguments
|
|
id - Int!
|
|
lastAcceptedRevisionEvent - Event
|
|
lastCommentEvent - Event
|
|
lastSubmittedRevisionEvent - Event
|
|
link - String!
|
|
molecularProfile - MolecularProfile!
|
|
name - String!
|
|
nccnGuideline - NccnGuideline
|
|
nccnGuidelineVersion - String
|
|
openRevisionCount - Int!
|
|
phenotypes - [Phenotype!]!
|
|
regulatoryApproval - Boolean
|
|
regulatoryApprovalLastUpdated - ISO8601DateTime
|
|
rejectionEvent - Event
|
|
revisions - RevisionConnection!
|
List and filter revisions. |
Arguments
|
|
significance - AssertionSignificance!
|
|
status - EvidenceStatus!
|
|
submissionActivity - SubmitAssertionActivity!
|
|
submissionEvent - Event!
|
|
summary - String!
|
|
therapies - [Therapy!]!
|
|
therapyInteractionType - TherapyInteraction
|
|
variantOrigin - VariantOrigin!
|
|
Example
{
"acceptanceEvent": Event,
"acmgCodes": [AcmgCode],
"ampLevel": "NA",
"assertionDirection": "DOES_NOT_SUPPORT",
"assertionType": "DIAGNOSTIC",
"clingenCodes": [ClingenCode],
"comments": CommentConnection,
"description": "xyz789",
"disease": Disease,
"endorsements": EndorsementConnection,
"events": EventConnection,
"evidenceItems": [EvidenceItem],
"evidenceItemsCount": 987,
"fdaCompanionTest": true,
"fdaCompanionTestLastUpdated": ISO8601DateTime,
"flagged": false,
"flags": FlagConnection,
"id": 987,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"molecularProfile": MolecularProfile,
"name": "abc123",
"nccnGuideline": NccnGuideline,
"nccnGuidelineVersion": "abc123",
"openRevisionCount": 123,
"phenotypes": [Phenotype],
"regulatoryApproval": false,
"regulatoryApprovalLastUpdated": ISO8601DateTime,
"rejectionEvent": Event,
"revisions": RevisionConnection,
"significance": "ADVERSE_RESPONSE",
"status": "ACCEPTED",
"submissionActivity": SubmitAssertionActivity,
"submissionEvent": Event,
"summary": "abc123",
"therapies": [Therapy],
"therapyInteractionType": "COMBINATION",
"variantOrigin": "COMBINED"
}
AssertionConnection
Description
The connection type for Assertion.
Fields
| Field Name | Description |
|---|---|
edges - [AssertionEdge!]!
|
A list of edges. |
nodes - [Assertion!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [AssertionEdge],
"nodes": [Assertion],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
AssertionDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DOES_NOT_SUPPORT"
AssertionDirectionTypeSearchInput
Fields
| Input Field | Description |
|---|---|
operator - EnumSearchOperator!
|
|
value - AssertionDirection!
|
Example
{"operator": "EQ", "value": "DOES_NOT_SUPPORT"}
AssertionEdge
AssertionFields
Description
Fields on an Assertion that curators may propose revisions to.
Fields
| Input Field | Description |
|---|---|
acmgCodeIds - [Int!]!
|
List of CIViC IDs for the ACMG/AMP codes associated with this Assertion |
ampLevel - NullableAmpLevelTypeInput!
|
The AMP/ASCO/CAP Category for this assertion. |
assertionDirection - AssertionDirection!
|
The evidence direction for this Assertion. |
assertionType - AssertionType!
|
The Type of the Assertion |
clingenCodeIds - [Int!]!
|
List of CIViC IDs for the ClinGen/CGC/VICC codes associated with this Assertion |
description - NullableStringInput!
|
A detailed description of the Assertion including practice guidelines and approved tests. |
diseaseId - NullableIntInput!
|
The ID of the disease (if applicable) for this Assertion |
evidenceItemIds - [Int!]!
|
IDs of evidence items that are included in this Assertion. |
fdaCompanionTest - NullableBooleanInput!
|
Is an FDA companion test available that pertains to this Assertion. |
fdaRegulatoryApproval - NullableBooleanInput!
|
Does the Assertion have FDA regulatory approval. |
molecularProfileId - Int!
|
The ID of the Molecular Profile to which this Assertion belongs |
nccnGuidelineId - NullableIntInput!
|
The internal CIViC ID of the NCCN guideline associated with this Assertion |
nccnGuidelineVersion - NullableStringInput!
|
The version of the NCCN Guideline specified |
phenotypeIds - [Int!]!
|
List of IDs of CIViC Phenotype entries for this Assertion. An empty list indicates none. |
significance - AssertionSignificance!
|
The Clinical Significance of the Assertion |
summary - NullableStringInput!
|
A brief single sentence statement summarizing the clinical significance of this Assertion. |
therapyIds - [Int!]!
|
List of IDs of CIViC Therapy entries for this Assertion. An empty list indicates none. |
therapyInteractionType - NullableTherapyInteractionTypeInput!
|
Therapy interaction type for cases where more than one therapy ID is provided. |
variantOrigin - VariantOrigin!
|
The Variant Origin for this Assertion. |
Example
{
"acmgCodeIds": [987],
"ampLevel": NullableAmpLevelTypeInput,
"assertionDirection": "DOES_NOT_SUPPORT",
"assertionType": "DIAGNOSTIC",
"clingenCodeIds": [987],
"description": NullableStringInput,
"diseaseId": NullableIntInput,
"evidenceItemIds": [123],
"fdaCompanionTest": NullableBooleanInput,
"fdaRegulatoryApproval": NullableBooleanInput,
"molecularProfileId": 123,
"nccnGuidelineId": NullableIntInput,
"nccnGuidelineVersion": NullableStringInput,
"phenotypeIds": [987],
"significance": "ADVERSE_RESPONSE",
"summary": NullableStringInput,
"therapyIds": [987],
"therapyInteractionType": NullableTherapyInteractionTypeInput,
"variantOrigin": "COMBINED"
}
AssertionSearchFilter
Fields
| Input Field | Description |
|---|---|
ampLevel - AmpLevelTypeSearchInput
|
|
assertionDirection - AssertionDirectionTypeSearchInput
|
|
assertionType - AssertionTypeTypeSearchInput
|
|
booleanOperator - BooleanOperator
|
|
creatingUser - UserSearchFilter
|
|
description - StringSearchInput
|
|
disease - DiseaseSearchFilter
|
|
evidenceItemCount - IntSearchInput
|
|
evidenceItems - EvidenceItemSearchFilter
|
|
fdaCompanionTest - BooleanSearchInput
|
|
id - IntSearchInput
|
|
isFlagged - BooleanSearchInput
|
|
moderatingUser - UserSearchFilter
|
|
molecularProfile - MolecularProfileSearchFilter
|
|
name - StringSearchInput
|
|
phenotypes - PhenotypeSearchFilter
|
|
regulatoryApproval - BooleanSearchInput
|
|
revisions - RevisionSearchFilter
|
|
significance - AssertionSignificanceTypeSearchInput
|
|
status - EvidenceStatusTypeSearchInput
|
|
subFilters - [AssertionSearchFilter!]
|
|
therapies - TherapySearchFilter
|
|
variantOrigin - VariantOriginTypeSearchInput
|
Example
{
"ampLevel": AmpLevelTypeSearchInput,
"assertionDirection": AssertionDirectionTypeSearchInput,
"assertionType": AssertionTypeTypeSearchInput,
"booleanOperator": "AND",
"creatingUser": UserSearchFilter,
"description": StringSearchInput,
"disease": DiseaseSearchFilter,
"evidenceItemCount": IntSearchInput,
"evidenceItems": EvidenceItemSearchFilter,
"fdaCompanionTest": BooleanSearchInput,
"id": IntSearchInput,
"isFlagged": BooleanSearchInput,
"moderatingUser": UserSearchFilter,
"molecularProfile": MolecularProfileSearchFilter,
"name": StringSearchInput,
"phenotypes": PhenotypeSearchFilter,
"regulatoryApproval": BooleanSearchInput,
"revisions": RevisionSearchFilter,
"significance": AssertionSignificanceTypeSearchInput,
"status": EvidenceStatusTypeSearchInput,
"subFilters": [AssertionSearchFilter],
"therapies": TherapySearchFilter,
"variantOrigin": VariantOriginTypeSearchInput
}
AssertionSignificance
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADVERSE_RESPONSE"
AssertionSignificanceTypeSearchInput
Fields
| Input Field | Description |
|---|---|
operator - EnumSearchOperator!
|
|
value - AssertionSignificance!
|
Example
{"operator": "EQ", "value": "ADVERSE_RESPONSE"}
AssertionSort
Fields
| Input Field | Description |
|---|---|
column - AssertionSortColumns!
|
Available columns for sorting |
direction - SortDirection!
|
Sort direction |
Example
{"column": "AMP_LEVEL", "direction": "ASC"}
AssertionSortColumns
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AMP_LEVEL"
AssertionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DIAGNOSTIC"
AssertionTypeTypeSearchInput
Fields
| Input Field | Description |
|---|---|
operator - EnumSearchOperator!
|
|
value - AssertionType!
|
Example
{"operator": "EQ", "value": "DIAGNOSTIC"}
AssociatedEvidenceStatusFilter
Values
| Enum Value | Description |
|---|---|
|
|
Apply no status filter to an entity in order to display all entities regardless of attached evidence status. |
|
|
Apply filter to an entity to display only those which have at least one accepted associated evidence item. |
|
|
Apply filter to an entity to display only those which have at least one accepted or submitted associated evidence item. |
|
|
Apply filter to an entity to display only those which have at least one submitted associated evidence item. |
Example
"ALL"
Boolean
Description
The Boolean scalar type represents true or false.
BooleanOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AND"
BooleanSearchInput
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
Example
{"value": false}
BrowseClinicalTrial
BrowseClinicalTrialConnection
Description
The connection type for BrowseClinicalTrial.
Fields
| Field Name | Description |
|---|---|
edges - [BrowseClinicalTrialEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
lastUpdated - ISO8601DateTime!
|
The last time the data in this browse table was refreshed |
nodes - [BrowseClinicalTrial!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowseClinicalTrialEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseClinicalTrial],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
BrowseClinicalTrialEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowseClinicalTrial
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": BrowseClinicalTrial
}
BrowseDisease
Example
{
"assertionCount": 123,
"deprecated": true,
"diseaseAliases": ["abc123"],
"diseaseUrl": "abc123",
"displayName": "xyz789",
"doid": "abc123",
"evidenceItemCount": 123,
"featureCount": 987,
"features": [LinkableFeature],
"id": 987,
"link": "abc123",
"name": "xyz789",
"variantCount": 123
}
BrowseDiseaseConnection
Description
The connection type for BrowseDisease.
Fields
| Field Name | Description |
|---|---|
edges - [BrowseDiseaseEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
lastUpdated - ISO8601DateTime!
|
The last time the data in this browse table was refreshed |
nodes - [BrowseDisease!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowseDiseaseEdge],
"filteredCount": 123,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseDisease],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
BrowseDiseaseEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowseDisease
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": BrowseDisease
}
BrowseFeature
Fields
| Field Name | Description |
|---|---|
assertionCount - Int!
|
|
deprecated - Boolean!
|
|
description - String!
|
|
diseases - [Disease!]
|
|
evidenceItemCount - Int!
|
|
featureAliases - [String!]
|
|
featureInstanceId - Int!
|
|
featureInstanceType - FeatureInstanceTypes!
|
|
flagged - Boolean!
|
|
flags - FlagConnection!
|
List and filter flags. |
Arguments
|
|
fullName - String
|
|
id - Int!
|
|
link - String!
|
|
molecularProfileCount - Int!
|
|
name - String!
|
|
therapies - [Therapy!]
|
|
variantCount - Int!
|
|
Example
{
"assertionCount": 987,
"deprecated": true,
"description": "xyz789",
"diseases": [Disease],
"evidenceItemCount": 123,
"featureAliases": ["xyz789"],
"featureInstanceId": 123,
"featureInstanceType": "FACTOR",
"flagged": true,
"flags": FlagConnection,
"fullName": "xyz789",
"id": 987,
"link": "xyz789",
"molecularProfileCount": 123,
"name": "xyz789",
"therapies": [Therapy],
"variantCount": 987
}
BrowseFeatureConnection
Description
The connection type for BrowseFeature.
Fields
| Field Name | Description |
|---|---|
edges - [BrowseFeatureEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
lastUpdated - ISO8601DateTime!
|
The last time the data in this browse table was refreshed |
nodes - [BrowseFeature!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowseFeatureEdge],
"filteredCount": 123,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseFeature],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
BrowseFeatureEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowseFeature
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": BrowseFeature
}
BrowseMolecularProfile
Fields
| Field Name | Description |
|---|---|
aliases - [MolecularProfileAlias!]!
|
|
assertionCount - Int!
|
|
deprecated - Boolean!
|
|
diseases - [LinkableDisease!]!
|
|
evidenceItemCount - Int!
|
|
id - Int!
|
|
link - String!
|
|
molecularProfileScore - Float!
|
|
name - String!
|
|
therapies - [LinkableTherapy!]!
|
|
variantCount - Int!
|
|
variants - [LinkableVariant!]!
|
Example
{
"aliases": [MolecularProfileAlias],
"assertionCount": 987,
"deprecated": false,
"diseases": [LinkableDisease],
"evidenceItemCount": 987,
"id": 123,
"link": "abc123",
"molecularProfileScore": 123.45,
"name": "xyz789",
"therapies": [LinkableTherapy],
"variantCount": 987,
"variants": [LinkableVariant]
}
BrowseMolecularProfileConnection
Description
The connection type for BrowseMolecularProfile.
Fields
| Field Name | Description |
|---|---|
edges - [BrowseMolecularProfileEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
lastUpdated - ISO8601DateTime!
|
The last time the data in this browse table was refreshed |
nodes - [BrowseMolecularProfile!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowseMolecularProfileEdge],
"filteredCount": 123,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseMolecularProfile],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
BrowseMolecularProfileEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowseMolecularProfile
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": BrowseMolecularProfile
}
BrowseOrganization
Fields
| Field Name | Description |
|---|---|
activityCount - Int!
|
|
childOrganizations - [Organization!]!
|
|
createdAt - ISO8601DateTime
|
|
description - String!
|
|
id - Int!
|
|
memberCount - Int!
|
|
mostRecentActivityTimestamp - ISO8601DateTime
|
|
name - String!
|
|
parentId - Int
|
|
updatedAt - ISO8601DateTime
|
|
url - String!
|
Example
{
"activityCount": 123,
"childOrganizations": [Organization],
"createdAt": ISO8601DateTime,
"description": "abc123",
"id": 123,
"memberCount": 123,
"mostRecentActivityTimestamp": ISO8601DateTime,
"name": "xyz789",
"parentId": 987,
"updatedAt": ISO8601DateTime,
"url": "abc123"
}
BrowseOrganizationConnection
Description
The connection type for BrowseOrganization.
Fields
| Field Name | Description |
|---|---|
edges - [BrowseOrganizationEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
lastUpdated - ISO8601DateTime!
|
The last time the data in this browse table was refreshed |
nodes - [BrowseOrganization!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowseOrganizationEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseOrganization],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
BrowseOrganizationEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowseOrganization
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": BrowseOrganization
}
BrowsePhenotype
BrowsePhenotypeConnection
Description
The connection type for BrowsePhenotype.
Fields
| Field Name | Description |
|---|---|
edges - [BrowsePhenotypeEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
lastUpdated - ISO8601DateTime!
|
The last time the data in this browse table was refreshed |
nodes - [BrowsePhenotype!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowsePhenotypeEdge],
"filteredCount": 123,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowsePhenotype],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
BrowsePhenotypeEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowsePhenotype
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": BrowsePhenotype
}
BrowseSource
Fields
| Field Name | Description |
|---|---|
authors - [String!]!
|
|
citation - String!
|
|
citationId - Int!
|
|
clinicalTrials - [ClinicalTrial!]!
|
|
deprecated - Boolean!
|
|
displayType - String!
|
|
evidenceItemCount - Int!
|
|
id - Int!
|
|
journal - String
|
|
link - String!
|
|
name - String
|
|
openAccess - Boolean!
|
|
publicationYear - Int
|
|
retractionNature - String
|
|
sourceSuggestionCount - Int!
|
|
sourceType - SourceSource!
|
|
sourceUrl - String!
|
Example
{
"authors": ["xyz789"],
"citation": "abc123",
"citationId": 123,
"clinicalTrials": [ClinicalTrial],
"deprecated": false,
"displayType": "xyz789",
"evidenceItemCount": 987,
"id": 123,
"journal": "abc123",
"link": "abc123",
"name": "xyz789",
"openAccess": true,
"publicationYear": 987,
"retractionNature": "xyz789",
"sourceSuggestionCount": 123,
"sourceType": "ASCO",
"sourceUrl": "abc123"
}
BrowseSourceConnection
Description
The connection type for BrowseSource.
Fields
| Field Name | Description |
|---|---|
edges - [BrowseSourceEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
lastUpdated - ISO8601DateTime!
|
The last time the data in this browse table was refreshed |
nodes - [BrowseSource!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowseSourceEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseSource],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
BrowseSourceEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowseSource
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": BrowseSource
}
BrowseTherapy
Example
{
"assertionCount": 987,
"deprecated": true,
"evidenceCount": 987,
"id": 987,
"link": "xyz789",
"name": "xyz789",
"ncitId": "xyz789",
"therapyAliases": ["xyz789"],
"therapyUrl": "xyz789"
}
BrowseTherapyConnection
Description
The connection type for BrowseTherapy.
Fields
| Field Name | Description |
|---|---|
edges - [BrowseTherapyEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
lastUpdated - ISO8601DateTime!
|
The last time the data in this browse table was refreshed |
nodes - [BrowseTherapy!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowseTherapyEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseTherapy],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
BrowseTherapyEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowseTherapy
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": BrowseTherapy
}
BrowseUser
Fields
| Field Name | Description |
|---|---|
apiKeys - [ApiKey!]!
|
|
areaOfExpertise - AreaOfExpertise
|
|
bio - String
|
|
country - Country
|
|
displayName - String!
|
|
email - String
|
|
events - EventConnection!
|
|
evidenceCount - Int!
|
|
facebookProfile - String
|
|
id - Int!
|
|
joinDate - ISO8601DateTime
|
|
linkedinProfile - String
|
|
mostRecentActivityTimestamp - ISO8601DateTime
|
|
mostRecentConflictOfInterestStatement - Coi
|
|
mostRecentEvent - Event
|
|
mostRecentOrganizationId - Int
|
|
name - String
|
|
notifications - NotificationConnection
|
Filterable list of notifications for the logged in user. |
Arguments
|
|
orcid - String
|
|
organizations - [Organization!]!
|
|
organizationsWithEndorsementPrivileges - [Organization!]!
|
|
profileImagePath - String
|
|
Arguments
|
|
ranks - Ranks!
|
|
revisionCount - Int!
|
|
role - UserRole!
|
|
statsHash - Stats!
|
|
twitterHandle - String
|
|
url - String
|
|
username - String!
|
|
Example
{
"apiKeys": [ApiKey],
"areaOfExpertise": "CLINICAL_SCIENTIST",
"bio": "abc123",
"country": Country,
"displayName": "xyz789",
"email": "xyz789",
"events": EventConnection,
"evidenceCount": 987,
"facebookProfile": "abc123",
"id": 987,
"joinDate": ISO8601DateTime,
"linkedinProfile": "xyz789",
"mostRecentActivityTimestamp": ISO8601DateTime,
"mostRecentConflictOfInterestStatement": Coi,
"mostRecentEvent": Event,
"mostRecentOrganizationId": 123,
"name": "xyz789",
"notifications": NotificationConnection,
"orcid": "abc123",
"organizations": [Organization],
"organizationsWithEndorsementPrivileges": [
Organization
],
"profileImagePath": "xyz789",
"ranks": Ranks,
"revisionCount": 123,
"role": "ADMIN",
"statsHash": Stats,
"twitterHandle": "abc123",
"url": "xyz789",
"username": "xyz789"
}
BrowseUserConnection
Description
The connection type for BrowseUser.
Fields
| Field Name | Description |
|---|---|
edges - [BrowseUserEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
lastUpdated - ISO8601DateTime!
|
The last time the data in this browse table was refreshed |
nodes - [BrowseUser!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowseUserEdge],
"filteredCount": 123,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseUser],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
BrowseUserEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowseUser
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": BrowseUser
}
BrowseVariant
Fields
| Field Name | Description |
|---|---|
aliases - [VariantAlias!]!
|
|
category - VariantCategories!
|
|
deprecated - Boolean!
|
|
diseases - [Disease!]!
|
|
evidenceItemCount - Int!
|
|
featureDeprecated - Boolean!
|
|
featureFlagged - Boolean!
|
|
featureId - Int!
|
|
featureLink - String!
|
|
featureName - String!
|
|
flagged - Boolean!
|
|
id - Int!
|
|
link - String!
|
|
name - String!
|
|
therapies - [Therapy!]!
|
|
variantTypes - [LinkableVariantType!]!
|
Example
{
"aliases": [VariantAlias],
"category": "FACTOR",
"deprecated": false,
"diseases": [Disease],
"evidenceItemCount": 987,
"featureDeprecated": false,
"featureFlagged": false,
"featureId": 123,
"featureLink": "xyz789",
"featureName": "abc123",
"flagged": false,
"id": 123,
"link": "xyz789",
"name": "xyz789",
"therapies": [Therapy],
"variantTypes": [LinkableVariantType]
}
BrowseVariantConnection
Description
The connection type for BrowseVariant.
Fields
| Field Name | Description |
|---|---|
edges - [BrowseVariantEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
lastUpdated - ISO8601DateTime!
|
The last time the data in this browse table was refreshed |
nodes - [BrowseVariant!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowseVariantEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseVariant],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
BrowseVariantEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowseVariant
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": BrowseVariant
}
BrowseVariantGroup
Fields
| Field Name | Description |
|---|---|
evidenceItemCount - Int!
|
|
featureNames - [String!]!
|
|
id - Int!
|
|
link - String!
|
|
name - String!
|
|
variantCount - Int!
|
|
variantNames - [String!]!
|
Example
{
"evidenceItemCount": 123,
"featureNames": ["xyz789"],
"id": 123,
"link": "xyz789",
"name": "abc123",
"variantCount": 987,
"variantNames": ["abc123"]
}
BrowseVariantGroupConnection
Description
The connection type for BrowseVariantGroup.
Fields
| Field Name | Description |
|---|---|
edges - [BrowseVariantGroupEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
lastUpdated - ISO8601DateTime!
|
The last time the data in this browse table was refreshed |
nodes - [BrowseVariantGroup!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowseVariantGroupEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseVariantGroup],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
BrowseVariantGroupEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowseVariantGroup
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": BrowseVariantGroup
}
BrowseVariantType
BrowseVariantTypeConnection
Description
The connection type for BrowseVariantType.
Fields
| Field Name | Description |
|---|---|
edges - [BrowseVariantTypeEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
lastUpdated - ISO8601DateTime!
|
The last time the data in this browse table was refreshed |
nodes - [BrowseVariantType!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [BrowseVariantTypeEdge],
"filteredCount": 123,
"lastUpdated": ISO8601DateTime,
"nodes": [BrowseVariantType],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
BrowseVariantTypeEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - BrowseVariantType
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": BrowseVariantType
}
Chromosome
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CHR_1"
ChromosomeTypeSearchInput
Fields
| Input Field | Description |
|---|---|
operator - EnumSearchOperator!
|
|
value - Chromosome!
|
Example
{"operator": "EQ", "value": "CHR_1"}
CivicTimepointStats
Description
Counts of CIViC activity over time, used for the homepage
Fields
| Field Name | Description |
|---|---|
assertions - TimePointCounts!
|
|
comments - TimePointCounts!
|
|
diseases - TimePointCounts!
|
|
evidenceItems - TimePointCounts!
|
|
features - TimePointCounts!
|
|
molecularProfiles - TimePointCounts!
|
|
revisions - TimePointCounts!
|
|
sources - TimePointCounts!
|
|
therapies - TimePointCounts!
|
|
users - TimePointCounts!
|
|
variants - TimePointCounts!
|
Example
{
"assertions": TimePointCounts,
"comments": TimePointCounts,
"diseases": TimePointCounts,
"evidenceItems": TimePointCounts,
"features": TimePointCounts,
"molecularProfiles": TimePointCounts,
"revisions": TimePointCounts,
"sources": TimePointCounts,
"therapies": TimePointCounts,
"users": TimePointCounts,
"variants": TimePointCounts
}
ClingenCode
ClinicalTrial
ClinicalTrialSort
Fields
| Input Field | Description |
|---|---|
column - ClinicalTrialSortColumns!
|
Available columns for sorting |
direction - SortDirection!
|
Sort direction |
Example
{"column": "EVIDENCE_ITEM_COUNT", "direction": "ASC"}
ClinicalTrialSortColumns
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EVIDENCE_ITEM_COUNT"
ClinvarInput
Description
An input object representing possible ClinVar ID states. You may specify either one or more Integer IDs OR either none found or not applicable.
Example
{"ids": [123], "noneFound": false, "notApplicable": true}
Coi
Fields
| Field Name | Description |
|---|---|
coiPresent - Boolean!
|
|
coiStatement - String
|
|
coiStatus - CoiStatus!
|
|
createdAt - ISO8601DateTime
|
|
expiresAt - ISO8601DateTime!
|
|
id - Int!
|
Example
{
"coiPresent": false,
"coiStatement": "xyz789",
"coiStatus": "CONFLICT",
"createdAt": ISO8601DateTime,
"expiresAt": ISO8601DateTime,
"id": 123
}
CoiStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONFLICT"
Comment
Fields
| Field Name | Description |
|---|---|
comment - String!
|
|
commentable - Commentable!
|
|
commenter - User!
|
|
createdAt - ISO8601DateTime!
|
|
creationEvent - Event
|
|
deleted - Boolean!
|
|
deletedAt - ISO8601DateTime
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
id - Int!
|
|
link - String!
|
|
name - String!
|
|
parsedComment - [CommentBodySegment!]!
|
|
title - String
|
|
Example
{
"comment": "xyz789",
"commentable": Commentable,
"commenter": User,
"createdAt": ISO8601DateTime,
"creationEvent": Event,
"deleted": true,
"deletedAt": ISO8601DateTime,
"events": EventConnection,
"id": 123,
"link": "abc123",
"name": "abc123",
"parsedComment": [CommentTagSegment],
"title": "xyz789"
}
CommentActivity
Fields
| Field Name | Description |
|---|---|
comment - Comment!
|
|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
id - Int!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"comment": Comment,
"createdAt": ISO8601DateTime,
"events": [Event],
"id": 987,
"note": "xyz789",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"subject": EventSubject,
"user": User,
"verbiage": "abc123"
}
CommentBodySegment
Description
Segment of a comment that can either be text or an object to be rendered as a tag
Example
CommentTagSegment
CommentConnection
Description
The connection type for Comment.
Fields
| Field Name | Description |
|---|---|
edges - [CommentEdge!]!
|
A list of edges. |
mentionedEntities - [CommentTagSegment!]!
|
List of entities mentioned in this comment thread. |
mentionedRoles - [CommentTagSegment!]!
|
List of roles mentioned in this comment thread |
mentionedUsers - [User!]!
|
List of users mentioned in this comment thread. |
nodes - [Comment!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
unfilteredCountForSubject - Int
|
When filtered on a subject, the total number of comments for that subject, irregardless of other filters. Returns null when there is no subject. |
uniqueCommenters - [User!]!
|
List of all users that have commented on this entity. |
Example
{
"edges": [CommentEdge],
"mentionedEntities": [CommentTagSegment],
"mentionedRoles": [CommentTagSegment],
"mentionedUsers": [User],
"nodes": [Comment],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123,
"unfilteredCountForSubject": 987,
"uniqueCommenters": [User]
}
CommentEdge
CommentSearchFilter
Fields
| Input Field | Description |
|---|---|
booleanOperator - BooleanOperator
|
|
comment - StringSearchInput
|
|
createdAt - DateSearchInput
|
|
id - IntSearchInput
|
|
subFilters - [CommentSearchFilter!]
|
Example
{
"booleanOperator": "AND",
"comment": StringSearchInput,
"createdAt": DateSearchInput,
"id": IntSearchInput,
"subFilters": [CommentSearchFilter]
}
CommentTagSegment
Fields
| Field Name | Description |
|---|---|
displayName - String!
|
|
entityId - Int!
|
|
feature - LinkableFeature
|
|
link - String!
|
|
revisionSetId - Int
|
|
tagType - TaggableEntity!
|
Example
{
"displayName": "abc123",
"entityId": 987,
"feature": LinkableFeature,
"link": "xyz789",
"revisionSetId": 987,
"tagType": "ASSERTION"
}
CommentTagSegmentFlagged
Fields
| Field Name | Description |
|---|---|
displayName - String!
|
|
entityId - Int!
|
|
feature - LinkableFeature
|
|
flagged - Boolean!
|
|
link - String!
|
|
revisionSetId - Int
|
|
tagType - TaggableEntity!
|
Example
{
"displayName": "abc123",
"entityId": 987,
"feature": LinkableFeature,
"flagged": true,
"link": "xyz789",
"revisionSetId": 987,
"tagType": "ASSERTION"
}
CommentTagSegmentFlaggedAndDeprecated
Fields
| Field Name | Description |
|---|---|
deprecated - Boolean!
|
|
displayName - String!
|
|
entityId - Int!
|
|
feature - LinkableFeature
|
|
flagged - Boolean!
|
|
link - String!
|
|
revisionSetId - Int
|
|
tagType - TaggableEntity!
|
Example
{
"deprecated": true,
"displayName": "xyz789",
"entityId": 123,
"feature": LinkableFeature,
"flagged": true,
"link": "abc123",
"revisionSetId": 123,
"tagType": "ASSERTION"
}
CommentTagSegmentFlaggedAndWithStatus
Fields
| Field Name | Description |
|---|---|
displayName - String!
|
|
entityId - Int!
|
|
feature - LinkableFeature
|
|
flagged - Boolean!
|
|
link - String!
|
|
revisionSetId - Int
|
|
status - EvidenceStatus!
|
|
tagType - TaggableEntity!
|
Example
{
"displayName": "xyz789",
"entityId": 987,
"feature": LinkableFeature,
"flagged": true,
"link": "abc123",
"revisionSetId": 123,
"status": "ACCEPTED",
"tagType": "ASSERTION"
}
CommentTextSegment
Fields
| Field Name | Description |
|---|---|
text - String!
|
Example
{"text": "xyz789"}
Commentable
Description
A CIViC entity that can have comments on it.
Fields
| Field Name | Description |
|---|---|
comments - CommentConnection!
|
List and filter comments. |
Arguments
|
|
id - Int!
|
|
lastCommentEvent - Event
|
|
link - String!
|
|
name - String!
|
|
Possible Types
| Commentable Types |
|---|
Example
{
"comments": CommentConnection,
"id": 987,
"lastCommentEvent": Event,
"link": "xyz789",
"name": "xyz789"
}
CommentableEntities
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSERTION"
CommentableInput
Description
Entity to comment on
Fields
| Input Field | Description |
|---|---|
entityType - CommentableEntities!
|
The type of the entity to comment on. |
id - Int!
|
ID of the entity to comment on. |
Example
{"entityType": "ASSERTION", "id": 987}
ContributingUser
Description
A user with all the unique kinds of actions they've performed on a given entity
Fields
| Field Name | Description |
|---|---|
lastActionDate - ISO8601DateTime!
|
|
totalActionCount - Int!
|
|
uniqueActions - [Contribution!]!
|
|
user - User!
|
Example
{
"lastActionDate": ISO8601DateTime,
"totalActionCount": 123,
"uniqueActions": [Contribution],
"user": User
}
ContributingUsersSummary
Fields
| Field Name | Description |
|---|---|
curators - [ContributingUser!]!
|
|
editors - [ContributingUser!]!
|
Example
{
"curators": [ContributingUser],
"editors": [ContributingUser]
}
Contribution
Fields
| Field Name | Description |
|---|---|
action - EventAction!
|
|
count - Int!
|
Example
{"action": "ACCEPTED", "count": 987}
CoordinateSearchInput
Fields
| Input Field | Description |
|---|---|
chromosome - ChromosomeTypeSearchInput
|
|
referenceBases - DnaBaseStringInput
|
|
start - IntSearchInput
|
|
stop - IntSearchInput
|
|
variantBases - DnaBaseStringInput
|
Example
{
"chromosome": ChromosomeTypeSearchInput,
"referenceBases": DnaBaseStringInput,
"start": IntSearchInput,
"stop": IntSearchInput,
"variantBases": DnaBaseStringInput
}
Country
CreateComplexMolecularProfileActivity
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
id - Int!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"createdAt": ISO8601DateTime,
"events": [Event],
"id": 123,
"note": "xyz789",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"subject": EventSubject,
"user": User,
"verbiage": "abc123"
}
CreateFeatureActivity
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
id - Int!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"createdAt": ISO8601DateTime,
"events": [Event],
"id": 123,
"note": "xyz789",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"subject": EventSubject,
"user": User,
"verbiage": "xyz789"
}
CreateFeatureInput
Description
Autogenerated input type of CreateFeature
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
featureType - CreateableFeatureTypes!
|
The Type of Feature you are creating |
name - String!
|
The name of the feature to create. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "abc123",
"featureType": "FACTOR",
"name": "abc123",
"organizationId": 123
}
CreateFeaturePayload
Description
Autogenerated return type of CreateFeature.
Example
{
"clientMutationId": "abc123",
"feature": Feature,
"new": false
}
CreateFusionFeatureInput
Description
Autogenerated input type of CreateFusionFeature
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
fivePrimeGene - FusionPartnerInput!
|
The 5" fusion partner |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
threePrimeGene - FusionPartnerInput!
|
The 3" fusion partner |
Example
{
"clientMutationId": "xyz789",
"fivePrimeGene": FusionPartnerInput,
"organizationId": 123,
"threePrimeGene": FusionPartnerInput
}
CreateFusionFeaturePayload
Description
Autogenerated return type of CreateFusionFeature.
Example
{
"clientMutationId": "abc123",
"feature": Feature,
"new": false
}
CreateFusionVariantInput
Description
Autogenerated input type of CreateFusionVariant
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
coordinates - FusionVariantInput!
|
|
featureId - Int!
|
The CIViC ID of the Feature to which the new variant belongs. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "abc123",
"coordinates": FusionVariantInput,
"featureId": 123,
"organizationId": 987
}
CreateFusionVariantPayload
Description
Autogenerated return type of CreateFusionVariant.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
molecularProfile - MolecularProfile!
|
The newly created molecular profile for the new variant. |
new - Boolean!
|
True if the variant was newly created. False if the returned variant was already in the database. |
variant - VariantInterface!
|
The newly created Variant. |
Example
{
"clientMutationId": "xyz789",
"molecularProfile": MolecularProfile,
"new": false,
"variant": VariantInterface
}
CreateMolecularProfileInput
Description
Autogenerated input type of CreateMolecularProfile
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
structure - MolecularProfileComponentInput!
|
Representation of the constituent parts of the Molecular Profile along with the logic used to combine them. |
Example
{
"clientMutationId": "xyz789",
"organizationId": 987,
"structure": MolecularProfileComponentInput
}
CreateMolecularProfilePayload
Description
Autogenerated return type of CreateMolecularProfile.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
molecularProfile - MolecularProfile!
|
The newly created (or already existing) Molecular Profile. |
Example
{
"clientMutationId": "abc123",
"molecularProfile": MolecularProfile
}
CreateVariantActivity
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
id - Int!
|
|
molecularProfile - MolecularProfile!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"createdAt": ISO8601DateTime,
"events": [Event],
"id": 987,
"molecularProfile": MolecularProfile,
"note": "abc123",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"subject": EventSubject,
"user": User,
"verbiage": "xyz789"
}
CreateVariantInput
Description
Autogenerated input type of CreateVariant
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
featureId - Int!
|
The CIViC ID of the Feature to which the new variant belongs. |
name - String!
|
The name of the variant to create. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "abc123",
"featureId": 123,
"name": "abc123",
"organizationId": 987
}
CreateVariantPayload
Description
Autogenerated return type of CreateVariant.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
molecularProfile - MolecularProfile!
|
The newly created molecular profile for the new variant. |
new - Boolean!
|
True if the variant was newly created. False if the returned variant was already in the database. |
variant - Variant!
|
The newly created Variant. |
Example
{
"clientMutationId": "xyz789",
"molecularProfile": MolecularProfile,
"new": true,
"variant": Variant
}
CreateableFeatureTypes
Description
Enum representing Feature types that can be user-created
Values
| Enum Value | Description |
|---|---|
|
|
Example
"FACTOR"
DataRelease
Fields
| Field Name | Description |
|---|---|
acceptedAndSubmittedVariantsVcf - DownloadableFile
|
|
acceptedVariantsVcf - DownloadableFile
|
|
assertionTsv - DownloadableFile
|
|
evidenceTsv - DownloadableFile
|
|
featureTsv - DownloadableFile
|
|
molecularProfileTsv - DownloadableFile
|
|
name - String!
|
|
variantGroupTsv - DownloadableFile
|
|
variantTsv - DownloadableFile
|
Example
{
"acceptedAndSubmittedVariantsVcf": DownloadableFile,
"acceptedVariantsVcf": DownloadableFile,
"assertionTsv": DownloadableFile,
"evidenceTsv": DownloadableFile,
"featureTsv": DownloadableFile,
"molecularProfileTsv": DownloadableFile,
"name": "abc123",
"variantGroupTsv": DownloadableFile,
"variantTsv": DownloadableFile
}
DateSearchInput
Fields
| Input Field | Description |
|---|---|
date - ISO8601DateTime!
|
|
operator - DateSearchOperator!
|
Example
{"date": ISO8601DateTime, "operator": "AFTER"}
DateSearchOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"AFTER"
DateSort
Fields
| Input Field | Description |
|---|---|
column - DateSortColumns!
|
Value to sort by. |
direction - SortDirection!
|
Sort direction. |
Example
{"column": "CREATED", "direction": "ASC"}
DateSortColumns
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CREATED"
DeleteCommentActivity
Fields
| Field Name | Description |
|---|---|
comment - Comment!
|
|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
id - Int!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"comment": Comment,
"createdAt": ISO8601DateTime,
"events": [Event],
"id": 987,
"note": "abc123",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"subject": EventSubject,
"user": User,
"verbiage": "abc123"
}
DeleteCommentInput
Description
Autogenerated input type of DeleteComment
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
commentId - Int!
|
The ID of the comment to delete. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "xyz789",
"commentId": 987,
"organizationId": 987
}
DeleteCommentPayload
DeprecateComplexMolecularProfileActivity
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
id - Int!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"createdAt": ISO8601DateTime,
"events": [Event],
"id": 987,
"note": "abc123",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"subject": EventSubject,
"user": User,
"verbiage": "abc123"
}
DeprecateComplexMolecularProfileInput
Description
Autogenerated input type of DeprecateComplexMolecularProfile
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String!
|
Text giving more context for deprecating this complex molecular profile. |
deprecationReason - MolecularProfileDeprecationReasonMutationInput!
|
The reason for deprecating this molecular profile. |
molecularProfileId - Int!
|
The CIViC ID of the complex molecular profile to deprecate. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "xyz789",
"comment": "xyz789",
"deprecationReason": "DUPLICATE",
"molecularProfileId": 987,
"organizationId": 123
}
DeprecateComplexMolecularProfilePayload
Description
Autogenerated return type of DeprecateComplexMolecularProfile.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
molecularProfile - MolecularProfile
|
The deprecated complex Molecular Profile. |
Example
{
"clientMutationId": "xyz789",
"molecularProfile": MolecularProfile
}
DeprecateFeatureActivity
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
id - Int!
|
|
molecularProfiles - [MolecularProfile!]!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
subject - EventSubject!
|
|
user - User!
|
|
variants - [VariantInterface!]!
|
|
verbiage - String!
|
Example
{
"createdAt": ISO8601DateTime,
"events": [Event],
"id": 123,
"molecularProfiles": [MolecularProfile],
"note": "abc123",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"subject": EventSubject,
"user": User,
"variants": [VariantInterface],
"verbiage": "abc123"
}
DeprecateFeatureInput
Description
Autogenerated input type of DeprecateFeature
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String!
|
Text giving more context for deprecation this feature. |
deprecationReason - FeatureDeprecationReason!
|
The reason for deprecation this feature. |
featureId - Int!
|
The CIViC ID of the feature to deprecate. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "abc123",
"comment": "abc123",
"deprecationReason": "DUPLICATE",
"featureId": 123,
"organizationId": 123
}
DeprecateFeaturePayload
Description
Autogenerated return type of DeprecateFeature.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
feature - Feature
|
The deprecated Feature. |
newlyDeprecatedMolecularProfiles - [MolecularProfile!]
|
The molecular profiles linked to this feature's variants that weren't already deprecated and have been newly deprecated by running this mutation. |
newlyDeprecatedVariants - [VariantInterface!]
|
The variants linked to this feature that are newly deprecated. |
Example
{
"clientMutationId": "abc123",
"feature": Feature,
"newlyDeprecatedMolecularProfiles": [MolecularProfile],
"newlyDeprecatedVariants": [VariantInterface]
}
DeprecateVariantActivity
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
id - Int!
|
|
molecularProfiles - [MolecularProfile!]!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"createdAt": ISO8601DateTime,
"events": [Event],
"id": 987,
"molecularProfiles": [MolecularProfile],
"note": "xyz789",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"subject": EventSubject,
"user": User,
"verbiage": "xyz789"
}
DeprecateVariantInput
Description
Autogenerated input type of DeprecateVariant
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String!
|
Text giving more context for deprecation this variant. |
deprecationReason - VariantDeprecationReason!
|
The reason for deprecation this variant. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
variantId - Int!
|
The CIViC ID of the variant to deprecate. |
Example
{
"clientMutationId": "xyz789",
"comment": "xyz789",
"deprecationReason": "DUPLICATE",
"organizationId": 123,
"variantId": 987
}
DeprecateVariantPayload
Description
Autogenerated return type of DeprecateVariant.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
newlyDeprecatedMolecularProfiles - [MolecularProfile!]
|
The molecular profiles linked to this variant that weren't already deprecated and have been newly deprecated by running this mutation. |
variant - VariantInterface
|
The deprecated Variant. |
Example
{
"clientMutationId": "xyz789",
"newlyDeprecatedMolecularProfiles": [MolecularProfile],
"variant": VariantInterface
}
Direction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NEGATIVE"
Disease
Fields
| Field Name | Description |
|---|---|
deprecated - Boolean!
|
|
diseaseAliases - [String!]!
|
|
diseaseUrl - String
|
|
displayName - String!
|
|
doid - String
|
|
id - Int!
|
|
link - String!
|
|
myDiseaseInfo - MyDiseaseInfo
|
|
name - String!
|
Example
{
"deprecated": true,
"diseaseAliases": ["abc123"],
"diseaseUrl": "xyz789",
"displayName": "xyz789",
"doid": "xyz789",
"id": 987,
"link": "abc123",
"myDiseaseInfo": MyDiseaseInfo,
"name": "abc123"
}
DiseaseConnection
Description
The connection type for Disease.
Fields
| Field Name | Description |
|---|---|
edges - [DiseaseEdge!]!
|
A list of edges. |
nodes - [Disease!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [DiseaseEdge],
"nodes": [Disease],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
DiseaseEdge
DiseasePopover
Example
{
"assertionCount": 987,
"deprecated": true,
"diseaseAliases": ["abc123"],
"diseaseUrl": "abc123",
"displayName": "abc123",
"doid": "xyz789",
"evidenceItemCount": 987,
"id": 123,
"link": "xyz789",
"molecularProfileCount": 123,
"myDiseaseInfo": MyDiseaseInfo,
"name": "abc123"
}
DiseaseSearchFilter
Fields
| Input Field | Description |
|---|---|
booleanOperator - BooleanOperator
|
|
deprecated - BooleanSearchInput
|
|
diseaseAliases - StringSearchInput
|
|
doid - OntologyTermSearchInput
|
|
id - IntSearchInput
|
|
name - StringSearchInput
|
|
subFilters - [DiseaseSearchFilter!]
|
Example
{
"booleanOperator": "AND",
"deprecated": BooleanSearchInput,
"diseaseAliases": StringSearchInput,
"doid": OntologyTermSearchInput,
"id": IntSearchInput,
"name": StringSearchInput,
"subFilters": [DiseaseSearchFilter]
}
DiseasesSort
Fields
| Input Field | Description |
|---|---|
column - DiseasesSortColumns!
|
Available columns for sorting |
direction - SortDirection!
|
Sort direction |
Example
{"column": "ASSERTION_COUNT", "direction": "ASC"}
DiseasesSortColumns
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSERTION_COUNT"
DnaBaseStringInput
Description
String search input that only accepts DNA bases (A, C, T, G, /)
Fields
| Input Field | Description |
|---|---|
operator - StringSearchOperator!
|
|
value - String!
|
Example
{"operator": "CONTAINS", "value": "xyz789"}
DownloadableFile
EditUserInput
Description
Autogenerated input type of EditUser
Fields
| Input Field | Description |
|---|---|
areaOfExpertise - NullableAreaOfExpertiseTypeInput!
|
The user's area of expertise |
bio - NullableStringInput!
|
A short biography describing the user's interests, accomplishments, associations, and/or anything else about they would like to share with the CIViC community. |
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
countryId - NullableIntInput!
|
The internal CIViC ID of the country the user resides or studies in. |
email - String!
|
The user's email address |
facebookProfile - NullableStringInput!
|
The user's Facebook profile handle |
linkedinProfile - NullableStringInput!
|
The user's LinkedIn username |
name - NullableStringInput!
|
The user's full name |
orcid - NullableIDInput!
|
The the user's ORCID (Open Research and Contributor ID) identifier |
twitterHandle - NullableStringInput!
|
The user's twitter handle |
url - NullableStringInput!
|
The user's personal website URL, omitting the https:// protocol part |
username - String!
|
The user's desired username |
Example
{
"areaOfExpertise": NullableAreaOfExpertiseTypeInput,
"bio": NullableStringInput,
"clientMutationId": "xyz789",
"countryId": NullableIntInput,
"email": "xyz789",
"facebookProfile": NullableStringInput,
"linkedinProfile": NullableStringInput,
"name": NullableStringInput,
"orcid": NullableIDInput,
"twitterHandle": NullableStringInput,
"url": NullableStringInput,
"username": "xyz789"
}
EditUserPayload
EndorseAssertionActivity
Fields
| Field Name | Description |
|---|---|
assertion - Assertion!
|
|
createdAt - ISO8601DateTime!
|
|
endorsement - Endorsement!
|
|
events - [Event!]!
|
|
id - Int!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"assertion": Assertion,
"createdAt": ISO8601DateTime,
"endorsement": Endorsement,
"events": [Event],
"id": 123,
"note": "abc123",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"subject": EventSubject,
"user": User,
"verbiage": "xyz789"
}
EndorseAssertionInput
Description
Autogenerated input type of EndorseAssertion
Fields
| Input Field | Description |
|---|---|
assertionId - Int!
|
ID of the Assertion to moderate |
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"assertionId": 987,
"clientMutationId": "xyz789",
"organizationId": 987
}
EndorseAssertionPayload
Description
Autogenerated return type of EndorseAssertion.
Fields
| Field Name | Description |
|---|---|
assertion - Assertion!
|
The endorsed Assertion |
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
Example
{
"assertion": Assertion,
"clientMutationId": "xyz789"
}
Endorsement
Fields
| Field Name | Description |
|---|---|
assertion - Assertion!
|
|
createdAt - ISO8601DateTime!
|
|
endorsementActivity - EndorseAssertionActivity!
|
|
id - Int!
|
|
lastReviewed - ISO8601DateTime!
|
|
organization - Organization!
|
|
readyForClinvarSubmission - Boolean!
|
|
revocationActivity - RevokeEndorsementActivity
|
|
status - EndorsementStatus!
|
|
updatedAt - ISO8601DateTime!
|
|
user - User!
|
Example
{
"assertion": Assertion,
"createdAt": ISO8601DateTime,
"endorsementActivity": EndorseAssertionActivity,
"id": 987,
"lastReviewed": ISO8601DateTime,
"organization": Organization,
"readyForClinvarSubmission": true,
"revocationActivity": RevokeEndorsementActivity,
"status": "ACTIVE",
"updatedAt": ISO8601DateTime,
"user": User
}
EndorsementConnection
Description
The connection type for Endorsement.
Fields
| Field Name | Description |
|---|---|
edges - [EndorsementEdge!]!
|
A list of edges. |
nodes - [Endorsement!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [EndorsementEdge],
"nodes": [Endorsement],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
EndorsementEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - Endorsement
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": Endorsement
}
EndorsementStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
EnumSearchOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EQ"
Event
Fields
| Field Name | Description |
|---|---|
action - EventAction!
|
|
createdAt - ISO8601DateTime!
|
|
id - Int!
|
|
organization - Organization
|
|
originatingObject - EventOriginObject
|
|
originatingUser - User!
|
|
subject - EventSubject
|
Example
{
"action": "ACCEPTED",
"createdAt": ISO8601DateTime,
"id": 987,
"organization": Organization,
"originatingObject": EventOriginObject,
"originatingUser": User,
"subject": EventSubject
}
EventAction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCEPTED"
EventConnection
Description
The connection type for Event.
Fields
| Field Name | Description |
|---|---|
edges - [EventEdge!]!
|
A list of edges. |
eventTypes - [EventAction!]!
|
List of event types that have occurred on this entity. |
nodes - [Event!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
participatingOrganizations - [Organization!]!
|
List of all organizations who are involved in this event stream. |
totalCount - Int!
|
The total number of records in this filtered collection. |
unfilteredCount - Int!
|
When filtered on a subject, user, or organization, the total number of events for that subject/user/organization, irregardless of other filters. Returns null when there is no subject, user, or organization. |
uniqueParticipants - [User!]!
|
List of all users that have generated an event on the subject entity. |
Example
{
"edges": [EventEdge],
"eventTypes": ["ACCEPTED"],
"nodes": [Event],
"pageCount": 987,
"pageInfo": PageInfo,
"participatingOrganizations": [Organization],
"totalCount": 987,
"unfilteredCount": 987,
"uniqueParticipants": [User]
}
EventEdge
EventFeedMode
Description
The context of an event feed, i.e. what is the root subject of the feed. This option is a no-op when accessing events via a parent.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ORGANIZATION"
EventOriginObject
Description
The originating object for an event. This is useful when the subject of an event is not the actual origin of the event. For instance when you suggest a revision, the subject of the Event will be the entity being revised, while the originating object will be the Revision itself.
Possible Types
| EventOriginObject Types |
|---|
Example
{
"id": 987,
"link": "xyz789",
"name": "xyz789"
}
EventSubject
Description
The subject of an event log event.
Fields
| Field Name | Description |
|---|---|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
id - Int!
|
|
link - String!
|
|
name - String!
|
|
Possible Types
| EventSubject Types |
|---|
Example
{
"events": EventConnection,
"id": 987,
"link": "xyz789",
"name": "xyz789"
}
EventSubjectWithCount
Description
An event subject paired with a count of how many times that subject has appeared
Fields
| Field Name | Description |
|---|---|
occuranceCount - Int!
|
|
subject - EventSubject
|
Example
{"occuranceCount": 123, "subject": EventSubject}
EvidenceDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DOES_NOT_SUPPORT"
EvidenceDirectionTypeSearchInput
Fields
| Input Field | Description |
|---|---|
operator - EnumSearchOperator!
|
|
value - EvidenceDirection!
|
Example
{"operator": "EQ", "value": "DOES_NOT_SUPPORT"}
EvidenceItem
Fields
| Field Name | Description |
|---|---|
acceptanceEvent - Event
|
|
assertions - [Assertion!]!
|
|
comments - CommentConnection!
|
List and filter comments. |
Arguments
|
|
description - String!
|
|
disease - Disease
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
evidenceDirection - EvidenceDirection!
|
|
evidenceLevel - EvidenceLevel!
|
|
evidenceRating - Int
|
|
evidenceType - EvidenceType!
|
|
flagged - Boolean!
|
|
flags - FlagConnection!
|
List and filter flags. |
Arguments
|
|
id - Int!
|
|
lastAcceptedRevisionEvent - Event
|
|
lastCommentEvent - Event
|
|
lastSubmittedRevisionEvent - Event
|
|
link - String!
|
|
molecularProfile - MolecularProfile!
|
|
name - String!
|
|
openRevisionCount - Int!
|
|
phenotypes - [Phenotype!]!
|
|
rejectionEvent - Event
|
|
revisions - RevisionConnection!
|
List and filter revisions. |
Arguments
|
|
significance - EvidenceSignificance!
|
|
source - Source!
|
|
status - EvidenceStatus!
|
|
submissionActivity - SubmitEvidenceItemActivity!
|
|
submissionEvent - Event!
|
|
therapies - [Therapy!]!
|
|
therapyInteractionType - TherapyInteraction
|
|
variantHgvs - String!
|
|
variantOrigin - VariantOrigin!
|
|
Example
{
"acceptanceEvent": Event,
"assertions": [Assertion],
"comments": CommentConnection,
"description": "abc123",
"disease": Disease,
"events": EventConnection,
"evidenceDirection": "DOES_NOT_SUPPORT",
"evidenceLevel": "A",
"evidenceRating": 987,
"evidenceType": "DIAGNOSTIC",
"flagged": false,
"flags": FlagConnection,
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"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"
}
EvidenceItemConnection
Description
The connection type for EvidenceItem.
Fields
| Field Name | Description |
|---|---|
edges - [EvidenceItemEdge!]!
|
A list of edges. |
nodes - [EvidenceItem!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [EvidenceItemEdge],
"nodes": [EvidenceItem],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
EvidenceItemEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - EvidenceItem
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": EvidenceItem
}
EvidenceItemFields
Description
Fields on an EvidenceItem that curators may propose revisions to.
Fields
| Input Field | Description |
|---|---|
description - NullableStringInput!
|
The Evidence Items's description/summary text. |
diseaseId - NullableIntInput!
|
The ID of the disease (if applicable) for this EvidenceItem |
evidenceDirection - EvidenceDirection!
|
The evidence direction for this EvidenceItem. |
evidenceLevel - EvidenceLevel!
|
The evidence level of the EvidenceItem |
evidenceType - EvidenceType!
|
The Type of the EvidenceItem |
molecularProfileId - Int!
|
The ID of the Molecular Profile to which this EvidenceItem belongs |
phenotypeIds - [Int!]!
|
List of IDs of CIViC Phenotype entries for this EvidenceItem. An empty list indicates none. |
rating - Int!
|
The rating for this EvidenceItem |
significance - EvidenceSignificance!
|
The Clinical Significance of the EvidenceItem |
sourceId - Int!
|
The ID of the Source from which this EvidenceItem was curated. |
therapyIds - [Int!]!
|
List of IDs of CIViC Therapy entries for this EvidenceItem. An empty list indicates none. |
therapyInteractionType - NullableTherapyInteractionTypeInput!
|
Therapy interaction type for cases where more than one Therapy ID is provided. |
variantOrigin - VariantOrigin!
|
The Variant Origin for this EvidenceItem. |
Example
{
"description": NullableStringInput,
"diseaseId": NullableIntInput,
"evidenceDirection": "DOES_NOT_SUPPORT",
"evidenceLevel": "A",
"evidenceType": "DIAGNOSTIC",
"molecularProfileId": 123,
"phenotypeIds": [987],
"rating": 987,
"significance": "ADVERSE_RESPONSE",
"sourceId": 123,
"therapyIds": [987],
"therapyInteractionType": NullableTherapyInteractionTypeInput,
"variantOrigin": "COMBINED"
}
EvidenceItemSearchFilter
Fields
| Input Field | Description |
|---|---|
assertion - AssertionSearchFilter
|
|
booleanOperator - BooleanOperator
|
|
comment - CommentSearchFilter
|
|
creatingUser - UserSearchFilter
|
|
description - StringSearchInput
|
|
disease - DiseaseSearchFilter
|
|
evidenceDirection - EvidenceDirectionTypeSearchInput
|
|
evidenceLevel - EvidenceLevelTypeSearchInput
|
|
evidenceRating - IntSearchInput
|
|
evidenceType - EvidenceTypeTypeSearchInput
|
|
id - IntSearchInput
|
|
isFlagged - BooleanSearchInput
|
|
moderatingUser - UserSearchFilter
|
|
molecularProfile - MolecularProfileSearchFilter
|
|
openRevisionCount - IntSearchInput
|
|
phenotypes - PhenotypeSearchFilter
|
|
revisions - RevisionSearchFilter
|
|
significance - EvidenceSignificanceTypeSearchInput
|
|
source - SourceSearchFilter
|
|
status - EvidenceStatusTypeSearchInput
|
|
subFilters - [EvidenceItemSearchFilter!]
|
|
therapies - TherapySearchFilter
|
|
therapyInteractionType - TherapyInteractionTypeSearchInput
|
Example
{
"assertion": AssertionSearchFilter,
"booleanOperator": "AND",
"comment": CommentSearchFilter,
"creatingUser": UserSearchFilter,
"description": StringSearchInput,
"disease": DiseaseSearchFilter,
"evidenceDirection": EvidenceDirectionTypeSearchInput,
"evidenceLevel": EvidenceLevelTypeSearchInput,
"evidenceRating": IntSearchInput,
"evidenceType": EvidenceTypeTypeSearchInput,
"id": IntSearchInput,
"isFlagged": BooleanSearchInput,
"moderatingUser": UserSearchFilter,
"molecularProfile": MolecularProfileSearchFilter,
"openRevisionCount": IntSearchInput,
"phenotypes": PhenotypeSearchFilter,
"revisions": RevisionSearchFilter,
"significance": EvidenceSignificanceTypeSearchInput,
"source": SourceSearchFilter,
"status": EvidenceStatusTypeSearchInput,
"subFilters": [EvidenceItemSearchFilter],
"therapies": TherapySearchFilter,
"therapyInteractionType": TherapyInteractionTypeSearchInput
}
EvidenceItemsByStatus
EvidenceItemsByType
Example
{
"diagnosticCount": 987,
"functionalCount": 123,
"molecularProfileId": 987,
"oncogenicCount": 123,
"predictiveCount": 987,
"predisposingCount": 987,
"prognosticCount": 987
}
EvidenceLevel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"A"
EvidenceLevelTypeSearchInput
Fields
| Input Field | Description |
|---|---|
operator - EnumSearchOperator!
|
|
value - EvidenceLevel!
|
Example
{"operator": "EQ", "value": "A"}
EvidenceSignificance
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Likely Oncogenic |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADVERSE_RESPONSE"
EvidenceSignificanceTypeSearchInput
Fields
| Input Field | Description |
|---|---|
operator - EnumSearchOperator!
|
|
value - EvidenceSignificance!
|
Example
{"operator": "EQ", "value": "ADVERSE_RESPONSE"}
EvidenceSort
Fields
| Input Field | Description |
|---|---|
column - EvidenceSortColumns!
|
Available columns for sorting |
direction - SortDirection!
|
Sort direction |
Example
{"column": "DESCRIPTION", "direction": "ASC"}
EvidenceSortColumns
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DESCRIPTION"
EvidenceStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACCEPTED"
EvidenceStatusFilter
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCEPTED"
EvidenceStatusTypeSearchInput
Fields
| Input Field | Description |
|---|---|
operator - EnumSearchOperator!
|
|
value - EvidenceStatus!
|
Example
{"operator": "EQ", "value": "ACCEPTED"}
EvidenceType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DIAGNOSTIC"
EvidenceTypeTypeSearchInput
Fields
| Input Field | Description |
|---|---|
operator - EnumSearchOperator!
|
|
value - EvidenceType!
|
Example
{"operator": "EQ", "value": "DIAGNOSTIC"}
ExonCoordinate
Fields
| Field Name | Description |
|---|---|
chromosome - String
|
|
coordinateType - ExonCoordinateType!
|
|
ensemblId - String
|
|
ensemblVersion - Int
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
exon - Int
|
|
exonOffset - Int
|
|
exonOffsetDirection - Direction
|
|
id - Int!
|
|
lastAcceptedRevisionEvent - Event
|
|
lastSubmittedRevisionEvent - Event
|
|
link - String!
|
|
name - String!
|
|
openRevisionCount - Int!
|
|
referenceBuild - ReferenceBuild
|
|
representativeTranscript - String
|
|
revisions - RevisionConnection!
|
List and filter revisions. |
Arguments
|
|
start - Int
|
|
stop - Int
|
|
strand - Direction
|
|
Example
{
"chromosome": "abc123",
"coordinateType": "FIVE_PRIME_END_EXON_COORDINATE",
"ensemblId": "xyz789",
"ensemblVersion": 987,
"events": EventConnection,
"exon": 123,
"exonOffset": 123,
"exonOffsetDirection": "NEGATIVE",
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"name": "abc123",
"openRevisionCount": 987,
"referenceBuild": "GRCH37",
"representativeTranscript": "abc123",
"revisions": RevisionConnection,
"start": 987,
"stop": 123,
"strand": "NEGATIVE"
}
ExonCoordinateType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"FIVE_PRIME_END_EXON_COORDINATE"
Factor
Description
The Feature that a Variant can belong to
Fields
| Field Name | Description |
|---|---|
comments - CommentConnection!
|
List and filter comments. |
Arguments
|
|
creationActivity - CreateFeatureActivity
|
|
deprecated - Boolean!
|
|
deprecationActivity - DeprecateFeatureActivity
|
|
deprecationReason - FeatureDeprecationReason
|
|
description - String
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
featureAliases - [String!]!
|
|
featureInstance - FeatureInstance!
|
|
featureType - FeatureInstanceTypes!
|
|
flagged - Boolean!
|
|
flags - FlagConnection!
|
List and filter flags. |
Arguments
|
|
fullName - String
|
|
id - Int!
|
|
lastAcceptedRevisionEvent - Event
|
|
lastCommentEvent - Event
|
|
lastSubmittedRevisionEvent - Event
|
|
link - String!
|
|
name - String!
|
|
ncitDetails - NcitDetails
|
|
ncitId - String
|
|
openRevisionCount - Int!
|
|
revisions - RevisionConnection!
|
List and filter revisions. |
Arguments
|
|
sources - [Source!]!
|
|
variants - FactorVariantConnection!
|
List and filter Gene variants. |
Arguments
|
|
Example
{
"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": "xyz789",
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"name": "xyz789",
"ncitDetails": NcitDetails,
"ncitId": "abc123",
"openRevisionCount": 123,
"revisions": RevisionConnection,
"sources": [Source],
"variants": FactorVariantConnection
}
FactorConnection
Description
The connection type for Factor.
Fields
| Field Name | Description |
|---|---|
edges - [FactorEdge!]!
|
A list of edges. |
nodes - [Factor!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [FactorEdge],
"nodes": [Factor],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
FactorEdge
FactorFields
Description
Fields on a Factor that curators may propose revisions to.
Fields
| Input Field | Description |
|---|---|
aliases - [String!]!
|
List of aliases or alternate names for the Factor. |
description - NullableStringInput!
|
The Factor's description/summary text. |
fullName - NullableStringInput!
|
The Factor's full name if applicable. |
name - String!
|
The Factor's display name. |
ncitId - NullableStringInput!
|
NCI Thesaurus concept ID for this Factor |
sourceIds - [Int!]!
|
Source IDs cited by the Factor's summary. |
Example
{
"aliases": ["xyz789"],
"description": NullableStringInput,
"fullName": NullableStringInput,
"name": "xyz789",
"ncitId": NullableStringInput,
"sourceIds": [123]
}
FactorVariant
Fields
| Field Name | Description |
|---|---|
comments - CommentConnection!
|
List and filter comments. |
Arguments
|
|
creationActivity - CreateVariantActivity
|
|
deprecated - Boolean!
|
|
deprecationActivity - DeprecateVariantActivity
|
|
deprecationReason - VariantDeprecationReason
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
feature - Feature!
|
|
flagged - Boolean!
|
|
flags - FlagConnection!
|
List and filter flags. |
Arguments
|
|
id - Int!
|
|
lastAcceptedRevisionEvent - Event
|
|
lastCommentEvent - Event
|
|
lastSubmittedRevisionEvent - Event
|
|
link - String!
|
|
molecularProfiles - MolecularProfileConnection!
|
|
name - String!
|
|
ncitDetails - NcitDetails
|
|
ncitId - String
|
|
openRevisionCount - Int!
|
|
revisions - RevisionConnection!
|
List and filter revisions. |
Arguments
|
|
singleVariantMolecularProfile - MolecularProfile!
|
|
singleVariantMolecularProfileId - Int!
|
|
variantAliases - [String!]!
|
|
variantTypes - [VariantType!]!
|
|
Example
{
"comments": CommentConnection,
"creationActivity": CreateVariantActivity,
"deprecated": true,
"deprecationActivity": DeprecateVariantActivity,
"deprecationReason": "DUPLICATE",
"events": EventConnection,
"feature": Feature,
"flagged": false,
"flags": FlagConnection,
"id": 987,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"molecularProfiles": MolecularProfileConnection,
"name": "abc123",
"ncitDetails": NcitDetails,
"ncitId": "xyz789",
"openRevisionCount": 123,
"revisions": RevisionConnection,
"singleVariantMolecularProfile": MolecularProfile,
"singleVariantMolecularProfileId": 123,
"variantAliases": ["abc123"],
"variantTypes": [VariantType]
}
FactorVariantConnection
Description
The connection type for FactorVariant.
Fields
| Field Name | Description |
|---|---|
edges - [FactorVariantEdge!]!
|
A list of edges. |
nodes - [FactorVariant!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [FactorVariantEdge],
"nodes": [FactorVariant],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
FactorVariantEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - FactorVariant
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": FactorVariant
}
FactorVariantFields
Description
Fields on a FactorVariant that curators may propose revisions to.
Fields
| Input Field | Description |
|---|---|
aliases - [String!]!
|
List of aliases or alternate names for the Variant. |
featureId - Int!
|
The ID of the Feature this Variant corresponds to. |
name - String!
|
The Variant's name. |
ncitId - NullableStringInput!
|
NCI Thesaurus concept ID for this Factor |
variantTypeIds - [Int!]!
|
List of IDs for the variant types for this Variant |
Example
{
"aliases": ["abc123"],
"featureId": 987,
"name": "xyz789",
"ncitId": NullableStringInput,
"variantTypeIds": [123]
}
FdaCode
Feature
Description
The Feature that a Variant can belong to
Fields
| Field Name | Description |
|---|---|
comments - CommentConnection!
|
List and filter comments. |
Arguments
|
|
creationActivity - CreateFeatureActivity
|
|
deprecated - Boolean!
|
|
deprecationActivity - DeprecateFeatureActivity
|
|
deprecationReason - FeatureDeprecationReason
|
|
description - String
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
featureAliases - [String!]!
|
|
featureInstance - FeatureInstance!
|
|
featureType - FeatureInstanceTypes!
|
|
flagged - Boolean!
|
|
flags - FlagConnection!
|
List and filter flags. |
Arguments
|
|
fullName - String
|
|
id - Int!
|
|
lastAcceptedRevisionEvent - Event
|
|
lastCommentEvent - Event
|
|
lastSubmittedRevisionEvent - Event
|
|
link - String!
|
|
name - String!
|
|
openRevisionCount - Int!
|
|
revisions - RevisionConnection!
|
List and filter revisions. |
Arguments
|
|
sources - [Source!]!
|
|
variants - VariantInterfaceConnection!
|
List and filter variants. |
Arguments
|
|
Example
{
"comments": CommentConnection,
"creationActivity": CreateFeatureActivity,
"deprecated": true,
"deprecationActivity": DeprecateFeatureActivity,
"deprecationReason": "DUPLICATE",
"description": "xyz789",
"events": EventConnection,
"featureAliases": ["abc123"],
"featureInstance": Factor,
"featureType": "FACTOR",
"flagged": false,
"flags": FlagConnection,
"fullName": "abc123",
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"name": "xyz789",
"openRevisionCount": 123,
"revisions": RevisionConnection,
"sources": [Source],
"variants": VariantInterfaceConnection
}
FeatureDeprecationReason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DUPLICATE"
FeatureDeprecationReasonTypeSearchInput
Fields
| Input Field | Description |
|---|---|
operator - EnumSearchOperator!
|
|
value - FeatureDeprecationReason!
|
Example
{"operator": "EQ", "value": "DUPLICATE"}
FeatureInstance
FeatureInstanceTypes
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"FACTOR"
FeatureInstanceTypesSearchInput
Fields
| Input Field | Description |
|---|---|
operator - EnumSearchOperator!
|
|
value - FeatureInstanceTypes!
|
Example
{"operator": "EQ", "value": "FACTOR"}
FeatureSearchFilter
Fields
| Input Field | Description |
|---|---|
alias - StringSearchInput
|
|
booleanOperator - BooleanOperator
|
|
creatingUser - UserSearchFilter
|
|
deprecatingUser - UserSearchFilter
|
|
deprecationReason - FeatureDeprecationReasonTypeSearchInput
|
|
description - StringSearchInput
|
|
entrezId - IntSearchInput
|
|
entrezSymbol - StringSearchInput
|
|
featureInstanceType - FeatureInstanceTypesSearchInput
|
|
fivePrimePartnerEntrezId - IntSearchInput
|
|
fivePrimePartnerEntrezSymbol - StringSearchInput
|
|
hasAssertion - BooleanSearchInput
|
|
id - IntSearchInput
|
|
isDeprecated - BooleanSearchInput
|
|
isFlagged - BooleanSearchInput
|
|
ncitId - StringSearchInput
|
|
openRevisionCount - IntSearchInput
|
|
subFilters - [FeatureSearchFilter!]
|
|
threePrimePartnerEntrezId - IntSearchInput
|
|
threePrimePartnerEntrezSymbol - StringSearchInput
|
Example
{
"alias": StringSearchInput,
"booleanOperator": "AND",
"creatingUser": UserSearchFilter,
"deprecatingUser": UserSearchFilter,
"deprecationReason": FeatureDeprecationReasonTypeSearchInput,
"description": StringSearchInput,
"entrezId": IntSearchInput,
"entrezSymbol": StringSearchInput,
"featureInstanceType": FeatureInstanceTypesSearchInput,
"fivePrimePartnerEntrezId": IntSearchInput,
"fivePrimePartnerEntrezSymbol": StringSearchInput,
"hasAssertion": BooleanSearchInput,
"id": IntSearchInput,
"isDeprecated": BooleanSearchInput,
"isFlagged": BooleanSearchInput,
"ncitId": StringSearchInput,
"openRevisionCount": IntSearchInput,
"subFilters": [FeatureSearchFilter],
"threePrimePartnerEntrezId": IntSearchInput,
"threePrimePartnerEntrezSymbol": StringSearchInput
}
FeaturesSort
Fields
| Input Field | Description |
|---|---|
column - FeaturesSortColumns!
|
Available columns for sorting |
direction - SortDirection!
|
Sort direction |
Example
{"column": "assertionCount", "direction": "ASC"}
FeaturesSortColumns
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"assertionCount"
FieldName
FieldValidationError
Flag
Fields
| Field Name | Description |
|---|---|
comments - CommentConnection!
|
List and filter comments. |
Arguments
|
|
createdAt - ISO8601DateTime!
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
flaggable - Flaggable!
|
|
flaggingUser - User!
|
|
id - Int!
|
|
lastCommentEvent - Event
|
|
link - String!
|
|
name - String!
|
|
openActivity - FlagEntityActivity!
|
|
resolutionActivity - ResolveFlagActivity
|
|
resolvingUser - User
|
|
state - FlagState!
|
|
Example
{
"comments": CommentConnection,
"createdAt": ISO8601DateTime,
"events": EventConnection,
"flaggable": Flaggable,
"flaggingUser": User,
"id": 123,
"lastCommentEvent": Event,
"link": "abc123",
"name": "xyz789",
"openActivity": FlagEntityActivity,
"resolutionActivity": ResolveFlagActivity,
"resolvingUser": User,
"state": "OPEN"
}
FlagConnection
Description
The connection type for Flag.
Fields
| Field Name | Description |
|---|---|
edges - [FlagEdge!]!
|
A list of edges. |
nodes - [Flag!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
unfilteredCountForSubject - Int
|
When filtered on a subject, the total number of flags for that subject, irregardless of other filters. Returns null when there is no subject. |
uniqueFlaggingUsers - [User!]!
|
List of all users that have flagged this entity. |
uniqueResolvingUsers - [User!]
|
List of all users that have resolved a flag on this entity. |
Example
{
"edges": [FlagEdge],
"nodes": [Flag],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123,
"unfilteredCountForSubject": 123,
"uniqueFlaggingUsers": [User],
"uniqueResolvingUsers": [User]
}
FlagEdge
FlagEntityActivity
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
flag - Flag!
|
|
id - Int!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"createdAt": ISO8601DateTime,
"events": [Event],
"flag": Flag,
"id": 123,
"note": "xyz789",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"subject": EventSubject,
"user": User,
"verbiage": "abc123"
}
FlagEntityInput
Description
Autogenerated input type of FlagEntity
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String!
|
Text describing the problem you observed with this entity. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
subject - FlaggableInput!
|
The entity to flag, specified by its ID and type. |
Example
{
"clientMutationId": "xyz789",
"comment": "abc123",
"organizationId": 123,
"subject": FlaggableInput
}
FlagEntityPayload
FlagState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"OPEN"
Flaggable
Description
A CIViC entity that can be flagged for editor attention.
Fields
| Field Name | Description |
|---|---|
flagged - Boolean!
|
|
flags - FlagConnection!
|
List and filter flags. |
Arguments
|
|
id - Int!
|
|
link - String!
|
|
name - String!
|
|
Possible Types
| Flaggable Types |
|---|
Example
{
"flagged": false,
"flags": FlagConnection,
"id": 987,
"link": "abc123",
"name": "abc123"
}
FlaggableEntities
Description
Enumeration of all entities in CIViC that can be flagged.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSERTION"
FlaggableInput
Description
Entity to flag
Fields
| Input Field | Description |
|---|---|
entityType - FlaggableEntities!
|
The type of the entity to flag. |
id - Int!
|
The ID of the entity. |
Example
{"entityType": "ASSERTION", "id": 987}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
FloatSearchInput
Fields
| Input Field | Description |
|---|---|
operator - FloatSearchOperator!
|
|
value - Float!
|
Example
{"operator": "EQ", "value": 123.45}
FloatSearchOperator
Values
| Enum Value | Description |
|---|---|
|
|
Equal To |
|
|
Greater Than or Equal To |
|
|
Greater Than |
|
|
Less Than or Equal To |
|
|
Less Than |
|
|
Not Equal To |
Example
"EQ"
Fusion
Description
The Feature that a Variant can belong to
Fields
| Field Name | Description |
|---|---|
comments - CommentConnection!
|
List and filter comments. |
Arguments
|
|
creationActivity - CreateFeatureActivity
|
|
deprecated - Boolean!
|
|
deprecationActivity - DeprecateFeatureActivity
|
|
deprecationReason - FeatureDeprecationReason
|
|
description - String
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
featureAliases - [String!]!
|
|
featureInstance - FeatureInstance!
|
|
featureType - FeatureInstanceTypes!
|
|
fivePrimeGene - Gene
|
|
fivePrimePartnerStatus - FusionPartnerStatus!
|
|
flagged - Boolean!
|
|
flags - FlagConnection!
|
List and filter flags. |
Arguments
|
|
fullName - String
|
|
id - Int!
|
|
lastAcceptedRevisionEvent - Event
|
|
lastCommentEvent - Event
|
|
lastSubmittedRevisionEvent - Event
|
|
link - String!
|
|
name - String!
|
|
openRevisionCount - Int!
|
|
revisions - RevisionConnection!
|
List and filter revisions. |
Arguments
|
|
sources - [Source!]!
|
|
threePrimeGene - Gene
|
|
threePrimePartnerStatus - FusionPartnerStatus!
|
|
variants - VariantInterfaceConnection!
|
List and filter variants. |
Arguments
|
|
Example
{
"comments": CommentConnection,
"creationActivity": CreateFeatureActivity,
"deprecated": false,
"deprecationActivity": DeprecateFeatureActivity,
"deprecationReason": "DUPLICATE",
"description": "abc123",
"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": "xyz789",
"name": "abc123",
"openRevisionCount": 987,
"revisions": RevisionConnection,
"sources": [Source],
"threePrimeGene": Gene,
"threePrimePartnerStatus": "KNOWN",
"variants": VariantInterfaceConnection
}
FusionConnection
Description
The connection type for Fusion.
Fields
| Field Name | Description |
|---|---|
edges - [FusionEdge!]!
|
A list of edges. |
nodes - [Fusion!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [FusionEdge],
"nodes": [Fusion],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
FusionEdge
FusionFields
Description
Fields on a Fusion that curators may propose revisions to.
Fields
| Input Field | Description |
|---|---|
aliases - [String!]!
|
List of aliases or alternate names for the Fusion. |
description - NullableStringInput!
|
The Fusion's description/summary text. |
sourceIds - [Int!]!
|
Source IDs cited by the Fusion's summary. |
Example
{
"aliases": ["abc123"],
"description": NullableStringInput,
"sourceIds": [123]
}
FusionPartnerInput
Description
The fusion partner's status and gene ID (if applicable)
Fields
| Input Field | Description |
|---|---|
geneId - Int
|
The CIViC gene ID of the partner, if known |
partnerStatus - FusionPartnerStatus!
|
The status of the fusion partner |
Example
{"geneId": 123, "partnerStatus": "KNOWN"}
FusionPartnerStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"KNOWN"
FusionVariant
Fields
| Field Name | Description |
|---|---|
comments - CommentConnection!
|
List and filter comments. |
Arguments
|
|
creationActivity - CreateVariantActivity
|
|
deprecated - Boolean!
|
|
deprecationActivity - DeprecateVariantActivity
|
|
deprecationReason - VariantDeprecationReason
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
feature - Feature!
|
|
fivePrimeCoordinates - VariantCoordinate
|
|
fivePrimeEndExonCoordinates - ExonCoordinate
|
|
fivePrimeStartExonCoordinates - ExonCoordinate
|
|
flagged - Boolean!
|
|
flags - FlagConnection!
|
List and filter flags. |
Arguments
|
|
fusion - Fusion!
|
|
id - Int!
|
|
lastAcceptedRevisionEvent - Event
|
|
lastCommentEvent - Event
|
|
lastSubmittedRevisionEvent - Event
|
|
link - String!
|
|
molecularProfiles - MolecularProfileConnection!
|
|
name - String!
|
|
openRevisionCount - Int!
|
|
revisions - RevisionConnection!
|
List and filter revisions. |
Arguments
|
|
singleVariantMolecularProfile - MolecularProfile!
|
|
singleVariantMolecularProfileId - Int!
|
|
threePrimeCoordinates - VariantCoordinate
|
|
threePrimeEndExonCoordinates - ExonCoordinate
|
|
threePrimeStartExonCoordinates - ExonCoordinate
|
|
variantAliases - [String!]!
|
|
variantTypes - [VariantType!]!
|
|
viccCompliantName - String!
|
|
Example
{
"comments": CommentConnection,
"creationActivity": CreateVariantActivity,
"deprecated": true,
"deprecationActivity": DeprecateVariantActivity,
"deprecationReason": "DUPLICATE",
"events": EventConnection,
"feature": Feature,
"fivePrimeCoordinates": VariantCoordinate,
"fivePrimeEndExonCoordinates": ExonCoordinate,
"fivePrimeStartExonCoordinates": ExonCoordinate,
"flagged": true,
"flags": FlagConnection,
"fusion": Fusion,
"id": 987,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"molecularProfiles": MolecularProfileConnection,
"name": "abc123",
"openRevisionCount": 987,
"revisions": RevisionConnection,
"singleVariantMolecularProfile": MolecularProfile,
"singleVariantMolecularProfileId": 987,
"threePrimeCoordinates": VariantCoordinate,
"threePrimeEndExonCoordinates": ExonCoordinate,
"threePrimeStartExonCoordinates": ExonCoordinate,
"variantAliases": ["xyz789"],
"variantTypes": [VariantType],
"viccCompliantName": "abc123"
}
FusionVariantFields
Description
Fields on a FusionVariant that curators may propose revisions to.
Fields
| Input Field | Description |
|---|---|
aliases - [String!]!
|
List of aliases or alternate names for the Variant. |
coordinates - FusionVariantInput!
|
The exon coordinates for this Variant. |
variantTypeIds - [Int!]!
|
List of IDs for the variant types for this Variant |
Example
{
"aliases": ["abc123"],
"coordinates": FusionVariantInput,
"variantTypeIds": [123]
}
FusionVariantInput
Description
The fields required to create a fusion variant
Fields
| Input Field | Description |
|---|---|
ensemblVersion - Int!
|
|
fivePrimeExonEnd - Int
|
|
fivePrimeOffset - Int
|
|
fivePrimeOffsetDirection - Direction
|
|
fivePrimeTranscript - String
|
|
referenceBuild - ReferenceBuild
|
The reference build for the genomic coordinates of this Variant. |
threePrimeExonStart - Int
|
|
threePrimeOffset - Int
|
|
threePrimeOffsetDirection - Direction
|
|
threePrimeTranscript - String
|
Example
{
"ensemblVersion": 123,
"fivePrimeExonEnd": 987,
"fivePrimeOffset": 123,
"fivePrimeOffsetDirection": "NEGATIVE",
"fivePrimeTranscript": "xyz789",
"referenceBuild": "GRCH37",
"threePrimeExonStart": 987,
"threePrimeOffset": 987,
"threePrimeOffsetDirection": "NEGATIVE",
"threePrimeTranscript": "abc123"
}
Gene
Description
The Feature that a Variant can belong to
Fields
| Field Name | Description |
|---|---|
comments - CommentConnection!
|
List and filter comments. |
Arguments
|
|
creationActivity - CreateFeatureActivity
|
|
deprecated - Boolean!
|
|
deprecationActivity - DeprecateFeatureActivity
|
|
deprecationReason - FeatureDeprecationReason
|
|
description - String
|
|
entrezId - Int!
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
featureAliases - [String!]!
|
|
featureInstance - FeatureInstance!
|
|
featureType - FeatureInstanceTypes!
|
|
flagged - Boolean!
|
|
flags - FlagConnection!
|
List and filter flags. |
Arguments
|
|
fullName - String
|
|
id - Int!
|
|
lastAcceptedRevisionEvent - Event
|
|
lastCommentEvent - Event
|
|
lastSubmittedRevisionEvent - Event
|
|
link - String!
|
|
myGeneInfoDetails - JSON
|
|
name - String!
|
|
openRevisionCount - Int!
|
|
revisions - RevisionConnection!
|
List and filter revisions. |
Arguments
|
|
sources - [Source!]!
|
|
variants - GeneVariantConnection!
|
List and filter Gene variants. |
Arguments
|
|
Example
{
"comments": CommentConnection,
"creationActivity": CreateFeatureActivity,
"deprecated": true,
"deprecationActivity": DeprecateFeatureActivity,
"deprecationReason": "DUPLICATE",
"description": "abc123",
"entrezId": 987,
"events": EventConnection,
"featureAliases": ["xyz789"],
"featureInstance": Factor,
"featureType": "FACTOR",
"flagged": false,
"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
}
GeneConnection
Description
The connection type for Gene.
Fields
| Field Name | Description |
|---|---|
edges - [GeneEdge!]!
|
A list of edges. |
nodes - [Gene!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [GeneEdge],
"nodes": [Gene],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
GeneEdge
GeneFields
Description
Fields on a Gene that curators may propose revisions to.
Fields
| Input Field | Description |
|---|---|
description - NullableStringInput!
|
The Gene's description/summary text. |
sourceIds - [Int!]!
|
Source IDs cited by the Gene's summary. |
Example
{"description": NullableStringInput, "sourceIds": [987]}
GeneVariant
Fields
| Field Name | Description |
|---|---|
alleleRegistryId - String
|
|
clinvarIds - [String!]!
|
|
comments - CommentConnection!
|
List and filter comments. |
Arguments
|
|
coordinates - VariantCoordinate
|
|
creationActivity - CreateVariantActivity
|
|
deprecated - Boolean!
|
|
deprecationActivity - DeprecateVariantActivity
|
|
deprecationReason - VariantDeprecationReason
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
feature - Feature!
|
|
flagged - Boolean!
|
|
flags - FlagConnection!
|
List and filter flags. |
Arguments
|
|
hgvsDescriptions - [String!]!
|
|
id - Int!
|
|
lastAcceptedRevisionEvent - Event
|
|
lastCommentEvent - Event
|
|
lastSubmittedRevisionEvent - Event
|
|
link - String!
|
|
maneSelectTranscript - String
|
|
molecularProfiles - MolecularProfileConnection!
|
|
myVariantInfo - MyVariantInfo
|
|
name - String!
|
|
openCravatAnnotations - JSON
|
|
openCravatUrl - String
|
|
openRevisionCount - Int!
|
|
primaryCoordinates - VariantCoordinate
|
The new Fusion variant type means Gene variants no longer have primary and secondary coordinates. Use 'coordinates' instead. |
revisions - RevisionConnection!
|
List and filter revisions. |
Arguments
|
|
singleVariantMolecularProfile - MolecularProfile!
|
|
singleVariantMolecularProfileId - Int!
|
|
variantAliases - [String!]!
|
|
variantTypes - [VariantType!]!
|
|
Example
{
"alleleRegistryId": "abc123",
"clinvarIds": ["abc123"],
"comments": CommentConnection,
"coordinates": VariantCoordinate,
"creationActivity": CreateVariantActivity,
"deprecated": true,
"deprecationActivity": DeprecateVariantActivity,
"deprecationReason": "DUPLICATE",
"events": EventConnection,
"feature": Feature,
"flagged": false,
"flags": FlagConnection,
"hgvsDescriptions": ["xyz789"],
"id": 987,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"maneSelectTranscript": "xyz789",
"molecularProfiles": MolecularProfileConnection,
"myVariantInfo": MyVariantInfo,
"name": "abc123",
"openCravatAnnotations": {},
"openCravatUrl": "abc123",
"openRevisionCount": 123,
"primaryCoordinates": VariantCoordinate,
"revisions": RevisionConnection,
"singleVariantMolecularProfile": MolecularProfile,
"singleVariantMolecularProfileId": 987,
"variantAliases": ["abc123"],
"variantTypes": [VariantType]
}
GeneVariantConnection
Description
The connection type for GeneVariant.
Fields
| Field Name | Description |
|---|---|
edges - [GeneVariantEdge!]!
|
A list of edges. |
nodes - [GeneVariant!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [GeneVariantEdge],
"nodes": [GeneVariant],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
GeneVariantCoordinateInput
Fields
| Input Field | Description |
|---|---|
chromosome - String
|
|
ensemblVersion - Int
|
The Ensembl database version. |
referenceBases - NullableStringInput!
|
Reference bases for this variant |
referenceBuild - ReferenceBuild
|
The reference build for the genomic coordinates of this Variant. |
representativeTranscript - String
|
|
start - Int
|
|
stop - Int
|
|
variantBases - NullableStringInput!
|
Variant bases for this variant |
Example
{
"chromosome": "abc123",
"ensemblVersion": 987,
"referenceBases": NullableStringInput,
"referenceBuild": "GRCH37",
"representativeTranscript": "xyz789",
"start": 987,
"stop": 987,
"variantBases": NullableStringInput
}
GeneVariantEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - GeneVariant
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": GeneVariant
}
GeneVariantFields
Description
Fields on a GeneVariant that curators may propose revisions to.
Fields
| Input Field | Description |
|---|---|
aliases - [String!]!
|
List of aliases or alternate names for the Variant. |
clinvarIds - ClinvarInput!
|
List of ClinVar IDs for the Variant. |
coordinates - GeneVariantCoordinateInput!
|
The genomic coordinates for this Variant. |
featureId - Int!
|
The ID of the Feature this Variant corresponds to. |
hgvsDescriptions - [String!]!
|
List of HGVS descriptions for the Variant. |
name - String!
|
The Variant's name. |
variantTypeIds - [Int!]!
|
List of IDs for the variant types for this Variant |
Example
{
"aliases": ["xyz789"],
"clinvarIds": ClinvarInput,
"coordinates": GeneVariantCoordinateInput,
"featureId": 123,
"hgvsDescriptions": ["xyz789"],
"name": "abc123",
"variantTypeIds": [987]
}
GenerateApiKeyInput
Description
Autogenerated input type of GenerateApiKey
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
Example
{"clientMutationId": "xyz789"}
GenerateApiKeyPayload
Description
Autogenerated return type of GenerateApiKey.
Example
{
"apiKey": ApiKey,
"clientMutationId": "abc123",
"user": User
}
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
ISO8601DateTime
Description
An ISO 8601-encoded datetime
Example
ISO8601DateTime
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
IntSearchInput
Fields
| Input Field | Description |
|---|---|
operator - IntSearchOperator!
|
|
value - Int!
|
Example
{"operator": "EQ", "value": 123}
IntSearchOperator
Values
| Enum Value | Description |
|---|---|
|
|
Equal To |
|
|
Greater Than or Equal To |
|
|
Greater Than |
|
|
Less Than or Equal To |
|
|
Less Than |
|
|
Not Equal To |
Example
"EQ"
JSON
Description
Represents untyped JSON
Example
{}
LeaderboardOrganization
Fields
| Field Name | Description |
|---|---|
actionCount - Int!
|
|
canEndorse - Boolean!
|
|
description - String!
|
|
eventCount - Int!
|
|
events - EventConnection!
|
|
hasEndorsingSubgroups - Boolean!
|
|
id - Int!
|
|
isApprovedVcep - Boolean!
|
|
memberCount - Int!
|
|
members - UserConnection!
|
|
mostRecentActivityTimestamp - ISO8601DateTime
|
|
name - String!
|
|
orgAndSuborgsStatsHash - Stats!
|
|
orgStatsHash - Stats!
|
|
profileImagePath - String
|
|
Arguments
|
|
rank - Int!
|
|
ranks - Ranks!
|
|
subGroups - [Organization!]!
|
|
url - String!
|
|
Example
{
"actionCount": 987,
"canEndorse": false,
"description": "abc123",
"eventCount": 987,
"events": EventConnection,
"hasEndorsingSubgroups": false,
"id": 123,
"isApprovedVcep": true,
"memberCount": 123,
"members": UserConnection,
"mostRecentActivityTimestamp": ISO8601DateTime,
"name": "abc123",
"orgAndSuborgsStatsHash": Stats,
"orgStatsHash": Stats,
"profileImagePath": "xyz789",
"rank": 123,
"ranks": Ranks,
"subGroups": [Organization],
"url": "xyz789"
}
LeaderboardOrganizationConnection
Description
The connection type for LeaderboardOrganization.
Fields
| Field Name | Description |
|---|---|
edges - [LeaderboardOrganizationEdge!]!
|
A list of edges. |
nodes - [LeaderboardOrganization!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [LeaderboardOrganizationEdge],
"nodes": [LeaderboardOrganization],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
LeaderboardOrganizationEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - LeaderboardOrganization
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": LeaderboardOrganization
}
LeaderboardRank
LeaderboardUser
Fields
| Field Name | Description |
|---|---|
actionCount - Int!
|
|
apiKeys - [ApiKey!]!
|
|
areaOfExpertise - AreaOfExpertise
|
|
bio - String
|
|
country - Country
|
|
displayName - String!
|
|
email - String
|
|
events - EventConnection!
|
|
facebookProfile - String
|
|
id - Int!
|
|
joinDate - ISO8601DateTime
|
|
linkedinProfile - String
|
|
mostRecentActivityTimestamp - ISO8601DateTime
|
|
mostRecentConflictOfInterestStatement - Coi
|
|
mostRecentEvent - Event
|
|
mostRecentOrganizationId - Int
|
|
name - String
|
|
notifications - NotificationConnection
|
Filterable list of notifications for the logged in user. |
Arguments
|
|
orcid - String
|
|
organizations - [Organization!]!
|
|
organizationsWithEndorsementPrivileges - [Organization!]!
|
|
profileImagePath - String
|
|
Arguments
|
|
rank - Int!
|
|
ranks - Ranks!
|
|
role - UserRole!
|
|
statsHash - Stats!
|
|
twitterHandle - String
|
|
url - String
|
|
username - String!
|
|
Example
{
"actionCount": 987,
"apiKeys": [ApiKey],
"areaOfExpertise": "CLINICAL_SCIENTIST",
"bio": "abc123",
"country": Country,
"displayName": "abc123",
"email": "xyz789",
"events": EventConnection,
"facebookProfile": "abc123",
"id": 987,
"joinDate": ISO8601DateTime,
"linkedinProfile": "xyz789",
"mostRecentActivityTimestamp": ISO8601DateTime,
"mostRecentConflictOfInterestStatement": Coi,
"mostRecentEvent": Event,
"mostRecentOrganizationId": 987,
"name": "xyz789",
"notifications": NotificationConnection,
"orcid": "abc123",
"organizations": [Organization],
"organizationsWithEndorsementPrivileges": [
Organization
],
"profileImagePath": "xyz789",
"rank": 123,
"ranks": Ranks,
"role": "ADMIN",
"statsHash": Stats,
"twitterHandle": "abc123",
"url": "xyz789",
"username": "abc123"
}
LeaderboardUserConnection
Description
The connection type for LeaderboardUser.
Fields
| Field Name | Description |
|---|---|
edges - [LeaderboardUserEdge!]!
|
A list of edges. |
nodes - [LeaderboardUser!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [LeaderboardUserEdge],
"nodes": [LeaderboardUser],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
LeaderboardUserEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - LeaderboardUser
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": LeaderboardUser
}
LinkableDisease
LinkableFeature
LinkableTherapy
LinkableVariant
Example
{
"deprecated": false,
"feature": LinkableFeature,
"flagged": true,
"id": 987,
"link": "abc123",
"matchText": "abc123",
"name": "xyz789"
}
LinkableVariantType
LinkoutData
Fields
| Field Name | Description |
|---|---|
currentValue - ModeratedField!
|
|
diffValue - ModeratedFieldDiff!
|
|
name - String!
|
|
suggestedValue - ModeratedField!
|
Example
{
"currentValue": ObjectField,
"diffValue": ObjectFieldDiff,
"name": "xyz789",
"suggestedValue": ObjectField
}
ModerateAssertionActivity
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
id - Int!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"createdAt": ISO8601DateTime,
"events": [Event],
"id": 123,
"note": "abc123",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"subject": EventSubject,
"user": User,
"verbiage": "xyz789"
}
ModerateAssertionInput
Description
Autogenerated input type of ModerateAssertion
Fields
| Input Field | Description |
|---|---|
assertionId - Int!
|
ID of the Assertion to moderate |
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String
|
Comment explaining the moderation action. Required when rejecting. |
newStatus - EvidenceStatus!
|
The desired status of the Assertion |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"assertionId": 123,
"clientMutationId": "xyz789",
"comment": "xyz789",
"newStatus": "ACCEPTED",
"organizationId": 987
}
ModerateAssertionPayload
Description
Autogenerated return type of ModerateAssertion.
Fields
| Field Name | Description |
|---|---|
assertion - Assertion!
|
The moderated Assertion |
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
Example
{
"assertion": Assertion,
"clientMutationId": "abc123"
}
ModerateEvidenceItemActivity
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
id - Int!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"createdAt": ISO8601DateTime,
"events": [Event],
"id": 123,
"note": "abc123",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"subject": EventSubject,
"user": User,
"verbiage": "xyz789"
}
ModerateEvidenceItemInput
Description
Autogenerated input type of ModerateEvidenceItem
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String
|
Optional comment explaining the moderation action. Required if the new status is 'rejected'. |
evidenceItemId - Int!
|
ID of the Evidence Item to moderate |
newStatus - EvidenceStatus!
|
The desired status of the Evidence Item |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "abc123",
"comment": "xyz789",
"evidenceItemId": 987,
"newStatus": "ACCEPTED",
"organizationId": 987
}
ModerateEvidenceItemPayload
Description
Autogenerated return type of ModerateEvidenceItem.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
evidenceItem - EvidenceItem!
|
The moderated Evidence Item |
Example
{
"clientMutationId": "abc123",
"evidenceItem": EvidenceItem
}
ModeratedEntities
Description
Enumeration of all moderated CIViC entities.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSERTION"
ModeratedEntitiesTypeSearchInput
Fields
| Input Field | Description |
|---|---|
operator - EnumSearchOperator!
|
|
value - ModeratedEntities!
|
Example
{"operator": "EQ", "value": "ASSERTION"}
ModeratedField
Description
Fields that can have revisions can be either scalar values or complex objects
Types
| Union Types |
|---|
Example
ObjectField
ModeratedFieldDiff
Description
Fields that can have revisions can be either scalar values or complex objects
Types
| Union Types |
|---|
Example
ObjectFieldDiff
ModeratedInput
Description
Entity to moderate.
Fields
| Input Field | Description |
|---|---|
entityType - ModeratedEntities!
|
Type of moderated entity. |
id - Int!
|
ID of moderated entity. |
Example
{"entityType": "ASSERTION", "id": 123}
ModeratedObjectField
Example
{
"deleted": false,
"deprecated": true,
"displayName": "abc123",
"displayType": "abc123",
"entityType": "xyz789",
"feature": LinkableFeature,
"flagged": true,
"id": 123,
"link": "xyz789"
}
MolecularProfile
Fields
| Field Name | Description |
|---|---|
assertions - AssertionConnection!
|
The collection of assertions associated with this molecular profile. |
Arguments
|
|
comments - CommentConnection!
|
List and filter comments. |
Arguments
|
|
complexMolecularProfileCreationActivity - CreateComplexMolecularProfileActivity
|
|
complexMolecularProfileDeprecationActivity - DeprecateComplexMolecularProfileActivity
|
|
deprecated - Boolean!
|
|
deprecatedVariants - [VariantInterface!]!
|
|
deprecationReason - MolecularProfileDeprecationReason
|
|
description - String
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
evidenceCountsByStatus - EvidenceItemsByStatus!
|
|
evidenceCountsByType - EvidenceItemsByType!
|
|
evidenceItems - EvidenceItemConnection!
|
The collection of evidence items associated with this molecular profile. |
Arguments
|
|
flagged - Boolean!
|
|
flags - FlagConnection!
|
List and filter flags. |
Arguments
|
|
id - Int!
|
|
isComplex - Boolean!
|
|
isMultiVariant - Boolean!
|
|
lastAcceptedRevisionEvent - Event
|
|
lastCommentEvent - Event
|
|
lastSubmittedRevisionEvent - Event
|
|
link - String!
|
|
molecularProfileAliases - [String!]!
|
|
molecularProfileScore - Float!
|
|
name - String!
|
The human readable name of this profile, including gene and variant names. |
openRevisionCount - Int!
|
|
parsedName - [MolecularProfileSegment!]!
|
The profile name with its constituent parts as objects, suitable for building tags. |
rawName - String!
|
The profile name as stored, with ids rather than names. |
revisions - RevisionConnection!
|
List and filter revisions. |
Arguments
|
|
sources - [Source!]!
|
|
variantCreationActivity - CreateVariantActivity
|
|
variantDeprecationActivity - DeprecateVariantActivity
|
|
variants - [VariantInterface!]!
|
The collection of variants included in this molecular profile. Please note the name for their relation to each other. |
Example
{
"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": 987,
"isComplex": false,
"isMultiVariant": true,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"molecularProfileAliases": ["abc123"],
"molecularProfileScore": 123.45,
"name": "abc123",
"openRevisionCount": 987,
"parsedName": [Feature],
"rawName": "xyz789",
"revisions": RevisionConnection,
"sources": [Source],
"variantCreationActivity": CreateVariantActivity,
"variantDeprecationActivity": DeprecateVariantActivity,
"variants": [VariantInterface]
}
MolecularProfileAlias
Fields
| Field Name | Description |
|---|---|
name - String!
|
Example
{"name": "abc123"}
MolecularProfileComponent
Description
A taggable/linkable component of a molecular profile
Possible Types
| MolecularProfileComponent Types |
|---|
Example
{
"id": 987,
"link": "xyz789",
"name": "abc123"
}
MolecularProfileComponentInput
Fields
| Input Field | Description |
|---|---|
booleanOperator - BooleanOperator
|
Boolean operation used to combined the components into a Molecular Profile. |
complexComponents - [MolecularProfileComponentInput!]
|
One or more complex (multi-Variant) components that make up the Molecular Profile. |
variantComponents - [VariantComponent!]
|
One or more single Variants that make up the Molecular Profile. |
Example
{
"booleanOperator": "AND",
"complexComponents": [MolecularProfileComponentInput],
"variantComponents": [VariantComponent]
}
MolecularProfileConnection
Description
The connection type for MolecularProfile.
Fields
| Field Name | Description |
|---|---|
edges - [MolecularProfileEdge!]!
|
A list of edges. |
nodes - [MolecularProfile!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [MolecularProfileEdge],
"nodes": [MolecularProfile],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
MolecularProfileDeprecationReason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DUPLICATE"
MolecularProfileDeprecationReasonMutationInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DUPLICATE"
MolecularProfileEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - MolecularProfile
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": MolecularProfile
}
MolecularProfileFields
Description
Fields on a MolecularProfile that curators may propose revisions to.
Fields
| Input Field | Description |
|---|---|
aliases - [String!]!
|
List of aliases or alternate names for the MolecularProfile. |
description - NullableStringInput!
|
The MolecularProfile's description/summary text. |
sourceIds - [Int!]!
|
Source IDs cited by the MolecularProfile's summary. |
Example
{
"aliases": ["abc123"],
"description": NullableStringInput,
"sourceIds": [987]
}
MolecularProfileNamePreview
Fields
| Field Name | Description |
|---|---|
deprecatedVariants - [VariantInterface!]!
|
|
existingMolecularProfile - MolecularProfile
|
The already existing MP matching this name, if it exists |
segments - [MolecularProfileSegment!]!
|
Example
{
"deprecatedVariants": [VariantInterface],
"existingMolecularProfile": MolecularProfile,
"segments": [Feature]
}
MolecularProfileSearchFilter
Fields
| Input Field | Description |
|---|---|
alias - StringSearchInput
|
|
booleanOperator - BooleanOperator
|
|
creatingUser - UserSearchFilter
|
|
deprecatingUser - UserSearchFilter
|
|
description - StringSearchInput
|
|
evidenceItemsCount - IntSearchInput
|
|
hasAssertion - BooleanSearchInput
|
|
id - IntSearchInput
|
|
isFlagged - BooleanSearchInput
|
|
openRevisionCount - IntSearchInput
|
|
score - FloatSearchInput
|
|
source - SourceSearchFilter
|
|
subFilters - [MolecularProfileSearchFilter!]
|
Example
{
"alias": StringSearchInput,
"booleanOperator": "AND",
"creatingUser": UserSearchFilter,
"deprecatingUser": UserSearchFilter,
"description": StringSearchInput,
"evidenceItemsCount": IntSearchInput,
"hasAssertion": BooleanSearchInput,
"id": IntSearchInput,
"isFlagged": BooleanSearchInput,
"openRevisionCount": IntSearchInput,
"score": FloatSearchInput,
"source": SourceSearchFilter,
"subFilters": [MolecularProfileSearchFilter]
}
MolecularProfileSegment
Description
A segment of a molecular profile. Either a string representing a boolean operator or a tag component representing a gene or variant
Types
| Union Types |
|---|
Example
Feature
MolecularProfileTextSegment
Fields
| Field Name | Description |
|---|---|
text - String!
|
Example
{"text": "xyz789"}
MolecularProfilesSort
Fields
| Input Field | Description |
|---|---|
column - MolecularProfilesSortColumns!
|
Available columns for sorting |
direction - SortDirection!
|
Sort direction |
Example
{"column": "assertionCount", "direction": "ASC"}
MolecularProfilesSortColumns
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"assertionCount"
MyChemInfo
Fields
| Field Name | Description |
|---|---|
chebiDefinition - String
|
|
chebiId - String
|
|
chemblId - String
|
|
chemblMoleculeType - String
|
|
drugbankId - String
|
|
fdaEpcCodes - [FdaCode!]!
|
|
fdaMoaCodes - [FdaCode!]!
|
|
firstApproval - String
|
|
inchikey - String
|
|
indications - [String!]!
|
|
pharmgkbId - String
|
|
pubchemCid - String
|
|
rxnorm - String
|
Example
{
"chebiDefinition": "xyz789",
"chebiId": "abc123",
"chemblId": "xyz789",
"chemblMoleculeType": "xyz789",
"drugbankId": "xyz789",
"fdaEpcCodes": [FdaCode],
"fdaMoaCodes": [FdaCode],
"firstApproval": "abc123",
"inchikey": "abc123",
"indications": ["abc123"],
"pharmgkbId": "abc123",
"pubchemCid": "xyz789",
"rxnorm": "abc123"
}
MyDiseaseInfo
Fields
| Field Name | Description |
|---|---|
diseaseOntologyExactSynonyms - [String!]!
|
|
diseaseOntologyRelatedSynonyms - [String!]!
|
|
doDef - String
|
|
doDefCitations - [String!]!
|
|
icd10 - String
|
|
icdo - String
|
|
mesh - String
|
|
mondoDef - String
|
|
mondoId - String
|
|
ncit - [String!]!
|
|
omim - String
|
Example
{
"diseaseOntologyExactSynonyms": [
"abc123"
],
"diseaseOntologyRelatedSynonyms": [
"abc123"
],
"doDef": "xyz789",
"doDefCitations": ["abc123"],
"icd10": "xyz789",
"icdo": "xyz789",
"mesh": "abc123",
"mondoDef": "xyz789",
"mondoId": "abc123",
"ncit": ["xyz789"],
"omim": "abc123"
}
MyVariantInfo
Fields
| Field Name | Description |
|---|---|
caddConsequence - [String!]!
|
|
caddDetail - [String!]!
|
|
caddPhred - Float
|
|
caddScore - Float
|
|
clinvarClinicalSignificance - [String!]!
|
|
clinvarHgvsCoding - [String!]!
|
|
clinvarHgvsGenomic - [String!]!
|
|
clinvarHgvsNonCoding - [String!]!
|
|
clinvarHgvsProtein - [String!]!
|
|
clinvarId - Int
|
|
clinvarOmim - String
|
|
cosmicId - String
|
|
dbnsfpInterproDomain - [String!]!
|
|
dbsnpRsid - String
|
|
eglClass - String
|
|
eglHgvs - [String!]!
|
|
eglProtein - String
|
|
eglTranscript - String
|
|
exacAlleleCount - Int
|
|
exacAlleleFrequency - Float
|
|
exacAlleleNumber - Int
|
|
fathmmMklPrediction - String
|
|
fathmmMklScore - Float
|
|
fathmmPrediction - [String!]!
|
|
fathmmScore - [Float!]!
|
|
fitconsScore - Float
|
|
gerp - Float
|
|
gnomadExomeAlleleCount - Int
|
|
gnomadExomeAlleleFrequency - Float
|
|
gnomadExomeAlleleNumber - Int
|
|
gnomadExomeFilter - String
|
|
gnomadGenomeAlleleCount - Int
|
|
gnomadGenomeAlleleFrequency - Float
|
|
gnomadGenomeAlleleNumber - Int
|
|
gnomadGenomeFilter - String
|
|
lrtPrediction - String
|
|
lrtScore - Float
|
|
metalrPrediction - String
|
|
metalrScore - Float
|
|
metasvmPrediction - String
|
|
metasvmScore - Float
|
|
mutationassessorPrediction - [String!]!
|
|
mutationassessorScore - [Float!]!
|
|
mutationtasterPrediction - [String!]!
|
|
mutationtasterScore - [Float!]!
|
|
myVariantInfoId - String!
|
|
phastcons100way - Float
|
|
phastcons30way - Float
|
|
phyloP100way - Float
|
|
phyloP30way - Float
|
|
polyphen2HdivPrediction - [String!]!
|
|
polyphen2HdivScore - [Float!]!
|
|
polyphen2HvarPrediction - [String!]!
|
|
polyphen2HvarScore - [Float!]!
|
|
proveanPrediction - [String!]!
|
|
proveanScore - [Float!]!
|
|
revelScore - [Float!]
|
|
siftPrediction - [String!]!
|
|
siftScore - [Float!]!
|
|
siphy - Float
|
|
snpeffSnpEffect - [String!]!
|
|
snpeffSnpImpact - [String!]!
|
Example
{
"caddConsequence": ["xyz789"],
"caddDetail": ["xyz789"],
"caddPhred": 123.45,
"caddScore": 123.45,
"clinvarClinicalSignificance": ["xyz789"],
"clinvarHgvsCoding": ["xyz789"],
"clinvarHgvsGenomic": ["abc123"],
"clinvarHgvsNonCoding": ["xyz789"],
"clinvarHgvsProtein": ["xyz789"],
"clinvarId": 123,
"clinvarOmim": "abc123",
"cosmicId": "abc123",
"dbnsfpInterproDomain": ["abc123"],
"dbsnpRsid": "xyz789",
"eglClass": "xyz789",
"eglHgvs": ["xyz789"],
"eglProtein": "xyz789",
"eglTranscript": "xyz789",
"exacAlleleCount": 123,
"exacAlleleFrequency": 123.45,
"exacAlleleNumber": 987,
"fathmmMklPrediction": "xyz789",
"fathmmMklScore": 123.45,
"fathmmPrediction": ["abc123"],
"fathmmScore": [123.45],
"fitconsScore": 123.45,
"gerp": 987.65,
"gnomadExomeAlleleCount": 987,
"gnomadExomeAlleleFrequency": 987.65,
"gnomadExomeAlleleNumber": 987,
"gnomadExomeFilter": "xyz789",
"gnomadGenomeAlleleCount": 987,
"gnomadGenomeAlleleFrequency": 123.45,
"gnomadGenomeAlleleNumber": 987,
"gnomadGenomeFilter": "abc123",
"lrtPrediction": "abc123",
"lrtScore": 987.65,
"metalrPrediction": "xyz789",
"metalrScore": 987.65,
"metasvmPrediction": "xyz789",
"metasvmScore": 987.65,
"mutationassessorPrediction": ["abc123"],
"mutationassessorScore": [987.65],
"mutationtasterPrediction": ["xyz789"],
"mutationtasterScore": [123.45],
"myVariantInfoId": "xyz789",
"phastcons100way": 123.45,
"phastcons30way": 987.65,
"phyloP100way": 987.65,
"phyloP30way": 987.65,
"polyphen2HdivPrediction": ["xyz789"],
"polyphen2HdivScore": [987.65],
"polyphen2HvarPrediction": ["abc123"],
"polyphen2HvarScore": [987.65],
"proveanPrediction": ["abc123"],
"proveanScore": [123.45],
"revelScore": [987.65],
"siftPrediction": ["xyz789"],
"siftScore": [123.45],
"siphy": 123.45,
"snpeffSnpEffect": ["xyz789"],
"snpeffSnpImpact": ["xyz789"]
}
NccnGuideline
NcitDefinition
NcitDetails
Fields
| Field Name | Description |
|---|---|
definitions - [NcitDefinition!]!
|
|
synonyms - [NcitSynonym!]!
|
Example
{
"definitions": [NcitDefinition],
"synonyms": [NcitSynonym]
}
NcitSynonym
NewsItem
Fields
| Field Name | Description |
|---|---|
contentHtml - String
|
|
id - Int!
|
|
publishedAt - ISO8601DateTime
|
|
title - String!
|
Example
{
"contentHtml": "xyz789",
"id": 987,
"publishedAt": ISO8601DateTime,
"title": "abc123"
}
Notification
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
event - Event!
|
|
id - Int!
|
|
notifiedUser - User!
|
|
originatingUser - User!
|
|
seen - Boolean!
|
|
subscription - Subscription
|
|
type - NotificationReason!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"event": Event,
"id": 987,
"notifiedUser": User,
"originatingUser": User,
"seen": true,
"subscription": Subscription,
"type": "MENTION",
"updatedAt": ISO8601DateTime
}
NotificationConnection
Description
The connection type for Notification.
Fields
| Field Name | Description |
|---|---|
edges - [NotificationEdge!]!
|
A list of edges. |
eventTypes - [EventAction!]!
|
List of event types that have occurred on this entity. |
mentioningUsers - [User!]!
|
Users who have mentioned you. |
nodes - [Notification!]!
|
A list of nodes. |
notificationSubjects - [EventSubjectWithCount!]!
|
List of subjects of the notifications in the stream |
organizations - [Organization!]!
|
List of all organizations who are involved in this notification stream. |
originatingUsers - [User!]!
|
Users who have performed an action (other than a mention) that created a notification. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
unreadCount - Int!
|
Count of unread notifications |
Example
{
"edges": [NotificationEdge],
"eventTypes": ["ACCEPTED"],
"mentioningUsers": [User],
"nodes": [Notification],
"notificationSubjects": [EventSubjectWithCount],
"organizations": [Organization],
"originatingUsers": [User],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987,
"unreadCount": 987
}
NotificationEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - Notification
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": Notification
}
NotificationReason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"MENTION"
NullableAmpLevelTypeInput
Description
An input object that represents a field value that can be "unset" or changed to null. To change the field's value to null, pass unset as true, otherwise pass in the desired value as value. This is to work around two issues with the GraphQL spec: lack of support for unions in input types and the inability to have an input object argument be both required and nullable at the same time.
Example
{"unset": false, "value": "NA"}
NullableAreaOfExpertiseTypeInput
Description
An input object that represents a field value that can be "unset" or changed to null. To change the field's value to null, pass unset as true, otherwise pass in the desired value as value. This is to work around two issues with the GraphQL spec: lack of support for unions in input types and the inability to have an input object argument be both required and nullable at the same time.
Fields
| Input Field | Description |
|---|---|
unset - Boolean
|
Set to true if you wish to set the field's value to null. |
value - AreaOfExpertise
|
The desired value for the field. Mutually exclusive with unset. |
Example
{"unset": false, "value": "CLINICAL_SCIENTIST"}
NullableBooleanInput
Description
An input object that represents a field value that can be "unset" or changed to null. To change the field's value to null, pass unset as true, otherwise pass in the desired value as value. This is to work around two issues with the GraphQL spec: lack of support for unions in input types and the inability to have an input object argument be both required and nullable at the same time.
Example
{"unset": true, "value": true}
NullableIDInput
Description
An input object that represents a field value that can be "unset" or changed to null. To change the field's value to null, pass unset as true, otherwise pass in the desired value as value. This is to work around two issues with the GraphQL spec: lack of support for unions in input types and the inability to have an input object argument be both required and nullable at the same time.
Example
{"unset": false, "value": 4}
NullableIntInput
Description
An input object that represents a field value that can be "unset" or changed to null. To change the field's value to null, pass unset as true, otherwise pass in the desired value as value. This is to work around two issues with the GraphQL spec: lack of support for unions in input types and the inability to have an input object argument be both required and nullable at the same time.
Example
{"unset": false, "value": 123}
NullableStringInput
Description
An input object that represents a field value that can be "unset" or changed to null. To change the field's value to null, pass unset as true, otherwise pass in the desired value as value. This is to work around two issues with the GraphQL spec: lack of support for unions in input types and the inability to have an input object argument be both required and nullable at the same time.
Example
{"unset": false, "value": "xyz789"}
NullableTherapyInteractionTypeInput
Description
An input object that represents a field value that can be "unset" or changed to null. To change the field's value to null, pass unset as true, otherwise pass in the desired value as value. This is to work around two issues with the GraphQL spec: lack of support for unions in input types and the inability to have an input object argument be both required and nullable at the same time.
Fields
| Input Field | Description |
|---|---|
unset - Boolean
|
Set to true if you wish to set the field's value to null. |
value - TherapyInteraction
|
The desired value for the field. Mutually exclusive with unset. |
Example
{"unset": false, "value": "COMBINATION"}
ObjectField
Fields
| Field Name | Description |
|---|---|
objects - [ModeratedObjectField!]!
|
Example
{"objects": [ModeratedObjectField]}
ObjectFieldDiff
Fields
| Field Name | Description |
|---|---|
addedObjects - [ModeratedObjectField!]!
|
|
currentObjects - [ModeratedObjectField!]!
|
|
keptObjects - [ModeratedObjectField!]!
|
|
removedObjects - [ModeratedObjectField!]!
|
|
suggestedObjects - [ModeratedObjectField!]!
|
Example
{
"addedObjects": [ModeratedObjectField],
"currentObjects": [ModeratedObjectField],
"keptObjects": [ModeratedObjectField],
"removedObjects": [ModeratedObjectField],
"suggestedObjects": [ModeratedObjectField]
}
OntologyTermSearchInput
Fields
| Input Field | Description |
|---|---|
operator - OntologyTermSearchOperator!
|
|
value - String!
|
Example
{"operator": "EQ", "value": "abc123"}
OntologyTermSearchOperator
Values
| Enum Value | Description |
|---|---|
|
|
Equals |
|
|
Include the matched term and any sibling terms |
|
|
Include the matched term along with all ancestor terms recursively |
|
|
Include the matched term and any descendant terms recursively |
|
|
Include the matched term and any direct child terms |
|
|
Include the matched term and its direct parent terms |
|
|
Does not equal |
Example
"EQ"
Organization
Fields
| Field Name | Description |
|---|---|
canEndorse - Boolean!
|
|
description - String!
|
|
eventCount - Int!
|
|
events - EventConnection!
|
|
hasEndorsingSubgroups - Boolean!
|
|
id - Int!
|
|
isApprovedVcep - Boolean!
|
|
memberCount - Int!
|
|
members - UserConnection!
|
|
mostRecentActivityTimestamp - ISO8601DateTime
|
|
name - String!
|
|
orgAndSuborgsStatsHash - Stats!
|
|
orgStatsHash - Stats!
|
|
profileImagePath - String
|
|
Arguments
|
|
ranks - Ranks!
|
|
subGroups - [Organization!]!
|
|
url - String!
|
|
Example
{
"canEndorse": false,
"description": "abc123",
"eventCount": 123,
"events": EventConnection,
"hasEndorsingSubgroups": true,
"id": 987,
"isApprovedVcep": true,
"memberCount": 123,
"members": UserConnection,
"mostRecentActivityTimestamp": ISO8601DateTime,
"name": "abc123",
"orgAndSuborgsStatsHash": Stats,
"orgStatsHash": Stats,
"profileImagePath": "xyz789",
"ranks": Ranks,
"subGroups": [Organization],
"url": "abc123"
}
OrganizationConnection
Description
The connection type for Organization.
Fields
| Field Name | Description |
|---|---|
edges - [OrganizationEdge!]!
|
A list of edges. |
nodes - [Organization!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [OrganizationEdge],
"nodes": [Organization],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
OrganizationEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - Organization
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": Organization
}
OrganizationFilter
Description
Filter on organization id and whether or not to include the organization's subgroups
Example
{
"ids": [987],
"includeSubgroups": true,
"name": "xyz789"
}
OrganizationLeaderboards
Fields
| Field Name | Description |
|---|---|
commentsLeaderboard - LeaderboardOrganizationConnection!
|
|
Arguments
|
|
moderationLeaderboard - LeaderboardOrganizationConnection!
|
|
Arguments
|
|
revisionsLeaderboard - LeaderboardOrganizationConnection!
|
|
Arguments
|
|
submissionsLeaderboard - LeaderboardOrganizationConnection!
|
|
Arguments
|
|
Example
{
"commentsLeaderboard": LeaderboardOrganizationConnection,
"moderationLeaderboard": LeaderboardOrganizationConnection,
"revisionsLeaderboard": LeaderboardOrganizationConnection,
"submissionsLeaderboard": LeaderboardOrganizationConnection
}
OrganizationSort
Fields
| Input Field | Description |
|---|---|
column - OrganizationSortColumns!
|
Available columns for sorting |
direction - SortDirection!
|
Sort direction |
Example
{"column": "ACTIVITY_COUNT", "direction": "ASC"}
OrganizationSortColumns
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVITY_COUNT"
PageInfo
Description
Information about pagination in a connection.
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "abc123"
}
Phenotype
PhenotypeConnection
Description
The connection type for Phenotype.
Fields
| Field Name | Description |
|---|---|
edges - [PhenotypeEdge!]!
|
A list of edges. |
nodes - [Phenotype!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [PhenotypeEdge],
"nodes": [Phenotype],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
PhenotypeEdge
PhenotypePopover
Example
{
"assertionCount": 987,
"description": "xyz789",
"evidenceItemCount": 123,
"hpoId": "abc123",
"id": 987,
"link": "abc123",
"molecularProfileCount": 123,
"name": "abc123",
"url": "xyz789"
}
PhenotypeSearchFilter
Fields
| Input Field | Description |
|---|---|
booleanOperator - BooleanOperator
|
|
description - StringSearchInput
|
|
hpoId - OntologyTermSearchInput
|
|
id - IntSearchInput
|
|
name - StringSearchInput
|
|
subFilters - [PhenotypeSearchFilter!]
|
Example
{
"booleanOperator": "AND",
"description": StringSearchInput,
"hpoId": OntologyTermSearchInput,
"id": IntSearchInput,
"name": StringSearchInput,
"subFilters": [PhenotypeSearchFilter]
}
PhenotypeSort
Fields
| Input Field | Description |
|---|---|
column - PhenotypeSortColumns!
|
Available columns for sorting |
direction - SortDirection!
|
Sort direction |
Example
{"column": "ASSERTION_COUNT", "direction": "ASC"}
PhenotypeSortColumns
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSERTION_COUNT"
Ranks
Fields
| Field Name | Description |
|---|---|
commentsRank - LeaderboardRank
|
|
moderationRank - LeaderboardRank
|
|
revisionsRank - LeaderboardRank
|
|
submissionsRank - LeaderboardRank
|
Example
{
"commentsRank": LeaderboardRank,
"moderationRank": LeaderboardRank,
"revisionsRank": LeaderboardRank,
"submissionsRank": LeaderboardRank
}
ReadStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"READ"
ReferenceBuild
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"GRCH37"
RejectRevisionsActivity
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
id - Int!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
revisions - [Revision!]!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"createdAt": ISO8601DateTime,
"events": [Event],
"id": 123,
"note": "xyz789",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"revisions": [Revision],
"subject": EventSubject,
"user": User,
"verbiage": "abc123"
}
RejectRevisionsInput
Description
Autogenerated input type of RejectRevisions
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String!
|
Text explaining the reasoning for rejecting this Revision. Will be attached as a comment. |
ids - [Int!]
|
A list of IDs of the Revisions to reject. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
revisionSetId - Int
|
The ID of a revision set. |
Example
{
"clientMutationId": "abc123",
"comment": "abc123",
"ids": [987],
"organizationId": 123,
"revisionSetId": 987
}
RejectRevisionsPayload
Description
Autogenerated return type of RejectRevisions.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
revisions - [Revision!]!
|
The rejected Revisions. |
Example
{
"clientMutationId": "abc123",
"revisions": [Revision]
}
ResolveFlagActivity
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
flag - Flag!
|
|
id - Int!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"createdAt": ISO8601DateTime,
"events": [Event],
"flag": Flag,
"id": 123,
"note": "xyz789",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"subject": EventSubject,
"user": User,
"verbiage": "abc123"
}
ResolveFlagInput
Description
Autogenerated input type of ResolveFlag
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String!
|
Text describing the reason for resolving the flag. Will be attached as a comment. |
id - Int!
|
The ID of the flag to resolve. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "xyz789",
"comment": "xyz789",
"id": 123,
"organizationId": 987
}
ResolveFlagPayload
Revision
Fields
| Field Name | Description |
|---|---|
acceptanceActivity - AcceptRevisionsActivity
|
|
comments - CommentConnection!
|
List and filter comments. |
Arguments
|
|
createdAt - ISO8601DateTime!
|
|
creationActivity - SuggestRevisionSetActivity
|
|
currentValue - JSON
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
fieldName - String!
|
|
id - Int!
|
|
lastCommentEvent - Event
|
|
link - String!
|
|
linkoutData - LinkoutData!
|
|
name - String!
|
|
rejectionActivity - RejectRevisionsActivity
|
|
resolutionActivity - ActivityInterface
|
|
revisionSetId - Int!
|
|
status - RevisionStatus!
|
|
subject - EventSubject!
|
|
suggestedValue - JSON
|
|
supersedingActivity - AcceptRevisionsActivity
|
|
updatedAt - ISO8601DateTime!
|
|
Example
{
"acceptanceActivity": AcceptRevisionsActivity,
"comments": CommentConnection,
"createdAt": ISO8601DateTime,
"creationActivity": SuggestRevisionSetActivity,
"currentValue": {},
"events": EventConnection,
"fieldName": "xyz789",
"id": 123,
"lastCommentEvent": Event,
"link": "abc123",
"linkoutData": LinkoutData,
"name": "abc123",
"rejectionActivity": RejectRevisionsActivity,
"resolutionActivity": ActivityInterface,
"revisionSetId": 123,
"status": "ACCEPTED",
"subject": EventSubject,
"suggestedValue": {},
"supersedingActivity": AcceptRevisionsActivity,
"updatedAt": ISO8601DateTime
}
RevisionConnection
Description
The connection type for Revision.
Fields
| Field Name | Description |
|---|---|
edges - [RevisionEdge!]!
|
A list of edges. |
nodes - [Revision!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
revisedFieldNames - [FieldName!]!
|
List of all fields that have at least one revision. |
totalCount - Int!
|
The total number of records in this filtered collection. |
unfilteredCountForSubject - Int
|
When filtered on a subject, the total number of revisions for that subject, irregardless of other filters. Null when no subject provided. |
uniqueResolvers - [User!]!
|
List of all users that have accepted/rejected/superseded a revision to this entity. |
uniqueRevisors - [User!]!
|
List of all users that have submitted a revision to this entity. |
Example
{
"edges": [RevisionEdge],
"nodes": [Revision],
"pageCount": 987,
"pageInfo": PageInfo,
"revisedFieldNames": [FieldName],
"totalCount": 987,
"unfilteredCountForSubject": 123,
"uniqueResolvers": [User],
"uniqueRevisors": [User]
}
RevisionEdge
RevisionResult
Fields
| Field Name | Description |
|---|---|
fieldName - String!
|
Name of the field on the moderated entity that the Revision pertains to. |
id - Int!
|
ID of the Revision. |
newlyCreated - Boolean!
|
Was this Revision newly created as a result of this request? |
revisionSetId - Int!
|
An identifier that can be used to group Revisions proposed at the same time. |
Example
{
"fieldName": "xyz789",
"id": 123,
"newlyCreated": true,
"revisionSetId": 123
}
RevisionSearchFilter
Fields
| Input Field | Description |
|---|---|
booleanOperator - BooleanOperator
|
|
createdAt - DateSearchInput
|
|
creatingUser - UserSearchFilter
|
|
fieldName - StringSearchInput
|
|
moderatingUser - UserSearchFilter
|
|
status - RevisionStatusSearchInput
|
|
subFilters - [RevisionSearchFilter!]
|
|
subjectId - IntSearchInput
|
|
subjectType - ModeratedEntitiesTypeSearchInput
|
Example
{
"booleanOperator": "AND",
"createdAt": DateSearchInput,
"creatingUser": UserSearchFilter,
"fieldName": StringSearchInput,
"moderatingUser": UserSearchFilter,
"status": RevisionStatusSearchInput,
"subFilters": [RevisionSearchFilter],
"subjectId": IntSearchInput,
"subjectType": ModeratedEntitiesTypeSearchInput
}
RevisionSet
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
displayName - String!
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
id - Int!
|
|
link - String!
|
|
name - String!
|
|
revisions - [Revision!]!
|
|
updatedAt - ISO8601DateTime!
|
|
Example
{
"createdAt": ISO8601DateTime,
"displayName": "xyz789",
"events": EventConnection,
"id": 123,
"link": "xyz789",
"name": "xyz789",
"revisions": [Revision],
"updatedAt": ISO8601DateTime
}
RevisionStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCEPTED"
RevisionStatusSearchInput
Fields
| Input Field | Description |
|---|---|
operator - EnumSearchOperator!
|
|
value - RevisionStatus!
|
Example
{"operator": "EQ", "value": "ACCEPTED"}
RevokeApiKeyInput
RevokeApiKeyPayload
Description
Autogenerated return type of RevokeApiKey.
Example
{
"clientMutationId": "abc123",
"success": false
}
RevokeEndorsementActivity
Fields
| Field Name | Description |
|---|---|
assertion - Assertion!
|
|
createdAt - ISO8601DateTime!
|
|
endorsement - Endorsement!
|
|
events - [Event!]!
|
|
id - Int!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"assertion": Assertion,
"createdAt": ISO8601DateTime,
"endorsement": Endorsement,
"events": [Event],
"id": 987,
"note": "xyz789",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"subject": EventSubject,
"user": User,
"verbiage": "xyz789"
}
RevokeEndorsementInput
Description
Autogenerated input type of RevokeEndorsement
Fields
| Input Field | Description |
|---|---|
assertionId - Int!
|
ID of the Assertion |
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String!
|
Text describing the reason for revoking this Endorsement. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"assertionId": 987,
"clientMutationId": "abc123",
"comment": "abc123",
"organizationId": 987
}
RevokeEndorsementPayload
Description
Autogenerated return type of RevokeEndorsement.
Fields
| Field Name | Description |
|---|---|
assertion - Assertion!
|
The newly unendorsed Assertion |
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
Example
{
"assertion": Assertion,
"clientMutationId": "abc123"
}
ScalarField
Fields
| Field Name | Description |
|---|---|
value - String
|
Example
{"value": "xyz789"}
ScalarFieldDiff
SearchResult
Fields
| Field Name | Description |
|---|---|
id - Int!
|
|
matchingText - String!
|
|
name - String!
|
|
resultType - SearchableEntities!
|
Example
{
"id": 987,
"matchingText": "abc123",
"name": "xyz789",
"resultType": "ASSERTION"
}
SearchableEntities
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSERTION"
SortDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
Source
Fields
| Field Name | Description |
|---|---|
abstract - String
|
|
ascoAbstractId - Int
|
|
authorString - String
|
|
citation - String
|
|
citationId - String!
|
|
clinicalTrials - [ClinicalTrial!]
|
|
comments - CommentConnection!
|
List and filter comments. |
Arguments
|
|
deprecated - Boolean!
|
|
displayType - String!
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
fullJournalTitle - String
|
|
fullyCurated - Boolean!
|
|
id - Int!
|
|
journal - String
|
|
lastCommentEvent - Event
|
|
link - String!
|
|
name - String!
|
|
openAccess - Boolean!
|
|
pmcId - String
|
|
publicationDate - String
|
|
publicationDay - Int
|
|
publicationMonth - Int
|
|
publicationYear - Int
|
|
retracted - Boolean!
|
|
retractionDate - ISO8601DateTime
|
|
retractionNature - String
|
|
retractionReasons - String
|
|
sourceType - SourceSource!
|
|
sourceUrl - String
|
|
title - String
|
|
Example
{
"abstract": "abc123",
"ascoAbstractId": 987,
"authorString": "abc123",
"citation": "xyz789",
"citationId": "xyz789",
"clinicalTrials": [ClinicalTrial],
"comments": CommentConnection,
"deprecated": false,
"displayType": "abc123",
"events": EventConnection,
"fullJournalTitle": "abc123",
"fullyCurated": true,
"id": 123,
"journal": "abc123",
"lastCommentEvent": Event,
"link": "abc123",
"name": "xyz789",
"openAccess": false,
"pmcId": "abc123",
"publicationDate": "xyz789",
"publicationDay": 987,
"publicationMonth": 987,
"publicationYear": 987,
"retracted": true,
"retractionDate": ISO8601DateTime,
"retractionNature": "abc123",
"retractionReasons": "xyz789",
"sourceType": "ASCO",
"sourceUrl": "abc123",
"title": "xyz789"
}
SourceConnection
Description
The connection type for Source.
Fields
| Field Name | Description |
|---|---|
edges - [SourceEdge!]!
|
A list of edges. |
nodes - [Source!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [SourceEdge],
"nodes": [Source],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
SourceEdge
SourcePopover
Fields
| Field Name | Description |
|---|---|
abstract - String
|
|
ascoAbstractId - Int
|
|
authorString - String
|
|
citation - String
|
|
citationId - String!
|
|
clinicalTrials - [ClinicalTrial!]
|
|
comments - CommentConnection!
|
List and filter comments. |
Arguments
|
|
deprecated - Boolean!
|
|
displayType - String!
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
evidenceItemCount - Int!
|
|
fullJournalTitle - String
|
|
fullyCurated - Boolean!
|
|
id - Int!
|
|
journal - String
|
|
lastCommentEvent - Event
|
|
link - String!
|
|
name - String!
|
|
openAccess - Boolean!
|
|
pmcId - String
|
|
publicationDate - String
|
|
publicationDay - Int
|
|
publicationMonth - Int
|
|
publicationYear - Int
|
|
retracted - Boolean!
|
|
retractionDate - ISO8601DateTime
|
|
retractionNature - String
|
|
retractionReasons - String
|
|
sourceType - SourceSource!
|
|
sourceUrl - String
|
|
title - String
|
|
Example
{
"abstract": "abc123",
"ascoAbstractId": 987,
"authorString": "xyz789",
"citation": "abc123",
"citationId": "xyz789",
"clinicalTrials": [ClinicalTrial],
"comments": CommentConnection,
"deprecated": false,
"displayType": "abc123",
"events": EventConnection,
"evidenceItemCount": 987,
"fullJournalTitle": "abc123",
"fullyCurated": true,
"id": 987,
"journal": "xyz789",
"lastCommentEvent": Event,
"link": "abc123",
"name": "xyz789",
"openAccess": true,
"pmcId": "xyz789",
"publicationDate": "xyz789",
"publicationDay": 123,
"publicationMonth": 123,
"publicationYear": 123,
"retracted": false,
"retractionDate": ISO8601DateTime,
"retractionNature": "xyz789",
"retractionReasons": "abc123",
"sourceType": "ASCO",
"sourceUrl": "xyz789",
"title": "abc123"
}
SourceSearchFilter
Fields
| Input Field | Description |
|---|---|
abstract - StringSearchInput
|
|
booleanOperator - BooleanOperator
|
|
citation - StringSearchInput
|
|
citationId - StringSearchInput
|
|
id - IntSearchInput
|
|
isRetracted - BooleanSearchInput
|
|
journal - StringSearchInput
|
|
sourceType - SourceSourceTypeSearchInput
|
|
subFilters - [SourceSearchFilter!]
|
|
title - StringSearchInput
|
Example
{
"abstract": StringSearchInput,
"booleanOperator": "AND",
"citation": StringSearchInput,
"citationId": StringSearchInput,
"id": IntSearchInput,
"isRetracted": BooleanSearchInput,
"journal": StringSearchInput,
"sourceType": SourceSourceTypeSearchInput,
"subFilters": [SourceSearchFilter],
"title": StringSearchInput
}
SourceSource
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ASCO"
SourceSourceTypeSearchInput
Fields
| Input Field | Description |
|---|---|
operator - EnumSearchOperator!
|
|
value - SourceSource!
|
Example
{"operator": "EQ", "value": "ASCO"}
SourceStub
Fields
| Field Name | Description |
|---|---|
citationId - Int!
|
|
id - Int!
|
|
sourceType - SourceSource!
|
Example
{"citationId": 123, "id": 123, "sourceType": "ASCO"}
SourceSuggestion
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
creationActivity - SuggestSourceActivity!
|
|
disease - Disease
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
id - Int!
|
|
initialComment - String!
|
|
lastStatusUpdateActivity - UpdateSourceSuggestionStatusActivity
|
|
link - String!
|
|
molecularProfile - MolecularProfile
|
|
name - String!
|
|
reason - String
|
|
source - Source
|
|
status - SourceSuggestionStatus!
|
|
user - User
|
|
Example
{
"createdAt": ISO8601DateTime,
"creationActivity": SuggestSourceActivity,
"disease": Disease,
"events": EventConnection,
"id": 987,
"initialComment": "xyz789",
"lastStatusUpdateActivity": UpdateSourceSuggestionStatusActivity,
"link": "abc123",
"molecularProfile": MolecularProfile,
"name": "xyz789",
"reason": "abc123",
"source": Source,
"status": "CURATED",
"user": User
}
SourceSuggestionConnection
Description
The connection type for SourceSuggestion.
Fields
| Field Name | Description |
|---|---|
edges - [SourceSuggestionEdge!]!
|
A list of edges. |
filteredCount - Int!
|
The total number of records in this set. |
lastUpdated - ISO8601DateTime!
|
The last time the data in this browse table was refreshed |
nodes - [SourceSuggestion!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records of this type, regardless of any filtering. |
Example
{
"edges": [SourceSuggestionEdge],
"filteredCount": 987,
"lastUpdated": ISO8601DateTime,
"nodes": [SourceSuggestion],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
SourceSuggestionEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - SourceSuggestion
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": SourceSuggestion
}
SourceSuggestionStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CURATED"
SourceSuggestionValues
Fields
| Field Name | Description |
|---|---|
disease - Disease
|
|
molecularProfile - MolecularProfile
|
|
source - Source
|
Example
{
"disease": Disease,
"molecularProfile": MolecularProfile,
"source": Source
}
SourceSuggestionsSort
Fields
| Input Field | Description |
|---|---|
column - SourceSuggestionsSortColumns!
|
Available columns for sorting |
direction - SortDirection!
|
Sort direction |
Example
{"column": "CITATION", "direction": "ASC"}
SourceSuggestionsSortColumns
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CITATION"
SourcesSort
Fields
| Input Field | Description |
|---|---|
column - SourcesSortColumns!
|
Available columns for sorting |
direction - SortDirection!
|
Sort direction |
Example
{"column": "AUTHORS", "direction": "ASC"}
SourcesSortColumns
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AUTHORS"
Stats
Example
{
"acceptedAssertions": 987,
"acceptedEvidenceItems": 987,
"appliedRevisions": 123,
"comments": 123,
"revisions": 987,
"submittedAssertions": 987,
"submittedEvidenceItems": 123,
"suggestedSources": 987
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
StringSearchInput
Fields
| Input Field | Description |
|---|---|
operator - StringSearchOperator!
|
|
value - String!
|
Example
{"operator": "CONTAINS", "value": "xyz789"}
StringSearchOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONTAINS"
SubmitAssertionActivity
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
id - Int!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"createdAt": ISO8601DateTime,
"events": [Event],
"id": 987,
"note": "xyz789",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"subject": EventSubject,
"user": User,
"verbiage": "abc123"
}
SubmitAssertionInput
Description
Autogenerated input type of SubmitAssertion
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String
|
Text describing any further context or details about your proposed Assertion. Will be attached as a comment. |
fields - AssertionFields!
|
The desired state of the Assertion's editable fields. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "abc123",
"comment": "abc123",
"fields": AssertionFields,
"organizationId": 987
}
SubmitAssertionPayload
Description
Autogenerated return type of SubmitAssertion.
Fields
| Field Name | Description |
|---|---|
assertion - Assertion!
|
The newly created Assertion |
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
Example
{
"assertion": Assertion,
"clientMutationId": "abc123"
}
SubmitEvidenceItemActivity
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
id - Int!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"createdAt": ISO8601DateTime,
"events": [Event],
"id": 987,
"note": "abc123",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"subject": EventSubject,
"user": User,
"verbiage": "abc123"
}
SubmitEvidenceItemInput
Description
Autogenerated input type of SubmitEvidenceItem
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String
|
Text describing any further context or details about your proposed EvidenceItem. Will be attached as a comment. |
fields - EvidenceItemFields!
|
The desired state of the EvidenceItems's editable fields. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "xyz789",
"comment": "xyz789",
"fields": EvidenceItemFields,
"organizationId": 123
}
SubmitEvidenceItemPayload
Description
Autogenerated return type of SubmitEvidenceItem.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
evidenceItem - EvidenceItem!
|
The newly created EvidenceItem |
Example
{
"clientMutationId": "xyz789",
"evidenceItem": EvidenceItem
}
SubmitVariantGroupInput
Description
Autogenerated input type of SubmitVariantGroup
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
description - String
|
A description of the variant group. |
name - String!
|
The name of the disease. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
sourceIds - [Int!]!
|
A list of CIViC source IDs to associate with the variant group. |
variantIds - [Int!]!
|
A list of CIViC variant IDs to add to the variant group. |
Example
{
"clientMutationId": "abc123",
"description": "xyz789",
"name": "xyz789",
"organizationId": 987,
"sourceIds": [987],
"variantIds": [987]
}
SubmitVariantGroupPayload
Description
Autogenerated return type of SubmitVariantGroup.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
variantGroup - VariantGroup!
|
The newly created Variant Group |
Example
{
"clientMutationId": "xyz789",
"variantGroup": VariantGroup
}
Subscribable
Fields
| Field Name | Description |
|---|---|
entityType - SubscribableEntities!
|
|
id - Int!
|
Example
{"entityType": "ASSERTION", "id": 123}
SubscribableEntities
Description
Enumeration of all subscribable CIViC entities.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSERTION"
SubscribableInput
Description
Entity to subscribe to.
Fields
| Input Field | Description |
|---|---|
entityType - SubscribableEntities!
|
Type of subscribable entity. |
id - Int!
|
ID of subscribable entity. |
Example
{"entityType": "ASSERTION", "id": 987}
SubscribableQueryInput
Description
Entity to subscribe to.
Fields
| Input Field | Description |
|---|---|
entityType - SubscribableEntities!
|
Type of subscribable entity. |
id - Int!
|
ID of subscribable entity. |
includeChildren - Boolean
|
Include child entities of the requested subscribable. Default = false |
Example
{"entityType": "ASSERTION", "id": 123, "includeChildren": true}
SubscribeInput
Description
Autogenerated input type of Subscribe
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
subscribables - [SubscribableInput!]!
|
A list of one or more entities to subscribe to, each identified by its ID and type. |
subscribeToChildren - Boolean
|
Do you want to subscribe to related child entities of the subscribed entities? IE: If you subscribe to a Gene, do you want to receive notifications for its Variants as well?. Default = false |
Example
{
"clientMutationId": "xyz789",
"subscribables": [SubscribableInput],
"subscribeToChildren": false
}
SubscribePayload
Description
Autogenerated return type of Subscribe.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
subscriptions - [Subscription!]!
|
The newly created subscription objects. |
Example
{
"clientMutationId": "xyz789",
"subscriptions": [Subscription]
}
SuggestAssertionRevisionInput
Description
Autogenerated input type of SuggestAssertionRevision
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String!
|
Text describing the reason for the change. Will be attached to the Revision as a comment. |
fields - AssertionFields!
|
The desired state of the Assertion's editable fields if the change were applied. If no change is desired for a particular field, pass in the current value of that field. |
id - Int!
|
The ID of the Assertion to suggest a Revision to. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "xyz789",
"comment": "xyz789",
"fields": AssertionFields,
"id": 987,
"organizationId": 987
}
SuggestAssertionRevisionPayload
Description
Autogenerated return type of SuggestAssertionRevision.
Fields
| Field Name | Description |
|---|---|
assertion - Assertion!
|
The Assertion the user has proposed a Revision to. |
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
results - [RevisionResult!]!
|
A list of Revisions generated as a result of this suggestion. If an existing Revision exactly matches the proposed one, it will be returned instead. This is indicated via the 'newlyCreated' Boolean. Revisions are stored on a per-field basis. The changesetId can be used to group Revisions proposed at the same time. |
Example
{
"assertion": Assertion,
"clientMutationId": "abc123",
"results": [RevisionResult]
}
SuggestEvidenceItemRevisionInput
Description
Autogenerated input type of SuggestEvidenceItemRevision
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String!
|
Text describing the reason for the change. Will be attached to the Revision as a comment. |
fields - EvidenceItemFields!
|
The desired state of the EvidenceItems's editable fields if the change were applied. If no change is desired for a particular field, pass in the current value of that field. |
id - Int!
|
The ID of the EvidenceItem to suggest a Revision to. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "abc123",
"comment": "abc123",
"fields": EvidenceItemFields,
"id": 123,
"organizationId": 123
}
SuggestEvidenceItemRevisionPayload
Description
Autogenerated return type of SuggestEvidenceItemRevision.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
evidenceItem - EvidenceItem!
|
The EvidenceItem the user has proposed a Revision to. |
results - [RevisionResult!]!
|
A list of Revisions generated as a result of this suggestion. If an existing Revision exactly matches the proposed one, it will be returned instead. This is indicated via the 'newlyCreated' Boolean. Revisions are stored on a per-field basis. The changesetId can be used to group Revisions proposed at the same time. |
Example
{
"clientMutationId": "xyz789",
"evidenceItem": EvidenceItem,
"results": [RevisionResult]
}
SuggestFactorRevisionInput
Description
Autogenerated input type of SuggestFactorRevision
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String!
|
Text describing the reason for the change. Will be attached to the Revision as a comment. |
fields - FactorFields!
|
The desired state of the Factors's editable fields if the change were applied. If no change is desired for a particular field, pass in the current value of that field. |
id - Int!
|
The ID of the Feature of instance type "Factor" to suggest a Revision to. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "xyz789",
"comment": "xyz789",
"fields": FactorFields,
"id": 987,
"organizationId": 123
}
SuggestFactorRevisionPayload
Description
Autogenerated return type of SuggestFactorRevision.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
factor - Factor!
|
The Factor the user has proposed a Revision to. |
results - [RevisionResult!]!
|
A list of Revisions generated as a result of this suggestion. If an existing Revision exactly matches the proposed one, it will be returned instead. This is indicated via the 'newlyCreated' Boolean. Revisions are stored on a per-field basis. The changesetId can be used to group Revisions proposed at the same time. |
Example
{
"clientMutationId": "xyz789",
"factor": Factor,
"results": [RevisionResult]
}
SuggestFactorVariantRevisionInput
Description
Autogenerated input type of SuggestFactorVariantRevision
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String
|
Text describing the reason for the change. Will be attached to the Revision as a comment. |
fields - FactorVariantFields!
|
The desired state of the Variant's editable fields if the change were applied. If no change is desired for a particular field, pass in the current value of that field. |
id - Int!
|
The ID of the Variant to suggest a Revision to. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "xyz789",
"comment": "abc123",
"fields": FactorVariantFields,
"id": 987,
"organizationId": 123
}
SuggestFactorVariantRevisionPayload
Description
Autogenerated return type of SuggestFactorVariantRevision.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
results - [RevisionResult!]!
|
A list of Revisions generated as a result of this suggestion. If an existing Revision exactly matches the proposed one, it will be returned instead. This is indicated via the 'newlyCreated' Boolean. Revisions are stored on a per-field basis. The changesetId can be used to group Revisions proposed at the same time. |
variant - FactorVariant!
|
The Variant the user has proposed a Revision to. |
Example
{
"clientMutationId": "abc123",
"results": [RevisionResult],
"variant": FactorVariant
}
SuggestFusionRevisionInput
Description
Autogenerated input type of SuggestFusionRevision
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String!
|
Text describing the reason for the change. Will be attached to the Revision as a comment. |
fields - FusionFields!
|
The desired state of the Fusion's editable fields if the change were applied. If no change is desired for a particular field, pass in the current value of that field. |
id - Int!
|
The ID of the Feature of instance type "Fusion" to suggest a Revision to. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "xyz789",
"comment": "xyz789",
"fields": FusionFields,
"id": 123,
"organizationId": 123
}
SuggestFusionRevisionPayload
Description
Autogenerated return type of SuggestFusionRevision.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
fusion - Fusion!
|
The Fusion the user has proposed a Revision to. |
results - [RevisionResult!]!
|
A list of Revisions generated as a result of this suggestion. If an existing Revision exactly matches the proposed one, it will be returned instead. This is indicated via the 'newlyCreated' Boolean. Revisions are stored on a per-field basis. The changesetId can be used to group Revisions proposed at the same time. |
Example
{
"clientMutationId": "abc123",
"fusion": Fusion,
"results": [RevisionResult]
}
SuggestFusionVariantRevisionInput
Description
Autogenerated input type of SuggestFusionVariantRevision
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String
|
Text describing the reason for the change. Will be attached to the Revision as a comment. |
fields - FusionVariantFields!
|
The desired state of the Variant's editable fields if the change were applied. If no change is desired for a particular field, pass in the current value of that field. |
id - Int!
|
The ID of the Variant to suggest a Revision to. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "abc123",
"comment": "abc123",
"fields": FusionVariantFields,
"id": 987,
"organizationId": 987
}
SuggestFusionVariantRevisionPayload
Description
Autogenerated return type of SuggestFusionVariantRevision.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
results - [RevisionResult!]!
|
A list of Revisions generated as a result of this suggestion. If an existing Revision exactly matches the proposed one, it will be returned instead. This is indicated via the 'newlyCreated' Boolean. Revisions are stored on a per-field basis. The changesetId can be used to group Revisions proposed at the same time. |
variant - FusionVariant!
|
The Variant the user has proposed a Revision to. |
Example
{
"clientMutationId": "abc123",
"results": [RevisionResult],
"variant": FusionVariant
}
SuggestGeneRevisionInput
Description
Autogenerated input type of SuggestGeneRevision
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String!
|
Text describing the reason for the change. Will be attached to the Revision as a comment. |
fields - GeneFields!
|
The desired state of the Gene's editable fields if the change were applied. If no change is desired for a particular field, pass in the current value of that field. |
id - Int!
|
The ID of the Feature of instance type "Gene" to suggest a Revision to. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "xyz789",
"comment": "xyz789",
"fields": GeneFields,
"id": 987,
"organizationId": 987
}
SuggestGeneRevisionPayload
Description
Autogenerated return type of SuggestGeneRevision.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
gene - Gene!
|
The Gene the user has proposed a Revision to. |
results - [RevisionResult!]!
|
A list of Revisions generated as a result of this suggestion. If an existing Revision exactly matches the proposed one, it will be returned instead. This is indicated via the 'newlyCreated' Boolean. Revisions are stored on a per-field basis. The changesetId can be used to group Revisions proposed at the same time. |
Example
{
"clientMutationId": "xyz789",
"gene": Gene,
"results": [RevisionResult]
}
SuggestGeneVariantRevisionInput
Description
Autogenerated input type of SuggestGeneVariantRevision
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String
|
Text describing the reason for the change. Will be attached to the Revision as a comment. |
fields - GeneVariantFields!
|
The desired state of the Variant's editable fields if the change were applied. If no change is desired for a particular field, pass in the current value of that field. |
id - Int!
|
The ID of the Variant to suggest a Revision to. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "xyz789",
"comment": "abc123",
"fields": GeneVariantFields,
"id": 987,
"organizationId": 123
}
SuggestGeneVariantRevisionPayload
Description
Autogenerated return type of SuggestGeneVariantRevision.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
results - [RevisionResult!]!
|
A list of Revisions generated as a result of this suggestion. If an existing Revision exactly matches the proposed one, it will be returned instead. This is indicated via the 'newlyCreated' Boolean. Revisions are stored on a per-field basis. The changesetId can be used to group Revisions proposed at the same time. |
variant - GeneVariant!
|
The Variant the user has proposed a Revision to. |
Example
{
"clientMutationId": "abc123",
"results": [RevisionResult],
"variant": GeneVariant
}
SuggestMolecularProfileRevisionInput
Description
Autogenerated input type of SuggestMolecularProfileRevision
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String!
|
Text describing the reason for the change. Will be attached to the Revision as a comment. |
fields - MolecularProfileFields!
|
The desired state of the Molecular Profile's editable fields if the change were applied. If no change is desired for a particular field, pass in the current value of that field. |
id - Int!
|
The ID of the MolecularProfile to suggest a Revision to. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "abc123",
"comment": "abc123",
"fields": MolecularProfileFields,
"id": 987,
"organizationId": 123
}
SuggestMolecularProfileRevisionPayload
Description
Autogenerated return type of SuggestMolecularProfileRevision.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
molecularProfile - MolecularProfile!
|
The MolecularProfile the user has proposed a Revision to. |
results - [RevisionResult!]!
|
A list of Revisions generated as a result of this suggestion. If an existing Revision exactly matches the proposed one, it will be returned instead. This is indicated via the 'newlyCreated' Boolean. Revisions are stored on a per-field basis. The changesetId can be used to group Revisions proposed at the same time. |
Example
{
"clientMutationId": "xyz789",
"molecularProfile": MolecularProfile,
"results": [RevisionResult]
}
SuggestRevisionSetActivity
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
id - Int!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
revisionSet - RevisionSet!
|
|
revisions - [Revision!]!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"createdAt": ISO8601DateTime,
"events": [Event],
"id": 123,
"note": "abc123",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"revisionSet": RevisionSet,
"revisions": [Revision],
"subject": EventSubject,
"user": User,
"verbiage": "xyz789"
}
SuggestSourceActivity
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
id - Int!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
sourceSuggestion - SourceSuggestion!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"createdAt": ISO8601DateTime,
"events": [Event],
"id": 987,
"note": "xyz789",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"sourceSuggestion": SourceSuggestion,
"subject": EventSubject,
"user": User,
"verbiage": "abc123"
}
SuggestSourceInput
Description
Autogenerated input type of SuggestSource
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String!
|
Text explaining why this source should be curated for CIViC evidence. |
diseaseId - Int
|
Internal CIViC ID for the applicable disease, if any. |
molecularProfileId - Int
|
Internal CIViC ID for the applicable molecular profile, if any. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
sourceId - Int!
|
Internal CIViC ID for the source to suggest. Use the AddRemoteCitation mutation to populate this if needed. |
Example
{
"clientMutationId": "xyz789",
"comment": "xyz789",
"diseaseId": 987,
"molecularProfileId": 123,
"organizationId": 123,
"sourceId": 987
}
SuggestSourcePayload
Description
Autogenerated return type of SuggestSource.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
sourceSuggestion - SourceSuggestion!
|
The newly created Source Suggestion |
Example
{
"clientMutationId": "abc123",
"sourceSuggestion": SourceSuggestion
}
SuggestVariantGroupRevisionInput
Description
Autogenerated input type of SuggestVariantGroupRevision
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
comment - String!
|
Text describing the reason for the change. Will be attached to the Revision as a comment. |
fields - VariantGroupFields!
|
The desired state of the VariantGroup's editable fields if the change were applied. If no change is desired for a particular field, pass in the current value of that field. |
id - Int!
|
The ID of the VariantGroup you are suggesting a Revision to |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
Example
{
"clientMutationId": "xyz789",
"comment": "xyz789",
"fields": VariantGroupFields,
"id": 123,
"organizationId": 123
}
SuggestVariantGroupRevisionPayload
Description
Autogenerated return type of SuggestVariantGroupRevision.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
results - [RevisionResult!]!
|
A list of Revisions generated as a result of this suggestion. If an existing Revision exactly matches the proposed one, it will be returned instead. This is indicated via the 'newlyCreated' Boolean. Revisions are stored on a per-field basis. The changesetId can be used to group Revisions proposed at the same time. |
variantGroup - VariantGroup!
|
The VariantGroup the user has proposed a Revision to. |
Example
{
"clientMutationId": "xyz789",
"results": [RevisionResult],
"variantGroup": VariantGroup
}
TaggableEntity
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSERTION"
TaggableEntityInput
Description
Mentioned entity to filter comments on.
Fields
| Input Field | Description |
|---|---|
entityType - TaggableEntity!
|
The type of the entity |
id - Int!
|
ID of the mentioned entity |
Example
{"entityType": "ASSERTION", "id": 123}
Therapy
Fields
| Field Name | Description |
|---|---|
deprecated - Boolean!
|
|
id - Int!
|
|
link - String!
|
|
myChemInfo - MyChemInfo
|
|
name - String!
|
|
ncitId - String
|
|
therapyAliases - [String!]!
|
|
therapyUrl - String
|
Example
{
"deprecated": true,
"id": 123,
"link": "abc123",
"myChemInfo": MyChemInfo,
"name": "abc123",
"ncitId": "xyz789",
"therapyAliases": ["xyz789"],
"therapyUrl": "abc123"
}
TherapyConnection
Description
The connection type for Therapy.
Fields
| Field Name | Description |
|---|---|
edges - [TherapyEdge!]!
|
A list of edges. |
nodes - [Therapy!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [TherapyEdge],
"nodes": [Therapy],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 123
}
TherapyEdge
TherapyInteraction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMBINATION"
TherapyInteractionTypeSearchInput
Fields
| Input Field | Description |
|---|---|
operator - EnumSearchOperator!
|
|
value - TherapyInteraction!
|
Example
{"operator": "EQ", "value": "COMBINATION"}
TherapyPopover
Example
{
"assertionCount": 123,
"deprecated": true,
"evidenceItemCount": 123,
"id": 123,
"link": "xyz789",
"molecularProfileCount": 987,
"myChemInfo": MyChemInfo,
"name": "xyz789",
"ncitId": "xyz789",
"therapyAliases": ["abc123"],
"therapyUrl": "abc123"
}
TherapySearchFilter
Fields
| Input Field | Description |
|---|---|
booleanOperator - BooleanOperator
|
|
deprecated - BooleanSearchInput
|
|
id - IntSearchInput
|
|
name - StringSearchInput
|
|
ncitId - OntologyTermSearchInput
|
|
subFilters - [TherapySearchFilter!]
|
|
therapyAliases - StringSearchInput
|
Example
{
"booleanOperator": "AND",
"deprecated": BooleanSearchInput,
"id": IntSearchInput,
"name": StringSearchInput,
"ncitId": OntologyTermSearchInput,
"subFilters": [TherapySearchFilter],
"therapyAliases": StringSearchInput
}
TherapySort
Fields
| Input Field | Description |
|---|---|
column - TherapySortColumns!
|
Available columns for sorting |
direction - SortDirection!
|
Sort direction |
Example
{"column": "ASSERTION_COUNT", "direction": "ASC"}
TherapySortColumns
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSERTION_COUNT"
TimePointCounts
TimeWindow
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALL_TIME"
UnsubscribeInput
Description
Autogenerated input type of Unsubscribe
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
subscribables - [SubscribableInput!]!
|
A list of one or more entities to unsubscribe from, each identified by its ID and type. |
unsubscribeFromChildren - Boolean
|
Do you also wish to stop receiving notifications from child entities? IE: If you unsubscribe from a Gene do you want to stop receiving notifications for its Variants as well?. Default = false |
Example
{
"clientMutationId": "abc123",
"subscribables": [SubscribableInput],
"unsubscribeFromChildren": false
}
UnsubscribePayload
Description
Autogenerated return type of Unsubscribe.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
unsubscribedEntities - [Subscribable!]!
|
The entities that were unsubscribed from. |
Example
{
"clientMutationId": "abc123",
"unsubscribedEntities": [Subscribable]
}
UpdateCoiInput
Description
Autogenerated input type of UpdateCoi
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
coiPresent - Boolean!
|
Does the user report having a conflict of interest? Mark true if so. |
statement - String
|
If the user reports a potential conflict of interest please provide a brief summary of it. |
Example
{
"clientMutationId": "xyz789",
"coiPresent": true,
"statement": "xyz789"
}
UpdateCoiPayload
UpdateNotificationStatusInput
Description
Autogenerated input type of UpdateNotificationStatus
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
ids - [Int!]!
|
A list of one or more Notification IDs. |
newStatus - ReadStatus!
|
The new status of the selected notifications. |
Example
{
"clientMutationId": "xyz789",
"ids": [987],
"newStatus": "READ"
}
UpdateNotificationStatusPayload
Description
Autogenerated return type of UpdateNotificationStatus.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
notifications - [Notification!]!
|
A list of the notifications in their new state. |
Example
{
"clientMutationId": "abc123",
"notifications": [Notification]
}
UpdateSourceSuggestionStatusActivity
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
events - [Event!]!
|
|
id - Int!
|
|
note - String
|
|
organization - Organization
|
|
parsedNote - [CommentBodySegment!]!
|
|
sourceSuggestion - SourceSuggestion!
|
|
subject - EventSubject!
|
|
user - User!
|
|
verbiage - String!
|
Example
{
"createdAt": ISO8601DateTime,
"events": [Event],
"id": 987,
"note": "abc123",
"organization": Organization,
"parsedNote": [CommentTagSegment],
"sourceSuggestion": SourceSuggestion,
"subject": EventSubject,
"user": User,
"verbiage": "xyz789"
}
UpdateSourceSuggestionStatusInput
Description
Autogenerated input type of UpdateSourceSuggestionStatus
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
id - Int!
|
The ID of the SourceSuggestion to update. |
newStatus - SourceSuggestionStatus!
|
The desired status of the SourceSuggestion. |
organizationId - Int
|
The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided. |
reason - String
|
The justification for marking a source as curated/rejected |
Example
{
"clientMutationId": "abc123",
"id": 123,
"newStatus": "CURATED",
"organizationId": 123,
"reason": "abc123"
}
UpdateSourceSuggestionStatusPayload
Description
Autogenerated return type of UpdateSourceSuggestionStatus.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
sourceSuggestion - SourceSuggestion!
|
The updated SourceSuggestion. |
Example
{
"clientMutationId": "abc123",
"sourceSuggestion": SourceSuggestion
}
User
Fields
| Field Name | Description |
|---|---|
apiKeys - [ApiKey!]!
|
|
areaOfExpertise - AreaOfExpertise
|
|
bio - String
|
|
country - Country
|
|
displayName - String!
|
|
email - String
|
|
events - EventConnection!
|
|
facebookProfile - String
|
|
id - Int!
|
|
joinDate - ISO8601DateTime
|
|
linkedinProfile - String
|
|
mostRecentActivityTimestamp - ISO8601DateTime
|
|
mostRecentConflictOfInterestStatement - Coi
|
|
mostRecentEvent - Event
|
|
mostRecentOrganizationId - Int
|
|
name - String
|
|
notifications - NotificationConnection
|
Filterable list of notifications for the logged in user. |
Arguments
|
|
orcid - String
|
|
organizations - [Organization!]!
|
|
organizationsWithEndorsementPrivileges - [Organization!]!
|
|
profileImagePath - String
|
|
Arguments
|
|
ranks - Ranks!
|
|
role - UserRole!
|
|
statsHash - Stats!
|
|
twitterHandle - String
|
|
url - String
|
|
username - String!
|
|
Example
{
"apiKeys": [ApiKey],
"areaOfExpertise": "CLINICAL_SCIENTIST",
"bio": "abc123",
"country": Country,
"displayName": "xyz789",
"email": "xyz789",
"events": EventConnection,
"facebookProfile": "abc123",
"id": 123,
"joinDate": ISO8601DateTime,
"linkedinProfile": "xyz789",
"mostRecentActivityTimestamp": ISO8601DateTime,
"mostRecentConflictOfInterestStatement": Coi,
"mostRecentEvent": Event,
"mostRecentOrganizationId": 987,
"name": "xyz789",
"notifications": NotificationConnection,
"orcid": "xyz789",
"organizations": [Organization],
"organizationsWithEndorsementPrivileges": [
Organization
],
"profileImagePath": "abc123",
"ranks": Ranks,
"role": "ADMIN",
"statsHash": Stats,
"twitterHandle": "abc123",
"url": "abc123",
"username": "abc123"
}
UserConnection
Description
The connection type for User.
Fields
| Field Name | Description |
|---|---|
edges - [UserEdge!]!
|
A list of edges. |
nodes - [User!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [UserEdge],
"nodes": [User],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 987
}
UserEdge
UserLeaderboards
Fields
| Field Name | Description |
|---|---|
commentsLeaderboard - LeaderboardUserConnection!
|
|
Arguments
|
|
moderationLeaderboard - LeaderboardUserConnection!
|
|
Arguments
|
|
revisionsLeaderboard - LeaderboardUserConnection!
|
|
Arguments
|
|
submissionsLeaderboard - LeaderboardUserConnection!
|
|
Arguments
|
|
Example
{
"commentsLeaderboard": LeaderboardUserConnection,
"moderationLeaderboard": LeaderboardUserConnection,
"revisionsLeaderboard": LeaderboardUserConnection,
"submissionsLeaderboard": LeaderboardUserConnection
}
UserRole
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ADMIN"
UserSearchFilter
Fields
| Input Field | Description |
|---|---|
booleanOperator - BooleanOperator
|
|
createdAt - DateSearchInput
|
|
id - IntSearchInput
|
|
name - StringSearchInput
|
|
organizationId - IntSearchInput
|
|
organizationName - StringSearchInput
|
|
subFilters - [CommentSearchFilter!]
|
|
username - StringSearchInput
|
Example
{
"booleanOperator": "AND",
"createdAt": DateSearchInput,
"id": IntSearchInput,
"name": StringSearchInput,
"organizationId": IntSearchInput,
"organizationName": StringSearchInput,
"subFilters": [CommentSearchFilter],
"username": StringSearchInput
}
UsersSort
Fields
| Input Field | Description |
|---|---|
column - UsersSortColumns!
|
Available columns for sorting |
direction - SortDirection!
|
Sort direction |
Example
{"column": "EVIDENCE_COUNT", "direction": "ASC"}
UsersSortColumns
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EVIDENCE_COUNT"
ValidationErrors
Fields
| Field Name | Description |
|---|---|
genericErrors - [String!]!
|
|
validationErrors - [FieldValidationError!]!
|
Example
{
"genericErrors": ["xyz789"],
"validationErrors": [FieldValidationError]
}
Variant
Fields
| Field Name | Description |
|---|---|
comments - CommentConnection!
|
List and filter comments. |
Arguments
|
|
creationActivity - CreateVariantActivity
|
|
deprecated - Boolean!
|
|
deprecationActivity - DeprecateVariantActivity
|
|
deprecationReason - VariantDeprecationReason
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
feature - Feature!
|
|
flagged - Boolean!
|
|
flags - FlagConnection!
|
List and filter flags. |
Arguments
|
|
id - Int!
|
|
lastAcceptedRevisionEvent - Event
|
|
lastCommentEvent - Event
|
|
lastSubmittedRevisionEvent - Event
|
|
link - String!
|
|
molecularProfiles - MolecularProfileConnection!
|
|
name - String!
|
|
openRevisionCount - Int!
|
|
revisions - RevisionConnection!
|
List and filter revisions. |
Arguments
|
|
singleVariantMolecularProfile - MolecularProfile!
|
|
singleVariantMolecularProfileId - Int!
|
|
variantAliases - [String!]!
|
|
variantTypes - [VariantType!]!
|
|
Example
{
"comments": CommentConnection,
"creationActivity": CreateVariantActivity,
"deprecated": true,
"deprecationActivity": DeprecateVariantActivity,
"deprecationReason": "DUPLICATE",
"events": EventConnection,
"feature": Feature,
"flagged": false,
"flags": FlagConnection,
"id": 987,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"molecularProfiles": MolecularProfileConnection,
"name": "xyz789",
"openRevisionCount": 123,
"revisions": RevisionConnection,
"singleVariantMolecularProfile": MolecularProfile,
"singleVariantMolecularProfileId": 123,
"variantAliases": ["abc123"],
"variantTypes": [VariantType]
}
VariantAlias
Fields
| Field Name | Description |
|---|---|
name - String!
|
Example
{"name": "abc123"}
VariantCategories
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"FACTOR"
VariantComponent
Description
Representation of a Variant's membership in a Molecular Profile.
Example
{"not": true, "variantId": 987}
VariantCoordinate
Fields
| Field Name | Description |
|---|---|
chromosome - String
|
|
coordinateType - VariantCoordinateType!
|
|
ensemblVersion - Int
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
id - Int!
|
|
lastAcceptedRevisionEvent - Event
|
|
lastSubmittedRevisionEvent - Event
|
|
link - String!
|
|
name - String!
|
|
openRevisionCount - Int!
|
|
referenceBases - String
|
|
referenceBuild - ReferenceBuild
|
|
representativeTranscript - String
|
|
revisions - RevisionConnection!
|
List and filter revisions. |
Arguments
|
|
start - Int
|
|
stop - Int
|
|
variantBases - String
|
|
Example
{
"chromosome": "abc123",
"coordinateType": "FIVE_PRIME_FUSION_COORDINATE",
"ensemblVersion": 987,
"events": EventConnection,
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "abc123",
"name": "xyz789",
"openRevisionCount": 987,
"referenceBases": "xyz789",
"referenceBuild": "GRCH37",
"representativeTranscript": "xyz789",
"revisions": RevisionConnection,
"start": 987,
"stop": 123,
"variantBases": "xyz789"
}
VariantCoordinateType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"FIVE_PRIME_FUSION_COORDINATE"
VariantDeprecationReason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DUPLICATE"
VariantDeprecationReasonTypeSearchInput
Fields
| Input Field | Description |
|---|---|
operator - EnumSearchOperator!
|
|
value - VariantDeprecationReason!
|
Example
{"operator": "EQ", "value": "DUPLICATE"}
VariantGroup
Fields
| Field Name | Description |
|---|---|
comments - CommentConnection!
|
List and filter comments. |
Arguments
|
|
description - String!
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
flagged - Boolean!
|
|
flags - FlagConnection!
|
List and filter flags. |
Arguments
|
|
id - Int!
|
|
lastAcceptedRevisionEvent - Event
|
|
lastCommentEvent - Event
|
|
lastSubmittedRevisionEvent - Event
|
|
link - String!
|
|
name - String!
|
|
openRevisionCount - Int!
|
|
revisions - RevisionConnection!
|
List and filter revisions. |
Arguments
|
|
sources - [Source!]!
|
|
variants - VariantInterfaceConnection!
|
List and filter variants. |
Arguments
|
|
Example
{
"comments": CommentConnection,
"description": "xyz789",
"events": EventConnection,
"flagged": false,
"flags": FlagConnection,
"id": 987,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"name": "abc123",
"openRevisionCount": 123,
"revisions": RevisionConnection,
"sources": [Source],
"variants": VariantInterfaceConnection
}
VariantGroupConnection
Description
The connection type for VariantGroup.
Fields
| Field Name | Description |
|---|---|
edges - [VariantGroupEdge!]!
|
A list of edges. |
nodes - [VariantGroup!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [VariantGroupEdge],
"nodes": [VariantGroup],
"pageCount": 123,
"pageInfo": PageInfo,
"totalCount": 987
}
VariantGroupEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - VariantGroup
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": VariantGroup
}
VariantGroupFields
Description
Fields on a VariantGroup that curators may propose revisions to.
Fields
| Input Field | Description |
|---|---|
description - NullableStringInput!
|
The VariantGroups's description/summary text. |
name - String!
|
The VariantGroups's name. |
sourceIds - [Int!]!
|
Source IDs cited by the VariantGroup's summary. |
variantIds - [Int!]!
|
Variants in this VariantGroup. |
Example
{
"description": NullableStringInput,
"name": "abc123",
"sourceIds": [123],
"variantIds": [123]
}
VariantGroupsSort
Fields
| Input Field | Description |
|---|---|
column - VariantGroupsSortColumns!
|
Available columns for sorting |
direction - SortDirection!
|
Sort direction |
Example
{"column": "EVIDENCE_ITEM_COUNT", "direction": "ASC"}
VariantGroupsSortColumns
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EVIDENCE_ITEM_COUNT"
VariantInterface
Description
A taggable/linkable component of a molecular profile
Fields
| Field Name | Description |
|---|---|
comments - CommentConnection!
|
List and filter comments. |
Arguments
|
|
creationActivity - CreateVariantActivity
|
|
deprecated - Boolean!
|
|
deprecationActivity - DeprecateVariantActivity
|
|
deprecationReason - VariantDeprecationReason
|
|
events - EventConnection!
|
List and filter events for an object |
Arguments
|
|
feature - Feature!
|
|
flagged - Boolean!
|
|
flags - FlagConnection!
|
List and filter flags. |
Arguments
|
|
id - Int!
|
|
lastAcceptedRevisionEvent - Event
|
|
lastCommentEvent - Event
|
|
lastSubmittedRevisionEvent - Event
|
|
link - String!
|
|
molecularProfiles - MolecularProfileConnection!
|
|
name - String!
|
|
openRevisionCount - Int!
|
|
revisions - RevisionConnection!
|
List and filter revisions. |
Arguments
|
|
singleVariantMolecularProfile - MolecularProfile!
|
|
singleVariantMolecularProfileId - Int!
|
|
variantAliases - [String!]!
|
|
variantTypes - [VariantType!]!
|
|
Possible Types
| VariantInterface Types |
|---|
Example
{
"comments": CommentConnection,
"creationActivity": CreateVariantActivity,
"deprecated": false,
"deprecationActivity": DeprecateVariantActivity,
"deprecationReason": "DUPLICATE",
"events": EventConnection,
"feature": Feature,
"flagged": true,
"flags": FlagConnection,
"id": 123,
"lastAcceptedRevisionEvent": Event,
"lastCommentEvent": Event,
"lastSubmittedRevisionEvent": Event,
"link": "xyz789",
"molecularProfiles": MolecularProfileConnection,
"name": "xyz789",
"openRevisionCount": 987,
"revisions": RevisionConnection,
"singleVariantMolecularProfile": MolecularProfile,
"singleVariantMolecularProfileId": 987,
"variantAliases": ["abc123"],
"variantTypes": [VariantType]
}
VariantInterfaceConnection
Description
The connection type for VariantInterface.
Fields
| Field Name | Description |
|---|---|
edges - [VariantInterfaceEdge!]!
|
A list of edges. |
nodes - [VariantInterface!]!
|
A list of nodes. |
pageCount - Int!
|
Total number of pages, based on filtered count and pagesize. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
The total number of records in this filtered collection. |
Example
{
"edges": [VariantInterfaceEdge],
"nodes": [VariantInterface],
"pageCount": 987,
"pageInfo": PageInfo,
"totalCount": 123
}
VariantInterfaceEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - VariantInterface
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": VariantInterface
}
VariantMenuSort
Fields
| Input Field | Description |
|---|---|
column - VariantMenuSortColumns!
|
Available columns for sorting |
direction - SortDirection!
|
Sort direction |
Example
{"column": "COORDINATE_END", "direction": "ASC"}
VariantMenuSortColumns
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COORDINATE_END"
VariantOrigin
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMBINED"
VariantOriginTypeSearchInput
Fields
| Input Field | Description |
|---|---|
operator - EnumSearchOperator!
|
|
value - VariantOrigin!
|
Example
{"operator": "EQ", "value": "COMBINED"}
VariantSearchFilter
Fields
| Input Field | Description |
|---|---|
booleanOperator - BooleanOperator
|
|
comment - CommentSearchFilter
|
|
coordinates - CoordinateSearchInput
|
|
creatingUser - UserSearchFilter
|
|
deprecatingUser - UserSearchFilter
|
|
deprecationReason - VariantDeprecationReasonTypeSearchInput
|
|
feature - FeatureSearchFilter
|
|
id - IntSearchInput
|
|
isDeprecated - BooleanSearchInput
|
|
isFlagged - BooleanSearchInput
|
|
molecularProfile - MolecularProfileSearchFilter
|
|
name - StringSearchInput
|
|
openRevisionCount - IntSearchInput
|
|
revisions - RevisionSearchFilter
|
|
singleVariantMolecularProfile - MolecularProfileSearchFilter
|
|
subFilters - [VariantSearchFilter!]
|
|
variantAlias - StringSearchInput
|
|
variantType - VariantTypeSearchFilter
|
Example
{
"booleanOperator": "AND",
"comment": CommentSearchFilter,
"coordinates": CoordinateSearchInput,
"creatingUser": UserSearchFilter,
"deprecatingUser": UserSearchFilter,
"deprecationReason": VariantDeprecationReasonTypeSearchInput,
"feature": FeatureSearchFilter,
"id": IntSearchInput,
"isDeprecated": BooleanSearchInput,
"isFlagged": BooleanSearchInput,
"molecularProfile": MolecularProfileSearchFilter,
"name": StringSearchInput,
"openRevisionCount": IntSearchInput,
"revisions": RevisionSearchFilter,
"singleVariantMolecularProfile": MolecularProfileSearchFilter,
"subFilters": [VariantSearchFilter],
"variantAlias": StringSearchInput,
"variantType": VariantTypeSearchFilter
}
VariantType
VariantTypePopover
VariantTypeSearchFilter
Fields
| Input Field | Description |
|---|---|
booleanOperator - BooleanOperator
|
|
description - StringSearchInput
|
|
id - IntSearchInput
|
|
name - StringSearchInput
|
|
soid - OntologyTermSearchInput
|
|
subFilters - [VariantTypeSearchFilter!]
|
Example
{
"booleanOperator": "AND",
"description": StringSearchInput,
"id": IntSearchInput,
"name": StringSearchInput,
"soid": OntologyTermSearchInput,
"subFilters": [VariantTypeSearchFilter]
}
VariantTypeSort
Fields
| Input Field | Description |
|---|---|
column - VariantTypeSortColumns!
|
Available columns for sorting |
direction - SortDirection!
|
Sort direction |
Example
{"column": "NAME", "direction": "ASC"}
VariantTypeSortColumns
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NAME"
VariantsSort
Fields
| Input Field | Description |
|---|---|
column - VariantsSortColumns!
|
Available columns for sorting |
direction - SortDirection!
|
Sort direction |
Example
{"column": "diseaseName", "direction": "ASC"}
VariantsSortColumns
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"diseaseName"
WithRevisions
Description
A CIViC entity that can have revisions proposed to it.
Fields
| Field Name | Description |
|---|---|
lastAcceptedRevisionEvent - Event
|
|
lastSubmittedRevisionEvent - Event
|
|
openRevisionCount - Int!
|
|
revisions - RevisionConnection!
|
List and filter revisions. |
Arguments
|
|
Possible Types
| WithRevisions Types |
|---|
Example
{
"lastAcceptedRevisionEvent": Event,
"lastSubmittedRevisionEvent": Event,
"openRevisionCount": 123,
"revisions": RevisionConnection
}