You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Create-And-Publish-Virtual-Study.md
+35-8Lines changed: 35 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,8 @@
2
2
3
3
A [Virtual Study](./user-guide/faq.md#what-is-a-virtual-study) defines a subset or a combination of samples from one or more studies in the system.
4
4
5
+
A [Virtual Study](./user-guide/faq.md#what-is-a-virtual-study) is a custom study made up of samples from one or more existing studies. By default, a virtual study appears only under **My Virtual Studies** for its author. When it is published to the `/api/public_virtual_studies` endpoint, it becomes a **public virtual study** that is visible to all users on the landing page and can be used as a shared, reusable cohort. Publishing works for both static virtual studies (saved cohorts) and dynamic virtual studies whose contents are recomputed from filters on each load.
6
+
5
7
*Note*: To publish or un-publish a virtual study, your cBioPortal instance must be configured with `session.endpoint.publisher-api-key` in the `application.properties`.
6
8
7
9
## Create Virtual Study
@@ -23,28 +25,53 @@ You can always find the ID of the virtual study from the URL of the page that op
23
25
24
26
## Publish Virtual Study
25
27
26
-
To publish a virtual study, you need to supply the publisher API key in the `X-PUBLISHER-API-KEY` header.
28
+
Publishing requires the publisher API key in the `X-PUBLISHER-API-KEY` header and can now happen in two different ways:
29
+
30
+
1.**Create in the UI, then publish by hash ID.** This is the original workflow where you first create a virtual study through the interface (the ID in the study URL is a MongoDB hash), and then publish that specific study.
31
+
2.**Create and publish with a custom ID.** This RFC96 addition lets you publish a public virtual study in a single request by providing its definition (constraints/filters) and the desired ID. The ID must be unique and is typically a human-readable string so permissions can be managed up front.
32
+
33
+
### Publish an existing virtual study
34
+
35
+
After creating the study in the UI and copying its ID (hash), publish it via:
27
36
28
-
Here is a curl command to publish a virtual study:
The published virtual study will appear under the `Public Virtual Studies` section (next to the `My Virtual Studies` section) on the landing page for all users of cBioPortal.
36
43
37
-
While publishing, you can specify the PubMed ID (`pmid`) and `typeOfCancerId` of the virtual study using the following command:
The JSON payload should follow the format returned by the `/api/session/virtual_study` endpoint (fields such as `name`, `description`, `studyViewFilter`, and `studies`). If the ID already exists you will receive a `409 Conflict`. When the request succeeds, the virtual study is immediately available to all users under the `Public Virtual Studies` section, optionally enriched with `pmid` and `typeOfCancerId` query parameters the same way as above.
Where `study_ids` is a comma-separated list of Cancer Study IDs to search and `patient_ids` is a comma-separated list of patient identifiers to delete.
Copy file name to clipboardExpand all lines: docs/deployment/customization/security.properties-Reference.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Security Properties
2
2
3
-
The following are the properties for configuring authentication and authorization in the application. The cBioPortal application mainly uses Spring Security for auth configuration; see also [Spring Security](./../authorization-and-authentication/authorization-and-authentication/Spring-Security.md) docs.
3
+
The following are the properties for configuring authentication and authorization in the application. The cBioPortal application mainly uses Spring Security for auth configuration; see also [Spring Security](./../authorization-and-authentication/Spring-Security.md) docs.
0 commit comments