IBM API Hub
Maximo Application Suite Admin APIs 9.0.x

By IBM Maximo

Provides REST APIs for performing Suite administration operations.


API reference

Get the current BAS Analytics configuration

GET

/config/bas/

Requires System Administration permission.

Request URL
https://api.{mas-instance-id}.{mas-domain}/config/bas/
Security
apiKey
x-access-token
required in header
Responses
  • 200

    BAS Analytics configuration

  • 400

    Bad Request

  • 401

    Authentication token is empty or invalid

  • 403

    Authenticated user is not permitted to make the request

  • 404

    The requested resource could not be found

  • 500

    An internal server error occured

Code snippet
    1curl --request GET \
    2  --url https://api.replace_mas-instance-id_variable.replace_mas-domain_variable/config/bas/ \
    3  --header 'accept: application/json' \
    4  --header 'x-access-token: REPLACE_THIS_VALUE'

      Example response

        1{
        2  "metadata": {
        3    "creationTimestamp": "2020-02-20T13:54:00",
        4    "deletionTimestamp": "2020-02-20T13:58:00"
        5  },
        6  "spec": {
        7    "displayName": "Lillie Jimenez",
        8    "config": {
        9      "url": "https://mybas.com",
        10      "contact": {
        11        "email": "owner@tech.com",
        12        "firstName": "Ada",
        13        "lastName": "Lovelace"
        14      },
        15      "credentials": {
        16        "secretName": "bas-apikey"
        17      }
        18    },
        19    "certificates": [
        20      {
        21        "alias": "intermediate",
        22        "crt": "-----BEGIN CERTIFICATE-----MIIGxTCCBa2g...<snip>-----END CERTIFICATE-----"
        23      }
        24    ]
        25  },
        26  "status": {
        27    "conditions": [
        28      {
        29        "lastTransitionTime": "2020-08-10T16:45:47Z",
        30        "reason": "Ready",
        31        "message": "Configuration was updated successfully",
        32        "status": "True",
        33        "type": "Ready"
        34      }
        35    ],
        36    "config": {
        37      "url": "https://mybas.com",
        38      "contact": {
        39        "email": "owner@tech.com",
        40        "firstName": "Ada",
        41        "lastName": "Lovelace"
        42      },
        43      "credentials": {
        44        "secretName": "bas-apikey"
        45      }
        46    },
        47    "certificates": [
        48      {
        49        "alias": "intermediate",
        50        "crt": "-----BEGIN CERTIFICATE-----MIIGxTCCBa2g...<snip>-----END CERTIFICATE-----"
        51      }
        52    ],
        53    "version": {
        54      "reconciled": "8.4.0"
        55    }
        56  }
        57}