CIViC 2 API Documentation

Documentation for the CIViC GraphQL API

Contact

The CIViC Development Team

help@civicdb.org

License

MIT

https://github.com/griffithlab/civic-v2/blob/main/LICENSE

API Endpoints
https://civicdb.org/api/graphql

Queries

acmgCode

Description

Find an ACMG code by CIViC ID

Response

Returns an AcmgCode

Arguments
Name Description
id - Int!

Example

Query
query acmgCode($id: Int!) {
  acmgCode(id: $id) {
    code
    description
    id
    name
    tooltip
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "acmgCode": {
      "code": "xyz789",
      "description": "xyz789",
      "id": 123,
      "name": "abc123",
      "tooltip": "abc123"
    }
  }
}
Queries

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": "abc123"
      }
    ]
  }
}
Queries

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.
last - Int Returns the last n elements from the list.
mode - EventFeedMode
organizationId - [Int!]
sortBy - DateSort Sort order for the activities. Defaults to most recent.
subject - [SubscribableQueryInput!]
subjectType - [ActivitySubjectInput!]
userId - [Int!]

Example

Query
query activities(
  $activityType: [ActivityTypeInput!],
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $mode: EventFeedMode,
  $organizationId: [Int!],
  $sortBy: DateSort,
  $subject: [SubscribableQueryInput!],
  $subjectType: [ActivitySubjectInput!],
  $userId: [Int!]
) {
  activities(
    activityType: $activityType,
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    mode: $mode,
    organizationId: $organizationId,
    sortBy: $sortBy,
    subject: $subject,
    subjectType: $subjectType,
    userId: $userId
  ) {
    activityTypes
    edges {
      ...ActivityInterfaceEdgeFragment
    }
    nodes {
      ...ActivityInterfaceFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    participatingOrganizations {
      ...OrganizationFragment
    }
    subjectTypes
    totalCount
    unfilteredCount
    uniqueParticipants {
      ...UserFragment
    }
  }
}
Variables
{
  "activityType": ["ACCEPT_REVISIONS"],
  "after": "abc123",
  "before": "xyz789",
  "first": 987,
  "last": 123,
  "mode": "ORGANIZATION",
  "organizationId": [987],
  "sortBy": DateSort,
  "subject": [SubscribableQueryInput],
  "subjectType": ["ASSERTION"],
  "userId": [123]
}
Response
{
  "data": {
    "activities": {
      "activityTypes": ["ACCEPT_REVISIONS"],
      "edges": [ActivityInterfaceEdge],
      "nodes": [ActivityInterface],
      "pageCount": 123,
      "pageInfo": PageInfo,
      "participatingOrganizations": [Organization],
      "subjectTypes": ["ASSERTION"],
      "totalCount": 123,
      "unfilteredCount": 987,
      "uniqueParticipants": [User]
    }
  }
}
Queries

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 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"
    }
  }
}
Queries

assertion

Description

Find an assertion by CIViC ID

Response

Returns an Assertion

Arguments
Name Description
id - Int!

Example

Query
query assertion($id: Int!) {
  assertion(id: $id) {
    acceptanceEvent {
      ...EventFragment
    }
    acmgCodes {
      ...AcmgCodeFragment
    }
    ampLevel
    assertionDirection
    assertionType
    clingenCodes {
      ...ClingenCodeFragment
    }
    comments {
      ...CommentConnectionFragment
    }
    description
    disease {
      ...DiseaseFragment
    }
    events {
      ...EventConnectionFragment
    }
    evidenceItems {
      ...EvidenceItemFragment
    }
    evidenceItemsCount
    fdaCompanionTest
    fdaCompanionTestLastUpdated
    flagged
    flags {
      ...FlagConnectionFragment
    }
    id
    lastAcceptedRevisionEvent {
      ...EventFragment
    }
    lastCommentEvent {
      ...EventFragment
    }
    lastSubmittedRevisionEvent {
      ...EventFragment
    }
    link
    molecularProfile {
      ...MolecularProfileFragment
    }
    name
    nccnGuideline {
      ...NccnGuidelineFragment
    }
    nccnGuidelineVersion
    phenotypes {
      ...PhenotypeFragment
    }
    regulatoryApproval
    regulatoryApprovalLastUpdated
    rejectionEvent {
      ...EventFragment
    }
    revisions {
      ...RevisionConnectionFragment
    }
    significance
    status
    submissionActivity {
      ...SubmitAssertionActivityFragment
    }
    submissionEvent {
      ...EventFragment
    }
    summary
    therapies {
      ...TherapyFragment
    }
    therapyInteractionType
    variantOrigin
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "assertion": {
      "acceptanceEvent": Event,
      "acmgCodes": [AcmgCode],
      "ampLevel": "NA",
      "assertionDirection": "DOES_NOT_SUPPORT",
      "assertionType": "DIAGNOSTIC",
      "clingenCodes": [ClingenCode],
      "comments": CommentConnection,
      "description": "xyz789",
      "disease": Disease,
      "events": EventConnection,
      "evidenceItems": [EvidenceItem],
      "evidenceItemsCount": 123,
      "fdaCompanionTest": false,
      "fdaCompanionTestLastUpdated": ISO8601DateTime,
      "flagged": false,
      "flags": FlagConnection,
      "id": 123,
      "lastAcceptedRevisionEvent": Event,
      "lastCommentEvent": Event,
      "lastSubmittedRevisionEvent": Event,
      "link": "abc123",
      "molecularProfile": MolecularProfile,
      "name": "abc123",
      "nccnGuideline": NccnGuideline,
      "nccnGuidelineVersion": "xyz789",
      "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"
    }
  }
}
Queries

assertions

Description

List and filter assertions.

Response

Returns an AssertionConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
ampLevel - AmpLevel Filtering on the AMP/ASCO/CAP category.
assertionDirection - EvidenceDirection Filtering on the assertion direction.
assertionType - EvidenceType Filtering on the assertion type.
before - String Returns the elements in the list that come before the specified cursor.
diseaseId - Int Exact match filtering of the assertions based on the internal CIViC disease id
diseaseName - String Substring filtering on disease name.
evidenceId - Int Exact match filtering on the ID of evidence underlying the assertion.
first - Int Returns the first n elements from the list.
id - Int Exact match filtering on the ID of the assertion.
last - Int Returns the last n elements from the list.
molecularProfileId - Int Exact match filtering on the ID of the molecular_profile.
molecularProfileName - String Substring filtering on molecular profile name
organizationId - Int Exact match filtering on the ID of the organization the assertion was submitted under.
phenotypeId - Int Exact match filtering of the assertions based on the internal CIViC phenotype id
significance - EvidenceSignificance Filtering on the assertion's significance.
sortBy - AssertionSort Columm and direction to sort evidence on.
status - EvidenceStatusFilter Filtering on the status of the assertion.
summary - String Substring filtering on assertion description.
therapyId - Int Exact match filtering of the assertions based on the internal CIViC therapy id
therapyName - String Substring filtering on therapy name.
userId - Int Exact match filtering on the ID of the user who submitted the assertion.
variantId - Int Exact match filtering on the ID of the variant.
variantName - String Substring filtering on variant name.

Example

