static osapi.jive.corev3.places

Web service endpoints for functionality that is common to all places. The standard place types (and corresponding entities) are:

  • blog (Blog) - a blog, associated with this place, in which people can create posts related to activity that is coordinated in this place.
  • group (Group) - a social group, with defined members, typically focused on a particular topic.
  • project (Project) - a project (with associated tasks) to track progress towards particular goals.
  • space (Space) - a formally defined (typically around departmental or topical hierarchies) location for communication about a particular topic.

See Place Use Cases for usage examples.

Methods

↑
create(place,options)
POST /places

Retrieves

Place

Description

Create a new place.

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

    Retrieves

    Content

    Description

    Create a new place.

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

    Retrieves

    Place[]

    Description

    Return a paginated list of places that match the specified criteria.

    Options:
    NameTypeRequiredDescription
    countIntegerfalseMaximum number of places to return (default is 25)
    entityDescriptorStringfalseComma delimited list of objectType / objectID values (useful only for the Jive UI). When used other filters are not allowed
    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
    typeStringfalseComma delimited list of place types, limiting results to places of those types
    Retrieves:
  • Place[] Paginated list of matching places
    • ↑
    get(options)
    GET /places/{uri}

    Retrieves

    Place

    Description

    Return a single place by its URI.

    Options:
    NameTypeRequiredDescription
    uriStringtrueURI of the place to get
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Place Representation of the requested place
    • ↑
    getRecommendedPlaces(options)
    GET /places/recommended

    Retrieves

    Place[]

    Description

    Return a list of recommended places. This feature is only available when Jive has enabled the recommender. Use getPropertyMetadata({name:'feature.recommender.enabled'}) to figure out whether recommendation service is enabled or not.

    Options:
    NameTypeRequiredDescription
    countIntegerfalseMaximum number of places to return (default is 25)
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Place[] List of recommended places
    • Since: 3.1
    ↑
    getRootSpace(options)
    GET /places/root

    Retrieves

    Space

    Description

    ↑
    getTrendingPlaces(options)
    GET /places/trending

    Retrieves

    Place[]

    Description

    Return a list of trending places. This feature is only available when Jive has enabled the recommender. Use getPropertyMetadata({name:'feature.recommender.enabled'}) to figure out whether recommendation service is enabled or not.

    Options:
    NameTypeRequiredDescription
    countIntegerfalseMaximum number of places to return (default is 25)
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Place[] List of trending places
    • Since: 3.1
    ↑
    requestPicker(options)

    Retrieves

    Object

    Description

    Request the Jive container to prompt the user to select a place. When the user has done so, the success callback will be called, passing in the place object representing the selected place. If the user closes the picker dialog without selecting a place, no callback will occur. An example call:

         osapi.jive.corev3.places.requestPicker({
         type : "space",
         success : function(data) {
             // "data" will be the Space object (in this case) selected by the user
         }
     };
    Availability:

    Available only within a Jive App that has included the jive-core-v3 feature.

    Options:
    NameTypeRequiredDescription
    typeStringfalsePlace type to be returned (blog, group, project, or space). If not specified, group will be assumed.
    errorFunctionfalseCallback function that will be called if an error occurs. Passed data object will include a message field containing the error message.
    successFunctionfalseCallback function that will be called if the user successfully selects a place. Passed data object will be the place object for that place, including all of the instance methods
    ↑
    search(options)
    GET /search/places

    Retrieves

    Place[]

    Description

    Search for and return places that match the specified filter criteria.

    Options:
    NameTypeRequiredDescription
    countIntegerfalseMaximum number of results to be returned
    fieldsStringfalseNames of the fields to be returned
    nameonlyStringfalseFlag indicating whether to limit search results to only places that match by name (Defaults to false)
    searchStringfalseOne or more search terms, separated by commas. This filter is required. You must escape any of the following special characters embedded in the search terms: comma (","), backslash ("\"), left parenthesis ("("), and right parenthesis(")"), by preceding them with a backslash.
    startIndexIntegerfalseZero-relative index of the first result to be returned
    typeStringfalseSelect places that are of one of the specified types (separated by commas). Defaults to all available place types.
    Retrieves:
  • Place[] that are decorated with search result specific fields (highlightBody, highlightSubject, highlightTags, parentContent, parentPlace)