Skip to content

Working with Spaces

Creating a Space

Request

Try in Swagger

POST /spaces

As it is a POST request, it has to have at least the following body.

{
    "title": "My Demo Space",
    "description": "A description which may contain ***markdown*** syntax"
}

Response

{
    "id": "x-demospace",
    "title": "My Demo Space",
    "description": "A description which may contain ***markdown*** syntax"
}

Reading a Specific Space

Request

Try in Swagger

GET /spaces/{spaceId}

Response

{
  "id": "{spaceId}",
  "title": "My Demo Space",
  "description": "A description which may contain ***markdown*** syntax"
}

Reading all Spaces

Request

Try in Swagger

GET /spaces

Response

{
    {
        "id": "x-demospace",
        "title": "My Demo Space",
        "description": "A description which may contain ***markdown*** syntax"
    },
    {
        "id": "x-trees",
        "title": "A public space",
        "description": "All the old oaks in Berlin" 
    }
}

Updating a Space

Request

Try in Swagger

PUT /spaces/{spaceId}

which requires a body like the following:

{
    "title": "My Demo Space",
    "description": "**Altered** Description"
}

Response

{
    "title": "My Demo Space",
    "description": "**Altered** Description"
}

Deleting a Space

Request

Try in Swagger

DELETE /spaces/{spaceId}

A successful response to this request is the following

Response

HTTP/1.1 204 No Content