Query
query assertions(
  $after: String,
  $ampLevel: AmpLevel,
  $assertionDirection: EvidenceDirection,
  $assertionType: EvidenceType,
  $before: String,
  $diseaseId: Int,
  $diseaseName: String,
  $evidenceId: Int,
  $first: Int,
  $id: Int,
  $last: Int,
  $molecularProfileId: Int,
  $molecularProfileName: String,
  $organizationId: Int,
  $phenotypeId: Int,
  $significance: EvidenceSignificance,
  $sortBy: AssertionSort,
  $status: EvidenceStatusFilter,
  $summary: String,
  $therapyId: Int,
  $therapyName: String,
  $userId: Int,
  $variantId: Int,
  $variantName: String
) {
  assertions(
    after: $after,
    ampLevel: $ampLevel,
    assertionDirection: $assertionDirection,
    assertionType: $assertionType,
    before: $before,
    diseaseId: $diseaseId,
    diseaseName: $diseaseName,
    evidenceId: $evidenceId,
    first: $first,
    id: $id,
    last: $last,
    molecularProfileId: $molecularProfileId,
    molecularProfileName: $molecularProfileName,
    organizationId: $organizationId,
    phenotypeId: $phenotypeId,
    significance: $significance,
    sortBy: $sortBy,
    status: $status,
    summary: $summary,
    therapyId: $therapyId,
    therapyName: $therapyName,
    userId: $userId,
    variantId: $variantId,
    variantName: $variantName
  ) {
    edges {
      ...AssertionEdgeFragment
    }
    nodes {
      ...AssertionFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "ampLevel": "NA",
  "assertionDirection": "DOES_NOT_SUPPORT",
  "assertionType": "DIAGNOSTIC",
  "before": "xyz789",
  "diseaseId": 987,
  "diseaseName": "xyz789",
  "evidenceId": 123,
  "first": 123,
  "id": 987,
  "last": 123,
  "molecularProfileId": 987,
  "molecularProfileName": "abc123",
  "organizationId": 123,
  "phenotypeId": 123,
  "significance": "ADVERSE_RESPONSE",
  "sortBy": AssertionSort,
  "status": "ACCEPTED",
  "summary": "xyz789",
  "therapyId": 987,
  "therapyName": "xyz789",
  "userId": 987,
  "variantId": 123,
  "variantName": "abc123"
}
Response
{
  "data": {
    "assertions": {
      "edges": [AssertionEdge],
      "nodes": [Assertion],
      "pageCount": 123,
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

browseDiseases

Response

Returns a BrowseDiseaseConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
doid - String
featureName - String
first - Int Returns the first n elements from the list.
id - Int
last - Int Returns the last n elements from the list.
name - String
sortBy - DiseasesSort

Example

Query
query browseDiseases(
  $after: String,
  $before: String,
  $doid: String,
  $featureName: String,
  $first: Int,
  $id: Int,
  $last: Int,
  $name: String,
  $sortBy: DiseasesSort
) {
  browseDiseases(
    after: $after,
    before: $before,
    doid: $doid,
    featureName: $featureName,
    first: $first,
    id: $id,
    last: $last,
    name: $name,
    sortBy: $sortBy
  ) {
    edges {
      ...BrowseDiseaseEdgeFragment
    }
    filteredCount
    lastUpdated
    nodes {
      ...BrowseDiseaseFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "abc123",
  "before": "xyz789",
  "doid": "xyz789",
  "featureName": "abc123",
  "first": 123,
  "id": 987,
  "last": 987,
  "name": "abc123",
  "sortBy": DiseasesSort
}
Response
{
  "data": {
    "browseDiseases": {
      "edges": [BrowseDiseaseEdge],
      "filteredCount": 987,
      "lastUpdated": ISO8601DateTime,
      "nodes": [BrowseDisease],
      "pageCount": 123,
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

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
featureName - String
featureType - FeatureInstanceTypes
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.
sortBy - FeaturesSort
therapyName - String

Example

Query
query browseFeatures(
  $after: String,
  $before: String,
  $diseaseName: String,
  $featureAlias: String,
  $featureName: String,
  $featureType: FeatureInstanceTypes,
  $first: Int,
  $last: Int,
  $sortBy: FeaturesSort,
  $therapyName: String
) {
  browseFeatures(
    after: $after,
    before: $before,
    diseaseName: $diseaseName,
    featureAlias: $featureAlias,
    featureName: $featureName,
    featureType: $featureType,
    first: $first,
    last: $last,
    sortBy: $sortBy,
    therapyName: $therapyName
  ) {
    edges {
      ...BrowseFeatureEdgeFragment
    }
    filteredCount
    lastUpdated
    nodes {
      ...BrowseFeatureFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "diseaseName": "xyz789",
  "featureAlias": "abc123",
  "featureName": "xyz789",
  "featureType": "FACTOR",
  "first": 987,
  "last": 123,
  "sortBy": FeaturesSort,
  "therapyName": "xyz789"
}
Response
{
  "data": {
    "browseFeatures": {
      "edges": [BrowseFeatureEdge],
      "filteredCount": 987,
      "lastUpdated": ISO8601DateTime,
      "nodes": [BrowseFeature],
      "pageCount": 987,
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

browseMolecularProfiles

Response

Returns a BrowseMolecularProfileConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
diseaseName - String
featureName - String
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.
molecularProfileAlias - String
molecularProfileName - String
sortBy - MolecularProfilesSort
therapyName - String
variantId - Int
variantName - String

Example

Query
query browseMolecularProfiles(
  $after: String,
  $before: String,
  $diseaseName: String,
  $featureName: String,
  $first: Int,
  $last: Int,
  $molecularProfileAlias: String,
  $molecularProfileName: String,
  $sortBy: MolecularProfilesSort,
  $therapyName: String,
  $variantId: Int,
  $variantName: String
) {
  browseMolecularProfiles(
    after: $after,
    before: $before,
    diseaseName: $diseaseName,
    featureName: $featureName,
    first: $first,
    last: $last,
    molecularProfileAlias: $molecularProfileAlias,
    molecularProfileName: $molecularProfileName,
    sortBy: $sortBy,
    therapyName: $therapyName,
    variantId: $variantId,
    variantName: $variantName
  ) {
    edges {
      ...BrowseMolecularProfileEdgeFragment
    }
    filteredCount
    lastUpdated
    nodes {
      ...BrowseMolecularProfileFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "abc123",
  "before": "abc123",
  "diseaseName": "abc123",
  "featureName": "abc123",
  "first": 123,
  "last": 987,
  "molecularProfileAlias": "abc123",
  "molecularProfileName": "xyz789",
  "sortBy": MolecularProfilesSort,
  "therapyName": "xyz789",
  "variantId": 123,
  "variantName": "abc123"
}
Response
{
  "data": {
    "browseMolecularProfiles": {
      "edges": [BrowseMolecularProfileEdge],
      "filteredCount": 987,
      "lastUpdated": ISO8601DateTime,
      "nodes": [BrowseMolecularProfile],
      "pageCount": 123,
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

browseSources

Response

Returns a BrowseSourceConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
author - String
before - String Returns the elements in the list that come before the specified cursor.
citationId - Int
clinicalTrialId - Int
first - Int Returns the first n elements from the list.
id - Int
journal - String
last - Int Returns the last n elements from the list.
name - String
openAccess - Boolean
sortBy - SourcesSort
sourceType - SourceSource
year - Int

Example

Query
query browseSources(
  $after: String,
  $author: String,
  $before: String,
  $citationId: Int,
  $clinicalTrialId: Int,
  $first: Int,
  $id: Int,
  $journal: String,
  $last: Int,
  $name: String,
  $openAccess: Boolean,
  $sortBy: SourcesSort,
  $sourceType: SourceSource,
  $year: Int
) {
  browseSources(
    after: $after,
    author: $author,
    before: $before,
    citationId: $citationId,
    clinicalTrialId: $clinicalTrialId,
    first: $first,
    id: $id,
    journal: $journal,
    last: $last,
    name: $name,
    openAccess: $openAccess,
    sortBy: $sortBy,
    sourceType: $sourceType,
    year: $year
  ) {
    edges {
      ...BrowseSourceEdgeFragment
    }
    filteredCount
    lastUpdated
    nodes {
      ...BrowseSourceFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "author": "abc123",
  "before": "xyz789",
  "citationId": 987,
  "clinicalTrialId": 987,
  "first": 987,
  "id": 123,
  "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": 123,
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

browseVariantGroups

Response

Returns a BrowseVariantGroupConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
featureNames - String
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.
name - String
sortBy - VariantGroupsSort
variantNames - String

Example

Query
query browseVariantGroups(
  $after: String,
  $before: String,
  $featureNames: String,
  $first: Int,
  $last: Int,
  $name: String,
  $sortBy: VariantGroupsSort,
  $variantNames: String
) {
  browseVariantGroups(
    after: $after,
    before: $before,
    featureNames: $featureNames,
    first: $first,
    last: $last,
    name: $name,
    sortBy: $sortBy,
    variantNames: $variantNames
  ) {
    edges {
      ...BrowseVariantGroupEdgeFragment
    }
    filteredCount
    lastUpdated
    nodes {
      ...BrowseVariantGroupFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "abc123",
  "before": "xyz789",
  "featureNames": "abc123",
  "first": 123,
  "last": 123,
  "name": "xyz789",
  "sortBy": VariantGroupsSort,
  "variantNames": "xyz789"
}
Response
{
  "data": {
    "browseVariantGroups": {
      "edges": [BrowseVariantGroupEdge],
      "filteredCount": 123,
      "lastUpdated": ISO8601DateTime,
      "nodes": [BrowseVariantGroup],
      "pageCount": 987,
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

browseVariants

Response

Returns a BrowseVariantConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
category - VariantCategories
diseaseName - String
featureName - String
first - Int Returns the first n elements from the list.
hasNoVariantType - Boolean
last - Int Returns the last n elements from the list.
sortBy - VariantsSort
therapyName - String
variantAlias - String
variantGroupId - Int
variantName - String
variantTypeId - Int
variantTypeName - String

Example

Query
query browseVariants(
  $after: String,
  $before: String,
  $category: VariantCategories,
  $diseaseName: String,
  $featureName: String,
  $first: Int,
  $hasNoVariantType: Boolean,
  $last: Int,
  $sortBy: VariantsSort,
  $therapyName: String,
  $variantAlias: String,
  $variantGroupId: Int,
  $variantName: String,
  $variantTypeId: Int,
  $variantTypeName: String
) {
  browseVariants(
    after: $after,
    before: $before,
    category: $category,
    diseaseName: $diseaseName,
    featureName: $featureName,
    first: $first,
    hasNoVariantType: $hasNoVariantType,
    last: $last,
    sortBy: $sortBy,
    therapyName: $therapyName,
    variantAlias: $variantAlias,
    variantGroupId: $variantGroupId,
    variantName: $variantName,
    variantTypeId: $variantTypeId,
    variantTypeName: $variantTypeName
  ) {
    edges {
      ...BrowseVariantEdgeFragment
    }
    filteredCount
    lastUpdated
    nodes {
      ...BrowseVariantFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "category": "FACTOR",
  "diseaseName": "abc123",
  "featureName": "abc123",
  "first": 123,
  "hasNoVariantType": true,
  "last": 123,
  "sortBy": VariantsSort,
  "therapyName": "abc123",
  "variantAlias": "abc123",
  "variantGroupId": 987,
  "variantName": "abc123",
  "variantTypeId": 987,
  "variantTypeName": "xyz789"
}
Response
{
  "data": {
    "browseVariants": {
      "edges": [BrowseVariantEdge],
      "filteredCount": 987,
      "lastUpdated": ISO8601DateTime,
      "nodes": [BrowseVariant],
      "pageCount": 987,
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

clingenCode

Description

Find a ClinGen code by CIViC ID

Response

Returns a ClingenCode

Arguments
Name Description
id - Int!

Example

Query
query clingenCode($id: Int!) {
  clingenCode(id: $id) {
    code
    description
    exclusive
    id
    name
    tooltip
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "clingenCode": {
      "code": "xyz789",
      "description": "xyz789",
      "exclusive": true,
      "id": 987,
      "name": "abc123",
      "tooltip": "abc123"
    }
  }
}
Queries

clingenCodesTypeahead

Description

Retrieve Clingen Code options as a typeahead

Response

Returns [ClingenCode!]!

Arguments
Name Description
queryTerm - String!

Example

Query
query clingenCodesTypeahead($queryTerm: String!) {
  clingenCodesTypeahead(queryTerm: $queryTerm) {
    code
    description
    exclusive
    id
    name
    tooltip
  }
}
Variables
{"queryTerm": "abc123"}
Response
{
  "data": {
    "clingenCodesTypeahead": [
      {
        "code": "xyz789",
        "description": "xyz789",
        "exclusive": true,
        "id": 123,
        "name": "abc123",
        "tooltip": "abc123"
      }
    ]
  }
}
Queries

clinicalTrial

Description

Find a clinical trial by CIViC ID

Response

Returns a ClinicalTrial

Arguments
Name Description
id - Int!

Example

Query
query clinicalTrial($id: Int!) {
  clinicalTrial(id: $id) {
    description
    id
    link
    name
    nctId
    url
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "clinicalTrial": {
      "description": "abc123",
      "id": 123,
      "link": "abc123",
      "name": "xyz789",
      "nctId": "abc123",
      "url": "xyz789"
    }
  }
}
Queries

clinicalTrials

Description

List and filter Clinical Trials from ClinicalTrials.gov.

Response

Returns a BrowseClinicalTrialConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
id - Int Filter to a Clinical Trial based on its internal CIViC id
last - Int Returns the last n elements from the list.
name - String Wildcard match on clinical trial title
nctId - String Limit to clinical trials with a specific NCT ID
sortBy - ClinicalTrialSort Sort order for the clinical trials. Defaults to the highest source count.

Example

Query
query clinicalTrials(
  $after: String,
  $before: String,
  $first: Int,
  $id: Int,
  $last: Int,
  $name: String,
  $nctId: String,
  $sortBy: ClinicalTrialSort
) {
  clinicalTrials(
    after: $after,
    before: $before,
    first: $first,
    id: $id,
    last: $last,
    name: $name,
    nctId: $nctId,
    sortBy: $sortBy
  ) {
    edges {
      ...BrowseClinicalTrialEdgeFragment
    }
    filteredCount
    lastUpdated
    nodes {
      ...BrowseClinicalTrialFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "abc123",
  "before": "xyz789",
  "first": 123,
  "id": 987,
  "last": 987,
  "name": "xyz789",
  "nctId": "xyz789",
  "sortBy": ClinicalTrialSort
}
Response
{
  "data": {
    "clinicalTrials": {
      "edges": [BrowseClinicalTrialEdge],
      "filteredCount": 987,
      "lastUpdated": ISO8601DateTime,
      "nodes": [BrowseClinicalTrial],
      "pageCount": 987,
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

comment

Description

Find a comment by CIViC ID

Response

Returns a Comment

Arguments
Name Description
id - Int!

Example

Query
query comment($id: Int!) {
  comment(id: $id) {
    comment
    commentable {
      ...CommentableFragment
    }
    commenter {
      ...UserFragment
    }
    createdAt
    creationEvent {
      ...EventFragment
    }
    id
    link
    name
    parsedComment {
      ... on CommentTagSegment {
        ...CommentTagSegmentFragment
      }
      ... on CommentTextSegment {
        ...CommentTextSegmentFragment
      }
      ... on User {
        ...UserFragment
      }
    }
    title
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "comment": {
      "comment": "abc123",
      "commentable": Commentable,
      "commenter": User,
      "createdAt": ISO8601DateTime,
      "creationEvent": Event,
      "id": 123,
      "link": "xyz789",
      "name": "xyz789",
      "parsedComment": [CommentTagSegment],
      "title": "abc123"
    }
  }
}
Queries

comments

Description

List and filter comments.

Response

Returns a CommentConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.
mentionedEntity - TaggableEntityInput Limit to comments that mention a certain entity
mentionedRole - UserRole Limit to comments that mention a certain user role
mentionedUserId - Int Limit to comments that mention a certain user
originatingUserId - Int Limit to comments by a certain user
sortBy - DateSort Sort order for the comments. Defaults to most recent.
subject - CommentableInput Limit to comments on a certain subject.

Example

Query
query comments(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $mentionedEntity: TaggableEntityInput,
  $mentionedRole: UserRole,
  $mentionedUserId: Int,
  $originatingUserId: Int,
  $sortBy: DateSort,
  $subject: CommentableInput
) {
  comments(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    mentionedEntity: $mentionedEntity,
    mentionedRole: $mentionedRole,
    mentionedUserId: $mentionedUserId,
    originatingUserId: $originatingUserId,
    sortBy: $sortBy,
    subject: $subject
  ) {
    edges {
      ...CommentEdgeFragment
    }
    mentionedEntities {
      ...CommentTagSegmentFragment
    }
    mentionedRoles {
      ...CommentTagSegmentFragment
    }
    mentionedUsers {
      ...UserFragment
    }
    nodes {
      ...CommentFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
    unfilteredCountForSubject
    uniqueCommenters {
      ...UserFragment
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 123,
  "last": 123,
  "mentionedEntity": TaggableEntityInput,
  "mentionedRole": "ADMIN",
  "mentionedUserId": 987,
  "originatingUserId": 987,
  "sortBy": DateSort,
  "subject": CommentableInput
}
Response
{
  "data": {
    "comments": {
      "edges": [CommentEdge],
      "mentionedEntities": [CommentTagSegment],
      "mentionedRoles": [CommentTagSegment],
      "mentionedUsers": [User],
      "nodes": [Comment],
      "pageCount": 987,
      "pageInfo": PageInfo,
      "totalCount": 123,
      "unfilteredCountForSubject": 123,
      "uniqueCommenters": [User]
    }
  }
}
Queries

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]
    }
  }
}
Queries

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": 123,
        "iso": "abc123",
        "name": "abc123"
      }
    ]
  }
}
Queries

dataReleases

Response

Returns [DataRelease!]!

Example

Query
query dataReleases {
  dataReleases {
    acceptedAndSubmittedVariantsVcf {
      ...DownloadableFileFragment
    }
    acceptedVariantsVcf {
      ...DownloadableFileFragment
    }
    assertionTsv {
      ...DownloadableFileFragment
    }
    evidenceTsv {
      ...DownloadableFileFragment
    }
    geneTsv {
      ...DownloadableFileFragment
    }
    molecularProfileTsv {
      ...DownloadableFileFragment
    }
    name
    variantGroupTsv {
      ...DownloadableFileFragment
    }
    variantTsv {
      ...DownloadableFileFragment
    }
  }
}
Response
{
  "data": {
    "dataReleases": [
      {
        "acceptedAndSubmittedVariantsVcf": DownloadableFile,
        "acceptedVariantsVcf": DownloadableFile,
        "assertionTsv": DownloadableFile,
        "evidenceTsv": DownloadableFile,
        "geneTsv": DownloadableFile,
        "molecularProfileTsv": DownloadableFile,
        "name": "abc123",
        "variantGroupTsv": DownloadableFile,
        "variantTsv": DownloadableFile
      }
    ]
  }
}
Queries

disease

Description

Find a disease by CIViC ID

Response

Returns a Disease

Arguments
Name Description
id - Int!

Example

Query
query disease($id: Int!) {
  disease(id: $id) {
    diseaseAliases
    diseaseUrl
    displayName
    doid
    id
    link
    myDiseaseInfo {
      ...MyDiseaseInfoFragment
    }
    name
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "disease": {
      "diseaseAliases": ["xyz789"],
      "diseaseUrl": "xyz789",
      "displayName": "abc123",
      "doid": "xyz789",
      "id": 987,
      "link": "abc123",
      "myDiseaseInfo": MyDiseaseInfo,
      "name": "xyz789"
    }
  }
}
Queries

diseasePopover

Description

Retrieve popover fields for a specific disease.

Response

Returns a DiseasePopover

Arguments
Name Description
id - Int!

Example

Query
query diseasePopover($id: Int!) {
  diseasePopover(id: $id) {
    assertionCount
    diseaseAliases
    diseaseUrl
    displayName
    doid
    evidenceItemCount
    id
    link
    molecularProfileCount
    myDiseaseInfo {
      ...MyDiseaseInfoFragment
    }
    name
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "diseasePopover": {
      "assertionCount": 123,
      "diseaseAliases": ["xyz789"],
      "diseaseUrl": "xyz789",
      "displayName": "abc123",
      "doid": "abc123",
      "evidenceItemCount": 123,
      "id": 123,
      "link": "abc123",
      "molecularProfileCount": 987,
      "myDiseaseInfo": MyDiseaseInfo,
      "name": "abc123"
    }
  }
}
Queries

diseaseTypeahead

Description

Retrieve disease typeahead fields for a search term.

Response

Returns [Disease!]!

Arguments
Name Description
queryTerm - String!

Example

Query
query diseaseTypeahead($queryTerm: String!) {
  diseaseTypeahead(queryTerm: $queryTerm) {
    diseaseAliases
    diseaseUrl
    displayName
    doid
    id
    link
    myDiseaseInfo {
      ...MyDiseaseInfoFragment
    }
    name
  }
}
Variables
{"queryTerm": "abc123"}
Response
{
  "data": {
    "diseaseTypeahead": [
      {
        "diseaseAliases": ["xyz789"],
        "diseaseUrl": "xyz789",
        "displayName": "xyz789",
        "doid": "abc123",
        "id": 987,
        "link": "xyz789",
        "myDiseaseInfo": MyDiseaseInfo,
        "name": "xyz789"
      }
    ]
  }
}
Queries

entityTypeahead

Description

Retrieve entity type typeahead fields for a entity mention search term.

Response

Returns [CommentTagSegment!]!

Arguments
Name Description
queryTerm - String!

Example

Query
query entityTypeahead($queryTerm: String!) {
  entityTypeahead(queryTerm: $queryTerm) {
    deprecated
    displayName
    entityId
    feature {
      ...LinkableFeatureFragment
    }
    link
    revisionSetId
    status
    tagType
  }
}
Variables
{"queryTerm": "xyz789"}
Response
{
  "data": {
    "entityTypeahead": [
      {
        "deprecated": true,
        "displayName": "abc123",
        "entityId": 987,
        "feature": LinkableFeature,
        "link": "xyz789",
        "revisionSetId": 987,
        "status": "ACCEPTED",
        "tagType": "ASSERTION"
      }
    ]
  }
}
Queries

events

Description

List and filter events for an object

Response

Returns an EventConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
eventType - EventAction
first - Int Returns the first n elements from the list.
includeAutomatedEvents - Boolean
last - Int Returns the last n elements from the list.
mode - EventFeedMode
organizationId - Int
originatingUserId - Int
sortBy - DateSort Sort order for the events. Defaults to most recent.
subject - SubscribableQueryInput

Example

Query
query events(
  $after: String,
  $before: String,
  $eventType: EventAction,
  $first: Int,
  $includeAutomatedEvents: Boolean,
  $last: Int,
  $mode: EventFeedMode,
  $organizationId: Int,
  $originatingUserId: Int,
  $sortBy: DateSort,
  $subject: SubscribableQueryInput
) {
  events(
    after: $after,
    before: $before,
    eventType: $eventType,
    first: $first,
    includeAutomatedEvents: $includeAutomatedEvents,
    last: $last,
    mode: $mode,
    organizationId: $organizationId,
    originatingUserId: $originatingUserId,
    sortBy: $sortBy,
    subject: $subject
  ) {
    edges {
      ...EventEdgeFragment
    }
    eventTypes
    nodes {
      ...EventFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    participatingOrganizations {
      ...OrganizationFragment
    }
    totalCount
    unfilteredCount
    uniqueParticipants {
      ...UserFragment
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "eventType": "ACCEPTED",
  "first": 123,
  "includeAutomatedEvents": false,
  "last": 987,
  "mode": "ORGANIZATION",
  "organizationId": 987,
  "originatingUserId": 987,
  "sortBy": DateSort,
  "subject": SubscribableQueryInput
}
Response
{
  "data": {
    "events": {
      "edges": [EventEdge],
      "eventTypes": ["ACCEPTED"],
      "nodes": [Event],
      "pageCount": 123,
      "pageInfo": PageInfo,
      "participatingOrganizations": [Organization],
      "totalCount": 987,
      "unfilteredCount": 123,
      "uniqueParticipants": [User]
    }
  }
}
Queries

evidenceItem

Description

Find an evidence item by CIViC ID

Response

Returns an EvidenceItem

Arguments
Name Description
id - Int!

Example

Query
query evidenceItem($id: Int!) {
  evidenceItem(id: $id) {
    acceptanceEvent {
      ...EventFragment
    }
    assertions {
      ...AssertionFragment
    }
    comments {
      ...CommentConnectionFragment
    }
    description
    disease {
      ...DiseaseFragment
    }
    events {
      ...EventConnectionFragment
    }
    evidenceDirection
    evidenceLevel
    evidenceRating
    evidenceType
    flagged
    flags {
      ...FlagConnectionFragment
    }
    id
    lastAcceptedRevisionEvent {
      ...EventFragment
    }
    lastCommentEvent {
      ...EventFragment
    }
    lastSubmittedRevisionEvent {
      ...EventFragment
    }
    link
    molecularProfile {
      ...MolecularProfileFragment
    }
    name
    phenotypes {
      ...PhenotypeFragment
    }
    rejectionEvent {
      ...EventFragment
    }
    revisions {
      ...RevisionConnectionFragment
    }
    significance
    source {
      ...SourceFragment
    }
    status
    submissionActivity {
      ...SubmitEvidenceItemActivityFragment
    }
    submissionEvent {
      ...EventFragment
    }
    therapies {
      ...TherapyFragment
    }
    therapyInteractionType
    variantHgvs
    variantOrigin
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "evidenceItem": {
      "acceptanceEvent": Event,
      "assertions": [Assertion],
      "comments": CommentConnection,
      "description": "abc123",
      "disease": Disease,
      "events": EventConnection,
      "evidenceDirection": "DOES_NOT_SUPPORT",
      "evidenceLevel": "A",
      "evidenceRating": 987,
      "evidenceType": "DIAGNOSTIC",
      "flagged": true,
      "flags": FlagConnection,
      "id": 123,
      "lastAcceptedRevisionEvent": Event,
      "lastCommentEvent": Event,
      "lastSubmittedRevisionEvent": Event,
      "link": "abc123",
      "molecularProfile": MolecularProfile,
      "name": "abc123",
      "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"
    }
  }
}
Queries

evidenceItems

Description

List and filter evidence items.

Response

Returns an EvidenceItemConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
assertionId - Int Exact match filtering on the ID of the assertion.
before - String Returns the elements in the list that come before the specified cursor.
clinicalTrialId - Int Exact match filtering of the evidence items based on the CIViC clinical trial id linked to the evidence item's source
description - String Substring filtering on evidence item description.
diseaseId - Int Exact match filtering of the evidence items based on the internal CIViC disease id
diseaseName - String Substring filtering on disease name.
evidenceDirection - EvidenceDirection Filtering on the evidence direction.
evidenceLevel - EvidenceLevel Filtering on the evidence level.
evidenceRating - Int Filtering on the evidence rating. Valid values: 1, 2, 3, 4, 5
evidenceType - EvidenceType Filtering on the evidence type.
first - Int Returns the first n elements from the list.
id - Int Exact match filtering on the ID of the evidence item.
last - Int Returns the last n elements from the list.
molecularProfileId - Int Exact match filtering on the ID of the molecular profile.
molecularProfileName - String Substring filtering on molecular profile name
organizationId - Int Exact match filtering on the ID of the organization the evidence item was submitted under.
phenotypeId - Int Exact match filtering of the evidence items based on the internal CIViC phenotype id
significance - EvidenceSignificance Filtering on the evidence significance.
sortBy - EvidenceSort Columm and direction to sort evidence on.
sourceId - Int Exact match filtering of the evidence items based on the interal CIViC source id
status - EvidenceStatusFilter Filtering on the evidence status.
therapyId - Int Exact match filtering of the evidence items based on the internal CIViC therapy id
therapyName - String Substring filtering on therapy name.
userId - Int Exact match filtering on the ID of the user who submitted the evidence item.
variantId - Int Exact match filtering on the ID of the variant.
variantOrigin - VariantOrigin Filtering on the evidence variant origin.

Example

Query
query evidenceItems(
  $after: String,
  $assertionId: Int,
  $before: String,
  $clinicalTrialId: Int,
  $description: String,
  $diseaseId: Int,
  $diseaseName: String,
  $evidenceDirection: EvidenceDirection,
  $evidenceLevel: EvidenceLevel,
  $evidenceRating: Int,
  $evidenceType: EvidenceType,
  $first: Int,
  $id: Int,
  $last: Int,
  $molecularProfileId: Int,
  $molecularProfileName: String,
  $organizationId: Int,
  $phenotypeId: Int,
  $significance: EvidenceSignificance,
  $sortBy: EvidenceSort,
  $sourceId: Int,
  $status: EvidenceStatusFilter,
  $therapyId: Int,
  $therapyName: String,
  $userId: Int,
  $variantId: Int,
  $variantOrigin: VariantOrigin
) {
  evidenceItems(
    after: $after,
    assertionId: $assertionId,
    before: $before,
    clinicalTrialId: $clinicalTrialId,
    description: $description,
    diseaseId: $diseaseId,
    diseaseName: $diseaseName,
    evidenceDirection: $evidenceDirection,
    evidenceLevel: $evidenceLevel,
    evidenceRating: $evidenceRating,
    evidenceType: $evidenceType,
    first: $first,
    id: $id,
    last: $last,
    molecularProfileId: $molecularProfileId,
    molecularProfileName: $molecularProfileName,
    organizationId: $organizationId,
    phenotypeId: $phenotypeId,
    significance: $significance,
    sortBy: $sortBy,
    sourceId: $sourceId,
    status: $status,
    therapyId: $therapyId,
    therapyName: $therapyName,
    userId: $userId,
    variantId: $variantId,
    variantOrigin: $variantOrigin
  ) {
    edges {
      ...EvidenceItemEdgeFragment
    }
    nodes {
      ...EvidenceItemFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "abc123",
  "assertionId": 123,
  "before": "xyz789",
  "clinicalTrialId": 123,
  "description": "xyz789",
  "diseaseId": 123,
  "diseaseName": "xyz789",
  "evidenceDirection": "DOES_NOT_SUPPORT",
  "evidenceLevel": "A",
  "evidenceRating": 123,
  "evidenceType": "DIAGNOSTIC",
  "first": 123,
  "id": 987,
  "last": 123,
  "molecularProfileId": 987,
  "molecularProfileName": "xyz789",
  "organizationId": 123,
  "phenotypeId": 123,
  "significance": "ADVERSE_RESPONSE",
  "sortBy": EvidenceSort,
  "sourceId": 123,
  "status": "ACCEPTED",
  "therapyId": 987,
  "therapyName": "abc123",
  "userId": 123,
  "variantId": 987,
  "variantOrigin": "COMBINED"
}
Response
{
  "data": {
    "evidenceItems": {
      "edges": [EvidenceItemEdge],
      "nodes": [EvidenceItem],
      "pageCount": 123,
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

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.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.
name - [String!] List of Factor names to return
ncitIt - [String!] List of NCIt Codes to return Factors for

Example

Query
query factors(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $name: [String!],
  $ncitIt: [String!]
) {
  factors(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    name: $name,
    ncitIt: $ncitIt
  ) {
    edges {
      ...FactorEdgeFragment
    }
    nodes {
      ...FactorFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 123,
  "name": ["xyz789"],
  "ncitIt": ["abc123"]
}
Response
{
  "data": {
    "factors": {
      "edges": [FactorEdge],
      "nodes": [Factor],
      "pageCount": 987,
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

feature

Description

Find a single feature by CIViC ID

Response

Returns a Feature

Arguments
Name Description
id - Int

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 Gene {
        ...GeneFragment
      }
    }
    flagged
    flags {
      ...FlagConnectionFragment
    }
    fullName
    id
    lastAcceptedRevisionEvent {
      ...EventFragment
    }
    lastCommentEvent {
      ...EventFragment
    }
    lastSubmittedRevisionEvent {
      ...EventFragment
    }
    link
    name
    revisions {
      ...RevisionConnectionFragment
    }
    sources {
      ...SourceFragment
    }
    variants {
      ...VariantInterfaceConnectionFragment
    }
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "feature": {
      "comments": CommentConnection,
      "creationActivity": CreateFeatureActivity,
      "deprecated": false,
      "deprecationActivity": DeprecateFeatureActivity,
      "deprecationReason": "DUPLICATE",
      "description": "xyz789",
      "events": EventConnection,
      "featureAliases": ["abc123"],
      "featureInstance": Factor,
      "flagged": true,
      "flags": FlagConnection,
      "fullName": "xyz789",
      "id": 987,
      "lastAcceptedRevisionEvent": Event,
      "lastCommentEvent": Event,
      "lastSubmittedRevisionEvent": Event,
      "link": "xyz789",
      "name": "xyz789",
      "revisions": RevisionConnection,
      "sources": [Source],
      "variants": VariantInterfaceConnection
    }
  }
}
Queries

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 Gene {
        ...GeneFragment
      }
    }
    flagged
    flags {
      ...FlagConnectionFragment
    }
    fullName
    id
    lastAcceptedRevisionEvent {
      ...EventFragment
    }
    lastCommentEvent {
      ...EventFragment
    }
    lastSubmittedRevisionEvent {
      ...EventFragment
    }
    link
    name
    revisions {
      ...RevisionConnectionFragment
    }
    sources {
      ...SourceFragment
    }
    variants {
      ...VariantInterfaceConnectionFragment
    }
  }
}
Variables
{
  "featureType": "FACTOR",
  "queryTerm": "abc123"
}
Response
{
  "data": {
    "featureTypeahead": [
      {
        "comments": CommentConnection,
        "creationActivity": CreateFeatureActivity,
        "deprecated": true,
        "deprecationActivity": DeprecateFeatureActivity,
        "deprecationReason": "DUPLICATE",
        "description": "xyz789",
        "events": EventConnection,
        "featureAliases": ["abc123"],
        "featureInstance": Factor,
        "flagged": false,
        "flags": FlagConnection,
        "fullName": "xyz789",
        "id": 123,
        "lastAcceptedRevisionEvent": Event,
        "lastCommentEvent": Event,
        "lastSubmittedRevisionEvent": Event,
        "link": "xyz789",
        "name": "abc123",
        "revisions": RevisionConnection,
        "sources": [Source],
        "variants": VariantInterfaceConnection
      }
    ]
  }
}
Queries

flag

Description

Find a flag by CIViC ID

Response

Returns a Flag

Arguments
Name Description
id - Int!

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": "abc123",
      "name": "abc123",
      "openActivity": FlagEntityActivity,
      "resolutionActivity": ResolveFlagActivity,
      "resolvingUser": User,
      "state": "OPEN"
    }
  }
}
Queries

flags

Description

List and filter flags.

Response

Returns a FlagConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
flaggable - FlaggableInput
flaggingUserId - Int Limit to flags added by a certain user
last - Int Returns the last n elements from the list.
resolvingUserId - Int Limit to flags resolved by a certain user
sortBy - DateSort Sort order for the flags. Defaults to most recent.
state - FlagState Limit to flags in a particular state

Example

Query
query flags(
  $after: String,
  $before: String,
  $first: Int,
  $flaggable: FlaggableInput,
  $flaggingUserId: Int,
  $last: Int,
  $resolvingUserId: Int,
  $sortBy: DateSort,
  $state: FlagState
) {
  flags(
    after: $after,
    before: $before,
    first: $first,
    flaggable: $flaggable,
    flaggingUserId: $flaggingUserId,
    last: $last,
    resolvingUserId: $resolvingUserId,
    sortBy: $sortBy,
    state: $state
  ) {
    edges {
      ...FlagEdgeFragment
    }
    nodes {
      ...FlagFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
    unfilteredCountForSubject
    uniqueFlaggingUsers {
      ...UserFragment
    }
    uniqueResolvingUsers {
      ...UserFragment
    }
  }
}
Variables
{
  "after": "abc123",
  "before": "abc123",
  "first": 123,
  "flaggable": FlaggableInput,
  "flaggingUserId": 123,
  "last": 987,
  "resolvingUserId": 987,
  "sortBy": DateSort,
  "state": "OPEN"
}
Response
{
  "data": {
    "flags": {
      "edges": [FlagEdge],
      "nodes": [Flag],
      "pageCount": 123,
      "pageInfo": PageInfo,
      "totalCount": 123,
      "unfilteredCountForSubject": 987,
      "uniqueFlaggingUsers": [User],
      "uniqueResolvingUsers": [User]
    }
  }
}
Queries

gene

Description

Find a single gene by CIViC ID or Entrez symbol

Response

Returns a Gene

Arguments
Name Description
entrezSymbol - String
id - Int

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 Gene {
        ...GeneFragment
      }
    }
    flagged
    flags {
      ...FlagConnectionFragment
    }
    fullName
    id
    lastAcceptedRevisionEvent {
      ...EventFragment
    }
    lastCommentEvent {
      ...EventFragment
    }
    lastSubmittedRevisionEvent {
      ...EventFragment
    }
    link
    myGeneInfoDetails
    name
    revisions {
      ...RevisionConnectionFragment
    }
    sources {
      ...SourceFragment
    }
    variants {
      ...GeneVariantConnectionFragment
    }
  }
}
Variables
{"entrezSymbol": "abc123", "id": 987}
Response
{
  "data": {
    "gene": {
      "comments": CommentConnection,
      "creationActivity": CreateFeatureActivity,
      "deprecated": false,
      "deprecationActivity": DeprecateFeatureActivity,
      "deprecationReason": "DUPLICATE",
      "description": "abc123",
      "entrezId": 123,
      "events": EventConnection,
      "featureAliases": ["abc123"],
      "featureInstance": Factor,
      "flagged": false,
      "flags": FlagConnection,
      "fullName": "abc123",
      "id": 987,
      "lastAcceptedRevisionEvent": Event,
      "lastCommentEvent": Event,
      "lastSubmittedRevisionEvent": Event,
      "link": "abc123",
      "myGeneInfoDetails": {},
      "name": "xyz789",
      "revisions": RevisionConnection,
      "sources": [Source],
      "variants": GeneVariantConnection
    }
  }
}
Queries

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
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query genes(
  $after: String,
  $before: String,
  $entrezIds: [Int!],
  $entrezSymbols: [String!],
  $first: Int,
  $last: Int
) {
  genes(
    after: $after,
    before: $before,
    entrezIds: $entrezIds,
    entrezSymbols: $entrezSymbols,
    first: $first,
    last: $last
  ) {
    edges {
      ...GeneEdgeFragment
    }
    nodes {
      ...GeneFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "abc123",
  "before": "xyz789",
  "entrezIds": [987],
  "entrezSymbols": ["xyz789"],
  "first": 987,
  "last": 123
}
Response
{
  "data": {
    "genes": {
      "edges": [GeneEdge],
      "nodes": [Gene],
      "pageCount": 123,
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

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
    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": "xyz789",
      "events": EventConnection,
      "evidenceCountsByStatus": EvidenceItemsByStatus,
      "evidenceCountsByType": EvidenceItemsByType,
      "evidenceItems": EvidenceItemConnection,
      "flagged": true,
      "flags": FlagConnection,
      "id": 123,
      "isComplex": true,
      "isMultiVariant": true,
      "lastAcceptedRevisionEvent": Event,
      "lastCommentEvent": Event,
      "lastSubmittedRevisionEvent": Event,
      "link": "xyz789",
      "molecularProfileAliases": ["xyz789"],
      "molecularProfileScore": 987.65,
      "name": "abc123",
      "parsedName": [Feature],
      "rawName": "xyz789",
      "revisions": RevisionConnection,
      "sources": [Source],
      "variantCreationActivity": CreateVariantActivity,
      "variantDeprecationActivity": DeprecateVariantActivity,
      "variants": [VariantInterface]
    }
  }
}
Queries

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 - MolecularProfileDisplayFilter Limit molecular profiles by the status of attached evidence.
featureId - Int Filter molecular profiles to the CIViC ID of the feature(s) involved.
first - Int Returns the first n elements from the list.
geneId - Int Filter molecular profiles to the CIViC id of the gene(s) involved.
last - Int Returns the last n elements from the list.
name - String Left anchored filtering for molecular profile name and aliases.
variantId - Int Filter molecular profiles by the CIViC ID of an involved variant.

Example

Query
query molecularProfiles(
  $after: String,
  $alleleRegistryId: String,
  $before: String,
  $evidenceStatusFilter: MolecularProfileDisplayFilter,
  $featureId: Int,
  $first: Int,
  $geneId: Int,
  $last: Int,
  $name: String,
  $variantId: Int
) {
  molecularProfiles(
    after: $after,
    alleleRegistryId: $alleleRegistryId,
    before: $before,
    evidenceStatusFilter: $evidenceStatusFilter,
    featureId: $featureId,
    first: $first,
    geneId: $geneId,
    last: $last,
    name: $name,
    variantId: $variantId
  ) {
    edges {
      ...MolecularProfileEdgeFragment
    }
    nodes {
      ...MolecularProfileFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "alleleRegistryId": "abc123",
  "before": "xyz789",
  "evidenceStatusFilter": "ALL",
  "featureId": 987,
  "first": 123,
  "geneId": 987,
  "last": 987,
  "name": "abc123",
  "variantId": 987
}
Response
{
  "data": {
    "molecularProfiles": {
      "edges": [MolecularProfileEdge],
      "nodes": [MolecularProfile],
      "pageCount": 123,
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

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": 123,
      "name": "abc123"
    }
  }
}
Queries

nccnGuidelinesTypeahead

Description

Retrieve NCCN Guideline options as a typeahead

Response

Returns [NccnGuideline!]!

Arguments
Name Description
queryTerm - String!

Example

Query
query nccnGuidelinesTypeahead($queryTerm: String!) {
  nccnGuidelinesTypeahead(queryTerm: $queryTerm) {
    id
    name
  }
}
Variables
{"queryTerm": "abc123"}
Response
{
  "data": {
    "nccnGuidelinesTypeahead": [
      {"id": 987, "name": "xyz789"}
    ]
  }
}
Queries

notifications

Description

List and filter notifications for the logged in user.

Response

Returns a NotificationConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
eventType - EventAction
first - Int Returns the first n elements from the list.
includeRead - Boolean Default = false
last - Int Returns the last n elements from the list.
notificationReason - NotificationReason
organizationId - Int
originatingObject - SubscribableInput
originatingUserId - Int
subscriptionId - Int

Example

Query
query notifications(
  $after: String,
  $before: String,
  $eventType: EventAction,
  $first: Int,
  $includeRead: Boolean,
  $last: Int,
  $notificationReason: NotificationReason,
  $organizationId: Int,
  $originatingObject: SubscribableInput,
  $originatingUserId: Int,
  $subscriptionId: Int
) {
  notifications(
    after: $after,
    before: $before,
    eventType: $eventType,
    first: $first,
    includeRead: $includeRead,
    last: $last,
    notificationReason: $notificationReason,
    organizationId: $organizationId,
    originatingObject: $originatingObject,
    originatingUserId: $originatingUserId,
    subscriptionId: $subscriptionId
  ) {
    edges {
      ...NotificationEdgeFragment
    }
    eventTypes
    mentioningUsers {
      ...UserFragment
    }
    nodes {
      ...NotificationFragment
    }
    notificationSubjects {
      ...EventSubjectWithCountFragment
    }
    organizations {
      ...OrganizationFragment
    }
    originatingUsers {
      ...UserFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
    unreadCount
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "eventType": "ACCEPTED",
  "first": 987,
  "includeRead": false,
  "last": 987,
  "notificationReason": "MENTION",
  "organizationId": 987,
  "originatingObject": SubscribableInput,
  "originatingUserId": 987,
  "subscriptionId": 987
}
Response
{
  "data": {
    "notifications": {
      "edges": [NotificationEdge],
      "eventTypes": ["ACCEPTED"],
      "mentioningUsers": [User],
      "nodes": [Notification],
      "notificationSubjects": [EventSubjectWithCount],
      "organizations": [Organization],
      "originatingUsers": [User],
      "pageCount": 123,
      "pageInfo": PageInfo,
      "totalCount": 123,
      "unreadCount": 123
    }
  }
}
Queries

organization

Description

Find an organization by CIViC ID

Response

Returns an Organization

Arguments
Name Description
id - Int!

Example

Query
query organization($id: Int!) {
  organization(id: $id) {
    description
    eventCount
    events {
      ...EventConnectionFragment
    }
    id
    memberCount
    members {
      ...UserConnectionFragment
    }
    mostRecentActivityTimestamp
    name
    orgAndSuborgsStatsHash {
      ...StatsFragment
    }
    orgStatsHash {
      ...StatsFragment
    }
    profileImagePath
    ranks {
      ...RanksFragment
    }
    subGroups {
      ...OrganizationFragment
    }
    url
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "organization": {
      "description": "abc123",
      "eventCount": 987,
      "events": EventConnection,
      "id": 987,
      "memberCount": 123,
      "members": UserConnection,
      "mostRecentActivityTimestamp": ISO8601DateTime,
      "name": "abc123",
      "orgAndSuborgsStatsHash": Stats,
      "orgStatsHash": Stats,
      "profileImagePath": "xyz789",
      "ranks": Ranks,
      "subGroups": [Organization],
      "url": "xyz789"
    }
  }
}
Queries

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
    }
  }
}
Queries

organizations

Description

List and filter organizations.

Response

Returns an OrganizationConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
id - Int Exact match filtering on the id of the organization.
last - Int Returns the last n elements from the list.
name - String Substring filtering on the name of the organization.
sortBy - OrganizationSort Columm and direction to sort evidence on.

Example

Query
query organizations(
  $after: String,
  $before: String,
  $first: Int,
  $id: Int,
  $last: Int,
  $name: String,
  $sortBy: OrganizationSort
) {
  organizations(
    after: $after,
    before: $before,
    first: $first,
    id: $id,
    last: $last,
    name: $name,
    sortBy: $sortBy
  ) {
    edges {
      ...OrganizationEdgeFragment
    }
    nodes {
      ...OrganizationFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "abc123",
  "before": "xyz789",
  "first": 987,
  "id": 987,
  "last": 987,
  "name": "xyz789",
  "sortBy": OrganizationSort
}
Response
{
  "data": {
    "organizations": {
      "edges": [OrganizationEdge],
      "nodes": [Organization],
      "pageCount": 987,
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

phenotype

Description

Find a phenotype by CIViC ID

Response

Returns a Phenotype

Arguments
Name Description
id - Int!

Example

Query
query phenotype($id: Int!) {
  phenotype(id: $id) {
    description
    hpoId
    id
    link
    name
    url
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "phenotype": {
      "description": "xyz789",
      "hpoId": "abc123",
      "id": 987,
      "link": "abc123",
      "name": "abc123",
      "url": "abc123"
    }
  }
}
Queries

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": 987}
Response
{
  "data": {
    "phenotypePopover": {
      "assertionCount": 987,
      "description": "xyz789",
      "evidenceItemCount": 987,
      "hpoId": "abc123",
      "id": 987,
      "link": "abc123",
      "molecularProfileCount": 987,
      "name": "xyz789",
      "url": "abc123"
    }
  }
}
Queries

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": "xyz789",
        "hpoId": "abc123",
        "id": 987,
        "link": "abc123",
        "name": "xyz789",
        "url": "xyz789"
      }
    ]
  }
}
Queries

phenotypes

Description

List and filter Phenotypes from the Human Phenotype Ontology.

Response

Returns a BrowsePhenotypeConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
hpoId - String Limit to phenotypes with a specific HPO ID
id - Int Filter Phenotype on internal CIViC id
last - Int Returns the last n elements from the list.
name - String Wildcard match on phenotype name (class)
sortBy - PhenotypeSort Sort order for the phenotypes. Defaults to the highest evidence item count.

Example

Query
query phenotypes(
  $after: String,
  $before: String,
  $first: Int,
  $hpoId: String,
  $id: Int,
  $last: Int,
  $name: String,
  $sortBy: PhenotypeSort
) {
  phenotypes(
    after: $after,
    before: $before,
    first: $first,
    hpoId: $hpoId,
    id: $id,
    last: $last,
    name: $name,
    sortBy: $sortBy
  ) {
    edges {
      ...BrowsePhenotypeEdgeFragment
    }
    filteredCount
    lastUpdated
    nodes {
      ...BrowsePhenotypeFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "abc123",
  "before": "xyz789",
  "first": 987,
  "hpoId": "abc123",
  "id": 987,
  "last": 123,
  "name": "abc123",
  "sortBy": PhenotypeSort
}
Response
{
  "data": {
    "phenotypes": {
      "edges": [BrowsePhenotypeEdge],
      "filteredCount": 987,
      "lastUpdated": ISO8601DateTime,
      "nodes": [BrowsePhenotype],
      "pageCount": 987,
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

previewCommentText

Response

Returns [CommentBodySegment!]!

Arguments
Name Description
commentText - String!

Example

Query
query previewCommentText($commentText: String!) {
  previewCommentText(commentText: $commentText) {
    ... on CommentTagSegment {
      ...CommentTagSegmentFragment
    }
    ... on CommentTextSegment {
      ...CommentTextSegmentFragment
    }
    ... on User {
      ...UserFragment
    }
  }
}
Variables
{"commentText": "xyz789"}
Response
{"data": {"previewCommentText": [CommentTagSegment]}}
Queries

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]
    }
  }
}
Queries

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": "abc123"}}
Queries

revision

Description

Find a revision by CIViC ID

Response

Returns a Revision

Arguments
Name Description
id - Int!

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": "abc123",
      "id": 987,
      "lastCommentEvent": Event,
      "link": "abc123",
      "linkoutData": LinkoutData,
      "name": "abc123",
      "rejectionActivity": RejectRevisionsActivity,
      "resolutionActivity": ActivityInterface,
      "revisionSetId": 987,
      "status": "ACCEPTED",
      "subject": EventSubject,
      "suggestedValue": {},
      "supersedingActivity": AcceptRevisionsActivity,
      "updatedAt": ISO8601DateTime
    }
  }
}
Queries

revisions

Description

List and filter revisions.

Response

Returns a RevisionConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
fieldName - String Limit to revisions on a particular field.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.
originatingUserId - Int Limit to revisions by a certain user
resolvingUserId - Int Limit to revisions accepted, rejected, or superseded by a certain user
revisionSetId - Int Limit to revisions suggested as part of a single Revision Set.
sortBy - DateSort Sort order for the comments. Defaults to most recent.
status - RevisionStatus Limit to revisions with a certain status
subject - ModeratedInput Limit to revisions of a specific CIViC entity

Example

Query
query revisions(
  $after: String,
  $before: String,
  $fieldName: String,
  $first: Int,
  $last: Int,
  $originatingUserId: Int,
  $resolvingUserId: Int,
  $revisionSetId: Int,
  $sortBy: DateSort,
  $status: RevisionStatus,
  $subject: ModeratedInput
) {
  revisions(
    after: $after,
    before: $before,
    fieldName: $fieldName,
    first: $first,
    last: $last,
    originatingUserId: $originatingUserId,
    resolvingUserId: $resolvingUserId,
    revisionSetId: $revisionSetId,
    sortBy: $sortBy,
    status: $status,
    subject: $subject
  ) {
    edges {
      ...RevisionEdgeFragment
    }
    nodes {
      ...RevisionFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    revisedFieldNames {
      ...FieldNameFragment
    }
    totalCount
    unfilteredCountForSubject
    uniqueResolvers {
      ...UserFragment
    }
    uniqueRevisors {
      ...UserFragment
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "fieldName": "abc123",
  "first": 987,
  "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": 123,
      "unfilteredCountForSubject": 123,
      "uniqueResolvers": [User],
      "uniqueRevisors": [User]
    }
  }
}
Queries

searchGenes

Response

Returns an AdvancedSearchResult!

Arguments
Name Description
createPermalink - Boolean Default = false
query - GeneSearchFilter!

Example

Query
query searchGenes(
  $createPermalink: Boolean,
  $query: GeneSearchFilter!
) {
  searchGenes(
    createPermalink: $createPermalink,
    query: $query
  ) {
    permalinkId
    resultIds
    searchEndpoint
  }
}
Variables
{"createPermalink": false, "query": GeneSearchFilter}
Response
{
  "data": {
    "searchGenes": {
      "permalinkId": "xyz789",
      "resultIds": [987],
      "searchEndpoint": "xyz789"
    }
  }
}
Queries

source

Description

Find a source by CIViC ID

Response

Returns a Source

Arguments
Name Description
id - Int!

Example

Query
query source($id: Int!) {
  source(id: $id) {
    abstract
    ascoAbstractId
    authorString
    citation
    citationId
    clinicalTrials {
      ...ClinicalTrialFragment
    }
    comments {
      ...CommentConnectionFragment
    }
    displayType
    events {
      ...EventConnectionFragment
    }
    fullJournalTitle
    fullyCurated
    id
    journal
    lastCommentEvent {
      ...EventFragment
    }
    link
    name
    openAccess
    pmcId
    publicationDate
    publicationDay
    publicationMonth
    publicationYear
    sourceType
    sourceUrl
    title
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "source": {
      "abstract": "xyz789",
      "ascoAbstractId": 123,
      "authorString": "xyz789",
      "citation": "abc123",
      "citationId": "abc123",
      "clinicalTrials": [ClinicalTrial],
      "comments": CommentConnection,
      "displayType": "abc123",
      "events": EventConnection,
      "fullJournalTitle": "xyz789",
      "fullyCurated": true,
      "id": 123,
      "journal": "abc123",
      "lastCommentEvent": Event,
      "link": "abc123",
      "name": "abc123",
      "openAccess": true,
      "pmcId": "abc123",
      "publicationDate": "abc123",
      "publicationDay": 987,
      "publicationMonth": 123,
      "publicationYear": 123,
      "sourceType": "ASCO",
      "sourceUrl": "xyz789",
      "title": "abc123"
    }
  }
}
Queries

sourcePopover

Description

Retrieve popover fields for a specific source.

Response

Returns a SourcePopover

Arguments
Name Description
id - Int!

Example

Query
query sourcePopover($id: Int!) {
  sourcePopover(id: $id) {
    abstract
    ascoAbstractId
    authorString
    citation
    citationId
    clinicalTrials {
      ...ClinicalTrialFragment
    }
    comments {
      ...CommentConnectionFragment
    }
    displayType
    events {
      ...EventConnectionFragment
    }
    evidenceItemCount
    fullJournalTitle
    fullyCurated
    id
    journal
    lastCommentEvent {
      ...EventFragment
    }
    link
    name
    openAccess
    pmcId
    publicationDate
    publicationDay
    publicationMonth
    publicationYear
    sourceType
    sourceUrl
    title
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "sourcePopover": {
      "abstract": "abc123",
      "ascoAbstractId": 987,
      "authorString": "xyz789",
      "citation": "abc123",
      "citationId": "abc123",
      "clinicalTrials": [ClinicalTrial],
      "comments": CommentConnection,
      "displayType": "xyz789",
      "events": EventConnection,
      "evidenceItemCount": 987,
      "fullJournalTitle": "xyz789",
      "fullyCurated": false,
      "id": 987,
      "journal": "xyz789",
      "lastCommentEvent": Event,
      "link": "abc123",
      "name": "abc123",
      "openAccess": true,
      "pmcId": "xyz789",
      "publicationDate": "xyz789",
      "publicationDay": 987,
      "publicationMonth": 123,
      "publicationYear": 987,
      "sourceType": "ASCO",
      "sourceUrl": "abc123",
      "title": "abc123"
    }
  }
}
Queries

sourceSuggestionValues

Description

Given the parameters in a source suggestion, fetch the values to populate the add evidence form

Response

Returns a SourceSuggestionValues!

Arguments
Name Description
diseaseId - Int
molecularProfileId - Int
sourceId - Int

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": 987}
Response
{
  "data": {
    "sourceSuggestionValues": {
      "disease": Disease,
      "molecularProfile": MolecularProfile,
      "source": Source
    }
  }
}
Queries

sourceSuggestions

Response

Returns a SourceSuggestionConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
citation - String
citationId - Int
comment - String
diseaseName - String
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.
molecularProfileName - String
sortBy - SourceSuggestionsSort
sourceId - Int
sourceType - SourceSource
status - SourceSuggestionStatus
submitter - String
submitterId - Int

Example

Query
query sourceSuggestions(
  $after: String,
  $before: String,
  $citation: String,
  $citationId: Int,
  $comment: String,
  $diseaseName: String,
  $first: Int,
  $last: Int,
  $molecularProfileName: String,
  $sortBy: SourceSuggestionsSort,
  $sourceId: Int,
  $sourceType: SourceSource,
  $status: SourceSuggestionStatus,
  $submitter: String,
  $submitterId: Int
) {
  sourceSuggestions(
    after: $after,
    before: $before,
    citation: $citation,
    citationId: $citationId,
    comment: $comment,
    diseaseName: $diseaseName,
    first: $first,
    last: $last,
    molecularProfileName: $molecularProfileName,
    sortBy: $sortBy,
    sourceId: $sourceId,
    sourceType: $sourceType,
    status: $status,
    submitter: $submitter,
    submitterId: $submitterId
  ) {
    edges {
      ...SourceSuggestionEdgeFragment
    }
    filteredCount
    lastUpdated
    nodes {
      ...SourceSuggestionFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "citation": "abc123",
  "citationId": 123,
  "comment": "xyz789",
  "diseaseName": "xyz789",
  "first": 987,
  "last": 123,
  "molecularProfileName": "xyz789",
  "sortBy": SourceSuggestionsSort,
  "sourceId": 987,
  "sourceType": "ASCO",
  "status": "CURATED",
  "submitter": "xyz789",
  "submitterId": 987
}
Response
{
  "data": {
    "sourceSuggestions": {
      "edges": [SourceSuggestionEdge],
      "filteredCount": 123,
      "lastUpdated": ISO8601DateTime,
      "nodes": [SourceSuggestion],
      "pageCount": 987,
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

sourceTypeahead

Description

Provide suggestions for sources based on a partial citation ID

Response

Returns [Source!]!

Arguments
Name Description
citationId - String!
sourceType - SourceSource!

Example

Query
query sourceTypeahead(
  $citationId: String!,
  $sourceType: SourceSource!
) {
  sourceTypeahead(
    citationId: $citationId,
    sourceType: $sourceType
  ) {
    abstract
    ascoAbstractId
    authorString
    citation
    citationId
    clinicalTrials {
      ...ClinicalTrialFragment
    }
    comments {
      ...CommentConnectionFragment
    }
    displayType
    events {
      ...EventConnectionFragment
    }
    fullJournalTitle
    fullyCurated
    id
    journal
    lastCommentEvent {
      ...EventFragment
    }
    link
    name
    openAccess
    pmcId
    publicationDate
    publicationDay
    publicationMonth
    publicationYear
    sourceType
    sourceUrl
    title
  }
}
Variables
{
  "citationId": "abc123",
  "sourceType": "ASCO"
}
Response
{
  "data": {
    "sourceTypeahead": [
      {
        "abstract": "abc123",
        "ascoAbstractId": 987,
        "authorString": "xyz789",
        "citation": "abc123",
        "citationId": "xyz789",
        "clinicalTrials": [ClinicalTrial],
        "comments": CommentConnection,
        "displayType": "abc123",
        "events": EventConnection,
        "fullJournalTitle": "xyz789",
        "fullyCurated": true,
        "id": 987,
        "journal": "xyz789",
        "lastCommentEvent": Event,
        "link": "xyz789",
        "name": "xyz789",
        "openAccess": false,
        "pmcId": "abc123",
        "publicationDate": "abc123",
        "publicationDay": 987,
        "publicationMonth": 123,
        "publicationYear": 123,
        "sourceType": "ASCO",
        "sourceUrl": "xyz789",
        "title": "xyz789"
      }
    ]
  }
}
Queries

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
    }
  }
}
Queries

therapies

Description

List and filter Therapies from the NCI Thesaurus.

Response

Returns a BrowseTherapyConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
id - Int Filter on a therapy's internal CIViC id
last - Int Returns the last n elements from the list.
name - String Wildcard match on therapy name
ncitId - String Limit to therapies with a specific NCIT ID
sortBy - TherapySort Sort order for the therapies. Defaults to the highest evidence item count.

Example

Query
query therapies(
  $after: String,
  $before: String,
  $first: Int,
  $id: Int,
  $last: Int,
  $name: String,
  $ncitId: String,
  $sortBy: TherapySort
) {
  therapies(
    after: $after,
    before: $before,
    first: $first,
    id: $id,
    last: $last,
    name: $name,
    ncitId: $ncitId,
    sortBy: $sortBy
  ) {
    edges {
      ...BrowseTherapyEdgeFragment
    }
    filteredCount
    lastUpdated
    nodes {
      ...BrowseTherapyFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 123,
  "id": 987,
  "last": 987,
  "name": "xyz789",
  "ncitId": "xyz789",
  "sortBy": TherapySort
}
Response
{
  "data": {
    "therapies": {
      "edges": [BrowseTherapyEdge],
      "filteredCount": 987,
      "lastUpdated": ISO8601DateTime,
      "nodes": [BrowseTherapy],
      "pageCount": 987,
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

therapy

Description

Find a therapy by CIViC ID

Response

Returns a Therapy

Arguments
Name Description
id - Int!

Example

Query
query therapy($id: Int!) {
  therapy(id: $id) {
    id
    link
    myChemInfo {
      ...MyChemInfoFragment
    }
    name
    ncitId
    therapyAliases
    therapyUrl
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "therapy": {
      "id": 123,
      "link": "abc123",
      "myChemInfo": MyChemInfo,
      "name": "abc123",
      "ncitId": "abc123",
      "therapyAliases": ["xyz789"],
      "therapyUrl": "abc123"
    }
  }
}
Queries

therapyPopover

Description

Retrieve popover fields for a specific therapy.

Response

Returns a TherapyPopover

Arguments
Name Description
id - Int!

Example

Query
query therapyPopover($id: Int!) {
  therapyPopover(id: $id) {
    assertionCount
    evidenceItemCount
    id
    link
    molecularProfileCount
    myChemInfo {
      ...MyChemInfoFragment
    }
    name
    ncitId
    therapyAliases
    therapyUrl
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "therapyPopover": {
      "assertionCount": 123,
      "evidenceItemCount": 123,
      "id": 123,
      "link": "xyz789",
      "molecularProfileCount": 123,
      "myChemInfo": MyChemInfo,
      "name": "xyz789",
      "ncitId": "abc123",
      "therapyAliases": ["xyz789"],
      "therapyUrl": "abc123"
    }
  }
}
Queries

therapyTypeahead

Description

Retrieve therapy typeahead fields for a search term.

Response

Returns [Therapy!]!

Arguments
Name Description
queryTerm - String!

Example

Query
query therapyTypeahead($queryTerm: String!) {
  therapyTypeahead(queryTerm: $queryTerm) {
    id
    link
    myChemInfo {
      ...MyChemInfoFragment
    }
    name
    ncitId
    therapyAliases
    therapyUrl
  }
}
Variables
{"queryTerm": "xyz789"}
Response
{
  "data": {
    "therapyTypeahead": [
      {
        "id": 987,
        "link": "abc123",
        "myChemInfo": MyChemInfo,
        "name": "xyz789",
        "ncitId": "xyz789",
        "therapyAliases": ["abc123"],
        "therapyUrl": "abc123"
      }
    ]
  }
}
Queries

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
    }
  }
}
Queries

user

Response

Returns a User

Arguments
Name Description
id - Int!

Example

Query
query user($id: Int!) {
  user(id: $id) {
    areaOfExpertise
    bio
    country {
      ...CountryFragment
    }
    displayName
    email
    events {
      ...EventConnectionFragment
    }
    facebookProfile
    id
    linkedinProfile
    mostRecentActivityTimestamp
    mostRecentConflictOfInterestStatement {
      ...CoiFragment
    }
    mostRecentEvent {
      ...EventFragment
    }
    mostRecentOrganizationId
    name
    notifications {
      ...NotificationConnectionFragment
    }
    orcid
    organizations {
      ...OrganizationFragment
    }
    profileImagePath
    ranks {
      ...RanksFragment
    }
    role
    statsHash {
      ...StatsFragment
    }
    twitterHandle
    url
    username
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "user": {
      "areaOfExpertise": "CLINICAL_SCIENTIST",
      "bio": "xyz789",
      "country": Country,
      "displayName": "abc123",
      "email": "abc123",
      "events": EventConnection,
      "facebookProfile": "xyz789",
      "id": 987,
      "linkedinProfile": "abc123",
      "mostRecentActivityTimestamp": ISO8601DateTime,
      "mostRecentConflictOfInterestStatement": Coi,
      "mostRecentEvent": Event,
      "mostRecentOrganizationId": 987,
      "name": "abc123",
      "notifications": NotificationConnection,
      "orcid": "abc123",
      "organizations": [Organization],
      "profileImagePath": "abc123",
      "ranks": Ranks,
      "role": "ADMIN",
      "statsHash": Stats,
      "twitterHandle": "abc123",
      "url": "xyz789",
      "username": "xyz789"
    }
  }
}
Queries

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
    }
  }
}
Queries

userTypeahead

Description

Retrieve user type typeahead fields for a search term.

Response

Returns [User!]!

Arguments
Name Description
queryTerm - String!

Example

Query
query userTypeahead($queryTerm: String!) {
  userTypeahead(queryTerm: $queryTerm) {
    areaOfExpertise
    bio
    country {
      ...CountryFragment
    }
    displayName
    email
    events {
      ...EventConnectionFragment
    }
    facebookProfile
    id
    linkedinProfile
    mostRecentActivityTimestamp
    mostRecentConflictOfInterestStatement {
      ...CoiFragment
    }
    mostRecentEvent {
      ...EventFragment
    }
    mostRecentOrganizationId
    name
    notifications {
      ...NotificationConnectionFragment
    }
    orcid
    organizations {
      ...OrganizationFragment
    }
    profileImagePath
    ranks {
      ...RanksFragment
    }
    role
    statsHash {
      ...StatsFragment
    }
    twitterHandle
    url
    username
  }
}
Variables
{"queryTerm": "xyz789"}
Response
{
  "data": {
    "userTypeahead": [
      {
        "areaOfExpertise": "CLINICAL_SCIENTIST",
        "bio": "xyz789",
        "country": Country,
        "displayName": "abc123",
        "email": "abc123",
        "events": EventConnection,
        "facebookProfile": "abc123",
        "id": 123,
        "linkedinProfile": "xyz789",
        "mostRecentActivityTimestamp": ISO8601DateTime,
        "mostRecentConflictOfInterestStatement": Coi,
        "mostRecentEvent": Event,
        "mostRecentOrganizationId": 123,
        "name": "xyz789",
        "notifications": NotificationConnection,
        "orcid": "abc123",
        "organizations": [Organization],
        "profileImagePath": "abc123",
        "ranks": Ranks,
        "role": "ADMIN",
        "statsHash": Stats,
        "twitterHandle": "abc123",
        "url": "xyz789",
        "username": "xyz789"
      }
    ]
  }
}
Queries

users

Description

List and filter users.

Response

Returns a UserConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.
name - String Filtering on name
organization - OrganizationFilter Limit to users that belong to a certain organizations
role - UserRole Filtering on role.
sortBy - UsersSort Sort user columns in ascending or decending order
username - String Filtering on username

Example

Query
query users(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $name: String,
  $organization: OrganizationFilter,
  $role: UserRole,
  $sortBy: UsersSort,
  $username: String
) {
  users(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    name: $name,
    organization: $organization,
    role: $role,
    sortBy: $sortBy,
    username: $username
  ) {
    edges {
      ...UserEdgeFragment
    }
    nodes {
      ...UserFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 987,
  "last": 123,
  "name": "abc123",
  "organization": OrganizationFilter,
  "role": "ADMIN",
  "sortBy": UsersSort,
  "username": "abc123"
}
Response
{
  "data": {
    "users": {
      "edges": [UserEdge],
      "nodes": [User],
      "pageCount": 987,
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

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": ["xyz789"],
      "validationErrors": [FieldValidationError]
    }
  }
}
Queries

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
    revisions {
      ...RevisionConnectionFragment
    }
    singleVariantMolecularProfile {
      ...MolecularProfileFragment
    }
    singleVariantMolecularProfileId
    variantAliases
    variantTypes {
      ...VariantTypeFragment
    }
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "variant": {
      "comments": CommentConnection,
      "creationActivity": CreateVariantActivity,
      "deprecated": true,
      "deprecationActivity": DeprecateVariantActivity,
      "deprecationReason": "DUPLICATE",
      "events": EventConnection,
      "feature": Feature,
      "flagged": true,
      "flags": FlagConnection,
      "id": 987,
      "lastAcceptedRevisionEvent": Event,
      "lastCommentEvent": Event,
      "lastSubmittedRevisionEvent": Event,
      "link": "abc123",
      "molecularProfiles": MolecularProfileConnection,
      "name": "abc123",
      "revisions": RevisionConnection,
      "singleVariantMolecularProfile": MolecularProfile,
      "singleVariantMolecularProfileId": 123,
      "variantAliases": ["xyz789"],
      "variantTypes": [VariantType]
    }
  }
}
Queries

variantGroup

Description

Find a variant group by CIViC ID

Response

Returns a VariantGroup

Arguments
Name Description
id - Int!

Example

Query
query variantGroup($id: Int!) {
  variantGroup(id: $id) {
    comments {
      ...CommentConnectionFragment
    }
    description
    events {
      ...EventConnectionFragment
    }
    flagged
    flags {
      ...FlagConnectionFragment
    }
    id
    lastAcceptedRevisionEvent {
      ...EventFragment
    }
    lastCommentEvent {
      ...EventFragment
    }
    lastSubmittedRevisionEvent {
      ...EventFragment
    }
    link
    name
    revisions {
      ...RevisionConnectionFragment
    }
    sources {
      ...SourceFragment
    }
    variants {
      ...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": "xyz789",
      "name": "abc123",
      "revisions": RevisionConnection,
      "sources": [Source],
      "variants": VariantInterfaceConnection
    }
  }
}
Queries

variantGroups

Description

List and filter variant groups.

Response

Returns a VariantGroupConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query variantGroups(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  variantGroups(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...VariantGroupEdgeFragment
    }
    nodes {
      ...VariantGroupFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "variantGroups": {
      "edges": [VariantGroupEdge],
      "nodes": [VariantGroup],
      "pageCount": 123,
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

variantType

Description

Find a variant type by CIViC ID

Response

Returns a VariantType

Arguments
Name Description
id - Int!

Example

Query
query variantType($id: Int!) {
  variantType(id: $id) {
    description
    id
    link
    name
    soid
    url
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "variantType": {
      "description": "xyz789",
      "id": 123,
      "link": "xyz789",
      "name": "xyz789",
      "soid": "xyz789",
      "url": "abc123"
    }
  }
}
Queries

variantTypePopover

Description

Retrieve popover fields for a specific variant type.

Response

Returns a VariantTypePopover

Arguments
Name Description
id - Int!

Example

Query
query variantTypePopover($id: Int!) {
  variantTypePopover(id: $id) {
    description
    id
    link
    name
    soid
    url
    variantCount
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "variantTypePopover": {
      "description": "abc123",
      "id": 987,
      "link": "abc123",
      "name": "xyz789",
      "soid": "xyz789",
      "url": "xyz789",
      "variantCount": 987
    }
  }
}
Queries

variantTypeTypeahead

Description

Retrieve variant type typeahead fields for a search term.

Response

Returns [VariantType!]!

Arguments
Name Description
queryTerm - String!

Example

Query
query variantTypeTypeahead($queryTerm: String!) {
  variantTypeTypeahead(queryTerm: $queryTerm) {
    description
    id
    link
    name
    soid
    url
  }
}
Variables
{"queryTerm": "xyz789"}
Response
{
  "data": {
    "variantTypeTypeahead": [
      {
        "description": "abc123",
        "id": 987,
        "link": "xyz789",
        "name": "xyz789",
        "soid": "abc123",
        "url": "abc123"
      }
    ]
  }
}
Queries

variantTypes

Description

List and filter Variant Types from the Sequence Ontology.

Response

Returns a BrowseVariantTypeConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
featureId - Int Filter variant types by internal CIViC id a feature
first - Int Returns the first n elements from the list.
geneId - Int Filter variant types by internal CIViC id of a gene
id - Int Filter variant types by internal CIViC id
last - Int Returns the last n elements from the list.
name - String Wildcard match on variant type name
soid - String Limit to variant types with a specific Sequence Ontology ID
sortBy - VariantTypeSort Sort order for the variant type. Defaults to most recent.

Example

Query
query variantTypes(
  $after: String,
  $before: String,
  $featureId: Int,
  $first: Int,
  $geneId: Int,
  $id: Int,
  $last: Int,
  $name: String,
  $soid: String,
  $sortBy: VariantTypeSort
) {
  variantTypes(
    after: $after,
    before: $before,
    featureId: $featureId,
    first: $first,
    geneId: $geneId,
    id: $id,
    last: $last,
    name: $name,
    soid: $soid,
    sortBy: $sortBy
  ) {
    edges {
      ...BrowseVariantTypeEdgeFragment
    }
    filteredCount
    lastUpdated
    nodes {
      ...BrowseVariantTypeFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "abc123",
  "before": "abc123",
  "featureId": 123,
  "first": 123,
  "geneId": 123,
  "id": 123,
  "last": 123,
  "name": "xyz789",
  "soid": "xyz789",
  "sortBy": VariantTypeSort
}
Response
{
  "data": {
    "variantTypes": {
      "edges": [BrowseVariantTypeEdge],
      "filteredCount": 123,
      "lastUpdated": ISO8601DateTime,
      "nodes": [BrowseVariantType],
      "pageCount": 123,
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}
Queries

variants

Description

List and filter variants.

Response

Returns a VariantInterfaceConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
alleleRegistryId - String Find a CIViC Variant based on its ClinGen Allele Registry ID
before - String Returns the elements in the list that come before the specified cursor.
category - VariantCategories
factorId - Int Feature that the variants are associated with, limited to only Factor type features.
featureId - Int Feature that the variants are associated with.
first - Int Returns the first n elements from the list.
geneId - Int Feature that the variants are associated with, limited to only Gene type features.
hasNoVariantType - Boolean Return Variants lacking an assigned VariantType
last - Int Returns the last n elements from the list.
name - String Left anchored filtering for variant name and aliases.
sortBy - VariantMenuSort
variantTypeIds - [Int!] A list of CIViC identifiers for variant types

Example

Query
query variants(
  $after: String,
  $alleleRegistryId: String,
  $before: String,
  $category: VariantCategories,
  $factorId: Int,
  $featureId: Int,
  $first: Int,
  $geneId: Int,
  $hasNoVariantType: Boolean,
  $last: Int,
  $name: String,
  $sortBy: VariantMenuSort,
  $variantTypeIds: [Int!]
) {
  variants(
    after: $after,
    alleleRegistryId: $alleleRegistryId,
    before: $before,
    category: $category,
    factorId: $factorId,
    featureId: $featureId,
    first: $first,
    geneId: $geneId,
    hasNoVariantType: $hasNoVariantType,
    last: $last,
    name: $name,
    sortBy: $sortBy,
    variantTypeIds: $variantTypeIds
  ) {
    edges {
      ...VariantInterfaceEdgeFragment
    }
    nodes {
      ...VariantInterfaceFragment
    }
    pageCount
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "abc123",
  "alleleRegistryId": "xyz789",
  "before": "xyz789",
  "category": "FACTOR",
  "factorId": 987,
  "featureId": 123,
  "first": 987,
  "geneId": 123,
  "hasNoVariantType": true,
  "last": 123,
  "name": "abc123",
  "sortBy": VariantMenuSort,
  "variantTypeIds": [123]
}
Response
{
  "data": {
    "variants": {
      "edges": [VariantInterfaceEdge],
      "nodes": [VariantInterface],
      "pageCount": 123,
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}
Queries

variantsTypeahead

Response

Returns [Variant!]!

Arguments
Name Description
featureId - Int
queryTerm - String!

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
    revisions {
      ...RevisionConnectionFragment
    }
    singleVariantMolecularProfile {
      ...MolecularProfileFragment
    }
    singleVariantMolecularProfileId
    variantAliases
    variantTypes {
      ...VariantTypeFragment
    }
  }
}
Variables
{"featureId": 123, "queryTerm": "xyz789"}
Response
{
  "data": {
    "variantsTypeahead": [
      {
        "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",
        "revisions": RevisionConnection,
        "singleVariantMolecularProfile": MolecularProfile,
        "singleVariantMolecularProfileId": 987,
        "variantAliases": ["abc123"],
        "variantTypes": [VariantType]
      }
    ]
  }
}
Queries

viewer

Response

Returns a User

Example

Query
query viewer {
  viewer {
    areaOfExpertise
    bio
    country {
      ...CountryFragment
    }
    displayName
    email
    events {
      ...EventConnectionFragment
    }
    facebookProfile
    id
    linkedinProfile
    mostRecentActivityTimestamp
    mostRecentConflictOfInterestStatement {
      ...CoiFragment
    }
    mostRecentEvent {
      ...EventFragment
    }
    mostRecentOrganizationId
    name
    notifications {
      ...NotificationConnectionFragment
    }
    orcid
    organizations {
      ...OrganizationFragment
    }
    profileImagePath
    ranks {
      ...RanksFragment
    }
    role
    statsHash {
      ...StatsFragment
    }
    twitterHandle
    url
    username
  }
}
Response
{
  "data": {
    "viewer": {
      "areaOfExpertise": "CLINICAL_SCIENTIST",
      "bio": "abc123",
      "country": Country,
      "displayName": "xyz789",
      "email": "abc123",
      "events": EventConnection,
      "facebookProfile": "abc123",
      "id": 123,
      "linkedinProfile": "xyz789",
      "mostRecentActivityTimestamp": ISO8601DateTime,
      "mostRecentConflictOfInterestStatement": Coi,
      "mostRecentEvent": Event,
      "mostRecentOrganizationId": 987,
      "name": "xyz789",
      "notifications": NotificationConnection,
      "orcid": "abc123",
      "organizations": [Organization],
      "profileImagePath": "xyz789",
      "ranks": Ranks,
      "role": "ADMIN",
      "statsHash": Stats,
      "twitterHandle": "xyz789",
      "url": "abc123",
      "username": "xyz789"
    }
  }
}

Mutations

acceptRevisions

Description

Accept multiple revisions by ID. The accepting user must be an editor with a valid conflict of interest statement on file and the revisions must not be their own. The revisions must be for the same subject. The revisions may not conflict, i.e. be for the same field.

Response

Returns an AcceptRevisionsPayload

Arguments
Name Description
input - AcceptRevisionsInput! Parameters for AcceptRevisions

Example

Query
mutation acceptRevisions($input: AcceptRevisionsInput!) {
  acceptRevisions(input: $input) {
    clientMutationId
    revisions {
      ...RevisionFragment
    }
    supersededRevisions {
      ...RevisionFragment
    }
  }
}
Variables
{"input": AcceptRevisionsInput}
Response
{
  "data": {
    "acceptRevisions": {
      "clientMutationId": "abc123",
      "revisions": [Revision],
      "supersededRevisions": [Revision]
    }
  }
}
Mutations

addComment

Description

Add a comment to any commentable entity.

Response

Returns an AddCommentPayload

Arguments
Name Description
input - AddCommentInput! Parameters for AddComment

Example

Query
mutation addComment($input: AddCommentInput!) {
  addComment(input: $input) {
    clientMutationId
    comment {
      ...CommentFragment
    }
  }
}
Variables
{"input": AddCommentInput}
Response
{
  "data": {
    "addComment": {
      "clientMutationId": "abc123",
      "comment": Comment
    }
  }
}
Mutations

addDisease

Description

Add a new disease to the database.

Response

Returns an AddDiseasePayload

Arguments
Name Description
input - AddDiseaseInput! Parameters for AddDisease

Example

Query
mutation addDisease($input: AddDiseaseInput!) {
  addDisease(input: $input) {
    clientMutationId
    disease {
      ...DiseaseFragment
    }
    new
  }
}
Variables
{"input": AddDiseaseInput}
Response
{
  "data": {
    "addDisease": {
      "clientMutationId": "xyz789",
      "disease": Disease,
      "new": true
    }
  }
}
Mutations

addRemoteCitation

Description

Add a stub record for an external source that is not yet in CIViC. This is for adding a new Source inline while performing other curation activities such as adding new evidence items and is distinct from suggesting a source for curation.

Response

Returns an AddRemoteCitationPayload

Arguments
Name Description
input - AddRemoteCitationInput! Parameters for AddRemoteCitation

Example

Query
mutation addRemoteCitation($input: AddRemoteCitationInput!) {
  addRemoteCitation(input: $input) {
    clientMutationId
    newSource {
      ...SourceStubFragment
    }
  }
}
Variables
{"input": AddRemoteCitationInput}
Response
{
  "data": {
    "addRemoteCitation": {
      "clientMutationId": "abc123",
      "newSource": SourceStub
    }
  }
}
Mutations

addTherapy

Description

Add a new therapy to the database.

Response

Returns an AddTherapyPayload

Arguments
Name Description
input - AddTherapyInput! Parameters for AddTherapy

Example

Query
mutation addTherapy($input: AddTherapyInput!) {
  addTherapy(input: $input) {
    clientMutationId
    new
    therapy {
      ...TherapyFragment
    }
  }
}
Variables
{"input": AddTherapyInput}
Response
{
  "data": {
    "addTherapy": {
      "clientMutationId": "xyz789",
      "new": true,
      "therapy": Therapy
    }
  }
}
Mutations

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": "xyz789",
      "feature": Feature,
      "new": false
    }
  }
}
Mutations

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
    }
  }
}
Mutations

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
    }
  }
}
Mutations

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
    }
  }
}
Mutations

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]
    }
  }
}
Mutations

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
    }
  }
}
Mutations

editUser

Description

Updated currently logged in Users's profile

Response

Returns an EditUserPayload

Arguments
Name Description
input - EditUserInput! Parameters for EditUser

Example

Query
mutation editUser($input: EditUserInput!) {
  editUser(input: $input) {
    clientMutationId
    user {
      ...UserFragment
    }
  }
}
Variables
{"input": EditUserInput}
Response
{
  "data": {
    "editUser": {
      "clientMutationId": "abc123",
      "user": User
    }
  }
}
Mutations

flagEntity

Description

Flag an entity to signal to the editorial team that you believe there is an issue with it.

Response

Returns a FlagEntityPayload

Arguments
Name Description
input - FlagEntityInput! Parameters for FlagEntity

Example

Query
mutation flagEntity($input: FlagEntityInput!) {
  flagEntity(input: $input) {
    clientMutationId
    flag {
      ...FlagFragment
    }
  }
}
Variables
{"input": FlagEntityInput}
Response
{
  "data": {
    "flagEntity": {
      "clientMutationId": "abc123",
      "flag": Flag
    }
  }
}
Mutations

moderateAssertion

Description

Perform moderation actions on an assertion such as accepting, rejecting, or reverting.

Response

Returns a ModerateAssertionPayload

Arguments
Name Description
input - ModerateAssertionInput! Parameters for ModerateAssertion

Example

Query
mutation moderateAssertion($input: ModerateAssertionInput!) {
  moderateAssertion(input: $input) {
    assertion {
      ...AssertionFragment
    }
    clientMutationId
  }
}
Variables
{"input": ModerateAssertionInput}
Response
{
  "data": {
    "moderateAssertion": {
      "assertion": Assertion,
      "clientMutationId": "xyz789"
    }
  }
}
Mutations

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
    }
  }
}
Mutations

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": "xyz789",
      "revisions": [Revision]
    }
  }
}
Mutations

resolveFlag

Description

Resolve a flag on a CIViC entity indicating that it was either erronously flagged or the issue has been resolved. Any user may resolve their own flag however only editors with valid conflict of interest statements can resolve other flags.

Response

Returns a ResolveFlagPayload

Arguments
Name Description
input - ResolveFlagInput! Parameters for ResolveFlag

Example

Query
mutation resolveFlag($input: ResolveFlagInput!) {
  resolveFlag(input: $input) {
    clientMutationId
    flag {
      ...FlagFragment
    }
  }
}
Variables
{"input": ResolveFlagInput}
Response
{
  "data": {
    "resolveFlag": {
      "clientMutationId": "xyz789",
      "flag": Flag
    }
  }
}
Mutations

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"
    }
  }
}
Mutations

submitEvidence

Description

Propose adding a new EvidenceItem to the CIViC database.

Response

Returns a SubmitEvidenceItemPayload

Arguments
Name Description
input - SubmitEvidenceItemInput! Parameters for SubmitEvidenceItem

Example

Query
mutation submitEvidence($input: SubmitEvidenceItemInput!) {
  submitEvidence(input: $input) {
    clientMutationId
    evidenceItem {
      ...EvidenceItemFragment
    }
  }
}
Variables
{"input": SubmitEvidenceItemInput}
Response
{
  "data": {
    "submitEvidence": {
      "clientMutationId": "xyz789",
      "evidenceItem": EvidenceItem
    }
  }
}
Mutations

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
    }
  }
}
Mutations

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": "abc123",
      "subscriptions": [Subscription]
    }
  }
}
Mutations

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]
    }
  }
}
Mutations

suggestEvidenceItemRevision

Description

Suggest a Revision to an EvidenceItem entity.

Response

Returns a SuggestEvidenceItemRevisionPayload

Arguments
Name Description
input - SuggestEvidenceItemRevisionInput! Parameters for SuggestEvidenceItemRevision

Example

Query
mutation suggestEvidenceItemRevision($input: SuggestEvidenceItemRevisionInput!) {
  suggestEvidenceItemRevision(input: $input) {
    clientMutationId
    evidenceItem {
      ...EvidenceItemFragment
    }
    results {
      ...RevisionResultFragment
    }
  }
}
Variables
{"input": SuggestEvidenceItemRevisionInput}
Response
{
  "data": {
    "suggestEvidenceItemRevision": {
      "clientMutationId": "xyz789",
      "evidenceItem": EvidenceItem,
      "results": [RevisionResult]
    }
  }
}
Mutations

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]
    }
  }
}
Mutations

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
    }
  }
}
Mutations

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]
    }
  }
}
Mutations

