Each member organization can make Release Packages available to their approved affiliates for downloading. A Release Package has a current version and past versions. A Release version can contain multiple files that can be individually downloaded by an affiliate.
Release files are not stored in MLDS and instead a URL is provided where the file can be download from on demand. Files are typically stored on the Amazon s3 service. The URL to directly access the release file is not made available to affiliate users, who instead use a MLDS based URL that in turn download the file from the original location.
Client errors
Client errors on API calls will typically result in a 400 Bad Request response.
[HTTP/1.1 400 Bad Request Content-Type: application/json Transfer-Encoding: chunked Date: Tue, 27 Oct 2015 19:54:17 GMT
{"error":"Bad Request","status":400,"message":"Unknown member: 'xz'. Valid options: AU BE BN CA CL CZ DK EE ES GB HK IHTSDO IL IN IS LT MT MY NL NZ PL PT SE SG SI SK US UY "}
Error responses can be detected by a status code of 4xx or 5xx. The message value is an optional human description of the problem.
Authentication
The public APIs do not require authentication to be supplied.
Basic Authentication
The APIs that do require authentication support Basic Authentication using MLDS credentials.
Ensure that all communication uses https to ensure the credentials aren't revealed.
Where possible, the API supports appropriate HTTP Methods/Verbs for each resource.
Method
Description
List all release packages. [code] $ curl -i 'https://mlds.ihtsdotools.org/api/releasePackages' [/code]
Name
Type
Description
Name
Type
Description
Add a new release file to a Release Version.
Name
Type
Description
Note that an affiliate download URL is used by affiliates to download the content via MLDS. [/code]
To publish a Release Version online the Release Version's online flag should be set to true. To take the Release Version offline the online flag should be set to false.
Name
Type
Description
A license document can be associated with a Release Package. [code] POST /api/releasePackages/:releasePackageId/license [/code]
Name
Type
Description
The request should be a `multipart\form-data' post to the server.
The content associated with a Release File can be downloaded using the value of the `clientDownloadUrl'.
To download a file content the supplied user credentials must be approved to get access to the member's files.
The response body is the file content.
Where possible, the response headers Content-Disposition and Content-Type are set with content meta-data, such as filename.
Given the existing published Release Package:
The content for Release file 211928 can be downloaded using the value of the clientDownloadUrl.
DELETE
Delete a resource.
description
string
Description of the Release Package. Can be plain text or HTML.
publishedAt
date
Optional - The publish date of the Released Version. Format: YYYY-MM-DD
online
boolean
True if the release version is available to affiliates to download
GET
Retrieve a representation of the resource.
POST
Create a new resource.
PUT
Replace a resource.
member.key
string
Member organization, either IHTSDO or the two letter country code of the member country
name
string
Name of the Release Package
name
string
Name of the Release Version
description
string
Description of the Release Version. Can be plain text or HTML.
label
string
Short description of the file
downloadUrl
string
URL of file content
name
string
Name of the Release Version
description
string
Description of the Release Version. Can be plain text or HTML.