[EPISODES Platform Documentation] Mail Feed
Confluence Syndication Feed
https://docs.cyfronet.pl
TCS AH API used by ICS-C
Joanna Kocot
tag:docs.cyfronet.pl,2009:page-74814886-6
2024-03-27T10:54:01Z
2020-09-25T15:38:05Z
<div class="feed"> <p>
Page
<b>edited</b> by
<a href=" https://docs.cyfronet.pl/display/~plgkocot
">Joanna Kocot</a>
</p>
<div style="border-top: 1px solid #ddd; border-bottom: 1px solid #ddd; padding: 10px;">
<p><br/></p><p><style type='text/css'>/*<![CDATA[*/
div.rbtoc1711665093692 {padding: 0px;}
div.rbtoc1711665093692 ul {list-style: square !important;margin-left: 0px;}
div.rbtoc1711665093692 li {margin-left: 0px;padding-left: 0px;}
/*]]>*/</style><div class='toc-macro rbtoc1711665093692'>
<ul class='toc-indentation'>
<li><a href='#TCSAHAPIusedbyICSC-Endpoints'>Endpoints</a>
<ul class='toc-indentation'>
<li><a href='#TCSAHAPIusedbyICSC-datasets'>datasets</a></li>
<li><a href='#TCSAHAPIusedbyICSC-downloadFile'>downloadFile</a></li>
<li><a href='#TCSAHAPIusedbyICSC-listApps'>listApps</a></li>
<li><a href='#TCSAHAPIusedbyICSC-listEpisodes'>listEpisodes</a></li>
</ul>
</li>
<li><a href='#TCSAHAPIusedbyICSC-Models'>Models</a></li>
</ul>
</div></p><h1 id="TCSAHAPIusedbyICSC-Endpoints">Endpoints</h1><h2 id="TCSAHAPIusedbyICSC-datasets">datasets</h2><p><span class="status-macro aui-lozenge aui-lozenge-moved">GET</span></p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: plain; gutter: false; theme: Default" data-theme="Default"> get /api/epos/episode-elements/
</pre>
</div></div><p><strong>Summary:</strong> Episode dataset<br/><strong>Description:</strong> Returns a list of JSON documents containing metadata describing files conained within one of the TCS AH episodes</p><h4 id="TCSAHAPIusedbyICSC-Parameters">Parameters</h4><h5 id="TCSAHAPIusedbyICSC-QueryParameters">Query Parameters</h5><div class="table-wrap"><table class="wrapped confluenceTable"><colgroup><col/><col/><col/><col/><col/></colgroup><tbody><tr><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Name</span></p></th><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Description</span></p></th><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Required</span></p></th><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Default</span></p></th><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Pattern</span></p></th></tr><tr><td class="confluenceTd"><p>episode</p></td><td class="confluenceTd"><p>Allows to filter the files by given episode id. May contain multiple values separated by a comma</p></td><td class="confluenceTd"><p><img class="emoticon emoticon-tick" src="https://docs.cyfronet.pl/s/2lfhar/8804/xgjkrn/_/images/icons/emoticons/check.svg" data-emoticon-name="tick" alt="(tick)" /></p></td><td class="confluenceTd"><p><br/></p></td><td class="confluenceTd"><p><br/></p></td></tr><tr><td class="confluenceTd"><p>dataType</p></td><td class="confluenceTd"><p>Allows to filter the files by the type of data they contain. Parameter may contain multiple values separated by a comma</p></td><td class="confluenceTd"><p><img class="emoticon emoticon-cross" src="https://docs.cyfronet.pl/s/2lfhar/8804/xgjkrn/_/images/icons/emoticons/error.svg" data-emoticon-name="cross" alt="(error)" /></p></td><td class="confluenceTd"><p><br/></p></td><td class="confluenceTd"><p><br/></p></td></tr><tr><td class="confluenceTd"><p>before</p></td><td class="confluenceTd"><p>Allows to filter the files that have the end date metadata set to before the given date. Should be formatted as date-time - <a class="external-link" href="http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14" rel="nofollow">RFC3339</a></p></td><td class="confluenceTd"><p><img class="emoticon emoticon-cross" src="https://docs.cyfronet.pl/s/2lfhar/8804/xgjkrn/_/images/icons/emoticons/error.svg" data-emoticon-name="cross" alt="(error)" /></p></td><td class="confluenceTd"><p><br/></p></td><td class="confluenceTd"><p><br/></p></td></tr><tr><td class="confluenceTd"><p>after</p></td><td class="confluenceTd"><p>Allows to filter the files that have the start date metadata set to after the given date. Should be formatted as date-time - <a class="external-link" href="http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14" rel="nofollow">RFC3339</a></p></td><td class="confluenceTd"><p><img class="emoticon emoticon-cross" src="https://docs.cyfronet.pl/s/2lfhar/8804/xgjkrn/_/images/icons/emoticons/error.svg" data-emoticon-name="cross" alt="(error)" /></p></td><td class="confluenceTd"><p><br/></p></td><td class="confluenceTd"><p><br/></p></td></tr><tr><td class="confluenceTd"><p>offset</p></td><td class="confluenceTd"><p>Number of results skipped from the beginning</p></td><td class="confluenceTd"><p><img class="emoticon emoticon-cross" src="https://docs.cyfronet.pl/s/2lfhar/8804/xgjkrn/_/images/icons/emoticons/error.svg" data-emoticon-name="cross" alt="(error)" /></p></td><td class="confluenceTd"><p><br/></p></td><td class="confluenceTd"><p><br/></p></td></tr><tr><td class="confluenceTd"><p>limit</p></td><td class="confluenceTd"><p>Maximum number of returned results</p></td><td class="confluenceTd"><p><img class="emoticon emoticon-cross" src="https://docs.cyfronet.pl/s/2lfhar/8804/xgjkrn/_/images/icons/emoticons/error.svg" data-emoticon-name="cross" alt="(error)" /></p></td><td class="confluenceTd"><p><br/></p></td><td class="confluenceTd"><p><br/></p></td></tr></tbody></table></div><p>Responses</p><p><strong>Status Code:</strong> 200<br/><strong>Message:</strong> Request was successful. Response contains a list of episode elements (episode file metadata)</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>Response Type</b></div><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: plain; gutter: false; theme: Default" data-theme="Default"></pre>
</div></div><p>See <a href="#TCSAHAPIusedbyICSC-models">#models</a></p><div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom" style="border-bottom-width: 1px;">
<b class="code-title">Response Schema</b><span class="collapse-source expand-control" style="display:none;"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span><span class="collapse-spinner-wrapper"></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: plain; gutter: false; theme: Default; collapse: true" data-theme="Default">{
"description" : "Request was successful. Response contains a list of episode elements (episode file metadata)"
}
</pre>
</div>
</div><p><strong>Status Code:</strong> 400<br/><strong>Message:</strong> Invalid time format of 'before' or 'after' parameters</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>Response Type</b></div><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: plain; gutter: false; theme: Default" data-theme="Default"></pre>
</div></div><p>See <a href="#TCSAHAPIusedbyICSC-models">#models</a></p><div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom" style="border-bottom-width: 1px;">
<b class="code-title">Response Schema</b><span class="collapse-source expand-control" style="display:none;"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span><span class="collapse-spinner-wrapper"></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: plain; gutter: false; theme: Default; collapse: true" data-theme="Default">{
"description" : "Invalid time format of 'before' or 'after' parameters"
}
</pre>
</div>
</div><hr/><h4 id="TCSAHAPIusedbyICSC-Examples">Examples</h4><p><a class="external-link" href="https://episodesplatform.eu/api/epos/episode-elements?episode=CZORSZTYN&dataType=Miniseed%20Signal&before=2023-12-31&after=1996-01-01&limit=5&offset=10" rel="nofollow">https://episodesplatform.eu/api/epos/episode-elements?episode=CZORSZTYN&dataType=Miniseed%20Signal&before=2023-12-31&after=1996-01-01&limit=5&offset=10</a></p><h2 id="TCSAHAPIusedbyICSC-downloadFile">downloadFile</h2><p><span class="status-macro aui-lozenge aui-lozenge-moved">POST</span></p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: plain; gutter: false; theme: Default" data-theme="Default"> post /api/epos/files/{fileId}
</pre>
</div></div><p><strong>Summary:</strong> Download episode file<br/><strong>Description:</strong> The operation starts to download the file pointed by the 'fileId'. The header of the request has to contain a valid user authentication token, otherwise the operation would fail.</p><h4 id="TCSAHAPIusedbyICSC-Parameters.1">Parameters</h4><h5 id="TCSAHAPIusedbyICSC-PathParameters">Path Parameters</h5><div class="table-wrap"><table class="wrapped confluenceTable"><colgroup><col/><col/><col/><col/><col/></colgroup><tbody><tr><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Name</span></p></th><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Description</span></p></th><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Required</span></p></th><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Default</span></p></th><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Pattern</span></p></th></tr><tr><td class="confluenceTd"><p>fileId</p></td><td class="confluenceTd"><p>ID of the file to be download. The ID is displayed within the file metadata (obtained from the /api/epos/episode-elements/ endpoint)</p></td><td class="confluenceTd"><p><img class="emoticon emoticon-tick" src="https://docs.cyfronet.pl/s/2lfhar/8804/xgjkrn/_/images/icons/emoticons/check.svg" data-emoticon-name="tick" alt="(tick)" /></p></td><td class="confluenceTd"><p><br/></p></td><td class="confluenceTd"><p><br/></p></td></tr></tbody></table></div><h4 id="TCSAHAPIusedbyICSC-Responses">Responses</h4><p><strong>Status Code:</strong> 200<br/><strong>Message:</strong> The download request was successful</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>Response Type</b></div><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: plain; gutter: false; theme: Default" data-theme="Default"></pre>
</div></div><p>See <a href="#TCSAHAPIusedbyICSC-models">#models</a></p><div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom" style="border-bottom-width: 1px;">
<b class="code-title">Response Schema</b><span class="collapse-source expand-control" style="display:none;"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span><span class="collapse-spinner-wrapper"></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: plain; gutter: false; theme: Default; collapse: true" data-theme="Default">{
"description" : "The download request was successful"
}
</pre>
</div>
</div><p><strong>Status Code:</strong> 401<br/><strong>Message:</strong> Invalid or missing credentials</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>Response Type</b></div><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: plain; gutter: false; theme: Default" data-theme="Default"></pre>
</div></div><p>See <a href="#TCSAHAPIusedbyICSC-models">#models</a></p><div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom" style="border-bottom-width: 1px;">
<b class="code-title">Response Schema</b><span class="collapse-source expand-control" style="display:none;"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span><span class="collapse-spinner-wrapper"></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: plain; gutter: false; theme: Default; collapse: true" data-theme="Default">{
"description" : "Invalid or missing credentials"
}
</pre>
</div>
</div><p><strong>Status Code:</strong> 404<br/><strong>Message:</strong> The file with the specified ID does not exist</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>Response Type</b></div><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: plain; gutter: false; theme: Default" data-theme="Default"></pre>
</div></div><p>See <a href="#TCSAHAPIusedbyICSC-models">#models</a></p><div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom" style="border-bottom-width: 1px;">
<b class="code-title">Response Schema</b><span class="collapse-source expand-control" style="display:none;"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span><span class="collapse-spinner-wrapper"></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: plain; gutter: false; theme: Default; collapse: true" data-theme="Default">{
"description" : "The file with the specified ID does not exist"
}
</pre>
</div>
</div><hr/><h2 id="TCSAHAPIusedbyICSC-listApps">listApps</h2><p><span class="status-macro aui-lozenge aui-lozenge-moved">GET</span></p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: plain; gutter: false; theme: Default" data-theme="Default"> get /api/epos/apps/
</pre>
</div></div><p><strong>Summary:</strong> List of Applications<br/><strong>Description:</strong> Returns a list of JSON documents describing the applications integrated within TCS AH. The method allows filtering the list by applying the query criteria.</p><h4 id="TCSAHAPIusedbyICSC-Parameters.2">Parameters</h4><h5 id="TCSAHAPIusedbyICSC-QueryParameters.1">Query Parameters</h5><div class="table-wrap"><table class="wrapped confluenceTable"><colgroup><col/><col/><col/><col/><col/></colgroup><tbody><tr><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Name</span></p></th><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Description</span></p></th><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Required</span></p></th><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Default</span></p></th><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Pattern</span></p></th></tr><tr><td class="confluenceTd"><p>keyword</p></td><td class="confluenceTd"><p>Allows to filter the returned applications by keywords they declare. May contain multiple values separated by a comma</p></td><td class="confluenceTd"><p><img class="emoticon emoticon-cross" src="https://docs.cyfronet.pl/s/2lfhar/8804/xgjkrn/_/images/icons/emoticons/error.svg" data-emoticon-name="cross" alt="(error)" /></p></td><td class="confluenceTd"><p><br/></p></td><td class="confluenceTd"><p><br/></p></td></tr></tbody></table></div><div class="table-wrap"><table class="wrapped confluenceTable"><colgroup><col/><col/><col/><col/><col/></colgroup><tbody><tr><td class="confluenceTd"><p>category</p></td><td class="confluenceTd"><p>Allows to filter the returned applications by category. May contain multiple values separated by a comma</p></td><td class="confluenceTd"><p><img class="emoticon emoticon-cross" src="https://docs.cyfronet.pl/s/2lfhar/8804/xgjkrn/_/images/icons/emoticons/error.svg" data-emoticon-name="cross" alt="(error)" /></p></td><td class="confluenceTd"><p><br/></p></td><td class="confluenceTd"><p><br/></p></td></tr></tbody></table></div><h4 id="TCSAHAPIusedbyICSC-Responses.1">Responses</h4><p><strong>Status Code:</strong> 200<br/><strong>Message:</strong> Request was successful. Response contains a list of application descriptions matching the query criteria</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>Response Type</b></div><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: plain; gutter: false; theme: Default" data-theme="Default"></pre>
</div></div><p>See <a href="#TCSAHAPIusedbyICSC-models">#models</a></p><div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom" style="border-bottom-width: 1px;">
<b class="code-title">Response Schema</b><span class="collapse-source expand-control" style="display:none;"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span><span class="collapse-spinner-wrapper"></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: plain; gutter: false; theme: Default; collapse: true" data-theme="Default">{
"description" : "Request was successful. Response contains a list of application descriptions matching the query criteria"
}
</pre>
</div>
</div><hr/><h2 id="TCSAHAPIusedbyICSC-listEpisodes">listEpisodes</h2><p><span class="status-macro aui-lozenge aui-lozenge-moved">GET</span></p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: plain; gutter: false; theme: Default" data-theme="Default"> get /api/epos/episodes/
</pre>
</div></div><p><strong>Summary:</strong> List of Episodes<br/><strong>Description:</strong> Returns a list of JSON documents describing the episodes integrated within TCS AH. The method allows filtering the list by impacting factor.</p><h4 id="TCSAHAPIusedbyICSC-Parameters.3">Parameters</h4><h5 id="TCSAHAPIusedbyICSC-QueryParameters.2">Query Parameters</h5><div class="table-wrap"><table class="wrapped confluenceTable"><colgroup><col/><col/><col/><col/><col/></colgroup><tbody><tr><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Name</span></p></th><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Description</span></p></th><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Required</span></p></th><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Default</span></p></th><th class="confluenceTh"><p><span style="color: rgb(0,51,102);">Pattern</span></p></th></tr><tr><td class="confluenceTd"><p>impactingFactor</p></td><td class="confluenceTd"><p>Allows to filter the episodes by impacting or inducing factor relevant to the registrations collected into the episode. May contain multiple values separated by a comma</p></td><td class="confluenceTd"><p><img class="emoticon emoticon-cross" src="https://docs.cyfronet.pl/s/2lfhar/8804/xgjkrn/_/images/icons/emoticons/error.svg" data-emoticon-name="cross" alt="(error)" /></p></td><td class="confluenceTd"><p><br/></p></td><td class="confluenceTd"><p><br/></p></td></tr></tbody></table></div><h4 id="TCSAHAPIusedbyICSC-Responses.2">Responses</h4><p><strong>Status Code:</strong> 200<br/><strong>Message:</strong> Request was successful. Response contains a list of episode descriptions matching the query criteria</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>Response Type</b></div><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: plain; gutter: false; theme: Default" data-theme="Default"></pre>
</div></div><p>See <a href="#TCSAHAPIusedbyICSC-models">#models</a></p><div class="code panel pdl" style="border-width: 1px;">
<div class="codeHeader panelHeader pdl hide-border-bottom" style="border-bottom-width: 1px;">
<b class="code-title">Response Schema</b><span class="collapse-source expand-control" style="display:none;"><span class="expand-control-icon icon"> </span><span class="expand-control-text">Expand source</span></span><span class="collapse-spinner-wrapper"></span>
</div>
<div class="codeContent panelContent pdl hide-toolbar">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: plain; gutter: false; theme: Default; collapse: true" data-theme="Default">{
"description" : "Request was successful. Response contains a list of episode descriptions matching the query criteria"
}
</pre>
</div>
</div><hr/><h1 id="TCSAHAPIusedbyICSC-Models">Models</h1><p>TODO</p>
</div>
<div style="padding: 10px 0;">
<a href="https://docs.cyfronet.pl/display/ISDOC/TCS+AH+API+used+by+ICS-C">View Online</a>
·
<a href="https://docs.cyfronet.pl/pages/diffpagesbyversion.action?pageId=74814886&revisedVersion=6&originalVersion=5">View Changes Online</a>
</div>
</div>
Joanna Kocot
2020-09-25T15:38:05Z