suggestGeneVariantRevision

Description

Suggest a Revision to a Variant entity.

Response

Returns a SuggestGeneVariantRevisionPayload

Arguments
Name Description
input - SuggestGeneVariantRevisionInput! Parameters for SuggestGeneVariantRevision

Example

Query
mutation suggestGeneVariantRevision($input: SuggestGeneVariantRevisionInput!) {
  suggestGeneVariantRevision(input: $input) {
    clientMutationId
    results {
      ...RevisionResultFragment
    }
    variant {
      ...GeneVariantFragment
    }
  }
}
Variables
{"input": SuggestGeneVariantRevisionInput}
Response
{
  "data": {
    "suggestGeneVariantRevision": {
      "clientMutationId": "xyz789",
      "results": [RevisionResult],
      "variant": GeneVariant
    }
  }
}
Mutations

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]
    }
  }
}
Mutations

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
    }
  }
}
Mutations

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
    }
  }
}
Mutations

unsubscribe

Description

Unsubscribe from a CIViC entity to stop receiving notifications about it.

Response

Returns an UnsubscribePayload

Arguments
Name Description
input - UnsubscribeInput! Parameters for Unsubscribe

Example

Query
mutation unsubscribe($input: UnsubscribeInput!) {
  unsubscribe(input: $input) {
    clientMutationId
    unsubscribedEntities {
      ...SubscribableFragment
    }
  }
}
Variables
{"input": UnsubscribeInput}
Response
{
  "data": {
    "unsubscribe": {
      "clientMutationId": "xyz789",
      "unsubscribedEntities": [Subscribable]
    }
  }
}
Mutations

