Custom Applications

Retrieve custom mobile application configurations

List custom apps

get

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

Authorizations

OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

---

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:

Path parameters

app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

Query parameters

pagestringOptional

Page of the overview.

Default: 0Pattern: \d+

per_pagestringOptional

Number of result by page (Max 100)

Default: 10Pattern: -?\d+

Header parameters

X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:

Responses

200

List of custom apps

application/json

total_countintegerOptional

total_pagesintegerOptional

server_timeintegerOptional

401

Missing or invalid access token.

application/json

get/{app_short}/customapps

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

{
  "apps": [
    {
      "banner": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "created_at": 1,
      "groups": [],
      "id": 1,
      "logo": "text",
      "menus": [
        {
          "created_at": 1,
          "icon": {
            "type": "text",
            "value": "text"
          },
          "index": 1,
          "label": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "target": "text",
          "updated_at": 1
        }
      ],
      "name": "text",
      "screens": [
        {
          "created_at": 1,
          "name": "text",
          "pages": [
            {
              "layout": [
                {
                  "height": 1,
                  "width": 1,
                  "x": 1,
                  "y": 1
                }
              ],
              "side_menu": true,
              "system_name": "text",
              "title": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "widgets": [
                {
                  "background": "text",
                  "color": "text",
                  "icon": {
                    "ANY_ADDITIONAL_PROPERTY": "anything"
                  },
                  "index": 1,
                  "label": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "target": "text",
                  "type": "text"
                }
              ]
            }
          ],
          "updated_at": 1
        }
      ],
      "settings": [],
      "updated_at": 1
    }
  ],
  "total_count": 1,
  "total_pages": 1,
  "server_time": 1
}

Get a custom app

get

Authorizations

OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

---

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:

Path parameters

app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

app_idstringRequiredPattern: \d+

Query parameters

updated_atstringOptional

Results updated since this date

Default: nullPattern: \d+

Header parameters

X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:

Responses

200

Custom app details

application/json

total_countintegerOptional

total_pagesintegerOptional

server_timeintegerOptional

401

Missing or invalid access token.

application/json

404

No custom app with this identifier.

application/json

get/{app_short}/customapps/{app_id}

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

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

Get a file from a custom app

get

Authorizations

OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

---

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:

Path parameters

app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

app_idstringRequiredPattern: \d+

uuidstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}

Header parameters

X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:

Responses

200

Binary file content

application/octet-stream

string · binaryOptional

401

Missing or invalid access token.

application/json

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

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

binary