POST Query Space

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

Request

HTTP request

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

Request body

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

Response

If successful, this operation returns a response with a HTTP 200 OK status code.

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

Error messages

Error key	Error	HTTP status code
internalError	Please see Error Log ID {number}	500 Internal Server Error
unableToResolvePortal	Unable to resolve portal from request	400 Bad Request

Error responses

HTTP status code	Description
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.

Example

Example successful response

{
    "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
                    }
                }
            ]
        }
    ]
}