updateCoi

Description

Update the currentlly logged in User's Conflict of Interest statement

Response

Returns an UpdateCoiPayload

Arguments
Name Description
input - UpdateCoiInput! Parameters for UpdateCoi

Example

Query
mutation updateCoi($input: UpdateCoiInput!) {
  updateCoi(input: $input) {
    clientMutationId
    coiStatement {
      ...CoiFragment
    }
  }
}
Variables
{"input": UpdateCoiInput}
Response
{
  "data": {
    "updateCoi": {
      "clientMutationId": "xyz789",
      "coiStatement": Coi
    }
  }
}
Mutations

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]
    }
  }
}
Mutations

updateSourceSuggestionStatus

Description

Update the status of a SourceSuggestion by ID. The user updating the SourceSuggestion must be signed in.

Response

Returns an UpdateSourceSuggestionStatusPayload

Arguments
Name Description
input - UpdateSourceSuggestionStatusInput! Parameters for UpdateSourceSuggestionStatus

Example

Query
mutation updateSourceSuggestionStatus($input: UpdateSourceSuggestionStatusInput!) {
  updateSourceSuggestionStatus(input: $input) {
    clientMutationId
    sourceSuggestion {
      ...SourceSuggestionFragment
    }
  }
}
Variables
{"input": UpdateSourceSuggestionStatusInput}
Response
{
  "data": {
    "updateSourceSuggestionStatus": {
      "clientMutationId": "xyz789",
      "sourceSuggestion": SourceSuggestion
    }
  }
}

Subscriptions

id

Response

Returns an Int!

Example

Query
subscription id {
  id
}
Response
{"data": {"id": 123}}
Subscriptions

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": 123,
  "note": "abc123",
  "organization": Organization,
  "parsedNote": [CommentTagSegment],
  "revisions": [Revision],
  "subject": EventSubject,
  "supersededRevisions": [Revision],
  "user": User,
  "verbiage": "abc123"
}
Types

AcceptRevisionsInput

Description

Autogenerated input type of AcceptRevisions

Fields
Input Field Description
clientMutationId - String A unique identifier for the client performing the mutation.
comment - String Body of an optional comment to attach to the revision on acceptance.
ids - [Int!] A list of IDs of the Revisions to accept.
organizationId - Int The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided.
revisionSetId - Int The ID of a revision set.
Example
{
  "clientMutationId": "xyz789",
  "comment": "xyz789",
  "ids": [987],
  "organizationId": 987,
  "revisionSetId": 123
}
Types

AcceptRevisionsPayload

Description

Autogenerated return type of AcceptRevisions.

Fields
Field Name Description
clientMutationId - String A unique identifier for the client performing the mutation.
revisions - [Revision!]! A list of newly accepted Revisions.
supersededRevisions - [Revision!]! A list of any revisions that were superseded by the acceptance of this one.
Example
{
  "clientMutationId": "xyz789",
  "revisions": [Revision],
  "supersededRevisions": [Revision]
}
Types

AcmgCode

Fields
Field Name Description
code - String!
description - String!
id - Int!
name - String!
tooltip - String!
Example
{
  "code": "abc123",
  "description": "xyz789",
  "id": 123,
  "name": "abc123",
  "tooltip": "abc123"
}
Types

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

AcceptRevisionsActivity

CommentActivity

CreateComplexMolecularProfileActivity

CreateFeatureActivity

CreateVariantActivity

DeprecateComplexMolecularProfileActivity

DeprecateFeatureActivity

DeprecateVariantActivity

FlagEntityActivity

ModerateAssertionActivity

ModerateEvidenceItemActivity

RejectRevisionsActivity

ResolveFlagActivity

SubmitAssertionActivity

SubmitEvidenceItemActivity

SuggestRevisionSetActivity

SuggestSourceActivity

UpdateSourceSuggestionStatusActivity
Example
{
  "createdAt": ISO8601DateTime,
  "events": [Event],
  "id": 987,
  "note": "abc123",
  "organization": Organization,
  "parsedNote": [CommentTagSegment],
  "subject": EventSubject,
  "user": User,
  "verbiage": "xyz789"
}
Types

ActivityInterfaceConnection

Description

The connection type for ActivityInterface.

Fields
Field Name Description
activityTypes - [ActivityTypeInput!]! List of activity types that have occured 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": 123,
  "pageInfo": PageInfo,
  "participatingOrganizations": [Organization],
  "subjectTypes": ["ASSERTION"],
  "totalCount": 123,
  "unfilteredCount": 987,
  "uniqueParticipants": [User]
}
Types

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": "xyz789",
  "node": ActivityInterface
}
Types

ActivitySubjectInput

Values
Enum Value Description

ASSERTION

EVIDENCE_ITEM

FEATURE

FLAG

MOLECULAR_PROFILE

REVISION

REVISION_SET

SOURCE

SOURCE_SUGGESTION

VARIANT

VARIANT_GROUP
Example
"ASSERTION"
Types

ActivityTypeInput

Values
Enum Value Description

ACCEPT_REVISIONS

COMMENT

CREATE_COMPLEX_MOLECULAR_PROFILE

CREATE_FEATURE

CREATE_VARIANT

DEPRECATE_COMPLEX_MOLECULAR_PROFILE

DEPRECATE_FEATURE

DEPRECATE_VARIANT

FLAG_ENTITY

MODERATE_ASSERTION

MODERATE_EVIDENCE_ITEM

REJECT_REVISIONS

RESOLVE_FLAG

SUBMIT_ASSERTION

SUBMIT_EVIDENCE_ITEM

SUGGEST_REVISION

SUGGEST_SOURCE

UPDATE_SOURCE_SUGGESTION
Example
"ACCEPT_REVISIONS"
Types

AddCommentInput

Description

Autogenerated input type of AddComment

Fields
Input Field Description
body - String! Text of the comment.
clientMutationId - String A unique identifier for the client performing the mutation.
organizationId - Int The ID of the organization to credit the user's contributions to. If the user belongs to a single organization or no organizations, this field is not required. This field is required if the user belongs to more than one organization. The user must belong to the organization provided.
subject - CommentableInput! The commentable to attach the comment to. Specified by ID and Type.
title - String Optional title for the comment.
Example
{
  "body": "abc123",
  "clientMutationId": "xyz789",
  "organizationId": 987,
  "subject": CommentableInput,
  "title": "xyz789"
}
Types

AddCommentPayload

Description

Autogenerated return type of AddComment.

Fields
Field Name Description
clientMutationId - String A unique identifier for the client performing the mutation.
comment - Comment The newly created comment.
Example
{
  "clientMutationId": "abc123",
  "comment": Comment
}
Types

AddDiseaseInput

Description

Autogenerated input type of AddDisease

Fields
Input Field Description
clientMutationId - String A unique identifier for the client performing the mutation.
doid - String The DOID of the disease, if the disease is present in the Disease Ontology.
name - String! The name of the disease.
Example
{
  "clientMutationId": "xyz789",
  "doid": "xyz789",
  "name": "xyz789"
}
Types

AddDiseasePayload

Description

Autogenerated return type of AddDisease.

Fields
Field Name Description
clientMutationId - String A unique identifier for the client performing the mutation.
disease - Disease! The newly created disease.
new - Boolean! True if the disease was newly created. False if the returned disease was already in the database.
Example
{
  "clientMutationId": "abc123",
  "disease": Disease,
  "new": true
}
Types

AddRemoteCitationInput

Description

Autogenerated input type of AddRemoteCitation

Fields
Input Field Description
citationId - String! The external id for the source to add.
clientMutationId - String A unique identifier for the client performing the mutation.
sourceType - SourceSource! The origin of the external source.
Example
{
  "citationId": "xyz789",
  "clientMutationId": "xyz789",
  "sourceType": "ASCO"
}
Types

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
}
Types

AddTherapyInput

Description

Autogenerated input type of AddTherapy

Fields
Input Field Description
clientMutationId - String A unique identifier for the client performing the mutation.
name - String! The name of the therapy.
ncitId - String The NCIt ID of the therapy, if the therapy is present in the NCIthesaurus.
Example
{
  "clientMutationId": "xyz789",
  "name": "abc123",
  "ncitId": "xyz789"
}
Types

AddTherapyPayload

Description

Autogenerated return type of AddTherapy.

Fields
Field Name Description
clientMutationId - String A unique identifier for the client performing the mutation.
new - Boolean! True if the therapy was newly created. False if the returned therapy was already in the database.
therapy - Therapy! The newly created therapy.
Example
{
  "clientMutationId": "xyz789",
  "new": false,
  "therapy": Therapy
}
Types

AdvancedSearchResult

Fields
Field Name Description
permalinkId - String
resultIds - [Int!]!
searchEndpoint - String!
Example
{
  "permalinkId": "xyz789",
  "resultIds": [987],
  "searchEndpoint": "abc123"
}
Types

AmpLevel

Values
Enum Value Description

NA

TIER_III

TIER_II_LEVEL_C

TIER_II_LEVEL_D

TIER_IV

TIER_I_LEVEL_A

TIER_I_LEVEL_B
Example
"NA"
Types

AreaOfExpertise

Values
Enum Value Description

CLINICAL_SCIENTIST

PATIENT_ADVOCATE

RESEARCH_SCIENTIST
Example
"CLINICAL_SCIENTIST"
Types

Assertion

Fields
Field Name Description
acceptanceEvent - Event
acmgCodes - [AcmgCode!]!
ampLevel - AmpLevel
assertionDirection - AssertionDirection!
assertionType - AssertionType!
clingenCodes - [ClingenCode!]!
comments - CommentConnection! List and filter comments.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

mentionedEntity - TaggableEntityInput

Limit to comments that mention a certain entity

mentionedRole - UserRole

Limit to comments that mention a certain user role

mentionedUserId - Int

Limit to comments that mention a certain user

originatingUserId - Int

Limit to comments by a certain user

sortBy - DateSort

Sort order for the comments. Defaults to most recent.
description - String!
disease - Disease
events - EventConnection! List and filter events for an object
Arguments
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.

last - Int

Returns the last n elements from the list.

organizationId - Int
originatingUserId - Int
sortBy - DateSort

Sort order for the events. Defaults to most recent.
evidenceItems - [EvidenceItem!]!
evidenceItemsCount - Int!
fdaCompanionTest - Boolean
fdaCompanionTestLastUpdated - ISO8601DateTime
flagged - Boolean!
flags - FlagConnection! List and filter flags.
Arguments
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.

flaggingUserId - Int

Limit to flags added by a certain user

last - Int

Returns the last n elements from the list.

resolvingUserId - Int

Limit to flags resolved by a certain user

sortBy - DateSort

Sort order for the flags. Defaults to most recent.

state - FlagState

Limit to flags in a particular state
id - Int!
lastAcceptedRevisionEvent - Event
lastCommentEvent - Event
lastSubmittedRevisionEvent - Event
link - String!
molecularProfile - MolecularProfile!
name - String!
nccnGuideline - NccnGuideline
nccnGuidelineVersion - String
phenotypes - [Phenotype!]!
regulatoryApproval - Boolean
regulatoryApprovalLastUpdated - ISO8601DateTime
rejectionEvent - Event
revisions - RevisionConnection! List and filter revisions.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

fieldName - String

Limit to revisions on a particular field.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

originatingUserId - Int

Limit to revisions by a certain user

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
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": "abc123",
  "disease": Disease,
  "events": EventConnection,
  "evidenceItems": [EvidenceItem],
  "evidenceItemsCount": 123,
  "fdaCompanionTest": true,
  "fdaCompanionTestLastUpdated": ISO8601DateTime,
  "flagged": false,
  "flags": FlagConnection,
  "id": 123,
  "lastAcceptedRevisionEvent": Event,
  "lastCommentEvent": Event,
  "lastSubmittedRevisionEvent": Event,
  "link": "abc123",
  "molecularProfile": MolecularProfile,
  "name": "xyz789",
  "nccnGuideline": NccnGuideline,
  "nccnGuidelineVersion": "abc123",
  "phenotypes": [Phenotype],
  "regulatoryApproval": true,
  "regulatoryApprovalLastUpdated": ISO8601DateTime,
  "rejectionEvent": Event,
  "revisions": RevisionConnection,
  "significance": "ADVERSE_RESPONSE",
  "status": "ACCEPTED",
  "submissionActivity": SubmitAssertionActivity,
  "submissionEvent": Event,
  "summary": "abc123",
  "therapies": [Therapy],
  "therapyInteractionType": "COMBINATION",
  "variantOrigin": "COMBINED"
}
Types

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": 123,
  "pageInfo": PageInfo,
  "totalCount": 123
}
Types

