User Tools

Site Tools


api:flexcare:appwhitelist:createrelease

API : FlexCare : App whitelist : Create release

Introduction

This will add a new release (APK version) to a whitelisted app.

A release describes one version of the app that can be installed on tablets. An app must always have a default release: if none of the app's existing releases is the default, the new release is made the default regardless of the value sent. If the new release is the default, the default flag is cleared on all other releases of the app.

Request

URL https://api.telecomx.dk/flexcare/appwhitelist/:id/release
Method POST
Access level ADMIN, or RESELLER admin with the TV employee feature
params id ObjectId [required] Id of the app the release is added to
body version String [required] App version
versionCode Number [required] Android version code (build number)
file ObjectId [required] File id of the APK (may be null)
default Boolean [optional] True if this is chosen as the default version of the app. Default false. Forced to true if the app has no default release.
minAndroidVersion Number [optional] Minimum Android version required for this APK. Default 0.
notes String [optional] Release notes for this version. Default empty.
bundle Array [optional] Additional files bundled with the APK. Default empty.
bundle[].file ObjectId [required] Unique id of the bundle file
bundle[].url String [required] Url where file is located

_id and releaseDate must NOT be sent — they are assigned by the server.

Query examples

https://api.telecomx.dk/flexcare/appwhitelist/ABCDEF1234567890ABCDEF12/release

Body example

{
  version: "1.1",
  versionCode: 110,
  default: true,
  minAndroidVersion: 8,
  file: "4434567890ABCD1234567980",
  notes: "Bug fixes",
  bundle: [
    {
      file: "1234567890ABCD1234657890",
      url: "https://doc.telecomx.dk/1234567890ABCD1234657890"
    }
  ]
}

Response

The created release is returned, with the server-assigned _id and releaseDate. The default field reflects the value actually stored, which may differ from the one sent (see Introduction).

JSON object
_id ObjectId Unique object id of the release (generated by the server)
version String App version
versionCode Number Android version code (build number)
default Boolean True if this is chosen as the default version of the app
minAndroidVersion Number Minimum Android version required for this APK
file ObjectId File id of the APK (null if none)
notes String Release notes for this version
releaseDate Date Set by the server to the time the release was created
bundle Array Array of files from apk bundle
bundle[].file ObjectId Unique id of the bundle file
bundle[].url String Url where file is located

Example

{
  _id: "5678901234ABCD5678901234",
  version: "1.1",
  versionCode: 110,
  default: true,
  minAndroidVersion: 8,
  file: "4434567890ABCD1234567980",
  notes: "Bug fixes",
  releaseDate: "2026-10-12T12:00:00.000Z",
  bundle: [
    {
      file: "1234567890ABCD1234657890",
      url: "https://doc.telecomx.dk/1234567890ABCD1234657890"
    }
  ]
}

Errors

Error code Message Description
422 <field> Invalid id param, or invalid or missing body field (e.g. version, versionCode, file, bundle[].file, bundle[].url).
404 id App not found.
403 access_denied Insufficient access level, or the reseller admin lacks the TV employee feature.
500 internal_error <Unspecified>
api/flexcare/appwhitelist/createrelease.txt · Last modified: by Mikkel Frederiksen

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki