Commit d45e6d6c authored by Piotr Gawron's avatar Piotr Gawron
Browse files

documentation for overlay API calls

parent 67260968
Pipeline #22116 failed with stage
in 18 minutes and 29 seconds
= 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[]
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment