project_overlays.adoc 4.28 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
= Rest API Documentation - Project Data overlays
Piotr Gawron
v{project-version} {build-time}
:toc: left
:sectnums:

== List data overlays

=== Path Parameters
include::{snippets}/projects/project_overlays/get_all_by_creator/path-parameters.adoc[]

=== Response Fields
include::{snippets}/projects/project_overlays/get_all_by_creator/response-fields.adoc[]

=== CURL sample 1
include::{snippets}/projects/project_overlays/get_all/curl-request.adoc[]

=== Sample Response 1
include::{snippets}/projects/project_overlays/get_all/response-body.adoc[]

=== CURL sample 2
include::{snippets}/projects/project_overlays/get_all_by_creator/curl-request.adoc[]

=== Sample Response 2
include::{snippets}/projects/project_overlays/get_all_by_creator/response-body.adoc[]


== Get data overlay 

=== Path Parameters
include::{snippets}/projects/project_overlays/get_by_id/path-parameters.adoc[]

=== Response Fields
include::{snippets}/projects/project_overlays/get_by_id/response-fields.adoc[]

=== CURL sample
include::{snippets}/projects/project_overlays/get_by_id/curl-request.adoc[]

=== Sample Response
include::{snippets}/projects/project_overlays/get_by_id/response-body.adoc[]


== Add overlay

=== Path Parameters
include::{snippets}/projects/project_overlays/create_from_file/path-parameters.adoc[]

=== Request Parameters
include::{snippets}/projects/project_overlays/create_from_file/request-parameters.adoc[]

=== Response Fields
include::{snippets}/projects/project_overlays/create_from_file/response-fields.adoc[]

=== CURL sample from file
include::{snippets}/projects/project_overlays/create_from_file/curl-request.adoc[]

=== Sample Response from file
include::{snippets}/projects/project_overlays/create_from_file/response-body.adoc[]

=== CURL sample from content
include::{snippets}/projects/project_overlays/create_from_content/curl-request.adoc[]

=== Sample Response from content
include::{snippets}/projects/project_overlays/create_from_content/response-body.adoc[]


== Update overlay

=== Path Parameters
include::{snippets}/projects/project_overlays/update_overlay/path-parameters.adoc[]

=== Request Fields
include::{snippets}/projects/project_overlays/update_overlay/request-fields.adoc[]

=== Response Fields
include::{snippets}/projects/project_overlays/update_overlay/response-fields.adoc[]

=== CURL sample
include::{snippets}/projects/project_overlays/update_overlay/curl-request.adoc[]

=== Sample Response
include::{snippets}/projects/project_overlays/update_overlay/response-body.adoc[]


== Delete overlay

=== CURL sample
include::{snippets}/projects/project_overlays/delete_overlay/curl-request.adoc[]

=== Path Parameters
include::{snippets}/projects/project_overlays/delete_overlay/path-parameters.adoc[]


== Download source data

=== Path Parameters
include::{snippets}/projects/project_overlays/download_source/path-parameters.adoc[]

=== CURL sample
include::{snippets}/projects/project_overlays/download_source/curl-request.adoc[]

=== Sample Response
include::{snippets}/projects/project_overlays/download_source/response-body.adoc[]


== Get list of associated bioEntites

=== Path Parameters
include::{snippets}/projects/project_overlays/get_bio_entities/path-parameters.adoc[]

=== Response Fields
include::{snippets}/projects/project_overlays/get_bio_entities/response-fields.adoc[]

=== CURL sample
include::{snippets}/projects/project_overlays/get_bio_entities/curl-request.adoc[]

=== Sample Response
include::{snippets}/projects/project_overlays/get_bio_entities/response-body.adoc[]


== Get reaction data

=== Path Parameters
include::{snippets}/projects/project_overlays/get_reaction/path-parameters.adoc[]

=== Response Fields
include::{snippets}/projects/project_overlays/get_reaction/response-fields.adoc[]

=== CURL sample
include::{snippets}/projects/project_overlays/get_reaction/curl-request.adoc[]

=== Sample Response
include::{snippets}/projects/project_overlays/get_reaction/response-body.adoc[]


== Get element data

=== Path Parameters
include::{snippets}/projects/project_overlays/get_element/path-parameters.adoc[]

=== Response Fields
include::{snippets}/projects/project_overlays/get_element/response-fields.adoc[]

=== CURL sample
include::{snippets}/projects/project_overlays/get_element/curl-request.adoc[]

=== Sample Response
include::{snippets}/projects/project_overlays/get_element/response-body.adoc[]