AssertionDirection

Values
Enum Value Description

DOES_NOT_SUPPORT

SUPPORTS
Example
"DOES_NOT_SUPPORT"
Types

AssertionEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Assertion The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": Assertion
}
Types

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": 987,
  "nccnGuidelineId": NullableIntInput,
  "nccnGuidelineVersion": NullableStringInput,
  "phenotypeIds": [987],
  "significance": "ADVERSE_RESPONSE",
  "summary": NullableStringInput,
  "therapyIds": [123],
  "therapyInteractionType": NullableTherapyInteractionTypeInput,
  "variantOrigin": "COMBINED"
}
Types

AssertionSignificance

Values
Enum Value Description

ADVERSE_RESPONSE

BENIGN

BETTER_OUTCOME

LIKELY_BENIGN

LIKELY_ONCOGENIC

LIKELY_PATHOGENIC

NA

NEGATIVE

ONCOGENIC

PATHOGENIC

POOR_OUTCOME

POSITIVE

REDUCED_SENSITIVITY

RESISTANCE

SENSITIVITYRESPONSE

UNCERTAIN_SIGNIFICANCE
Example
"ADVERSE_RESPONSE"
Types

AssertionSort

Fields
Input Field Description
column - AssertionSortColumns! Available columns for sorting
direction - SortDirection! Sort direction
Example
{"column": "AMP_LEVEL", "direction": "ASC"}
Types

AssertionSortColumns

Values
Enum Value Description

AMP_LEVEL

ASSERTION_DIRECTION

ASSERTION_TYPE

DISEASE_NAME

EVIDENCE_ITEMS_COUNT

ID

SIGNIFICANCE

STATUS

SUMMARY

THERAPY_NAME
Example
"AMP_LEVEL"
Types

AssertionType

Values
Enum Value Description

DIAGNOSTIC

ONCOGENIC

PREDICTIVE

PREDISPOSING

PROGNOSTIC
Example
"DIAGNOSTIC"
Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
true
Types

BooleanOperator

Values
Enum Value Description

AND

OR
Example
"AND"
Types

BooleanSearchInput

Fields
Input Field Description
value - Boolean!
Example
{"value": false}
Types

BrowseClinicalTrial

Fields
Field Name Description
evidenceCount - Int!
id - Int!
link - String!
name - String!
nctId - String
sourceCount - Int!
url - String
Example
{
  "evidenceCount": 987,
  "id": 987,
  "link": "abc123",
  "name": "abc123",
  "nctId": "xyz789",
  "sourceCount": 123,
  "url": "xyz789"
}
Types

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": 123,
  "lastUpdated": ISO8601DateTime,
  "nodes": [BrowseClinicalTrial],
  "pageCount": 123,
  "pageInfo": PageInfo,
  "totalCount": 123
}
Types

BrowseClinicalTrialEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - BrowseClinicalTrial The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": BrowseClinicalTrial
}
Types

BrowseDisease

Fields
Field Name Description
assertionCount - Int!
diseaseUrl - String
displayName - String!
doid - String
evidenceItemCount - Int!
featureCount - Int!
features - [LinkableFeature!]!
id - Int!
link - String!
name - String!
variantCount - Int!
Example
{
  "assertionCount": 123,
  "diseaseUrl": "xyz789",
  "displayName": "xyz789",
  "doid": "abc123",
  "evidenceItemCount": 123,
  "featureCount": 123,
  "features": [LinkableFeature],
  "id": 987,
  "link": "xyz789",
  "name": "abc123",
  "variantCount": 123
}
Types

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": 123,
  "pageInfo": PageInfo,
  "totalCount": 123
}
Types

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": "abc123",
  "node": BrowseDisease
}
Types

BrowseFeature

Fields
Field Name Description
assertionCount - Int!
description - String!
diseases - [Disease!]
evidenceItemCount - Int!
featureAliases - [String!]
featureInstanceId - Int!
featureInstanceType - FeatureInstanceTypes!
flagged - Boolean!
flags - FlagConnection! List and filter flags.
Arguments
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.

flaggingUserId - Int

Limit to flags added by a certain user

last - Int

Returns the last n elements from the list.

resolvingUserId - Int

Limit to flags resolved by a certain user

sortBy - DateSort

Sort order for the flags. Defaults to most recent.

state - FlagState

Limit to flags in a particular state
id - Int!
link - String!
molecularProfileCount - Int!
name - String!
therapies - [Therapy!]
variantCount - Int!
Example
{
  "assertionCount": 123,
  "description": "abc123",
  "diseases": [Disease],
  "evidenceItemCount": 123,
  "featureAliases": ["xyz789"],
  "featureInstanceId": 987,
  "featureInstanceType": "FACTOR",
  "flagged": false,
  "flags": FlagConnection,
  "id": 987,
  "link": "abc123",
  "molecularProfileCount": 123,
  "name": "xyz789",
  "therapies": [Therapy],
  "variantCount": 123
}
Types

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": 987,
  "lastUpdated": ISO8601DateTime,
  "nodes": [BrowseFeature],
  "pageCount": 987,
  "pageInfo": PageInfo,
  "totalCount": 987
}
Types

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
}
Types

BrowseMolecularProfile

Fields
Field Name Description
aliases - [MolecularProfileAlias!]!
assertionCount - Int!
diseases - [LinkableDisease!]!
evidenceItemCount - Int!
id - Int!
link - String!
molecularProfileScore - Float!
name - String!
therapies - [LinkableTherapy!]!
variantCount - Int!
variants - [LinkableVariant!]!
Example
{
  "aliases": [MolecularProfileAlias],
  "assertionCount": 123,
  "diseases": [LinkableDisease],
  "evidenceItemCount": 987,
  "id": 987,
  "link": "xyz789",
  "molecularProfileScore": 123.45,
  "name": "abc123",
  "therapies": [LinkableTherapy],
  "variantCount": 123,
  "variants": [LinkableVariant]
}
Types

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": 123
}
Types

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
}
Types

BrowsePhenotype

Fields
Field Name Description
assertionCount - Int!
evidenceCount - Int!
hpoId - String!
id - Int!
link - String!
name - String!
url - String!
Example
{
  "assertionCount": 987,
  "evidenceCount": 123,
  "hpoId": "abc123",
  "id": 123,
  "link": "abc123",
  "name": "abc123",
  "url": "abc123"
}
Types

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": 987,
  "lastUpdated": ISO8601DateTime,
  "nodes": [BrowsePhenotype],
  "pageCount": 123,
  "pageInfo": PageInfo,
  "totalCount": 987
}
Types

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
}
Types

BrowseSource

Fields
Field Name Description
authors - [String!]!
citation - String!
citationId - Int!
clinicalTrials - [ClinicalTrial!]!
displayType - String!
evidenceItemCount - Int!
id - Int!
journal - String
link - String!
name - String
openAccess - Boolean!
publicationYear - Int
sourceSuggestionCount - Int!
sourceType - SourceSource!
sourceUrl - String!
Example
{
  "authors": ["abc123"],
  "citation": "xyz789",
  "citationId": 987,
  "clinicalTrials": [ClinicalTrial],
  "displayType": "xyz789",
  "evidenceItemCount": 987,
  "id": 123,
  "journal": "abc123",
  "link": "abc123",
  "name": "xyz789",
  "openAccess": true,
  "publicationYear": 123,
  "sourceSuggestionCount": 123,
  "sourceType": "ASCO",
  "sourceUrl": "abc123"
}
Types

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": 123,
  "lastUpdated": ISO8601DateTime,
  "nodes": [BrowseSource],
  "pageCount": 987,
  "pageInfo": PageInfo,
  "totalCount": 123
}
Types

BrowseSourceEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - BrowseSource The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": BrowseSource
}
Types

BrowseTherapy

Fields
Field Name Description
assertionCount - Int!
evidenceCount - Int!
id - Int!
link - String!
name - String!
ncitId - String
therapyUrl - String
Example
{
  "assertionCount": 987,
  "evidenceCount": 123,
  "id": 987,
  "link": "xyz789",
  "name": "xyz789",
  "ncitId": "abc123",
  "therapyUrl": "xyz789"
}
Types

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": 123,
  "lastUpdated": ISO8601DateTime,
  "nodes": [BrowseTherapy],
  "pageCount": 123,
  "pageInfo": PageInfo,
  "totalCount": 987
}
Types

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
}
Types

BrowseVariant

Fields
Field Name Description
aliases - [VariantAlias!]!
category - VariantCategories!
diseases - [Disease!]!
featureId - Int!
featureLink - String!
featureName - String!
id - Int!
link - String!
name - String!
therapies - [Therapy!]!
variantTypes - [LinkableVariantType!]!
Example
{
  "aliases": [VariantAlias],
  "category": "FACTOR",
  "diseases": [Disease],
  "featureId": 987,
  "featureLink": "abc123",
  "featureName": "xyz789",
  "id": 987,
  "link": "xyz789",
  "name": "xyz789",
  "therapies": [Therapy],
  "variantTypes": [LinkableVariantType]
}
Types

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": 123,
  "lastUpdated": ISO8601DateTime,
  "nodes": [BrowseVariant],
  "pageCount": 987,
  "pageInfo": PageInfo,
  "totalCount": 123
}
Types

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": "abc123",
  "node": BrowseVariant
}
Types

BrowseVariantGroup

Fields
Field Name Description
evidenceItemCount - Int!
featureNames - [String!]!
id - Int!
link - String!
name - String!
variantCount - Int!
variantNames - [String!]!
Example
{
  "evidenceItemCount": 987,
  "featureNames": ["abc123"],
  "id": 987,
  "link": "abc123",
  "name": "xyz789",
  "variantCount": 987,
  "variantNames": ["xyz789"]
}
Types

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": 123,
  "lastUpdated": ISO8601DateTime,
  "nodes": [BrowseVariantGroup],
  "pageCount": 987,
  "pageInfo": PageInfo,
  "totalCount": 987
}
Types

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
}
Types

BrowseVariantType

Fields
Field Name Description
id - Int!
link - String!
name - String!
soid - String!
url - String
variantCount - Int!
Example
{
  "id": 987,
  "link": "abc123",
  "name": "xyz789",
  "soid": "abc123",
  "url": "xyz789",
  "variantCount": 123
}
Types

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": 987
}
Types

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": "abc123",
  "node": BrowseVariantType
}
Types

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
}
Types

ClingenCode

Fields
Field Name Description
code - String!
description - String!
exclusive - Boolean!
id - Int!
name - String!
tooltip - String!
Example
{
  "code": "xyz789",
  "description": "abc123",
  "exclusive": false,
  "id": 123,
  "name": "abc123",
  "tooltip": "xyz789"
}
Types

ClinicalTrial

Fields
Field Name Description
description - String!
id - Int!
link - String!
name - String!
nctId - String!
url - String
Example
{
  "description": "xyz789",
  "id": 987,
  "link": "abc123",
  "name": "abc123",
  "nctId": "abc123",
  "url": "xyz789"
}
Types

ClinicalTrialSort

Fields
Input Field Description
column - ClinicalTrialSortColumns! Available columns for sorting
direction - SortDirection! Sort direction
Example
{"column": "EVIDENCE_ITEM_COUNT", "direction": "ASC"}
Types

ClinicalTrialSortColumns

Values
Enum Value Description

EVIDENCE_ITEM_COUNT

NAME

NCT_ID

SOURCE_COUNT
Example
"EVIDENCE_ITEM_COUNT"
Types

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.

Fields
Input Field Description
ids - [Int!] The ClinVar ID(s)
noneFound - Boolean
notApplicable - Boolean
Example
{"ids": [987], "noneFound": false, "notApplicable": false}
Types

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": 987
}
Types

CoiStatus

Values
Enum Value Description

CONFLICT

EXPIRED

MISSING

VALID
Example
"CONFLICT"
Types

Comment

Fields
Field Name Description
comment - String!
commentable - Commentable!
commenter - User!
createdAt - ISO8601DateTime!
creationEvent - Event
id - Int!
link - String!
name - String!
parsedComment - [CommentBodySegment!]!
title - String
Example
{
  "comment": "abc123",
  "commentable": Commentable,
  "commenter": User,
  "createdAt": ISO8601DateTime,
  "creationEvent": Event,
  "id": 123,
  "link": "abc123",
  "name": "abc123",
  "parsedComment": [CommentTagSegment],
  "title": "xyz789"
}
Types

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": "xyz789"
}
Types

CommentBodySegment

Description

Segment of a comment that can either be text or an object to be rendered as a tag

Types
Union Types

CommentTagSegment

CommentTextSegment

User
Example
CommentTagSegment
Types

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": 987,
  "unfilteredCountForSubject": 987,
  "uniqueCommenters": [User]
}
Types

CommentEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Comment The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": Comment
}
Types

CommentTagSegment

Fields
Field Name Description
deprecated - Boolean
displayName - String!
entityId - Int!
feature - LinkableFeature
link - String!
revisionSetId - Int
status - EvidenceStatus
tagType - TaggableEntity!
Example
{
  "deprecated": true,
  "displayName": "abc123",
  "entityId": 123,
  "feature": LinkableFeature,
  "link": "abc123",
  "revisionSetId": 987,
  "status": "ACCEPTED",
  "tagType": "ASSERTION"
}
Types

CommentTextSegment

Fields
Field Name Description
text - String!
Example
{"text": "abc123"}
Types

Commentable

Description

A CIViC entity that can have comments on it.

Fields
Field Name Description
comments - CommentConnection! List and filter comments.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

mentionedEntity - TaggableEntityInput

Limit to comments that mention a certain entity

mentionedRole - UserRole

Limit to comments that mention a certain user role

mentionedUserId - Int

Limit to comments that mention a certain user

originatingUserId - Int

Limit to comments by a certain user

sortBy - DateSort

Sort order for the comments. Defaults to most recent.
id - Int!
lastCommentEvent - Event
link - String!
name - String!
Possible Types
Commentable Types

Assertion

EvidenceItem

Factor

FactorVariant

Feature

Flag

Gene

GeneVariant

MolecularProfile

Revision

Source

SourcePopover

Variant

VariantGroup
Example
{
  "comments": CommentConnection,
  "id": 123,
  "lastCommentEvent": Event,
  "link": "xyz789",
  "name": "abc123"
}
Types

CommentableEntities

Values
Enum Value Description

ASSERTION

EVIDENCE_ITEM

FEATURE

MOLECULAR_PROFILE

SOURCE

VARIANT

VARIANT_GROUP
Example
"ASSERTION"
Types

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": 123}
Types

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": 987,
  "uniqueActions": [Contribution],
  "user": User
}
Types

ContributingUsersSummary

Fields
Field Name Description
curators - [ContributingUser!]!
editors - [ContributingUser!]!
Example
{
  "curators": [ContributingUser],
  "editors": [ContributingUser]
}
Types

Contribution

Fields
Field Name Description
action - EventAction!
count - Int!
Example
{"action": "ACCEPTED", "count": 123}
Types

Coordinate

Fields
Field Name Description
chromosome - String
representativeTranscript - String
start - Int
stop - Int
Example
{
  "chromosome": "xyz789",
  "representativeTranscript": "xyz789",
  "start": 987,
  "stop": 123
}
Types

CoordinateInput

Fields
Input Field Description
chromosome - String
representativeTranscript - String
start - Int
stop - Int
Example
{
  "chromosome": "abc123",
  "representativeTranscript": "xyz789",
  "start": 123,
  "stop": 987
}
Types

Country

Fields
Field Name Description
id - Int!
iso - String!
name - String!
Example
{
  "id": 123,
  "iso": "abc123",
  "name": "abc123"
}
Types

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": 987,
  "note": "xyz789",
  "organization": Organization,
  "parsedNote": [CommentTagSegment],
  "subject": EventSubject,
  "user": User,
  "verbiage": "abc123"
}
Types

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": 987,
  "note": "xyz789",
  "organization": Organization,
  "parsedNote": [CommentTagSegment],
  "subject": EventSubject,
  "user": User,
  "verbiage": "xyz789"
}
Types

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": "xyz789",
  "organizationId": 123
}
Types

CreateFeaturePayload

Description

Autogenerated return type of CreateFeature.

Fields
Field Name Description
clientMutationId - String A unique identifier for the client performing the mutation.
feature - Feature! The newly created Feature.
new - Boolean! True if the feature was newly created. False if the returned variant was already in the database.
Example
{
  "clientMutationId": "xyz789",
  "feature": Feature,
  "new": true
}
Types

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": "abc123",
  "organizationId": 987,
  "structure": MolecularProfileComponentInput
}
Types

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": "xyz789",
  "molecularProfile": MolecularProfile
}
Types

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": "xyz789",
  "organization": Organization,
  "parsedNote": [CommentTagSegment],
  "subject": EventSubject,
  "user": User,
  "verbiage": "abc123"
}
Types

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": "xyz789",
  "featureId": 123,
  "name": "abc123",
  "organizationId": 123
}
Types

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": "abc123",
  "molecularProfile": MolecularProfile,
  "new": true,
  "variant": Variant
}
Types

CreateableFeatureTypes

Description

Enum representing Feature types that can be user-created

Values
Enum Value Description

FACTOR
Example
"FACTOR"
Types

DataRelease

Fields
Field Name Description
acceptedAndSubmittedVariantsVcf - DownloadableFile
acceptedVariantsVcf - DownloadableFile
assertionTsv - DownloadableFile
evidenceTsv - DownloadableFile
geneTsv - DownloadableFile
molecularProfileTsv - DownloadableFile
name - String!
variantGroupTsv - DownloadableFile
variantTsv - DownloadableFile
Example
{
  "acceptedAndSubmittedVariantsVcf": DownloadableFile,
  "acceptedVariantsVcf": DownloadableFile,
  "assertionTsv": DownloadableFile,
  "evidenceTsv": DownloadableFile,
  "geneTsv": DownloadableFile,
  "molecularProfileTsv": DownloadableFile,
  "name": "abc123",
  "variantGroupTsv": DownloadableFile,
  "variantTsv": DownloadableFile
}
Types

DateSort

Fields
Input Field Description
column - DateSortColumns! Value to sort by.
direction - SortDirection! Sort direction.
Example
{"column": "CREATED", "direction": "ASC"}
Types

DateSortColumns

Values
Enum Value Description

CREATED

LAST_MODIFIED
Example
"CREATED"
Types

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": "xyz789",
  "organization": Organization,
  "parsedNote": [CommentTagSegment],
  "subject": EventSubject,
  "user": User,
  "verbiage": "xyz789"
}
Types

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": 987
}
Types

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": "abc123",
  "molecularProfile": MolecularProfile
}
Types

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": 987,
  "molecularProfiles": [MolecularProfile],
  "note": "abc123",
  "organization": Organization,
  "parsedNote": [CommentTagSegment],
  "subject": EventSubject,
  "user": User,
  "variants": [VariantInterface],
  "verbiage": "abc123"
}
Types

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": "xyz789",
  "comment": "abc123",
  "deprecationReason": "DUPLICATE",
  "featureId": 123,
  "organizationId": 123
}
Types

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": "xyz789",
  "feature": Feature,
  "newlyDeprecatedMolecularProfiles": [MolecularProfile],
  "newlyDeprecatedVariants": [VariantInterface]
}
Types

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": "abc123"
}
Types

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": 123
}
Types

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": "abc123",
  "newlyDeprecatedMolecularProfiles": [MolecularProfile],
  "variant": VariantInterface
}
Types

Disease

Fields
Field Name Description
diseaseAliases - [String!]!
diseaseUrl - String
displayName - String!
doid - String
id - Int!
link - String!
myDiseaseInfo - MyDiseaseInfo
name - String!
Example
{
  "diseaseAliases": ["xyz789"],
  "diseaseUrl": "xyz789",
  "displayName": "xyz789",
  "doid": "abc123",
  "id": 123,
  "link": "xyz789",
  "myDiseaseInfo": MyDiseaseInfo,
  "name": "xyz789"
}
Types

DiseasePopover

Fields
Field Name Description
assertionCount - Int!
diseaseAliases - [String!]!
diseaseUrl - String
displayName - String!
doid - String
evidenceItemCount - Int!
id - Int!
link - String!
molecularProfileCount - Int!
myDiseaseInfo - MyDiseaseInfo
name - String!
Example
{
  "assertionCount": 987,
  "diseaseAliases": ["abc123"],
  "diseaseUrl": "abc123",
  "displayName": "xyz789",
  "doid": "abc123",
  "evidenceItemCount": 123,
  "id": 123,
  "link": "abc123",
  "molecularProfileCount": 987,
  "myDiseaseInfo": MyDiseaseInfo,
  "name": "abc123"
}
Types

DiseasesSort

Fields
Input Field Description
column - DiseasesSortColumns! Available columns for sorting
direction - SortDirection! Sort direction
Example
{"column": "ASSERTION_COUNT", "direction": "ASC"}
Types

DiseasesSortColumns

Values
Enum Value Description

ASSERTION_COUNT

DOID

EVIDENCE_ITEM_COUNT

FEATURE_COUNT

NAME

VARIANT_COUNT
Example
"ASSERTION_COUNT"
Types

DownloadableFile

Fields
Field Name Description
filename - String!
path - String!
Example
{
  "filename": "xyz789",
  "path": "xyz789"
}
Types

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": "abc123",
  "countryId": NullableIntInput,
  "email": "xyz789",
  "facebookProfile": NullableStringInput,
  "linkedinProfile": NullableStringInput,
  "name": NullableStringInput,
  "orcid": NullableIDInput,
  "twitterHandle": NullableStringInput,
  "url": NullableStringInput,
  "username": "xyz789"
}
Types

EditUserPayload

Description

Autogenerated return type of EditUser.

Fields
Field Name Description
clientMutationId - String A unique identifier for the client performing the mutation.
user - User!
Example
{
  "clientMutationId": "xyz789",
  "user": User
}
Types

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
}
Types

EventAction

Values
Enum Value Description

ACCEPTED

ASSERTION_ACCEPTED

ASSERTION_REJECTED

ASSERTION_REVERTED

ASSERTION_SUBMITTED

COMMENTED

COMPLEX_MOLECULAR_PROFILE_CREATED

CURATED_SOURCE_SUGGESTION

DEPRECATED_FEATURE

DEPRECATED_MOLECULAR_PROFILE

DEPRECATED_VARIANT

FEATURE_CREATED

FLAGGED

FLAG_RESOLVED

PUBLICATION_SUGGESTED

REJECTED

REJECTED_SOURCE_SUGGESTION

REQUEUED_SOURCE_SUGGESTION

REVERTED

REVISION_ACCEPTED

REVISION_REJECTED

REVISION_SUGGESTED

REVISION_SUPERSEDED

SUBMITTED

VARIANT_CREATED
Example
"ACCEPTED"
Types

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 occured 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": 123,
  "unfilteredCount": 123,
  "uniqueParticipants": [User]
}
Types

EventEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Event The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": Event
}
Types

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

ORGANIZATION

SUBJECT

UNSCOPED

USER
Example
"ORGANIZATION"
Types

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.

Fields
Field Name Description
id - Int!
link - String!
name - String!
Possible Types
EventOriginObject Types

Assertion

Comment

EvidenceItem

Factor

FactorVariant

Feature

Flag

Gene

GeneVariant

MolecularProfile

Revision

SourceSuggestion

Variant
Example
{
  "id": 123,
  "link": "xyz789",
  "name": "abc123"
}
Types

EventSubject

Description

The subject of an event log event.

Fields
Field Name Description
events - EventConnection! List and filter events for an object
Arguments
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.

last - Int

Returns the last n elements from the list.

organizationId - Int
originatingUserId - Int
sortBy - DateSort

Sort order for the events. Defaults to most recent.
id - Int!
link - String!
name - String!
Possible Types
EventSubject Types

Assertion

EvidenceItem

Factor

FactorVariant

Feature

Flag

Gene

GeneVariant

MolecularProfile

Revision

RevisionSet

Source

SourcePopover

SourceSuggestion

Variant

VariantGroup
Example
{
  "events": EventConnection,
  "id": 987,
  "link": "abc123",
  "name": "xyz789"
}
Types

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": 987, "subject": EventSubject}
Types

EvidenceDirection

Values
Enum Value Description

DOES_NOT_SUPPORT

NA

SUPPORTS
Example
"DOES_NOT_SUPPORT"
Types

EvidenceItem

Fields
Field Name Description
acceptanceEvent - Event
assertions - [Assertion!]!
comments - CommentConnection! List and filter comments.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

mentionedEntity - TaggableEntityInput

Limit to comments that mention a certain entity

mentionedRole - UserRole

Limit to comments that mention a certain user role

mentionedUserId - Int

Limit to comments that mention a certain user

originatingUserId - Int

Limit to comments by a certain user

sortBy - DateSort

Sort order for the comments. Defaults to most recent.
description - String!
disease - Disease
events - EventConnection! List and filter events for an object
Arguments
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.

last - Int

Returns the last n elements from the list.

organizationId - Int
originatingUserId - Int
sortBy - DateSort

Sort order for the events. Defaults to most recent.
evidenceDirection - EvidenceDirection!
evidenceLevel - EvidenceLevel!
evidenceRating - Int
evidenceType - EvidenceType!
flagged - Boolean!
flags - FlagConnection! List and filter flags.
Arguments
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.

flaggingUserId - Int

Limit to flags added by a certain user

last - Int

Returns the last n elements from the list.

resolvingUserId - Int

Limit to flags resolved by a certain user

sortBy - DateSort

Sort order for the flags. Defaults to most recent.

state - FlagState

Limit to flags in a particular state
id - Int!
lastAcceptedRevisionEvent - Event
lastCommentEvent - Event
lastSubmittedRevisionEvent - Event
link - String!
molecularProfile - MolecularProfile!
name - String!
phenotypes - [Phenotype!]!
rejectionEvent - Event
revisions - RevisionConnection! List and filter revisions.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

fieldName - String

Limit to revisions on a particular field.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

originatingUserId - Int

