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
| Deprecating old response format | The old response format for tabular data will be deprecated. The **"multi_value"** response format (introduced in July 2023) will be the default option. It allows retrieval of data with one or more features and suits any type of tabular data, including **.gct** files. |
@@ -536,6 +537,7 @@ Please review the documentation, as these changes may impact your integrations.
536
537
537
538
538
539
??? danger "Affected endpoints (for both as-curator and as-users)"
| Introducing **“variant”** section | A new section **“variant”** contains all fields related to a specific variation from the original VCF file: CHROM, POS, ID, REF, ALT, QUAL, FILTER, INFO. |
552
555
553
556
??? example "Response example"
554
557
555
558
559
+
556
560
??? danger "Affected endpoints (for both as-curator and as-users)"
| Introducing **“feature”** and **“value”** sections | Flow-cytometry data response now has section **“feature”** including **"readoutType"**, **"cellPopulation"** and **"marker"** fields. **“Value”** section contains the expression field which is renamed to **“value”**.|
@@ -573,6 +579,7 @@ Please review the documentation, as these changes may impact your integrations.
573
579
574
580
575
581
??? danger "Affected endpoints (for both as-curator and as-users)"
<figcaption>Main dashboard of the ODM. Click on API documentation to explore the available resources</figcaption>
24
25
25
26
2.**Explore the API Documentation**
26
27
* This action will display the API Documentation window, where you can explore how the data model in ODM is structured.
@@ -49,6 +50,7 @@ Follow these steps to use Swagger effectively, based on your role and permission
49
50
3.**Accessing Endpoints:** Use the top right button to select specific functions. For example,
50
51
the `studyUser` definition contains API endpoints specifically for retrieving study metadata.
51
52
53
+
<figcaption>Swagger page interface. You can access the endpoints by selecting specific functions on the button on the top right, e.g., the definition <strong>studyUser</strong> contains the API endpoints for retrieving only study metadata</figcaption>
52
54
53
55
### API token
54
56
@@ -70,20 +72,23 @@ An access token is required to work with the API endpoints. Follow these steps t
70
72
* Save the token in an easily accessible location for future use.
<figcaption>Steps to create a new API token: 1) Access your profile window, 2) click on Create new token, and a link will be sent to your email address (the user who is logged in). 3) Access the link, 4) assign a name to the token and 5) download the plain text format file</figcaption>
73
76
74
77
### Authorize with the Token
75
78
1. Once the token is generated, you need to authorize the use of the endpoints.
76
79
2. Direct to the endpoint of interest depending on the action to run (retrieve data, stream data, upload entities, etc.)
77
80
3. Click on **Authorize**, select the type of token (Access Token or Genestack API token),
!!! Warning ""Manage organisation" and "Access all data" permissions are required for working with detached objects."
89
94
@@ -92,42 +97,49 @@ as a "study." A study itself is classified as detached if it has no links to low
92
97
93
98
1. To locate orphaned data (detached objects), you can use the "Retrieve a list of detached objects" endpoint.
94
99
100
+
<figcaption>Use the endpoint {==/api/v1/manage-data/detached-objects==} to find detached data</figcaption>
95
101
96
102
2. You can apply filters to specify the type of data you wish to retrieve and limit the number of results displayed
97
103
(up to 2,000). If no filters are applied, the endpoint will return a list of all available detached objects.
98
104
In the example below, the results are limited to the first 5 available objects.
99
105
106
+
<figcaption>Apply filters to limit the number of results</figcaption>
100
107
101
108
3. The results display the first 5 detached objects in the system, including detailed information for each object,
102
109
such as the Genestack accession number, the type of detached object, the owner's email, and the date of creation.
103
110
The "cursor" at the end indicates the last object retrieved from the list, which allows you to continue the
104
111
search from where it left off.
105
112
113
+
<figcaption>Response from the previous query. The window shows the number of results, the accession number. The last value "cursor" indicates the last retrieved object</figcaption>
106
114
107
115
4. You can apply filters to search for specific types of detached objects,
108
116
such as `STUDY`, `SAMPLE_GROUP`, `LIBRARY_GROUP`, `PREPARATION_GROUP`, `TABULAR_DATA`, `GENE_VARIANT`, and
109
117
`FLOW_CYTOMETRY`. For instance, you can filter by LIBRARY_GROUP to retrieve the first 10 detached library group objects.
110
118
119
+
<figcaption>Apply filter to customize the search for specific data, such as <cursor>Library Group</cursor></figcaption>
111
120
112
121
Identifying detached objects can help you recognize data that may no longer be relevant in the system.
113
122
You can use the Genestack accession number to delete data that is no longer required. For more information on
114
-
deleting data, refer to the next section "Delete Data in ODM".
123
+
deleting data, refer to the next section **Delete Data in ODM**.
115
124
116
125
## Use Case Example: Delete data in ODM
117
126
118
127
**Endpoint:** DELETE `/api/v1/manage-data/data`
119
128
!!! warning "The deletion of data is an irreversible action and it is only available for users with "Manage organization" and "Access all data" permissions."
120
129
121
-
1. To delete a data object or a data group, use the `/api/v1/manage-data/data` endpoint
122
-
130
+
1. To delete a data object or a data group, use the `DELETE /api/v1/manage-data/data` endpoint
131
+
132
+
<figcaption>Use the endpoint {==DELETE /api/v1/manage-data/data==} to delete data from ODM</figcaption>
123
133
124
134
2. Enter the data object or the data group accession of the data you intend to delete.
125
135
For this example, we will delete the study GSF1147012, named “Demo version 2”.
126
-
136
+
137
+
<figcaption>Use the endpoint {==/api/v1/manage-data/data==} to delete specific data. For example, to remove the study <strong>Demo version 2</strong>, add the ID details (GSF1147012) and click on <strong>Execute</strong></figcaption>
127
138
128
139
3. The response indicates that the deletion of the following files and all linked data has been started.
129
140
You can verify the deletion by checking the Groups section in the
130
141
ODM interface; the "Demo version 2" group should no longer be listed.
131
142
143
+
<figcaption>The 202 response indicates that the request to remove the study <strong>Demo version 2</strong> (ID GSF1147012) has been successfully initiated. You can confirm the completion of this operation by logging into ODM and searching for the specific study.</figcaption>
132
144
133
-
By following these steps, Data Administrators can efficiently manage users and groups within the ODM using the API.
145
+
By following these steps, Data Administrators can efficiently manage users and groups within the **ODM** using the API endpoints.
0 commit comments