Skip to content
Docs
Deploy
Submit
User Roles
Technical
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Deployment
Local deployment
Production deployment
Testing
Interact using Make
Logging
Back up/Restore
Troubleshooting
Update CanDIG
GitHub
Select theme
Dark
Light
Auto
Data submission steps
Prepare clinical data
Registering programs
Ingest clinical data
Prepare genomic data
Ingest genomic data
Troubleshooting
GitHub
Select theme
Dark
Light
Auto
User Roles
Roles Overview
Assign user roles
DAC Authorization
GitHub
Select theme
Dark
Light
Auto
Tech docs
Architecture
Docker and submods
candig api operations
Overview
Operations
Retrieve information about this service
Determine the current user's user key (usually their email)
Datasets
List datasets.
Create a new dataset.
Grab summary statistics for all datasets.
Retrieve a dataset according to its ID
Update a dataset corresponding to the given ID
Delete a dataset corresponding to the given ID
Retrieve a dataset's info
Alter a dataset's info
Grab summary statistics for the given dataset
List all sample for a dataset
Upload a JSON file for ingest data
Upload a MoH sample JSON file for ingest
Upload genomic JSON file for ingest
Check the status of an uploaded file
Persons
List persons.
Create a new person in the dataset.
Get all details about a person
Update an existing person.
Delete a person from the database.
Alter an existing person in the database.
clinical beacon api
Overview
Persons
beacon_operations.post_person
Datasets
beacon_operations.post
beacon_operations.get_filtering_terms
beacon_operations.post_filtering_terms
Informational endpoints
beacon_operations.get_beacon_info_root
beacon_operations.get_beacon_configuration
beacon_operations.get_beacon_map
beacon_operations.get_entry_types
POST Endpoints
beacon_operations.variants_search
api
Overview
Operations
Retrieve information about this service
Add a DrsObject to the db
Delete a DrsObject.
drs_operations.list_programs
drs_operations.post_program
drs_operations.get_program
Delete a program.
drs_operations.get_program_status
Objects
List all DRS objects
Get info about a DrsObject.
Download a file associated with a drs object
Get a URL for fetching bytes
List all DRS Experiment objects matching an array of submitter_sample_ids. Only authorized for site admins and authzed services.
htsget beacon api
Overview
Informational endpoints
beacon_operations.get_beacon_service_info
Operations
beacon_operations.get_full_result
GET Endpoints
beacon_operations.get_search
POST Endpoints
beacon_operations.post_search
htsget operations api
Overview
Reads
Get reads service info
Get alignment (reads) file download ticket
Stream alignment file part
Variants
Get variants service info
Get variant file download ticket
Stream variant file part
Service Info
Get reads service info
Get variants service info
Streaming
Stream alignment file part
Stream variant file part
Operations
htsget_operations.indexer_status
htsget_operations.indexer_switch
Verify the integrity of the object
Index variant file for search
List all available gene names
Get transcript region for genes matching id
List all available gene names
Get transcript region for transcripts matching id
Get metadata about a experiment
Get metadata about experiments in a program
Get metadata about multiple experiments
federation api
Overview
Operations
operations.service_info
operations.list_servers
operations.add_server
operations.get_server
operations.delete_server
operations.list_external_services
operations.add_external_service
operations.get_external_service
operations.delete_external_service
operations.list_services
operations.add_service
operations.get_service
operations.delete_service
Send a request to the CanDIG network
GitHub
Select theme
Dark
Light
Auto
operations.list_servers
GET
/servers
List registered servers.
Responses
200
Successful query
500
Internal Error
