Skip to main content

Version: 20.11 (EOL)

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 keyErrorHTTP status code
internalErrorPlease see Error Log ID {number}500 Internal Server Error
unableToResolvePortalUnable to resolve portal from request400 Bad Request

Error responses

HTTP status codeDescription
400 Bad RequestBad request or request parameter. Check error message for details.
404 Not FoundEnsure the URL endpoint is entered correctly.
500 Internal Server ErrorException 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
}
}
]
}
]
}