converter.adoc 1.84 KB
Newer Older
1
= Rest API Documentation - Converter
Piotr Gawron's avatar
Piotr Gawron committed
2
minerva
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
v{project-version} {build-time}
:toc: left
:sectnums:

Conversion API provides access to MINERVA’s ability convert between different systems biology network formats and to export of layouts to different graphical formats.


== Conversion to systems biology formats

=== List available formats
==== CURL sample
include::{snippets}/converter/list_formats/curl-request.adoc[]

==== Response Fields
include::{snippets}/converter/list_formats/response-fields.adoc[]

==== Sample Response
include::{snippets}/converter/list_formats/response-body.adoc[]


23
24
25
26
27
28
29
=== Convert network from an input format to an output format
==== CURL sample
include::{snippets}/converter/format_conversion/curl-request.adoc[]

==== Path Parameters
include::{snippets}/converter/format_conversion/path-parameters.adoc[]

30
31
32
33
34
35
== Convert network from an input format to an output image

=== List available formats
==== CURL sample
include::{snippets}/converter/list_image_formats/curl-request.adoc[]

36
==== Response Fields
37
include::{snippets}/converter/list_image_formats/response-fields.adoc[]
38

39
40
==== Sample Response
include::{snippets}/converter/list_image_formats/response-body.adoc[]
41
42


43
44
45
46
47
48
49
=== Convert network from an input format to an output image
==== CURL sample
include::{snippets}/converter/image_conversion/curl-request.adoc[]

==== Path Parameters
include::{snippets}/converter/image_conversion/path-parameters.adoc[]

Piotr Gawron's avatar
Piotr Gawron committed
50
51
52
53
54
55
56
57
58
59
60
61
62
== Merging of maps

=== Merge
This API call allows to merge few files into one. Layout of merged map files will be a simple matrix. 

==== CURL sample
include::{snippets}/converter/merge_maps/curl-request.adoc[]

==== Path Parameters
include::{snippets}/converter/merge_maps/path-parameters.adoc[]

==== Input file structure
Input file should be a zip file with single zip folder called "maps". All map files to merge should be located in this folder.