Custom Applications

Retrieve custom mobile application configurations

List custom apps

get

Returns all custom applications in short format. If none are configured, returns the default application in full format.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Responses

200

List of custom apps

application/json

total_countintegerOptional

total_pagesintegerOptional

server_timeinteger · int64Optional

get/{app_short}/customapps

HTTPcURLJavaScriptPython

GET /{app_short}/customapps HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

List of custom apps

{
  "apps": [
    {
      "id": 1,
      "name": "text",
      "created_at": 1,
      "updated_at": 1
    }
  ],
  "total_count": 1,
  "total_pages": 1,
  "server_time": 1
}

Get a custom app

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

app_idintegerRequired

Responses

200

Custom app details

application/json

total_countintegerOptional

total_pagesintegerOptional

server_timeinteger · int64Optional

get/{app_short}/customapps/{app_id}

HTTPcURLJavaScriptPython

GET /{app_short}/customapps/{app_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Custom app details

{
  "app": {
    "id": 1,
    "name": "text",
    "created_at": 1,
    "updated_at": 1,
    "banner": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "splash": {
      "active": true,
      "image": "text",
      "color": "text",
      "aspect": "fit",
      "created_at": 1,
      "updated_at": 1
    },
    "menus": [
      {
        "index": 1,
        "target": "text",
        "label": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "icon": {
          "type": "text",
          "value": "text"
        },
        "created_at": 1,
        "updated_at": 1
      }
    ],
    "screens": [
      {
        "name": "text",
        "created_at": 1,
        "updated_at": 1,
        "pages": [
          {
            "system_name": "text",
            "title": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "side_menu": true,
            "widgets": [
              {
                "type": "text",
                "index": 1,
                "label": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "color": "text",
                "target": "text",
                "icon": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "background": "text"
              }
            ],
            "layout": [
              {
                "x": 1,
                "y": 1,
                "width": 1,
                "height": 1
              }
            ]
          }
        ]
      }
    ],
    "settings": [],
    "groups": [],
    "widget_spacing": 0,
    "button_type": "standard",
    "label_overlay": true,
    "grant_all": true
  },
  "total_count": 1,
  "total_pages": 1,
  "server_time": 1,
  "required": {
    "files_uuid": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
}

Get a file from a custom app

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

app_idintegerRequired

file_uuidstring · uuidRequired

Responses

200

Binary file content

application/octet-stream

string · binaryOptional

get/{app_short}/customapps/{app_id}/file/{file_uuid}

HTTPcURLJavaScriptPython

GET /{app_short}/customapps/{app_id}/file/{file_uuid} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Binary file content

binary