static osapi.jive.corev3.spaces

Methods

↑
create(space,options)
POST /places

Retrieves

Space

Description

Create a new Jive community.

Here is an example of a JSON with the minimum set of fields you must include: 

{
    "displayName": "my-special-space",
    "name": "My Special Space"
}

Takes:
  • Space Description of the Jive community to be created.
Options:
NameTypeRequiredDescription
fieldsStringfalseNames of the fields to be returned.
Retrieves:
  • Space Representation of the newly created Jive community
    • ↑
    create(space,options)
    POST /places/{uri}/contents

    Retrieves

    Space

    Description

    Create a new Jive community.

    Here is an example of a JSON with the minimum set of fields you must include: 

    {
    "displayName": "my-special-space",
    "name": "My Special Space"
}

    Takes:
    • Space Description of the Jive community to be created.
    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned.
    Retrieves:
  • Space Representation of the newly created Jive community
    • ↑
    get(options)
    GET /places

    Retrieves

    Place[]

    Description

    Return a paginated list of Jive communities that match the specified criteria.

    Options:
    NameTypeRequiredDescription
    countIntegerfalseMaximum number of places to return (default is 25)
    fieldsStringfalseNames of the fields to be returned
    searchStringfalseOne or more search terms separated by commas, limiting results to places that match the terms. Wildcards can be used, e.g. to search by substring use "*someSubstring*".
    startIndexIntegerfalseZero-relative index of the first place to be returned
    tagStringfalseComma delimited list of tag values, limiting results to places with one of those tags
    Retrieves:
  • Space[] Paginated list of matching Jive communities
    • ↑
    get(options)
    GET /places/{uri}

    Retrieves

    Place

    Description

    Return a single Jive community by its URI.

    Options:
    NameTypeRequiredDescription
    uriStringtrueURI of the Jive community to get
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Space Representation of the requested Jive community