Workspaces Space API

The Space API provides a REST service for querying the current space/portal in Journey Manager in a secure and efficient manner.

Security

To access the Workspaces REST endpoint the caller needs to pass through Spring Security Session Management. First the user has to be authenticated with the Workspaces configured security manager. The user may authenticate via a login page or via Single Sign-on such as ADFS, oAuth2 or custom SSO.

The result of the API calls is subject to the user security policy.

URL Endpoint

The Workspaces Space API URL endpoint is as follows:

``` https:///workspaces/secure/api/v1/space ```

Service API

---

This section provides a description all the space API operations including:

• POST Query Space

POST Query Space

Retrieve the current portal/space of the request. Query only returns one result.

URL Format

POST https://<tm server>/workspaces/secure/api/v1/space/query

POST Body

The POST request must contain an empty JSON structure as the query. Any additional parameters will be ignored. This API uses the HTTP Content Type: application/json.

200 Response

Please note the properties are filtered to only include portal properties with the type "JSON".
The existing Work Space portals do not ship with any JSON type portal properties.

{
    "fetchLimit": 1,
    "fetchOffset": 0,
    "durationMs": 0,
    "result": [
        {
            "name": "Work Spaces",
            "status": "Normal",
            "properties": [
                {
                    "space": {
                        "locales": [
                            "en",
                            "es",
                            "pt"
                        ],
                        "currentLocale": "en",
                        "currentQueue": "Job Reviewers",
                        "currentPage": 0,
                        "pageSize": 10
                    }
                }
            ]
        }
    ]
}

Error Messages

Error Key	Error	Error Code
internalError	Please see Error Log ID {number}	500 - Internal Server Error
unableToResolvePortal	Unable to resolve portal from request	400 - Bad Request

Error Responses

400 - Bad Request

Bad request or request parameter. Check error message for details.

404 - Not Found

Ensure the URL endpoint is entered correctly.

500 - Internal Server Error

Exception occurred in space query. Contact administrator.