Limit to revisions by a certain user

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
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": 123,
  "evidenceType": "DIAGNOSTIC",
  "flagged": false,
  "flags": FlagConnection,
  "id": 123,
  "lastAcceptedRevisionEvent": Event,
  "lastCommentEvent": Event,
  "lastSubmittedRevisionEvent": Event,
  "link": "abc123",
  "molecularProfile": MolecularProfile,
  "name": "abc123",
  "phenotypes": [Phenotype],
  "rejectionEvent": Event,
  "revisions": RevisionConnection,
  "significance": "ADVERSE_RESPONSE",
  "source": Source,
  "status": "ACCEPTED",
  "submissionActivity": SubmitEvidenceItemActivity,
  "submissionEvent": Event,
  "therapies": [Therapy],
  "therapyInteractionType": "COMBINATION",
  "variantHgvs": "abc123",
  "variantOrigin": "COMBINED"
}
Types

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": 123,
  "pageInfo": PageInfo,
  "totalCount": 123
}
Types

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
}
Types

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": 987,
  "phenotypeIds": [123],
  "rating": 987,
  "significance": "ADVERSE_RESPONSE",
  "sourceId": 987,
  "therapyIds": [123],
  "therapyInteractionType": NullableTherapyInteractionTypeInput,
  "variantOrigin": "COMBINED"
}
Types

EvidenceItemsByStatus

Fields
Field Name Description
acceptedCount - Int!
molecularProfileId - Int!
rejectedCount - Int!
submittedCount - Int!
Example
{
  "acceptedCount": 123,
  "molecularProfileId": 123,
  "rejectedCount": 987,
  "submittedCount": 987
}
Types

EvidenceItemsByType

Fields
Field Name Description
diagnosticCount - Int!
functionalCount - Int!
molecularProfileId - Int!
oncogenicCount - Int!
predictiveCount - Int!
predisposingCount - Int!
prognosticCount - Int!
Example
{
  "diagnosticCount": 987,
  "functionalCount": 123,
  "molecularProfileId": 987,
  "oncogenicCount": 123,
  "predictiveCount": 123,
  "predisposingCount": 123,
  "prognosticCount": 123
}
Types

EvidenceLevel

Values
Enum Value Description

A

B

C

D

E
Example
"A"
Types

EvidenceSignificance

Values
Enum Value Description

ADVERSE_RESPONSE

BENIGN

BETTER_OUTCOME

DOMINANT_NEGATIVE

GAIN_OF_FUNCTION

LIKELY_BENIGN

LIKELY_PATHOGENIC

LOSS_OF_FUNCTION

NA

NEGATIVE

NEOMORPHIC

ONCOGENICITY

PATHOGENIC

POOR_OUTCOME

POSITIVE

PREDISPOSITION

PROTECTIVENESS

REDUCED_SENSITIVITY

RESISTANCE

SENSITIVITYRESPONSE

UNALTERED_FUNCTION

UNCERTAIN_SIGNIFICANCE

UNKNOWN
Example
"ADVERSE_RESPONSE"
Types

EvidenceSort

Fields
Input Field Description
column - EvidenceSortColumns! Available columns for sorting
direction - SortDirection! Sort direction
Example
{"column": "DESCRIPTION", "direction": "ASC"}
Types

EvidenceSortColumns

Values
Enum Value Description

DESCRIPTION

DISEASE_NAME

EVIDENCE_DIRECTION

EVIDENCE_LEVEL

EVIDENCE_RATING

EVIDENCE_TYPE

ID

SIGNIFICANCE

STATUS

THERAPY_NAME

VARIANT_ORIGIN
Example
"DESCRIPTION"
Types

EvidenceStatus

Values
Enum Value Description

ACCEPTED

REJECTED

SUBMITTED
Example
"ACCEPTED"
Types

EvidenceStatusFilter

Values
Enum Value Description

ACCEPTED

ALL

REJECTED

SUBMITTED
Example
"ACCEPTED"
Types

EvidenceType

Values
Enum Value Description

DIAGNOSTIC

FUNCTIONAL

ONCOGENIC

PREDICTIVE

PREDISPOSING

PROGNOSTIC
Example
"DIAGNOSTIC"
Types

Factor

Description

The Feature that a Variant can belong to

Fields
Field Name Description
comments - CommentConnection! List and filter comments.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

mentionedEntity - TaggableEntityInput

Limit to comments that mention a certain entity

mentionedRole - UserRole

Limit to comments that mention a certain user role

mentionedUserId - Int

Limit to comments that mention a certain user

originatingUserId - Int

Limit to comments by a certain user

sortBy - DateSort

Sort order for the comments. Defaults to most recent.
creationActivity - CreateFeatureActivity
deprecated - Boolean!
deprecationActivity - DeprecateFeatureActivity
deprecationReason - FeatureDeprecationReason
description - String
events - EventConnection! List and filter events for an object
Arguments
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.

last - Int

Returns the last n elements from the list.

organizationId - Int
originatingUserId - Int
sortBy - DateSort

Sort order for the events. Defaults to most recent.
featureAliases - [String!]!
featureInstance - FeatureInstance!
flagged - Boolean!
flags - FlagConnection! List and filter flags.
Arguments
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.

flaggingUserId - Int

Limit to flags added by a certain user

last - Int

Returns the last n elements from the list.

resolvingUserId - Int

Limit to flags resolved by a certain user

sortBy - DateSort

Sort order for the flags. Defaults to most recent.

state - FlagState

Limit to flags in a particular state
fullName - String
id - Int!
lastAcceptedRevisionEvent - Event
lastCommentEvent - Event
lastSubmittedRevisionEvent - Event
link - String!
name - String!
ncitDetails - NcitDetails
ncitId - String
revisions - RevisionConnection! List and filter revisions.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

fieldName - String

Limit to revisions on a particular field.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

originatingUserId - Int

Limit to revisions by a certain user

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
sources - [Source!]!
variants - FactorVariantConnection! List and filter Gene variants.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

alleleRegistryId - String

Find a CIViC Variant based on its ClinGen Allele Registry ID

before - String

Returns the elements in the list that come before the specified cursor.

category - VariantCategories
factorId - Int

Feature that the variants are associated with, limited to only Factor type features.

featureId - Int

Feature that the variants are associated with.

first - Int

Returns the first n elements from the list.

geneId - Int

Feature that the variants are associated with, limited to only Gene type features.

hasNoVariantType - Boolean

Return Variants lacking an assigned VariantType

last - Int

Returns the last n elements from the list.

name - String

Left anchored filtering for variant name and aliases.

sortBy - VariantMenuSort
variantTypeIds - [Int!]

A list of CIViC identifiers for variant types
Example
{
  "comments": CommentConnection,
  "creationActivity": CreateFeatureActivity,
  "deprecated": true,
  "deprecationActivity": DeprecateFeatureActivity,
  "deprecationReason": "DUPLICATE",
  "description": "xyz789",
  "events": EventConnection,
  "featureAliases": ["xyz789"],
  "featureInstance": Factor,
  "flagged": false,
  "flags": FlagConnection,
  "fullName": "abc123",
  "id": 987,
  "lastAcceptedRevisionEvent": Event,
  "lastCommentEvent": Event,
  "lastSubmittedRevisionEvent": Event,
  "link": "xyz789",
  "name": "xyz789",
  "ncitDetails": NcitDetails,
  "ncitId": "abc123",
  "revisions": RevisionConnection,
  "sources": [Source],
  "variants": FactorVariantConnection
}
Types

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": 987,
  "pageInfo": PageInfo,
  "totalCount": 987
}
Types

FactorEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Factor The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": Factor
}
Types

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": ["abc123"],
  "description": NullableStringInput,
  "fullName": NullableStringInput,
  "name": "xyz789",
  "ncitId": NullableStringInput,
  "sourceIds": [123]
}
Types

FactorVariant

Fields
Field Name Description
comments - CommentConnection! List and filter comments.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

mentionedEntity - TaggableEntityInput

Limit to comments that mention a certain entity

mentionedRole - UserRole

Limit to comments that mention a certain user role

mentionedUserId - Int

Limit to comments that mention a certain user

originatingUserId - Int

Limit to comments by a certain user

sortBy - DateSort

Sort order for the comments. Defaults to most recent.
creationActivity - CreateVariantActivity
deprecated - Boolean!
deprecationActivity - DeprecateVariantActivity
deprecationReason - VariantDeprecationReason
events - EventConnection! List and filter events for an object
Arguments
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.

last - Int

Returns the last n elements from the list.

organizationId - Int
originatingUserId - Int
sortBy - DateSort

Sort order for the events. Defaults to most recent.
feature - Feature!
flagged - Boolean!
flags - FlagConnection! List and filter flags.
Arguments
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.

flaggingUserId - Int

Limit to flags added by a certain user

last - Int

Returns the last n elements from the list.

resolvingUserId - Int

Limit to flags resolved by a certain user

sortBy - DateSort

Sort order for the flags. Defaults to most recent.

state - FlagState

Limit to flags in a particular state
id - Int!
lastAcceptedRevisionEvent - Event
lastCommentEvent - Event
lastSubmittedRevisionEvent - Event
link - String!
molecularProfiles - MolecularProfileConnection!
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.
name - String!
ncitDetails - NcitDetails
ncitId - String
revisions - RevisionConnection! List and filter revisions.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

fieldName - String

Limit to revisions on a particular field.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

originatingUserId - Int

Limit to revisions by a certain user

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
singleVariantMolecularProfile - MolecularProfile!
singleVariantMolecularProfileId - Int!
variantAliases - [String!]!
variantTypes - [VariantType!]!
Example
{
  "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": "abc123",
  "molecularProfiles": MolecularProfileConnection,
  "name": "xyz789",
  "ncitDetails": NcitDetails,
  "ncitId": "abc123",
  "revisions": RevisionConnection,
  "singleVariantMolecularProfile": MolecularProfile,
  "singleVariantMolecularProfileId": 987,
  "variantAliases": ["xyz789"],
  "variantTypes": [VariantType]
}
Types

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": 987,
  "pageInfo": PageInfo,
  "totalCount": 987
}
Types

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
}
Types

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": 123,
  "name": "abc123",
  "ncitId": NullableStringInput,
  "variantTypeIds": [123]
}
Types

FdaCode

Fields
Field Name Description
code - String!
description - String!
Example
{
  "code": "abc123",
  "description": "abc123"
}
Types

Feature

Description

The Feature that a Variant can belong to

Fields
Field Name Description
comments - CommentConnection! List and filter comments.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

mentionedEntity - TaggableEntityInput

Limit to comments that mention a certain entity

mentionedRole - UserRole

Limit to comments that mention a certain user role

mentionedUserId - Int

Limit to comments that mention a certain user

originatingUserId - Int

Limit to comments by a certain user

sortBy - DateSort

Sort order for the comments. Defaults to most recent.
creationActivity - CreateFeatureActivity
deprecated - Boolean!
deprecationActivity - DeprecateFeatureActivity
deprecationReason - FeatureDeprecationReason
description - String
events - EventConnection! List and filter events for an object
Arguments
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.

last - Int

Returns the last n elements from the list.

organizationId - Int
originatingUserId - Int
sortBy - DateSort

Sort order for the events. Defaults to most recent.
featureAliases - [String!]!
featureInstance - FeatureInstance!
flagged - Boolean!
flags - FlagConnection! List and filter flags.
Arguments
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.

flaggingUserId - Int

Limit to flags added by a certain user

last - Int

Returns the last n elements from the list.

resolvingUserId - Int

Limit to flags resolved by a certain user

sortBy - DateSort

Sort order for the flags. Defaults to most recent.

state - FlagState

Limit to flags in a particular state
fullName - String
id - Int!
lastAcceptedRevisionEvent - Event
lastCommentEvent - Event
lastSubmittedRevisionEvent - Event
link - String!
name - String!
revisions - RevisionConnection! List and filter revisions.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

fieldName - String

Limit to revisions on a particular field.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

originatingUserId - Int

Limit to revisions by a certain user

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
sources - [Source!]!
variants - VariantInterfaceConnection! List and filter Gene variants.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

alleleRegistryId - String

Find a CIViC Variant based on its ClinGen Allele Registry ID

before - String

Returns the elements in the list that come before the specified cursor.

category - VariantCategories
factorId - Int

Feature that the variants are associated with, limited to only Factor type features.

featureId - Int

Feature that the variants are associated with.

first - Int

Returns the first n elements from the list.

geneId - Int

Feature that the variants are associated with, limited to only Gene type features.

hasNoVariantType - Boolean

Return Variants lacking an assigned VariantType

last - Int

Returns the last n elements from the list.

name - String

Left anchored filtering for variant name and aliases.

sortBy - VariantMenuSort
variantTypeIds - [Int!]

A list of CIViC identifiers for variant types
Example
{
  "comments": CommentConnection,
  "creationActivity": CreateFeatureActivity,
  "deprecated": false,
  "deprecationActivity": DeprecateFeatureActivity,
  "deprecationReason": "DUPLICATE",
  "description": "abc123",
  "events": EventConnection,
  "featureAliases": ["abc123"],
  "featureInstance": Factor,
  "flagged": true,
  "flags": FlagConnection,
  "fullName": "xyz789",
  "id": 987,
  "lastAcceptedRevisionEvent": Event,
  "lastCommentEvent": Event,
  "lastSubmittedRevisionEvent": Event,
  "link": "abc123",
  "name": "abc123",
  "revisions": RevisionConnection,
  "sources": [Source],
  "variants": VariantInterfaceConnection
}
Types

FeatureDeprecationReason

Values
Enum Value Description

DUPLICATE

INVALID

OTHER
Example
"DUPLICATE"
Types

FeatureInstance

Description

The specific type of a feature instance

Types
Union Types

Factor

Gene
Example
Factor
Types

FeatureInstanceTypes

Values
Enum Value Description

FACTOR

GENE
Example
"FACTOR"
Types

FeaturesSort

Fields
Input Field Description
column - FeaturesSortColumns! Available columns for sorting
direction - SortDirection! Sort direction
Example
{"column": "assertionCount", "direction": "ASC"}
Types

FeaturesSortColumns

Values
Enum Value Description

assertionCount

diseaseName

evidenceItemCount

featureAlias

featureName

molecularProfileCount

therapyName

variantCount
Example
"assertionCount"
Types

FieldName

Fields
Field Name Description
displayName - String! The user facing representation of the field name.
name - String! The internal server representation of the field name.
Example
{
  "displayName": "xyz789",
  "name": "xyz789"
}
Types

FieldValidationError

Fields
Field Name Description
error - String!
fieldName - String!
Example
{
  "error": "abc123",
  "fieldName": "abc123"
}
Types

Flag

Fields
Field Name Description
comments - CommentConnection! List and filter comments.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

mentionedEntity - TaggableEntityInput

Limit to comments that mention a certain entity

mentionedRole - UserRole

Limit to comments that mention a certain user role

mentionedUserId - Int

Limit to comments that mention a certain user

originatingUserId - Int

Limit to comments by a certain user

sortBy - DateSort

Sort order for the comments. Defaults to most recent.
createdAt - ISO8601DateTime!
events - EventConnection! List and filter events for an object
Arguments
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.

last - Int

Returns the last n elements from the list.

organizationId - Int
originatingUserId - Int
sortBy - DateSort

Sort order for the events. Defaults to most recent.
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": 987,
  "lastCommentEvent": Event,
  "link": "xyz789",
  "name": "xyz789",
  "openActivity": FlagEntityActivity,
  "resolutionActivity": ResolveFlagActivity,
  "resolvingUser": User,
  "state": "OPEN"
}
Types

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": 987,
  "unfilteredCountForSubject": 987,
  "uniqueFlaggingUsers": [User],
  "uniqueResolvingUsers": [User]
}
Types

FlagEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Flag The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": Flag
}
Types

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": "abc123",
  "organization": Organization,
  "parsedNote": [CommentTagSegment],
  "subject": EventSubject,
  "user": User,
  "verbiage": "xyz789"
}
Types

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": "abc123",
  "comment": "xyz789",
  "organizationId": 987,
  "subject": FlaggableInput
}
Types

FlagEntityPayload

Description

Autogenerated return type of FlagEntity.

Fields
Field Name Description
clientMutationId - String A unique identifier for the client performing the mutation.
flag - Flag The newly created Flag.
Example
{
  "clientMutationId": "xyz789",
  "flag": Flag
}
Types

FlagState

Values
Enum Value Description

OPEN

RESOLVED
Example
"OPEN"
Types

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

flaggingUserId - Int

Limit to flags added by a certain user

last - Int

Returns the last n elements from the list.

resolvingUserId - Int

Limit to flags resolved by a certain user

sortBy - DateSort

Sort order for the flags. Defaults to most recent.

state - FlagState

Limit to flags in a particular state
id - Int!
link - String!
name - String!
Possible Types
Flaggable Types

Assertion

BrowseFeature

EvidenceItem

Factor

FactorVariant

Feature

Gene

GeneVariant

MolecularProfile

Variant

VariantGroup
Example
{
  "flagged": true,
  "flags": FlagConnection,
  "id": 987,
  "link": "xyz789",
  "name": "xyz789"
}
Types

FlaggableEntities

Description

Enumeration of all entities in CIViC that can be flagged.

Values
Enum Value Description

ASSERTION

EVIDENCE_ITEM

FEATURE

MOLECULAR_PROFILE

VARIANT

VARIANT_GROUP
Example
"ASSERTION"
Types

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": 123}
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65
Types

Gene

Description

The Feature that a Variant can belong to

Fields
Field Name Description
comments - CommentConnection! List and filter comments.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

mentionedEntity - TaggableEntityInput

Limit to comments that mention a certain entity

mentionedRole - UserRole

Limit to comments that mention a certain user role

mentionedUserId - Int

Limit to comments that mention a certain user

originatingUserId - Int

Limit to comments by a certain user

sortBy - DateSort

Sort order for the comments. Defaults to most recent.
creationActivity - CreateFeatureActivity
deprecated - Boolean!
deprecationActivity - DeprecateFeatureActivity
deprecationReason - FeatureDeprecationReason
description - String
entrezId - Int!
events - EventConnection! List and filter events for an object
Arguments
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.

last - Int

Returns the last n elements from the list.

organizationId - Int
originatingUserId - Int
sortBy - DateSort

Sort order for the events. Defaults to most recent.
featureAliases - [String!]!
featureInstance - FeatureInstance!
flagged - Boolean!
flags - FlagConnection! List and filter flags.
Arguments
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.

flaggingUserId - Int

Limit to flags added by a certain user

last - Int

Returns the last n elements from the list.

resolvingUserId - Int

Limit to flags resolved by a certain user

sortBy - DateSort

Sort order for the flags. Defaults to most recent.

state - FlagState

Limit to flags in a particular state
fullName - String
id - Int!
lastAcceptedRevisionEvent - Event
lastCommentEvent - Event
lastSubmittedRevisionEvent - Event
link - String!
myGeneInfoDetails - JSON
name - String!
revisions - RevisionConnection! List and filter revisions.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

fieldName - String

Limit to revisions on a particular field.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

originatingUserId - Int

Limit to revisions by a certain user

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
sources - [Source!]!
variants - GeneVariantConnection! List and filter Gene variants.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

alleleRegistryId - String

Find a CIViC Variant based on its ClinGen Allele Registry ID

before - String

Returns the elements in the list that come before the specified cursor.

category - VariantCategories
factorId - Int

Feature that the variants are associated with, limited to only Factor type features.

featureId - Int

Feature that the variants are associated with.

first - Int

Returns the first n elements from the list.

geneId - Int

Feature that the variants are associated with, limited to only Gene type features.

hasNoVariantType - Boolean

Return Variants lacking an assigned VariantType

last - Int

Returns the last n elements from the list.

name - String

Left anchored filtering for variant name and aliases.

sortBy - VariantMenuSort
variantTypeIds - [Int!]

A list of CIViC identifiers for variant types
Example
{
  "comments": CommentConnection,
  "creationActivity": CreateFeatureActivity,
  "deprecated": true,
  "deprecationActivity": DeprecateFeatureActivity,
  "deprecationReason": "DUPLICATE",
  "description": "xyz789",
  "entrezId": 987,
  "events": EventConnection,
  "featureAliases": ["xyz789"],
  "featureInstance": Factor,
  "flagged": false,
  "flags": FlagConnection,
  "fullName": "abc123",
  "id": 987,
  "lastAcceptedRevisionEvent": Event,
  "lastCommentEvent": Event,
  "lastSubmittedRevisionEvent": Event,
  "link": "abc123",
  "myGeneInfoDetails": {},
  "name": "abc123",
  "revisions": RevisionConnection,
  "sources": [Source],
  "variants": GeneVariantConnection
}
Types

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": 987,
  "pageInfo": PageInfo,
  "totalCount": 987
}
Types

GeneEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Gene The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": Gene
}
Types

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": [123]}
Types

GeneSearchFilter

Fields
Input Field Description
alias - StringSearchInput
booleanOperator - BooleanOperator
description - StringSearchInput
entrezId - IntSearchInput
entrezSymbol - StringSearchInput
hasAssertion - BooleanSearchInput
id - IntSearchInput
openRevisionCount - IntSearchInput
subFilters - [GeneSearchFilter!]
Example
{
  "alias": StringSearchInput,
  "booleanOperator": "AND",
  "description": StringSearchInput,
  "entrezId": IntSearchInput,
  "entrezSymbol": StringSearchInput,
  "hasAssertion": BooleanSearchInput,
  "id": IntSearchInput,
  "openRevisionCount": IntSearchInput,
  "subFilters": [GeneSearchFilter]
}
Types

GeneVariant

Fields
Field Name Description
alleleRegistryId - String
clinvarIds - [String!]!
comments - CommentConnection! List and filter comments.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

mentionedEntity - TaggableEntityInput

Limit to comments that mention a certain entity

mentionedRole - UserRole

Limit to comments that mention a certain user role

mentionedUserId - Int

Limit to comments that mention a certain user

originatingUserId - Int

Limit to comments by a certain user

sortBy - DateSort

Sort order for the comments. Defaults to most recent.
creationActivity - CreateVariantActivity
deprecated - Boolean!
deprecationActivity - DeprecateVariantActivity
deprecationReason - VariantDeprecationReason
ensemblVersion - Int
events - EventConnection! List and filter events for an object
Arguments
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.

last - Int

Returns the last n elements from the list.

organizationId - Int
originatingUserId - Int
sortBy - DateSort

Sort order for the events. Defaults to most recent.
feature - Feature!
flagged - Boolean!
flags - FlagConnection! List and filter flags.
Arguments
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.

flaggingUserId - Int

Limit to flags added by a certain user

last - Int

Returns the last n elements from the list.

resolvingUserId - Int

Limit to flags resolved by a certain user

sortBy - DateSort

Sort order for the flags. Defaults to most recent.

state - FlagState

Limit to flags in a particular state
hgvsDescriptions - [String!]!
id - Int!
lastAcceptedRevisionEvent - Event
lastCommentEvent - Event
lastSubmittedRevisionEvent - Event
link - String!
maneSelectTranscript - String
molecularProfiles - MolecularProfileConnection!
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.
myVariantInfo - MyVariantInfo
name - String!
openCravatUrl - String
primaryCoordinates - Coordinate
referenceBases - String
referenceBuild - ReferenceBuild
revisions - RevisionConnection! List and filter revisions.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

fieldName - String

Limit to revisions on a particular field.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

originatingUserId - Int

Limit to revisions by a certain user

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
secondaryCoordinates - Coordinate
singleVariantMolecularProfile - MolecularProfile!
singleVariantMolecularProfileId - Int!
variantAliases - [String!]!
variantBases - String
variantTypes - [VariantType!]!
Example
{
  "alleleRegistryId": "xyz789",
  "clinvarIds": ["abc123"],
  "comments": CommentConnection,
  "creationActivity": CreateVariantActivity,
  "deprecated": false,
  "deprecationActivity": DeprecateVariantActivity,
  "deprecationReason": "DUPLICATE",
  "ensemblVersion": 987,
  "events": EventConnection,
  "feature": Feature,
  "flagged": true,
  "flags": FlagConnection,
  "hgvsDescriptions": ["xyz789"],
  "id": 123,
  "lastAcceptedRevisionEvent": Event,
  "lastCommentEvent": Event,
  "lastSubmittedRevisionEvent": Event,
  "link": "xyz789",
  "maneSelectTranscript": "abc123",
  "molecularProfiles": MolecularProfileConnection,
  "myVariantInfo": MyVariantInfo,
  "name": "abc123",
  "openCravatUrl": "abc123",
  "primaryCoordinates": Coordinate,
  "referenceBases": "xyz789",
  "referenceBuild": "GRCH37",
  "revisions": RevisionConnection,
  "secondaryCoordinates": Coordinate,
  "singleVariantMolecularProfile": MolecularProfile,
  "singleVariantMolecularProfileId": 987,
  "variantAliases": ["xyz789"],
  "variantBases": "abc123",
  "variantTypes": [VariantType]
}
Types

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
}
Types

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
}
Types

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.
ensemblVersion - NullableIntInput! The Ensembl database version.
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.
primaryCoordinates - CoordinateInput! The primary coordinates for this Variant. In the case of Fusions this will be the coordinates of the 5' partner.
referenceBases - NullableStringInput! Reference bases for this variant
referenceBuild - NullableReferenceBuildTypeInput! The reference build for the genomic coordinates of this Variant.
secondaryCoordinates - CoordinateInput! In the case of Fusions these will be the coordinates of the 3' partner, otherwise set the values to null.
variantBases - NullableStringInput! Variant bases for this variant
variantTypeIds - [Int!]! List of IDs for the variant types for this Variant
Example
{
  "aliases": ["abc123"],
  "clinvarIds": ClinvarInput,
  "ensemblVersion": NullableIntInput,
  "featureId": 987,
  "hgvsDescriptions": ["abc123"],
  "name": "xyz789",
  "primaryCoordinates": CoordinateInput,
  "referenceBases": NullableStringInput,
  "referenceBuild": NullableReferenceBuildTypeInput,
  "secondaryCoordinates": CoordinateInput,
  "variantBases": NullableStringInput,
  "variantTypeIds": [987]
}
Types

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
Types

ISO8601DateTime

Description

An ISO 8601-encoded datetime

Example
ISO8601DateTime
Types

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
Types

IntSearchInput

Fields
Input Field Description
comparisonOperator - IntSearchOperator!
value - Int!
Example
{"comparisonOperator": "EQ", "value": 987}
Types

IntSearchOperator

Values
Enum Value Description

EQ

 Equal To

GE

GT

LE

LT

NE
Example
"EQ"
Types

JSON

Description

Represents untyped JSON

Example
{}
Types

LeaderboardOrganization

Fields
Field Name Description
actionCount - Int!
description - String!
eventCount - Int!
events - EventConnection!
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.
id - Int!
memberCount - Int!
members - UserConnection!
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.
mostRecentActivityTimestamp - ISO8601DateTime
name - String!
orgAndSuborgsStatsHash - Stats!
orgStatsHash - Stats!
profileImagePath - String
Arguments
size - Int
rank - Int!
ranks - Ranks!
subGroups - [Organization!]!
url - String!
Example
{
  "actionCount": 987,
  "description": "abc123",
  "eventCount": 123,
  "events": EventConnection,
  "id": 123,
  "memberCount": 987,
  "members": UserConnection,
  "mostRecentActivityTimestamp": ISO8601DateTime,
  "name": "abc123",
  "orgAndSuborgsStatsHash": Stats,
  "orgStatsHash": Stats,
  "profileImagePath": "xyz789",
  "rank": 987,
  "ranks": Ranks,
  "subGroups": [Organization],
  "url": "xyz789"
}
Types

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": 123
}
Types

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
}
Types

