PlaceTopics
PlaceTopics Service
Web service endpoints for interacting with place topics. See PlaceTopic for an example of the JSON representation.
Since: 3.8
Create Place Topic
POST /placeTopicsCreate a new place topic entry based on the characteristics in the incoming place topic object.
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| fields | String | false | Names of the fields to be returned (default value is @all) |
Takes:
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 201 (Created) | Request was successful |
| 400 (Bad Request) | An input field is missing or malformed |
| 403 (Forbidden) | You are not allowed to create this place topic entry |
Since: 3.8
Destroy Place Topic
DELETE /placeTopics/{placeTopicID}Delete the specified place topic.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| placeTopicID | String | true | ID of the place topic to be deleted |
Return Status:
| HTTP Status Code | Description |
|---|---|
| 204 (No Content) | Request was successful |
| 400 (Bad Request) | An input field is malformed |
| 403 (Forbidden) | You are not allowed to access this place topic |
| 404 (Not Found) | The specified place topic does not exist |
Since: 3.8
Get Place Topic
GET /placeTopics/{placeTopicID}Return a PlaceTopic whose name matches the specified name.
Availability:
Available to Jive admins only
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| placeTopicID | String | true | ID of the place topic to be returned |
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| fields | String | false | Fields to be returned for each place topic (default value is @all) |
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 400 (Bad Request) | Any input field is missing or malformed |
| 404 (Not Found) | The name does not match a valid place topic |
| 403 (Forbidden) | The requesting user is not authorized to retrieve place topics |
Since: 3.8
Get Place Topics
GET /placeTopicsReturn a PlaceTopic whose name matches the specified name.
Availability:
Available to Jive admins only
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| startIndex | Integer | false | The zero-relative index of the first matching content to be returned (default value is 0) |
| filter | Object[] | false | Filter expression(s) used to select matching results |
| count | Integer | false | The maximum number of contents to be returned (default value is 25) |
| fields | String | false | Fields to be returned for each place topic (default value is @all) |
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 400 (Bad Request) | Any input field is missing or malformed |
| 404 (Not Found) | The name does not match a valid place topic |
| 403 (Forbidden) | The requesting user is not authorized to retrieve place topics |
Since: 3.8
Update Place Topic
PUT /placeTopics/{placeTopicID}Update the place topic with the specified characteristics.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| placeTopicID | String | true | ID of the place topic to be updated |
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| fields | String | false | Fields to include in the returned entity (default value is @all) |
Takes:
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 200 (OK) | Request was successful |
| 400 (Bad Request) | An input field is missing or malformed |
| 403 (Forbidden) | You are not allowed to access the specified place topic |
| 404 (Not Found) | The specified place topic cannot be found |