JiveProperty

JiveProperty Service

Web service endpoints for managing Jive properties. These endpoints are available to Jive admins only. Jive Properties can be viewed in the Admin Console by clicking on "System --> System Properties". See JiveProperty for an example of the JSON representation.

Examples:
Create a Jive Property

Curl example of creating a Jive property called "test.jive.property" with a value of true.

curl -u admin:admin_password -H "Content-Type: application/json" --data '{ "name": "test.jive.property", "value": true }' jive.mycompany.com/api/core/v3/admin/properties/

Update a Jive Property

Curl example of a PUT request to add the "data:" URI scheme to the allowed HTML schemes for your Jive instance. Note this property may be required by multimedia apps in the future. The Jive property being modified is called "globalRenderManager.HTMLFilter.allowedSchemesString".

curl -X PUT -u admin:admin_password -H "Content-Type: application/json" --data "{'name': 'globalRenderManager.HTMLFilter.allowedSchemesString', 'value': 'http://,https://,ftp://,mailto:,clsid:,data:'}" http://jive.mycompany.com/api/core/v3/admin/properties/globalRenderManager.HTMLFilter.allowedSchemesString

Create Property

POST /admin/properties

Create a new Jive property with the specified name and value.

Availability:

Available to Jive admins only

Takes:
Query Parameters:
NameTypeRequiredDescription
fieldsStringfalseThe fields to be included in the response
Takes:
  • A JiveProperty containing the name and value of the new property
    • Retrieves:
  • JiveProperty representing the new property
    • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    400 (Bad Request)Any input field is missing or malformed
    409 (Conflict)A property with the specified name already exists
    403 (Forbidden)The requesting user is not allowed to manipulate Jive properties

    Destroy Property

    DELETE /admin/properties/{name}

    Delete the specified Jive property.

    Availability:

    Available to Jive admins only

    Path Parameters:
    NameTypeRequiredDescription
    nameStringtrueThe name of the Jive property to delete
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    403 (Forbidden)The requesting user is not allowed to manipulate Jive properties
    404 (Not Found)The specified Jive property does not exist

    Get Properties

    GET /admin/properties

    Return a paginated list of the Jive properties defined in this Jive instance.

    Availability:

    Available to Jive admins only

    Query Parameters:
    NameTypeRequiredDescription
    startIndexIntegerfalseZero-relative index of the first property to be returned
    countIntegerfalseMaximum number of properties to be returned
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • JiveProperty[]
  • JiveProperty[]
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)Any input field is missing or malformed
    403 (Forbidden)The requesting user is not allowed to manipulate Jive properties

    Get Property

    GET /admin/properties/{name}

    Return the specified Jive property.

    Availability:

    Available to Jive admins only

    Path Parameters:
    NameTypeRequiredDescription
    nameStringtrueName of the Jive property to return
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • JiveProperty
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)If an input argument is missing or malformed
    403 (Forbidden)If the requesting user is not allowed to manipulate Jive properties
    404 (Not Found)If the specified Jive property does not exist

    Update Property

    PUT /admin/properties/{name}

    Update an existing Jive property with the specified value.

    Availability:

    Available to Jive admins only

    Path Parameters:
    NameTypeRequiredDescription
    nameStringtrueThe name of the Jive property to be updated
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseThe fields to be included in the response
    Takes:
  • A JiveProperty containing the updated value for the specified property
    • Retrieves:
  • An JiveProperty representing the updated property
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)If any input field is missing or malformed
    403 (Forbidden)If the requesting user is not allowed to manipulate Jive properties
    404 (Not Found)If the specified Jive property does not exist