Knowledge Network Service (KNS)

This section provides information on the available KNS APIs. See Generating an API Key for information on obtaining an API key.

The following are the available endpoints:

association-pull-controller

Endpoint	Description	Request
GET	Get association for the association id.	GET /kns/{apiVersion}/association/{associationId}
GET	Get draft association for the associate id.	GET /kns/{apiVersion}/association/{associationId}/draft
GET	Get enabled association for the draft association id.	GET /kns/{apiVersion}/association/{associationId}/enabled
GET	Get association version for the id and version.	GET /kns/{apiVersion}/association/{associationId}/version/{associationVersion}
GET	Get draft duration version for the curation id.	GET /kns/{apiVersion}/association/draft/curation/{curationId}
GET	Get citation for pubMedId.	GET /kns/{apiVersion}/association/evidence/{pubMedId}/citation
POST	Get all association based on the file params.	POST /kns/{apiVersion}/association/search

association-push-controller

Endpoint	Description	Request
POST	Create an association.	POST /kns/{apiVersion}/association
POST	Update an association for association id.	POST /kns/{apiVersion}/association/{associationId}
POST	Review or Assign a Reviewer to an association.	POST /kns/{apiVersion}/association/{associationId}/{action}
POST	Create an evidence for association.	POST /kns/{apiVersion}/association/{associationId}/evidence
POST	Update an evidence for a given evidence Id.	POST /kns/{apiVersion}/association/{associationId}/evidence/{evidenceId}
POST	Disable an evidence,	POST /kns/{apiVersion}/association/{associationId}/evidence/{evidenceId}/disable
POST	Bulk action.	POST /kns/{apiVersion}/association/bulk/{action}
DELETE	Delete an association for association Id	DELETE /kns/{apiVersion}/association/bulk/delete
POST	Push draft curation.	POST /kns/{apiVersion}/association/draft/curation
POST	Get bulk associations for association ids.	POST /kns/{apiVersion}/association/search/bulk
POST	Get bulk association id and version.	POST /kns/{apiVersion}/association/search/bulk/version

cache-controller

Endpoint	Description	Request
POST	Generate a TSV file for cache.	POST /kns/{apiVersion}/association/cache

criteria-controller

Endpoint	Description	Request
POST	Create criteria without evidence.	POST /kns/{apiVersion}/association/{associationId}/criteria
POST	Update criteria without evidence.	POST /kns/{apiVersion}/association/{associationId}/criteria/{criteriaId}
DELETE	Delete criteria without evidence.	DELETE /kns/{apiVersion}/association/{associationId}/criteria/{criteriaId}

draft-curation-controller

Endpoint	Description	Request
GET	Get draft curations.	GET /kns/{apiVersion}/draft/curation

Endpoint	Description	Request
GET	Search Google Scholar for a given gene, along with optional amino acid and/or optional cDNA.	GET /kns/{apiVersion}/scholarsearch/

home-controller

Endpoint	Description	Request
GET	Get the shared domain ids.	GET /kns/{apiVersion}/info/domain/{domainId}/workgroups
GET	Get the shared domain ids.	GET /kns/{apiVersion}/info/shareddomains
GET	Get the app version.	GET /kns/{apiVersion}/info/version
GET	Get roles for the application, creates them in platform if missing.	GET /kns/{apiVersion}/roles
GET	Get the details for the current configuration.	GET /kns/api/v1/config
GET	Get the details for the current session.	GET /kns/api/v1/session
GET	Get the details for the current session.	GET /kns/api/v1/session/workgroups
GET	Get the configuration.	GET /kns/configuration
GET	Get the details for the current user.	GET /kns/current-user
GET	Get the details for the current session.	GET /kns/session
DELETE	Invalidate a session.	DELETE /kns/session
GET	Get the application version.	GET /kns/version
GET	Get the users for a workgroup.	GET /kns/workgroup/{workgroupId}/users
GET	Get the workgroup list for the user.	GET /kns/workgroups
GET	Get the shared workgroup list for the user.	GET /kns/workgroups/shared

interpretation-controller

Endpoint	Description	Request
POST	Create criteria without evidence.	POST /kns/{apiVersion}/association/{associationId}/criteria
POST	Update criteria without evidence.	POST /kns/{apiVersion}/association/{associationId}/criteria/{criteriaId}

nirvana-controller

Endpoint	Description	Request
POST	Execute Nirvana for VCF programa.	POST /kns/nirvana/vcf
POST	Convert VCF to VID.	POST /kns/nirvana/vcf/vid
GET	Get the supported Nirvana sessions.	GET /kns/nirvana/versions
POST	Execute Nirvana for VID.	POST /kns/nirvana/vid
POST	Convert VID to VCF.	POST /kns/nirvana/vid/vcf

preferred-name-controller

Endpoint	Description	Request
POST	Create a preferred disease name.	POST /kns/{apiVersion}/preferred-name
GET	Get a preferred disease name based on preferred name ID.	GET /kns/{apiVersion}/preferred-name/{preferredNameId}
DELETE	Delete a preferred disease name.	DELETE /kns/{apiVersion}/preferred-name/{preferredNameId}
PATCH	Update a preferred disease name.	PATCH /kns/{apiVersion}/preferred-name/{preferredNameId}
GET	Search a preferred disease name for auto-complete.	GET /kns/{apiVersion}/preferred-name/autocomplete
POST	Search a preferred disease name for a given ontology term.	POST /kns/{apiVersion}/preferred-name/search

validation-controller

Endpoint	Description	Request
GET	Validate start and stop based on chromosome.	GET /kns/{apiVersion}/validation/sv/position

variant-controller

Endpoint	Description	Request
POST	Push the list of variants.	POST /kns/{apiVersion}/variant
GET	Get variant by variant id.	GET /kns/{apiVersion}/variant/{variantId}
PATCH	Partial update for variant attributes by variant id.	PATCH /kns/{apiVersion}/variant/{variantId}
POST	Variant API to assign/start/done/cancel.	POST /kns/{apiVersion}/variant/{variantId}/{action}
POST	Bulk action.	POST /kns/{apiVersion}/variant/bulk/{action}
POST	Search variants.	POST /kns/{apiVersion}/variant/search
POST	Update the list of variants.	POST /kns/{apiVersion}/variant/update