static osapi.jive.corev3.jiveProperties
Static class for getting and creating
Jive Properties. A Jive
Property corresponds to System Properties in the admin console.Methods
↑
JiveProperty describing the newly created Jive property
create(jiveproperty,options)
POST /admin/propertiesRetrieves
JivePropertyDescription
Create a new Jive property, and return a JiveProperty representing the new object.
Availability:
Available to Jive admins only
Takes:
- JiveProperty fields describing the new Jive property
Options:
| Name | Type | Required | Description |
|---|---|---|---|
| fields | String | false | The names of the fields to be returned |
Retrieves:
↑
JiveProperty
get(options)
GET /admin/propertiesRetrieves
JiveProperty[]Description
Return a paginated list of Jive properties defined in this Jive instance.
Availability:
Available to Jive admins only
Options:
| Name | Type | Required | Description |
|---|---|---|---|
| count | Integer | false | The maximum number of Jive properties to return (default is 25) |
| fields | String | false | The names of the fields to be returned |
| startIndex | Integer | false | Zero-relative index of the first Jive property to return (default is 0) |
Retrieves:
↑
JiveProperty
get(options)
GET /admin/properties/{name}Retrieves
JivePropertyDescription
Return the specified Jive property.
Availability:
Available to Jive admins only
Options:
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | true | Name of the Jive property to return |
| fields | String | false | Names of the fields to be returned |