Page History
...
| Table of Contents | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Endpoints
datasets
| Status | ||||||
|---|---|---|---|---|---|---|
|
...
Parameters
Query Parameters
Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
episode | Allows to filter the files by given episode id. May contain multiple values separated by a comma |
|
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description" : "Invalid time format of 'before' or 'after' parameters"
}
|
...
downloadFile
| Status | ||||||
|---|---|---|---|---|---|---|
|
...
Parameters
Path Parameters
Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
fileId | ID of the file to be download. The ID is displayed within the file metadata (obtained from the /api/epos/episode-elements/ endpoint) |
|
...
Status Code: 200
Message: The download request was successfullsuccessful
| Code Block | ||
|---|---|---|
| ||
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description" : "The download request was successfullsuccessful"
}
|
Status Code: 401
Message: Invalid or missing credentials
...
Status Code: 404
Message: The file with the specifed specified ID does not exist
| Code Block | ||
|---|---|---|
| ||
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description" : "The file with the specifedspecified ID does not exist"
}
|
...
listApps
| Status | ||||||
|---|---|---|---|---|---|---|
|
...
Parameters
Query Parameters
Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
keyword | Allows to filter the returned applications by keywords they declare. May contain multiple values separated by a comma |
|
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description" : "Request was successful. Response contains a list of application descriptions matching the query criteria"
}
|
...
listEpisodes
| Status | ||||||
|---|---|---|---|---|---|---|
|
...
Parameters
Query Parameters
Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
impactingFactor | 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 |
|
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description" : "Request was successful. Response contains a list of episode descriptions matching the query criteria"
}
|
...
Models
TODO
Overview
Content Tools