LeaderboardRank

Fields
Field Name Description
actionCount - Int!
rank - Int!
Example
{"actionCount": 123, "rank": 987}
Types

LeaderboardUser

Fields
Field Name Description
actionCount - Int!
areaOfExpertise - AreaOfExpertise
bio - String
country - Country
displayName - String!
email - String
events - EventConnection!
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.
facebookProfile - String
id - Int!
linkedinProfile - String
mostRecentActivityTimestamp - ISO8601DateTime
mostRecentConflictOfInterestStatement - Coi
mostRecentEvent - Event
mostRecentOrganizationId - Int
name - String
notifications - NotificationConnection Filterable list of notifications for the logged in user.
Arguments
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

Filter the response to include only notifications generated by certain actions (ex: commenting).

first - Int

Returns the first n elements from the list.

includeSeen - Boolean

Filter the reponse to include only notifications generated by a particular subscription.

last - Int

Returns the last n elements from the list.

notificationType - NotificationReason

Filter the response to include only notifications of a certaint type (ex: mentions).

subscriptionId - Int

Filter the reponse to include only notifications generated by a particular subscription.
orcid - String
organizations - [Organization!]!
profileImagePath - String
Arguments
size - Int
rank - Int!
ranks - Ranks!
role - UserRole!
statsHash - Stats!
twitterHandle - String
url - String
username - String!
Example
{
  "actionCount": 987,
  "areaOfExpertise": "CLINICAL_SCIENTIST",
  "bio": "xyz789",
  "country": Country,
  "displayName": "xyz789",
  "email": "xyz789",
  "events": EventConnection,
  "facebookProfile": "abc123",
  "id": 123,
  "linkedinProfile": "xyz789",
  "mostRecentActivityTimestamp": ISO8601DateTime,
  "mostRecentConflictOfInterestStatement": Coi,
  "mostRecentEvent": Event,
  "mostRecentOrganizationId": 123,
  "name": "xyz789",
  "notifications": NotificationConnection,
  "orcid": "xyz789",
  "organizations": [Organization],
  "profileImagePath": "abc123",
  "rank": 123,
  "ranks": Ranks,
  "role": "ADMIN",
  "statsHash": Stats,
  "twitterHandle": "xyz789",
  "url": "xyz789",
  "username": "xyz789"
}
Types

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": 123
}
Types

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
}
Types

LinkableDisease

Fields
Field Name Description
id - Int!
link - String!
name - String!
Example
{
  "id": 987,
  "link": "abc123",
  "name": "xyz789"
}
Types

LinkableFeature

Fields
Field Name Description
id - Int!
link - String!
name - String!
Example
{
  "id": 987,
  "link": "xyz789",
  "name": "xyz789"
}
Types

LinkableTherapy

Fields
Field Name Description
id - Int!
link - String!
name - String!
Example
{
  "id": 987,
  "link": "xyz789",
  "name": "abc123"
}
Types

LinkableVariant

Fields
Field Name Description
deprecated - Boolean
feature - LinkableFeature
id - Int!
link - String!
matchText - String
name - String!
Example
{
  "deprecated": false,
  "feature": LinkableFeature,
  "id": 123,
  "link": "xyz789",
  "matchText": "abc123",
  "name": "abc123"
}
Types

LinkableVariantType

Fields
Field Name Description
id - Int!
link - String!
name - String!
Example
{
  "id": 123,
  "link": "xyz789",
  "name": "xyz789"
}
Types

LinkoutData

Fields
Field Name Description
currentValue - ModeratedField!
diffValue - ModeratedFieldDiff!
name - String!
suggestedValue - ModeratedField!
Example
{
  "currentValue": ObjectField,
  "diffValue": ObjectFieldDiff,
  "name": "xyz789",
  "suggestedValue": ObjectField
}
Types

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": 987,
  "note": "xyz789",
  "organization": Organization,
  "parsedNote": [CommentTagSegment],
  "subject": EventSubject,
  "user": User,
  "verbiage": "xyz789"
}
Types

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.
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": "abc123",
  "newStatus": "ACCEPTED",
  "organizationId": 123
}
Types

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": "xyz789"
}
Types

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": "xyz789",
  "organization": Organization,
  "parsedNote": [CommentTagSegment],
  "subject": EventSubject,
  "user": User,
  "verbiage": "abc123"
}
Types

ModerateEvidenceItemInput

Description

Autogenerated input type of ModerateEvidenceItem

Fields
Input Field Description
clientMutationId - String A unique identifier for the client performing the mutation.
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": "xyz789",
  "evidenceItemId": 987,
  "newStatus": "ACCEPTED",
  "organizationId": 987
}
Types

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": "xyz789",
  "evidenceItem": EvidenceItem
}
Types

ModeratedEntities

Description

Enumeration of all moderated CIViC entities.

Values
Enum Value Description

ASSERTION

EVIDENCE_ITEM

FEATURE

MOLECULAR_PROFILE

VARIANT

VARIANT_GROUP
Example
"ASSERTION"
Types

ModeratedField

Description

Fields that can have revisions can be either scalar values or complex objects

Types
Union Types

ObjectField

ScalarField
Example
ObjectField
Types

ModeratedFieldDiff

Description

Fields that can have revisions can be either scalar values or complex objects

Types
Union Types

ObjectFieldDiff

ScalarFieldDiff
Example
ObjectFieldDiff
Types

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}
Types

ModeratedObjectField

Fields
Field Name Description
deleted - Boolean!
deprecated - Boolean
displayName - String
displayType - String
entityType - String!
feature - LinkableFeature
id - Int!
link - String
Example
{
  "deleted": false,
  "deprecated": true,
  "displayName": "abc123",
  "displayType": "xyz789",
  "entityType": "xyz789",
  "feature": LinkableFeature,
  "id": 987,
  "link": "xyz789"
}
Types

MolecularProfile

Fields
Field Name Description
assertions - AssertionConnection! The collection of assertions associated with this molecular profile.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.
comments - CommentConnection! List and filter comments.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

mentionedEntity - TaggableEntityInput

Limit to comments that mention a certain entity

mentionedRole - UserRole

Limit to comments that mention a certain user role

mentionedUserId - Int

Limit to comments that mention a certain user

originatingUserId - Int

Limit to comments by a certain user

sortBy - DateSort

Sort order for the comments. Defaults to most recent.
complexMolecularProfileCreationActivity - CreateComplexMolecularProfileActivity
complexMolecularProfileDeprecationActivity - DeprecateComplexMolecularProfileActivity
deprecated - Boolean!
deprecatedVariants - [VariantInterface!]!
deprecationReason - MolecularProfileDeprecationReason
description - String
events - EventConnection! List and filter events for an object
Arguments
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.

last - Int

Returns the last n elements from the list.

organizationId - Int
originatingUserId - Int
sortBy - DateSort

Sort order for the events. Defaults to most recent.
evidenceCountsByStatus - EvidenceItemsByStatus!
evidenceCountsByType - EvidenceItemsByType!
evidenceItems - EvidenceItemConnection! The collection of evidence items associated with this molecular profile.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.
flagged - Boolean!
flags - FlagConnection! List and filter flags.
Arguments
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.

flaggingUserId - Int

Limit to flags added by a certain user

last - Int

Returns the last n elements from the list.

resolvingUserId - Int

Limit to flags resolved by a certain user

sortBy - DateSort

Sort order for the flags. Defaults to most recent.

state - FlagState

Limit to flags in a particular state
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.
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
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

fieldName - String

Limit to revisions on a particular field.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

originatingUserId - Int

Limit to revisions by a certain user

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
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": "abc123",
  "events": EventConnection,
  "evidenceCountsByStatus": EvidenceItemsByStatus,
  "evidenceCountsByType": EvidenceItemsByType,
  "evidenceItems": EvidenceItemConnection,
  "flagged": false,
  "flags": FlagConnection,
  "id": 987,
  "isComplex": false,
  "isMultiVariant": false,
  "lastAcceptedRevisionEvent": Event,
  "lastCommentEvent": Event,
  "lastSubmittedRevisionEvent": Event,
  "link": "xyz789",
  "molecularProfileAliases": ["abc123"],
  "molecularProfileScore": 987.65,
  "name": "abc123",
  "parsedName": [Feature],
  "rawName": "xyz789",
  "revisions": RevisionConnection,
  "sources": [Source],
  "variantCreationActivity": CreateVariantActivity,
  "variantDeprecationActivity": DeprecateVariantActivity,
  "variants": [VariantInterface]
}
Types

MolecularProfileAlias

Fields
Field Name Description
name - String!
Example
{"name": "abc123"}
Types

MolecularProfileComponent

Description

A taggable/linkable component of a molecular profile

Fields
Field Name Description
id - Int!
link - String!
name - String!
Possible Types
MolecularProfileComponent Types

Factor

FactorVariant

Feature

Gene

GeneVariant

Variant
Example
{
  "id": 987,
  "link": "xyz789",
  "name": "xyz789"
}
Types

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]
}
Types

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
}
Types

MolecularProfileDeprecationReason

Values
Enum Value Description

DUPLICATE

INVALID

OTHER

VARIANT_DEPRECATED
Example
"DUPLICATE"
Types

MolecularProfileDeprecationReasonMutationInput

Values
Enum Value Description

DUPLICATE

INVALID

OTHER
Example
"DUPLICATE"
Types

MolecularProfileDisplayFilter

Values
Enum Value Description

ALL

 Display all molecular profiles regardless of attached evidence status.

WITH_ACCEPTED

 Display only molecular profiles which have at least one accepted evidence item.

WITH_ACCEPTED_OR_SUBMITTED

 Display only molecular profiles which have evidence in either an accepted or submitted state.

WITH_SUBMITTED

 Display molecular profiles which have at least one submited evidence item.
Example
"ALL"
Types

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
}
Types

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": [123]
}
Types

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]
}
Types

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

Feature

MolecularProfileTextSegment

Variant
Example
Feature
Types

MolecularProfileTextSegment

Fields
Field Name Description
text - String!
Example
{"text": "abc123"}
Types

MolecularProfilesSort

Fields
Input Field Description
column - MolecularProfilesSortColumns! Available columns for sorting
direction - SortDirection! Sort direction
Example
{"column": "assertionCount", "direction": "ASC"}
Types

MolecularProfilesSortColumns

Values
Enum Value Description

assertionCount

evidenceItemCount

molecularProfileScore

variantCount
Example
"assertionCount"
Types

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": "abc123",
  "chebiId": "abc123",
  "chemblId": "abc123",
  "chemblMoleculeType": "abc123",
  "drugbankId": "abc123",
  "fdaEpcCodes": [FdaCode],
  "fdaMoaCodes": [FdaCode],
  "firstApproval": "abc123",
  "inchikey": "xyz789",
  "indications": ["xyz789"],
  "pharmgkbId": "xyz789",
  "pubchemCid": "xyz789",
  "rxnorm": "xyz789"
}
Types

MyDiseaseInfo

Fields
Field Name Description
diseaseOntologyExactSynonyms - [String!]!
diseaseOntologyRelatedSynonyms - [String!]!
doDef - String
doDefCitations - [String!]!
icd10 - String
icdo - String
mesh - String
mondoDef - String
ncit - [String!]!
omim - String
Example
{
  "diseaseOntologyExactSynonyms": [
    "abc123"
  ],
  "diseaseOntologyRelatedSynonyms": [
    "abc123"
  ],
  "doDef": "xyz789",
  "doDefCitations": ["xyz789"],
  "icd10": "abc123",
  "icdo": "abc123",
  "mesh": "abc123",
  "mondoDef": "xyz789",
  "ncit": ["xyz789"],
  "omim": "xyz789"
}
Types

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": ["abc123"],
  "caddDetail": ["abc123"],
  "caddPhred": 123.45,
  "caddScore": 987.65,
  "clinvarClinicalSignificance": ["abc123"],
  "clinvarHgvsCoding": ["abc123"],
  "clinvarHgvsGenomic": ["xyz789"],
  "clinvarHgvsNonCoding": ["abc123"],
  "clinvarHgvsProtein": ["abc123"],
  "clinvarId": 123,
  "clinvarOmim": "abc123",
  "cosmicId": "xyz789",
  "dbnsfpInterproDomain": ["abc123"],
  "dbsnpRsid": "abc123",
  "eglClass": "xyz789",
  "eglHgvs": ["xyz789"],
  "eglProtein": "abc123",
  "eglTranscript": "abc123",
  "exacAlleleCount": 123,
  "exacAlleleFrequency": 123.45,
  "exacAlleleNumber": 987,
  "fathmmMklPrediction": "xyz789",
  "fathmmMklScore": 987.65,
  "fathmmPrediction": ["abc123"],
  "fathmmScore": [123.45],
  "fitconsScore": 987.65,
  "gerp": 987.65,
  "gnomadExomeAlleleCount": 123,
  "gnomadExomeAlleleFrequency": 123.45,
  "gnomadExomeAlleleNumber": 987,
  "gnomadExomeFilter": "abc123",
  "gnomadGenomeAlleleCount": 123,
  "gnomadGenomeAlleleFrequency": 987.65,
  "gnomadGenomeAlleleNumber": 987,
  "gnomadGenomeFilter": "abc123",
  "lrtPrediction": "abc123",
  "lrtScore": 123.45,
  "metalrPrediction": "xyz789",
  "metalrScore": 987.65,
  "metasvmPrediction": "abc123",
  "metasvmScore": 123.45,
  "mutationassessorPrediction": ["xyz789"],
  "mutationassessorScore": [123.45],
  "mutationtasterPrediction": ["xyz789"],
  "mutationtasterScore": [987.65],
  "myVariantInfoId": "xyz789",
  "phastcons100way": 987.65,
  "phastcons30way": 987.65,
  "phyloP100way": 987.65,
  "phyloP30way": 987.65,
  "polyphen2HdivPrediction": ["xyz789"],
  "polyphen2HdivScore": [987.65],
  "polyphen2HvarPrediction": ["abc123"],
  "polyphen2HvarScore": [987.65],
  "proveanPrediction": ["abc123"],
  "proveanScore": [987.65],
  "revelScore": [987.65],
  "siftPrediction": ["abc123"],
  "siftScore": [123.45],
  "siphy": 123.45,
  "snpeffSnpEffect": ["abc123"],
  "snpeffSnpImpact": ["xyz789"]
}
Types

NccnGuideline

Fields
Field Name Description
id - Int!
name - String!
Example
{"id": 123, "name": "xyz789"}
Types

NcitDefinition

Fields
Field Name Description
definition - String!
source - String!
Example
{
  "definition": "abc123",
  "source": "xyz789"
}
Types

NcitDetails

Fields
Field Name Description
definitions - [NcitDefinition!]!
synonyms - [NcitSynonym!]!
Example
{
  "definitions": [NcitDefinition],
  "synonyms": [NcitSynonym]
}
Types

NcitSynonym

Fields
Field Name Description
name - String!
source - String!
Example
{
  "name": "xyz789",
  "source": "xyz789"
}
Types

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": 123,
  "notifiedUser": User,
  "originatingUser": User,
  "seen": false,
  "subscription": Subscription,
  "type": "MENTION",
  "updatedAt": ISO8601DateTime
}
Types

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 occured 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": 123,
  "pageInfo": PageInfo,
  "totalCount": 123,
  "unreadCount": 123
}
Types

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": "xyz789",
  "node": Notification
}
Types

NotificationReason

Values
Enum Value Description

MENTION

SUBSCRIPTION
Example
"MENTION"
Types

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.

Fields
Input Field Description
unset - Boolean Set to true if you wish to set the field's value to null.
value - AmpLevel The desired value for the field. Mutually exclusive with unset.
Example
{"unset": false, "value": "NA"}
Types

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": true, "value": "CLINICAL_SCIENTIST"}
Types

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.

Fields
Input Field Description
unset - Boolean Set to true if you wish to set the field's value to null.
value - Boolean The desired value for the field. Mutually exclusive with unset.
Example
{"unset": true, "value": true}
Types

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.

Fields
Input Field Description
unset - Boolean Set to true if you wish to set the field's value to null.
value - ID The desired value for the field. Mutually exclusive with unset.
Example
{"unset": false, "value": "4"}
Types

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.

Fields
Input Field Description
unset - Boolean Set to true if you wish to set the field's value to null.
value - Int The desired value for the field. Mutually exclusive with unset.
Example
{"unset": false, "value": 123}
Types

NullableReferenceBuildTypeInput

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 - ReferenceBuild The desired value for the field. Mutually exclusive with unset.
Example
{"unset": true, "value": "GRCH37"}
Types

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.

Fields
Input Field Description
unset - Boolean Set to true if you wish to set the field's value to null.
value - String The desired value for the field. Mutually exclusive with unset.
Example
{"unset": true, "value": "abc123"}
Types

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": true, "value": "COMBINATION"}
Types

ObjectField

Fields
Field Name Description
objects - [ModeratedObjectField!]!
Example
{"objects": [ModeratedObjectField]}
Types

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]
}
Types

Organization

Fields
Field Name Description
description - String!
eventCount - Int!
events - EventConnection!
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.
id - Int!
memberCount - Int!
members - UserConnection!
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.
mostRecentActivityTimestamp - ISO8601DateTime
name - String!
orgAndSuborgsStatsHash - Stats!
orgStatsHash - Stats!
profileImagePath - String
Arguments
size - Int
ranks - Ranks!
subGroups - [Organization!]!
url - String!
Example
{
  "description": "abc123",
  "eventCount": 987,
  "events": EventConnection,
  "id": 987,
  "memberCount": 987,
  "members": UserConnection,
  "mostRecentActivityTimestamp": ISO8601DateTime,
  "name": "xyz789",
  "orgAndSuborgsStatsHash": Stats,
  "orgStatsHash": Stats,
  "profileImagePath": "abc123",
  "ranks": Ranks,
  "subGroups": [Organization],
  "url": "abc123"
}
Types

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
}
Types

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
}
Types

OrganizationFilter

Description

Filter on organization id and whether or not to include the organization's subgroups

Fields
Input Field Description
id - Int The organization ID.
includeSubgroups - Boolean Whether or not to include the organization's subgroup. Default = false
name - String The organization name.
Example
{
  "id": 987,
  "includeSubgroups": false,
  "name": "xyz789"
}
Types

OrganizationLeaderboards

Fields
Field Name Description
commentsLeaderboard - LeaderboardOrganizationConnection!
Arguments
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.

direction - SortDirection
first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

window - TimeWindow
moderationLeaderboard - LeaderboardOrganizationConnection!
Arguments
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.

direction - SortDirection
first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

window - TimeWindow
revisionsLeaderboard - LeaderboardOrganizationConnection!
Arguments
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.

direction - SortDirection
first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

window - TimeWindow
submissionsLeaderboard - LeaderboardOrganizationConnection!
Arguments
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.

direction - SortDirection
first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

window - TimeWindow
Example
{
  "commentsLeaderboard": LeaderboardOrganizationConnection,
  "moderationLeaderboard": LeaderboardOrganizationConnection,
  "revisionsLeaderboard": LeaderboardOrganizationConnection,
  "submissionsLeaderboard": LeaderboardOrganizationConnection
}
Types

OrganizationSort

Fields
Input Field Description
column - OrganizationSortColumns! Available columns for sorting
direction - SortDirection! Sort direction
Example
{"column": "ID", "direction": "ASC"}
Types

OrganizationSortColumns

Values
Enum Value Description

ID

NAME
Example
"ID"
Types

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": true,
  "hasPreviousPage": true,
  "startCursor": "xyz789"
}
Types

Phenotype

Fields
Field Name Description
description - String
hpoId - String!
id - Int!
link - String!
name - String!
url - String!
Example
{
  "description": "abc123",
  "hpoId": "xyz789",
  "id": 123,
  "link": "xyz789",
  "name": "abc123",
  "url": "abc123"
}
Types

PhenotypePopover

Fields
Field Name Description
assertionCount - Int!
description - String
evidenceItemCount - Int!
hpoId - String!
id - Int!
link - String!
molecularProfileCount - Int!
name - String!
url - String!
Example
{
  "assertionCount": 987,
  "description": "xyz789",
  "evidenceItemCount": 987,
  "hpoId": "abc123",
  "id": 123,
  "link": "abc123",
  "molecularProfileCount": 987,
  "name": "xyz789",
  "url": "abc123"
}
Types

PhenotypeSort

Fields
Input Field Description
column - PhenotypeSortColumns! Available columns for sorting
direction - SortDirection! Sort direction
Example
{"column": "ASSERTION_COUNT", "direction": "ASC"}
Types

PhenotypeSortColumns

Values
Enum Value Description

ASSERTION_COUNT

EVIDENCE_ITEM_COUNT

HPO_ID

NAME
Example
"ASSERTION_COUNT"
Types

Ranks

Fields
Field Name Description
commentsRank - LeaderboardRank
moderationRank - LeaderboardRank
revisionsRank - LeaderboardRank
submissionsRank - LeaderboardRank
Example
{
  "commentsRank": LeaderboardRank,
  "moderationRank": LeaderboardRank,
  "revisionsRank": LeaderboardRank,
  "submissionsRank": LeaderboardRank
}
Types

ReadStatus

Values
Enum Value Description

READ

UNREAD
Example
"READ"
Types

ReferenceBuild

Values
Enum Value Description

GRCH37

GRCH38

NCBI36
Example
"GRCH37"
Types

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": 987,
  "note": "xyz789",
  "organization": Organization,
  "parsedNote": [CommentTagSegment],
  "revisions": [Revision],
  "subject": EventSubject,
  "user": User,
  "verbiage": "xyz789"
}
Types

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": "xyz789",
  "comment": "xyz789",
  "ids": [987],
  "organizationId": 987,
  "revisionSetId": 123
}
Types

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]
}
Types

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": 987,
  "note": "abc123",
  "organization": Organization,
  "parsedNote": [CommentTagSegment],
  "subject": EventSubject,
  "user": User,
  "verbiage": "xyz789"
}
Types

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": "abc123",
  "id": 987,
  "organizationId": 987
}
Types

ResolveFlagPayload

Description

Autogenerated return type of ResolveFlag.

Fields
Field Name Description
clientMutationId - String A unique identifier for the client performing the mutation.
flag - Flag
Example
{
  "clientMutationId": "xyz789",
  "flag": Flag
}
Types

Revision

Fields
Field Name Description
acceptanceActivity - AcceptRevisionsActivity
comments - CommentConnection! List and filter comments.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

mentionedEntity - TaggableEntityInput

Limit to comments that mention a certain entity

mentionedRole - UserRole

Limit to comments that mention a certain user role

mentionedUserId - Int

Limit to comments that mention a certain user

originatingUserId - Int

Limit to comments by a certain user

sortBy - DateSort

Sort order for the comments. Defaults to most recent.
createdAt - ISO8601DateTime!
creationActivity - SuggestRevisionSetActivity
currentValue - JSON
events - EventConnection! List and filter events for an object
Arguments
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.

last - Int

Returns the last n elements from the list.

organizationId - Int
originatingUserId - Int
sortBy - DateSort

Sort order for the events. Defaults to most recent.
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": 987,
  "lastCommentEvent": Event,
  "link": "abc123",
  "linkoutData": LinkoutData,
  "name": "abc123",
  "rejectionActivity": RejectRevisionsActivity,
  "resolutionActivity": ActivityInterface,
  "revisionSetId": 123,
  "status": "ACCEPTED",
  "subject": EventSubject,
  "suggestedValue": {},
  "supersedingActivity": AcceptRevisionsActivity,
  "updatedAt": ISO8601DateTime
}
Types

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": 123,
  "pageInfo": PageInfo,
  "revisedFieldNames": [FieldName],
  "totalCount": 123,
  "unfilteredCountForSubject": 987,
  "uniqueResolvers": [User],
  "uniqueRevisors": [User]
}
Types

RevisionEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Revision The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": Revision
}
Types

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": "abc123",
  "id": 123,
  "newlyCreated": false,
  "revisionSetId": 123
}
Types

RevisionSet

Fields
Field Name Description
createdAt - ISO8601DateTime!
displayName - String!
events - EventConnection! List and filter events for an object
Arguments
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.

last - Int

Returns the last n elements from the list.

organizationId - Int
originatingUserId - Int
sortBy - DateSort

Sort order for the events. Defaults to most recent.
id - Int!
link - String!
name - String!
revisions - [Revision!]!
updatedAt - ISO8601DateTime!
Example
{
  "createdAt": ISO8601DateTime,
  "displayName": "abc123",
  "events": EventConnection,
  "id": 123,
  "link": "xyz789",
  "name": "abc123",
  "revisions": [Revision],
  "updatedAt": ISO8601DateTime
}
Types

RevisionStatus

Values
Enum Value Description

ACCEPTED

NEW

REJECTED

SUPERSEDED
Example
"ACCEPTED"
Types

ScalarField

Fields
Field Name Description
value - String
Example
{"value": "abc123"}
Types

ScalarFieldDiff

Fields
Field Name Description
left - String!
right - String!
Example
{
  "left": "abc123",
  "right": "abc123"
}
Types

SearchResult

Fields
Field Name Description
id - Int!
matchingText - String!
name - String!
resultType - SearchableEntities!
Example
{
  "id": 123,
  "matchingText": "xyz789",
  "name": "abc123",
  "resultType": "ASSERTION"
}
Types

SearchableEntities

Values
Enum Value Description

ASSERTION

EVIDENCE_ITEM

FEATURE

MOLECULAR_PROFILE

REVISION

VARIANT

VARIANT_GROUP
Example
"ASSERTION"
Types

SortDirection

Values
Enum Value Description

ASC

DESC
Example
"ASC"
Types

Source

Fields
Field Name Description
abstract - String
ascoAbstractId - Int
authorString - String
citation - String
citationId - String!
clinicalTrials - [ClinicalTrial!]
comments - CommentConnection! List and filter comments.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

mentionedEntity - TaggableEntityInput

Limit to comments that mention a certain entity

mentionedRole - UserRole

Limit to comments that mention a certain user role

mentionedUserId - Int

Limit to comments that mention a certain user

originatingUserId - Int

Limit to comments by a certain user

sortBy - DateSort

Sort order for the comments. Defaults to most recent.
displayType - String!
events - EventConnection! List and filter events for an object
Arguments
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.

last - Int

Returns the last n elements from the list.

organizationId - Int
originatingUserId - Int
sortBy - DateSort

