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 all workspaces

GET

/workspaces

Available to all authenticated users. The response will only include the workspaces you are member of. With the System Administration permission the response will contain all workspaces

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

    MAS workspace configuration

  • 401

    Authentication token is empty or invalid

  • 404

    The requested resource could not be found

  • 500

    An internal server error occured

  • 503

    Initial Setup has not been completed:

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

      Example response

        1[
        2  {
        3    "metadata": {
        4      "creationTimestamp": "2020-02-20T13:54:00",
        5      "deletionTimestamp": "2020-02-20T13:58:00",
        6      "labels": {
        7        "mas.ibm.com/instanceId": "instanceId",
        8        "mas.ibm.com/workspaceId": "workspaceId"
        9      }
        10    },
        11    "spec": {
        12      "displayName": "Project 1",
        13      "settings": {
        14        "navigator": {
        15          "addons": {
        16            "eam": {
        17              "url": "https://myeam.mydomain.com/home"
        18            },
        19            "apm4eandu": {
        20              "url": "https://apm.mydomain.com/login"
        21            }
        22          }
        23        }
        24      }
        25    },
        26    "status": {
        27      "conditions": [
        28        {
        29          "lastTransitionTime": "2020-08-10T16:45:47Z",
        30          "reason": "Ready",
        31          "message": "Workspace is ready",
        32          "status": "True",
        33          "type": "Ready"
        34        }
        35      ],
        36      "version": {
        37        "reconciled": "8.4.0"
        38      }
        39    }
        40  }
        41]