ExtProps
ExtProps Service
Web service endpoints for functionality to list jive objects by extended properties.
Create System Ext Props
POST /extpropsSave a new set of extended properties for a system with specified characteristics, and return an entity representing the newly created extended properties.
This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, the properties being created will be those associated with the consumer of the oAuth token.
Takes:
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 201 (Created) | Request was successful |
| 400 (Bad Request) | An input field is malformed or max number of extended properties has been reached |
| 403 (Forbidden) | You are not allowed to manage ext properties for person |
Create System Ext Props
POST /extprops/addOn/{addonUUID}Save a new set of extended properties for a system with specified characteristics, and return an entity representing the newly created extended properties.
This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, this service will validate that the consumer of the oAuth token can access the specified add-on.
Takes:
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 201 (Created) | Request was successful |
| 400 (Bad Request) | An input field is malformed or max number of extended properties has been reached |
| 403 (Forbidden) | You are not allowed to manage ext properties for person |
Since: 3.9
Destroy System Ext Props
DELETE /extpropsDelete the existing extended properties for the system.
This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, the properties being deleted will be those associated with the consumer of the oAuth token.
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 delete properties |
| 404 (Not Found) | The specified person does not exist |
Destroy System Ext Props
DELETE /extprops/addOn/{addonUUID}Delete the existing extended properties for the system.
This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, this service will validate that the consumer of the oAuth token can access the specified add-on.
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 delete properties |
| 404 (Not Found) | The specified person does not exist |
Since: 3.9
Get Objects By Ext Prop
GET /extprops/{key}/{value}Return a paginated list of entities with that contains supplied extended property and value.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| key | String | true | Property key |
| value | String | true | Property value |
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| startIndex | Integer | false | The zero-relative index of the first matching content to be returned |
| count | Integer | false | The maximum number of contents to be returned |
| fields | String | false | The fields to be returned on each content |
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 200 (OK) | Request was successful |
Get Objects By Ext Prop Key
GET /extprops/{key}Return a paginated list of entities with that contains supplied extended property.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| key | String | true | Property key |
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| startIndex | Integer | false | The zero-relative index of the first matching content to be returned |
| count | Integer | false | The maximum number of contents to be returned |
| fields | String | false | The fields to be returned on each content |
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 200 (OK) | Request was successful |
Get System Ext Props
GET /extpropsReturn the specified extended properties for the system.
This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, the properties being fetched will be those associated with the consumer of the oAuth token.
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 200 (OK) | Request was successful |
| 404 (Not Found) | If the specified person does not exist |
Get System Ext Props By UUID
GET /extprops/addOn/{addonUUID}Return the specified extended properties for the system.
This service only accepts oAuth authentication. Assuming that the oAuth token used to access this service was acquired through 2-legged oAuth, this service will validate that the consumer of the oAuth token can access the specified add-on.
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 200 (OK) | Request was successful |
| 404 (Not Found) | If the specified person does not exist |