Sort order for the events. Defaults to most recent.
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
sourceType - SourceSource!
sourceUrl - String
title - String
Example
{
  "abstract": "abc123",
  "ascoAbstractId": 987,
  "authorString": "xyz789",
  "citation": "xyz789",
  "citationId": "abc123",
  "clinicalTrials": [ClinicalTrial],
  "comments": CommentConnection,
  "displayType": "xyz789",
  "events": EventConnection,
  "fullJournalTitle": "xyz789",
  "fullyCurated": true,
  "id": 987,
  "journal": "xyz789",
  "lastCommentEvent": Event,
  "link": "abc123",
  "name": "abc123",
  "openAccess": true,
  "pmcId": "abc123",
  "publicationDate": "abc123",
  "publicationDay": 123,
  "publicationMonth": 123,
  "publicationYear": 123,
  "sourceType": "ASCO",
  "sourceUrl": "xyz789",
  "title": "abc123"
}
Types

SourcePopover

Fields
Field Name Description
abstract - String
ascoAbstractId - Int
authorString - String
citation - String
citationId - String!
clinicalTrials - [ClinicalTrial!]
comments - CommentConnection! List and filter comments.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

mentionedEntity - TaggableEntityInput

Limit to comments that mention a certain entity

mentionedRole - UserRole

Limit to comments that mention a certain user role

mentionedUserId - Int

Limit to comments that mention a certain user

originatingUserId - Int

Limit to comments by a certain user

sortBy - DateSort

Sort order for the comments. Defaults to most recent.
displayType - String!
events - EventConnection! List and filter events for an object
Arguments
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.

last - Int

Returns the last n elements from the list.

organizationId - Int
originatingUserId - Int
sortBy - DateSort

Sort order for the events. Defaults to most recent.
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
sourceType - SourceSource!
sourceUrl - String
title - String
Example
{
  "abstract": "abc123",
  "ascoAbstractId": 123,
  "authorString": "abc123",
  "citation": "xyz789",
  "citationId": "xyz789",
  "clinicalTrials": [ClinicalTrial],
  "comments": CommentConnection,
  "displayType": "abc123",
  "events": EventConnection,
  "evidenceItemCount": 987,
  "fullJournalTitle": "abc123",
  "fullyCurated": true,
  "id": 987,
  "journal": "abc123",
  "lastCommentEvent": Event,
  "link": "xyz789",
  "name": "xyz789",
  "openAccess": true,
  "pmcId": "xyz789",
  "publicationDate": "xyz789",
  "publicationDay": 987,
  "publicationMonth": 123,
  "publicationYear": 987,
  "sourceType": "ASCO",
  "sourceUrl": "xyz789",
  "title": "xyz789"
}
Types

SourceSource

Values
Enum Value Description

ASCO

ASH

PUBMED
Example
"ASCO"
Types

SourceStub

Fields
Field Name Description
citationId - Int!
id - Int!
sourceType - SourceSource!
Example
{"citationId": 123, "id": 987, "sourceType": "ASCO"}
Types

SourceSuggestion

Fields
Field Name Description
createdAt - ISO8601DateTime!
creationActivity - SuggestSourceActivity!
disease - Disease
events - EventConnection! List and filter events for an object
Arguments
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.

last - Int

Returns the last n elements from the list.

organizationId - Int
originatingUserId - Int
sortBy - DateSort

Sort order for the events. Defaults to most recent.
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": 123,
  "initialComment": "xyz789",
  "lastStatusUpdateActivity": UpdateSourceSuggestionStatusActivity,
  "link": "xyz789",
  "molecularProfile": MolecularProfile,
  "name": "abc123",
  "reason": "xyz789",
  "source": Source,
  "status": "CURATED",
  "user": User
}
Types

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": 123
}
Types

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
}
Types

SourceSuggestionStatus

Values
Enum Value Description

CURATED

NEW

REJECTED
Example
"CURATED"
Types

SourceSuggestionValues

Fields
Field Name Description
disease - Disease
molecularProfile - MolecularProfile
source - Source
Example
{
  "disease": Disease,
  "molecularProfile": MolecularProfile,
  "source": Source
}
Types

SourceSuggestionsSort

Fields
Input Field Description
column - SourceSuggestionsSortColumns! Available columns for sorting
direction - SortDirection! Sort direction
Example
{"column": "CITATION", "direction": "ASC"}
Types

SourceSuggestionsSortColumns

Values
Enum Value Description

CITATION

CITATION_ID

CREATED_AT

DISEASE_NAME

SOURCE_TYPE

SUBMITTER
Example
"CITATION"
Types

SourcesSort

Fields
Input Field Description
column - SourcesSortColumns! Available columns for sorting
direction - SortDirection! Sort direction
Example
{"column": "AUTHORS", "direction": "ASC"}
Types

SourcesSortColumns

Values
Enum Value Description

AUTHORS

CITATION_ID

EVIDENCE_COUNT

JOURNAL

NAME

SOURCE_TYPE

SUGGESTION_COUNT

YEAR
Example
"AUTHORS"
Types

Stats

Fields
Field Name Description
acceptedAssertions - Int!
acceptedEvidenceItems - Int!
appliedRevisions - Int!
comments - Int!
revisions - Int!
submittedAssertions - Int!
submittedEvidenceItems - Int!
suggestedSources - Int!
Example
{
  "acceptedAssertions": 987,
  "acceptedEvidenceItems": 987,
  "appliedRevisions": 987,
  "comments": 123,
  "revisions": 123,
  "submittedAssertions": 987,
  "submittedEvidenceItems": 987,
  "suggestedSources": 123
}
Types

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"
Types

StringSearchInput

Fields
Input Field Description
comparisonOperator - StringSearchOperator!
value - String!
Example
{
  "comparisonOperator": "CONTAINS",
  "value": "xyz789"
}
Types

StringSearchOperator

Values
Enum Value Description

CONTAINS

DOES_NOT_CONTAIN

EQ

NE

STARTS_WITH
Example
"CONTAINS"
Types

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": 123,
  "note": "xyz789",
  "organization": Organization,
  "parsedNote": [CommentTagSegment],
  "subject": EventSubject,
  "user": User,
  "verbiage": "abc123"
}
Types

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": "xyz789",
  "comment": "xyz789",
  "fields": AssertionFields,
  "organizationId": 123
}
Types

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"
}
Types

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": "xyz789",
  "organization": Organization,
  "parsedNote": [CommentTagSegment],
  "subject": EventSubject,
  "user": User,
  "verbiage": "xyz789"
}
Types

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
}
Types

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": "abc123",
  "evidenceItem": EvidenceItem
}
Types

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": "abc123",
  "organizationId": 123,
  "sourceIds": [123],
  "variantIds": [123]
}
Types

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
}
Types

Subscribable

Fields
Field Name Description
entityType - SubscribableEntities!
id - Int!
Example
{"entityType": "ASSERTION", "id": 123}
Types

SubscribableEntities

Description

Enumeration of all subscribable CIViC entities.

Values
Enum Value Description

ASSERTION

EVIDENCE_ITEM

FEATURE

MOLECULAR_PROFILE

REVISION

SOURCE_SUGGESTION

VARIANT

VARIANT_GROUP
Example
"ASSERTION"
Types

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}
Types

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": 987, "includeChildren": true}
Types

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": "abc123",
  "subscribables": [SubscribableInput],
  "subscribeToChildren": true
}
Types

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]
}
Types

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": "abc123",
  "comment": "xyz789",
  "fields": AssertionFields,
  "id": 987,
  "organizationId": 123
}
Types

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]
}
Types

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": "xyz789",
  "comment": "abc123",
  "fields": EvidenceItemFields,
  "id": 987,
  "organizationId": 987
}
Types

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]
}
Types

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": "abc123",
  "comment": "xyz789",
  "fields": FactorFields,
  "id": 123,
  "organizationId": 987
}
Types

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 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": "abc123",
  "factor": Factor,
  "results": [RevisionResult]
}
Types

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": "xyz789",
  "fields": FactorVariantFields,
  "id": 987,
  "organizationId": 987
}
Types

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": "xyz789",
  "results": [RevisionResult],
  "variant": FactorVariant
}
Types

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": "abc123",
  "comment": "abc123",
  "fields": GeneFields,
  "id": 987,
  "organizationId": 987
}
Types

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": "abc123",
  "gene": Gene,
  "results": [RevisionResult]
}
Types

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": 123,
  "organizationId": 987
}
Types

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
}
Types

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": "xyz789",
  "comment": "abc123",
  "fields": MolecularProfileFields,
  "id": 123,
  "organizationId": 123
}
Types

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": "abc123",
  "molecularProfile": MolecularProfile,
  "results": [RevisionResult]
}
Types

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"
}
Types

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": 123,
  "note": "xyz789",
  "organization": Organization,
  "parsedNote": [CommentTagSegment],
  "sourceSuggestion": SourceSuggestion,
  "subject": EventSubject,
  "user": User,
  "verbiage": "xyz789"
}
Types

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": "abc123",
  "diseaseId": 123,
  "molecularProfileId": 987,
  "organizationId": 987,
  "sourceId": 987
}
Types

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
}
Types

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": "abc123",
  "comment": "xyz789",
  "fields": VariantGroupFields,
  "id": 123,
  "organizationId": 123
}
Types

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": "abc123",
  "results": [RevisionResult],
  "variantGroup": VariantGroup
}
Types

TaggableEntity

Values
Enum Value Description

ASSERTION

EVIDENCE_ITEM

FEATURE

MOLECULAR_PROFILE

REVISION

ROLE

VARIANT

VARIANT_GROUP
Example
"ASSERTION"
Types

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}
Types

Therapy

Fields
Field Name Description
id - Int!
link - String!
myChemInfo - MyChemInfo
name - String!
ncitId - String
therapyAliases - [String!]!
therapyUrl - String
Example
{
  "id": 987,
  "link": "abc123",
  "myChemInfo": MyChemInfo,
  "name": "xyz789",
  "ncitId": "abc123",
  "therapyAliases": ["xyz789"],
  "therapyUrl": "xyz789"
}
Types

TherapyInteraction

Values
Enum Value Description

COMBINATION

SEQUENTIAL

SUBSTITUTES
Example
"COMBINATION"
Types

TherapyPopover

Fields
Field Name Description
assertionCount - Int!
evidenceItemCount - Int!
id - Int!
link - String!
molecularProfileCount - Int!
myChemInfo - MyChemInfo
name - String!
ncitId - String
therapyAliases - [String!]!
therapyUrl - String
Example
{
  "assertionCount": 123,
  "evidenceItemCount": 987,
  "id": 123,
  "link": "xyz789",
  "molecularProfileCount": 987,
  "myChemInfo": MyChemInfo,
  "name": "xyz789",
  "ncitId": "abc123",
  "therapyAliases": ["abc123"],
  "therapyUrl": "xyz789"
}
Types

TherapySort

Fields
Input Field Description
column - TherapySortColumns! Available columns for sorting
direction - SortDirection! Sort direction
Example
{"column": "ASSERTION_COUNT", "direction": "ASC"}
Types

TherapySortColumns

Values
Enum Value Description

ASSERTION_COUNT

EVIDENCE_ITEM_COUNT

NAME

NCIT_ID
Example
"ASSERTION_COUNT"
Types

TimePointCounts

Fields
Field Name Description
allTime - Int!
newThisMonth - Int!
newThisWeek - Int!
newThisYear - Int!
Example
{"allTime": 123, "newThisMonth": 987, "newThisWeek": 123, "newThisYear": 987}
Types

TimeWindow

Values
Enum Value Description

ALL_TIME

LAST_MONTH

LAST_WEEK

LAST_YEAR
Example
"ALL_TIME"
Types

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": "xyz789",
  "subscribables": [SubscribableInput],
  "unsubscribeFromChildren": false
}
Types

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]
}
Types

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": "abc123",
  "coiPresent": true,
  "statement": "abc123"
}
Types

UpdateCoiPayload

Description

Autogenerated return type of UpdateCoi.

Fields
Field Name Description
clientMutationId - String A unique identifier for the client performing the mutation.
coiStatement - Coi!
Example
{
  "clientMutationId": "abc123",
  "coiStatement": Coi
}
Types

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": [123],
  "newStatus": "READ"
}
Types

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]
}
Types

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": "xyz789",
  "organization": Organization,
  "parsedNote": [CommentTagSegment],
  "sourceSuggestion": SourceSuggestion,
  "subject": EventSubject,
  "user": User,
  "verbiage": "abc123"
}
Types

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": "xyz789",
  "id": 123,
  "newStatus": "CURATED",
  "organizationId": 123,
  "reason": "xyz789"
}
Types

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
}
Types

User

Fields
Field Name Description
areaOfExpertise - AreaOfExpertise
bio - String
country - Country
displayName - String!
email - String
events - EventConnection!
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.
facebookProfile - String
id - Int!
linkedinProfile - String
mostRecentActivityTimestamp - ISO8601DateTime
mostRecentConflictOfInterestStatement - Coi
mostRecentEvent - Event
mostRecentOrganizationId - Int
name - String
notifications - NotificationConnection Filterable list of notifications for the logged in user.
Arguments
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

Filter the response to include only notifications generated by certain actions (ex: commenting).

first - Int

Returns the first n elements from the list.

includeSeen - Boolean

Filter the reponse to include only notifications generated by a particular subscription.

last - Int

Returns the last n elements from the list.

notificationType - NotificationReason

Filter the response to include only notifications of a certaint type (ex: mentions).

subscriptionId - Int

Filter the reponse to include only notifications generated by a particular subscription.
orcid - String
organizations - [Organization!]!
profileImagePath - String
Arguments
size - Int
ranks - Ranks!
role - UserRole!
statsHash - Stats!
twitterHandle - String
url - String
username - String!
Example
{
  "areaOfExpertise": "CLINICAL_SCIENTIST",
  "bio": "xyz789",
  "country": Country,
  "displayName": "xyz789",
  "email": "abc123",
  "events": EventConnection,
  "facebookProfile": "xyz789",
  "id": 987,
  "linkedinProfile": "abc123",
  "mostRecentActivityTimestamp": ISO8601DateTime,
  "mostRecentConflictOfInterestStatement": Coi,
  "mostRecentEvent": Event,
  "mostRecentOrganizationId": 123,
  "name": "abc123",
  "notifications": NotificationConnection,
  "orcid": "xyz789",
  "organizations": [Organization],
  "profileImagePath": "xyz789",
  "ranks": Ranks,
  "role": "ADMIN",
  "statsHash": Stats,
  "twitterHandle": "xyz789",
  "url": "xyz789",
  "username": "abc123"
}
Types

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
}
Types

UserEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - User The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": User
}
Types

UserLeaderboards

Fields
Field Name Description
commentsLeaderboard - LeaderboardUserConnection!
Arguments
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.

direction - SortDirection
first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

role - UserRole
window - TimeWindow
moderationLeaderboard - LeaderboardUserConnection!
Arguments
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.

direction - SortDirection
first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

role - UserRole
window - TimeWindow
revisionsLeaderboard - LeaderboardUserConnection!
Arguments
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.

direction - SortDirection
first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

role - UserRole
window - TimeWindow
submissionsLeaderboard - LeaderboardUserConnection!
Arguments
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.

direction - SortDirection
first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

role - UserRole
window - TimeWindow
Example
{
  "commentsLeaderboard": LeaderboardUserConnection,
  "moderationLeaderboard": LeaderboardUserConnection,
  "revisionsLeaderboard": LeaderboardUserConnection,
  "submissionsLeaderboard": LeaderboardUserConnection
}
Types

UserRole

Values
Enum Value Description

ADMIN

CURATOR

EDITOR
Example
"ADMIN"
Types

UsersSort

Fields
Input Field Description
column - UsersSortColumns! Available columns for sorting
direction - SortDirection! Sort direction
Example
{"column": "ID", "direction": "ASC"}
Types

UsersSortColumns

Values
Enum Value Description

ID

LAST_ACTION

NAME

ROLE
Example
"ID"
Types

ValidationErrors

Fields
Field Name Description
genericErrors - [String!]!
validationErrors - [FieldValidationError!]!
Example
{
  "genericErrors": ["xyz789"],
  "validationErrors": [FieldValidationError]
}
Types

Variant

Fields
Field Name Description
comments - CommentConnection! List and filter comments.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

mentionedEntity - TaggableEntityInput

Limit to comments that mention a certain entity

mentionedRole - UserRole

Limit to comments that mention a certain user role

mentionedUserId - Int

Limit to comments that mention a certain user

originatingUserId - Int

Limit to comments by a certain user

sortBy - DateSort

Sort order for the comments. Defaults to most recent.
creationActivity - CreateVariantActivity
deprecated - Boolean!
deprecationActivity - DeprecateVariantActivity
deprecationReason - VariantDeprecationReason
events - EventConnection! List and filter events for an object
Arguments
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.

last - Int

Returns the last n elements from the list.

organizationId - Int
originatingUserId - Int
sortBy - DateSort

Sort order for the events. Defaults to most recent.
feature - Feature!
flagged - Boolean!
flags - FlagConnection! List and filter flags.
Arguments
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.

flaggingUserId - Int

Limit to flags added by a certain user

last - Int

Returns the last n elements from the list.

resolvingUserId - Int

Limit to flags resolved by a certain user

sortBy - DateSort

Sort order for the flags. Defaults to most recent.

state - FlagState

Limit to flags in a particular state
id - Int!
lastAcceptedRevisionEvent - Event
lastCommentEvent - Event
lastSubmittedRevisionEvent - Event
link - String!
molecularProfiles - MolecularProfileConnection!
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.
name - String!
revisions - RevisionConnection! List and filter revisions.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

fieldName - String

Limit to revisions on a particular field.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

originatingUserId - Int

Limit to revisions by a certain user

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
singleVariantMolecularProfile - MolecularProfile!
singleVariantMolecularProfileId - Int!
variantAliases - [String!]!
variantTypes - [VariantType!]!
Example
{
  "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",
  "revisions": RevisionConnection,
  "singleVariantMolecularProfile": MolecularProfile,
  "singleVariantMolecularProfileId": 123,
  "variantAliases": ["abc123"],
  "variantTypes": [VariantType]
}
Types

VariantAlias

Fields
Field Name Description
name - String!
Example
{"name": "xyz789"}
Types

VariantCategories

Values
Enum Value Description

FACTOR

GENE
Example
"FACTOR"
Types

VariantComponent

Description

Representation of a Variant's membership in a Molecular Profile.

Fields
Input Field Description
not - Boolean! When set to true, this means the NOT operator will be applied to the Variant in the Molecluar Profile. Default = false
variantId - Int! The ID of the Variant involved in the Molecular Profile.
Example
{"not": true, "variantId": 123}
Types

VariantDeprecationReason

Values
Enum Value Description

DUPLICATE

FEATURE_DEPRECATED

INVALID

OTHER
Example
"DUPLICATE"
Types

VariantGroup

Fields
Field Name Description
comments - CommentConnection! List and filter comments.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

mentionedEntity - TaggableEntityInput

Limit to comments that mention a certain entity

mentionedRole - UserRole

Limit to comments that mention a certain user role

mentionedUserId - Int

Limit to comments that mention a certain user

originatingUserId - Int

Limit to comments by a certain user

sortBy - DateSort

Sort order for the comments. Defaults to most recent.
description - String!
events - EventConnection! List and filter events for an object
Arguments
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.

last - Int

Returns the last n elements from the list.

organizationId - Int
originatingUserId - Int
sortBy - DateSort

Sort order for the events. Defaults to most recent.
flagged - Boolean!
flags - FlagConnection! List and filter flags.
Arguments
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.

flaggingUserId - Int

Limit to flags added by a certain user

last - Int

Returns the last n elements from the list.

resolvingUserId - Int

Limit to flags resolved by a certain user

sortBy - DateSort

Sort order for the flags. Defaults to most recent.

state - FlagState

Limit to flags in a particular state
id - Int!
lastAcceptedRevisionEvent - Event
lastCommentEvent - Event
lastSubmittedRevisionEvent - Event
link - String!
name - String!
revisions - RevisionConnection! List and filter revisions.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

fieldName - String

Limit to revisions on a particular field.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

originatingUserId - Int

Limit to revisions by a certain user

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
sources - [Source!]!
variants - VariantInterfaceConnection! List and filter Gene variants.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

alleleRegistryId - String

Find a CIViC Variant based on its ClinGen Allele Registry ID

before - String

Returns the elements in the list that come before the specified cursor.

category - VariantCategories
factorId - Int

Feature that the variants are associated with, limited to only Factor type features.

featureId - Int

Feature that the variants are associated with.

first - Int

Returns the first n elements from the list.

geneId - Int

Feature that the variants are associated with, limited to only Gene type features.

hasNoVariantType - Boolean

Return Variants lacking an assigned VariantType

last - Int

Returns the last n elements from the list.

name - String

Left anchored filtering for variant name and aliases.

sortBy - VariantMenuSort
variantTypeIds - [Int!]

A list of CIViC identifiers for variant types
Example
{
  "comments": CommentConnection,
  "description": "abc123",
  "events": EventConnection,
  "flagged": true,
  "flags": FlagConnection,
  "id": 123,
  "lastAcceptedRevisionEvent": Event,
  "lastCommentEvent": Event,
  "lastSubmittedRevisionEvent": Event,
  "link": "abc123",
  "name": "abc123",
  "revisions": RevisionConnection,
  "sources": [Source],
  "variants": VariantInterfaceConnection
}
Types

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
}
Types

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": "abc123",
  "node": VariantGroup
}
Types

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": "xyz789",
  "sourceIds": [987],
  "variantIds": [987]
}
Types

VariantGroupsSort

Fields
Input Field Description
column - VariantGroupsSortColumns! Available columns for sorting
direction - SortDirection! Sort direction
Example
{"column": "EVIDENCE_ITEM_COUNT", "direction": "ASC"}
Types

VariantGroupsSortColumns

Values
Enum Value Description

EVIDENCE_ITEM_COUNT

GENE_NAMES

NAME

VARIANT_COUNT

VARIANT_NAMES
Example
"EVIDENCE_ITEM_COUNT"
Types

VariantInterface

Description

A taggable/linkable component of a molecular profile

Fields
Field Name Description
comments - CommentConnection! List and filter comments.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

mentionedEntity - TaggableEntityInput

Limit to comments that mention a certain entity

mentionedRole - UserRole

Limit to comments that mention a certain user role

mentionedUserId - Int

Limit to comments that mention a certain user

originatingUserId - Int

Limit to comments by a certain user

sortBy - DateSort

Sort order for the comments. Defaults to most recent.
creationActivity - CreateVariantActivity
deprecated - Boolean!
deprecationActivity - DeprecateVariantActivity
deprecationReason - VariantDeprecationReason
events - EventConnection! List and filter events for an object
Arguments
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.

last - Int

Returns the last n elements from the list.

organizationId - Int
originatingUserId - Int
sortBy - DateSort

Sort order for the events. Defaults to most recent.
feature - Feature!
flagged - Boolean!
flags - FlagConnection! List and filter flags.
Arguments
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.

flaggingUserId - Int

Limit to flags added by a certain user

last - Int

Returns the last n elements from the list.

resolvingUserId - Int

Limit to flags resolved by a certain user

sortBy - DateSort

Sort order for the flags. Defaults to most recent.

state - FlagState

Limit to flags in a particular state
id - Int!
lastAcceptedRevisionEvent - Event
lastCommentEvent - Event
lastSubmittedRevisionEvent - Event
link - String!
molecularProfiles - MolecularProfileConnection!
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.
name - String!
revisions - RevisionConnection! List and filter revisions.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

fieldName - String

Limit to revisions on a particular field.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

originatingUserId - Int

Limit to revisions by a certain user

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
singleVariantMolecularProfile - MolecularProfile!
singleVariantMolecularProfileId - Int!
variantAliases - [String!]!
variantTypes - [VariantType!]!
Possible Types
VariantInterface Types

FactorVariant

GeneVariant

Variant
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": "xyz789",
  "revisions": RevisionConnection,
  "singleVariantMolecularProfile": MolecularProfile,
  "singleVariantMolecularProfileId": 123,
  "variantAliases": ["abc123"],
  "variantTypes": [VariantType]
}
Types

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": 123,
  "pageInfo": PageInfo,
  "totalCount": 987
}
Types

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
}
Types

VariantMenuSort

Fields
Input Field Description
column - VariantMenuSortColumns! Available columns for sorting
direction - SortDirection! Sort direction
Example
{"column": "COORDINATE_END", "direction": "ASC"}
Types

VariantMenuSortColumns

Values
Enum Value Description

COORDINATE_END

COORDINATE_START

NAME
Example
"COORDINATE_END"
Types

VariantOrigin

Values
Enum Value Description

COMBINED

COMMON_GERMLINE

NA

RARE_GERMLINE

SOMATIC

UNKNOWN
Example
"COMBINED"
Types

VariantType

Fields
Field Name Description
description - String!
id - Int!
link - String!
name - String!
soid - String!
url - String
Example
{
  "description": "abc123",
  "id": 987,
  "link": "xyz789",
  "name": "abc123",
  "soid": "xyz789",
  "url": "xyz789"
}
Types

VariantTypePopover

Fields
Field Name Description
description - String!
id - Int!
link - String!
name - String!
soid - String!
url - String
variantCount - Int!
Example
{
  "description": "xyz789",
  "id": 123,
  "link": "abc123",
  "name": "abc123",
  "soid": "abc123",
  "url": "abc123",
  "variantCount": 123
}
Types

VariantTypeSort

Fields
Input Field Description
column - VariantTypeSortColumns! Available columns for sorting
direction - SortDirection! Sort direction
Example
{"column": "NAME", "direction": "ASC"}
Types

VariantTypeSortColumns

Values
Enum Value Description

NAME

SOID

VARIANT_COUNT
Example
"NAME"
Types

VariantsSort

Fields
Input Field Description
column - VariantsSortColumns! Available columns for sorting
direction - SortDirection! Sort direction
Example
{"column": "diseaseName", "direction": "ASC"}
Types

VariantsSortColumns

Values
Enum Value Description

diseaseName

featureName

therapyName

variantName
Example
"diseaseName"
Types

WithRevisions

Description

A CIViC entity that can have revisions proposed to it.

Fields
Field Name Description
lastAcceptedRevisionEvent - Event
lastSubmittedRevisionEvent - Event
revisions - RevisionConnection! List and filter revisions.
Arguments
after - String

Returns the elements in the list that come after the specified cursor.

before - String

Returns the elements in the list that come before the specified cursor.

fieldName - String

Limit to revisions on a particular field.

first - Int

Returns the first n elements from the list.

last - Int

Returns the last n elements from the list.

originatingUserId - Int

Limit to revisions by a certain user

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
Possible Types
WithRevisions Types

Assertion

EvidenceItem

Factor

FactorVariant

Feature

Gene

GeneVariant

MolecularProfile

Variant

VariantGroup
Example
{
  "lastAcceptedRevisionEvent": Event,
  "lastSubmittedRevisionEvent": Event,
  "revisions": RevisionConnection
}
Documentation by Anvil SpectaQL