Banners

Banners display short messages at the top of the client interface to share tenant-wide information, warnings, or issues. When embedding content, banners aren't shown inside qlik-embed UIs. The only embedding method that displays banners is an iFrame generated using the App Integration API.

Download specification

Get banner

Retrieves announcement banner configuration for the tenant, including content, scheduling, and link information for display at the top of the client interface.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories

Responses

200

Banner retrieval was successful.

  • application/jsonobject
    Show application/json properties
    • idstring
      Required

      format = "uid"

    • typestring
      Required

      Can be one of: "info""warning""error""resolved"

    • enabledboolean
      Required
    • endTimestring
      Required

      date-time in UTC.

      format = "date-time"

    • linkUrlstring

      format = "uri"

    • messagestring
      Required
    • tenantIdstring
      Required

      format = "uid"

    • createdAtstring
      Required

      format = "date-time"

    • createdBystring
      Required

      userId of the user who created the banner

    • linkLabelstring
    • startTimestring
      Required

      date-time in UTC.

      format = "date-time"

    • updatedAtstring
      Required

      format = "date-time"

    • updatedBystring
      Required

      userId of the user who last modified the banner

    • linkEnabledboolean
      Required

400

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusinteger
    • traceIdstring

401

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusinteger
    • traceIdstring

403

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusinteger
    • traceIdstring

404

Not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusinteger
    • traceIdstring

500

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusinteger
    • traceIdstring
GET /api/v1/banners 
// qlik-api has not implemented support for `GET /api/v1/banners` yet.
// In the meantime, you can use fetch like this:


const response = await fetch('/api/v1/banners', {
  method: 'GET',
  headers: { 'Content-Type': 'application/json' },
})
This API is not included yet in qlik-cli
curl "https://your-tenant.us.qlikcloud.com/api/v1/banners" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "type": "info",
  "enabled": true,
  "endTime": "2018-10-30T07:06:22Z",
  "linkUrl": "string",
  "message": "string",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "string",
  "linkLabel": "string",
  "startTime": "2018-10-30T07:06:22Z",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "string",
  "linkEnabled": true
}

Set banner

Sets content, scheduling, and optional action links for the tenant-wide announcement banner. Requires TenantAdmin role.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories

Request Body

  • application/jsonobject
    Show application/json properties
    • typestring
      Required

      Can be one of: "info""warning""error""resolved"

    • enabledboolean
      Required
    • endTimestring
      Required

      date-time in UTC.

      format = "date-time"

    • linkUrlstring

      format = "uri"

    • messagestring
      Required
    • linkLabelstring
    • startTimestring
      Required

      date-time in UTC.

      format = "date-time"

    • linkEnabledboolean
      Required

Responses

201

The banner has been successfully upserted.

  • application/jsonobject
    Show application/json properties
    • idstring
      Required

      format = "uid"

    • typestring
      Required

      Can be one of: "info""warning""error""resolved"

    • enabledboolean
      Required
    • endTimestring
      Required

      date-time in UTC.

      format = "date-time"

    • linkUrlstring

      format = "uri"

    • messagestring
      Required
    • tenantIdstring
      Required

      format = "uid"

    • createdAtstring
      Required

      format = "date-time"

    • createdBystring
      Required

      userId of the user who created the banner

    • linkLabelstring
    • startTimestring
      Required

      date-time in UTC.

      format = "date-time"

    • updatedAtstring
      Required

      format = "date-time"

    • updatedBystring
      Required

      userId of the user who last modified the banner

    • linkEnabledboolean
      Required

400

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusinteger
    • traceIdstring

401

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusinteger
    • traceIdstring

403

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusinteger
    • traceIdstring

404

Not found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusinteger
    • traceIdstring

500

Internal Server Error

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
      • titlestring
      • detailstring
      • statusinteger
    • traceIdstring
POST /api/v1/banners/actions/upsert 
// qlik-api has not implemented support for `POST /api/v1/banners/actions/upsert` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/api/v1/banners/actions/upsert',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      type: 'info',
      enabled: true,
      endTime: '2018-10-30T07:06:22Z',
      linkUrl: 'string',
      message: 'string',
      linkLabel: 'string',
      startTime: '2018-10-30T07:06:22Z',
      linkEnabled: true,
    }),
  },
)
This API is not included yet in qlik-cli
curl "https://your-tenant.us.qlikcloud.com/api/v1/banners/actions/upsert" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"type":"info","enabled":true,"endTime":"2018-10-30T07:06:22Z","linkUrl":"string","message":"string","linkLabel":"string","startTime":"2018-10-30T07:06:22Z","linkEnabled":true}'

Example Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "type": "info",
  "enabled": true,
  "endTime": "2018-10-30T07:06:22Z",
  "linkUrl": "string",
  "message": "string",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "string",
  "linkLabel": "string",
  "startTime": "2018-10-30T07:06:22Z",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "string",
  "linkEnabled": true
}