Page History
TCS-AH - ICS API TCS AH API used by ICS-C
Version: 1.0.1
| Table of Contents | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Endpoints
datasets
| Status | ||||||
|---|---|---|---|---|---|---|
|
...
Summary: Episode dataset
Description: Returns a list of JSON documents containing metadata describing files conained within one of the TCS AH episodes
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 |
|
...
after | Allows to filter the files that have the start date metadata set to after the given date. Should be formatted as date-time - RFC3339( http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14) |
|
Responses
Status Code: 200
Message: Request was successful. Response contains a list of episode elements (episode file metadata)
| Code Block | ||
|---|---|---|
| ||
See #models
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description" : "Request was successful. Response contains a list of episode elements (episode file metadata)"
}
|
...
| Code Block | ||
|---|---|---|
| ||
See #models
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description" : "Invalid time format of 'before' or 'after' parameters"
}
|
...
downloadFile
| Status | ||||||
|---|---|---|---|---|---|---|
|
...
Summary: Download episode file
Description: 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.
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) |
|
Responses
Status Code: 200
Message: The download request was successfull
| Code Block | ||
|---|---|---|
| ||
See #models
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description" : "The download request was successfull"
}
|
...
| Code Block | ||
|---|---|---|
| ||
See #models
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description" : "Invalid or missing credentials"
}
|
...
| Code Block | ||
|---|---|---|
| ||
See #models
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description" : "The file with the specifed ID does not exist"
}
|
...
listApps
| Status | ||||||
|---|---|---|---|---|---|---|
|
...
Summary: List of Applications
Description: Returns a list of JSON documents describing the applications integrated within TCS AH. The method allows filtering the list by applying the query criteria.
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 |
|
...
category | Allows to filter the returned applications by category. May contain multiple values separated by a comma |
|
Responses
Status Code: 200
Message: Request was successful. Response contains a list of application descriptions matching the query criteria
| Code Block | ||
|---|---|---|
| ||
See #models
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description" : "Request was successful. Response contains a list of application descriptions matching the query criteria"
}
|
...
listEpisodes
| Status | ||||||
|---|---|---|---|---|---|---|
|
...
Summary: List of Episodes
Description: Returns a list of JSON documents describing the episodes integrated within TCS AH. The method allows filtering the list by impacting factor.
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 |
|
Responses
Status Code: 200
Message: Request was successful. Response contains a list of episode descriptions matching the query criteria
| Code Block | ||
|---|---|---|
| ||
See #models
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description" : "Request was successful. Response contains a list of episode descriptions matching the query criteria"
}
|
...
Models
Overview
Content Tools