Wiki space

Method: list

Authorization is required. Group administrator's privileges required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/wiki-space/list/{groupId}

Parameters

propertyvaluedescription
groupId guid The elements group's ID

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "success": true,
  "message": "111 Ea velit quis deserunt Lorem aute duis amet enim cupidatat esse nulla do dolor qui.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "offset": 0,
    "spaces": [
      {
        "id": 1,
        "type": "wikiSpace",
        "name": "HiveSocial API",
        "description": "Deserunt aliquip eiusmod velit commodo",
        "position": 1,
        "parent": {}
      }
    ]
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

Method: update

Authorization is required. Group administrator's privileges required.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/wiki-space/{wikiId}

Parameters

propertyvaluedescription
wikiId integer In id of the updated record

Request body

propertyvaluedescription
name string The wiki space label
description string The wiki space description
parentId integer If there is a parent space for this space, its id
position integer The space position within its parents subspaces list

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [],
  "object": {
    "id": 4,
    "type": "wikiSpace",
    "name": "Users",
    "description": "Enim veniam eu anim est sint commodo.",
    "position": 2,
    "parent": {
      "id": 1,
      "name": "HiveSocial API",
      "position": 1
    }
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.