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

create(jiveproperty,options)
POST /admin/properties

Retrieves

JiveProperty

Description

Create a new Jive property, and return a JiveProperty representing the new object.

Availability:

Available to Jive admins only

Takes:
Options:
NameTypeRequiredDescription
fieldsStringfalseThe names of the fields to be returned
Retrieves:
  • JiveProperty describing the newly created Jive property
  • get(options)
    GET /admin/properties

    Retrieves

    JiveProperty[]

    Description

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

    Availability:

    Available to Jive admins only

    Options:
    NameTypeRequiredDescription
    countIntegerfalseThe maximum number of Jive properties to return (default is 25)
    fieldsStringfalseThe names of the fields to be returned
    startIndexIntegerfalseZero-relative index of the first Jive property to return (default is 0)
    Retrieves:
  • JiveProperty
  • get(options)
    GET /admin/properties/{name}

    Retrieves

    JiveProperty

    Description

    Return the specified Jive property.

    Availability:

    Available to Jive admins only

    Options:
    NameTypeRequiredDescription
    nameStringtrueName of the Jive property to return
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • JiveProperty
  • Since: 3.1