static osapi.jive.corev3.blogs

Static class for getting and creating Blogs. A Blog can be a personal blog or a blog inside a place.

Methods

create(blog,options)
POST /places

Retrieves

Blog

Description

Create a new blog.

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

 {
    "name" : "My New Personal Blog",
    "parent" : "https://example.jiveon.com/api/core/v3/people/@me",
    "displayName" : "chris"
 }

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

    Retrieves

    Blog

    Description

    Create a new blog.

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

     {
        "name" : "My New Personal Blog",
        "parent" : "https://example.jiveon.com/api/core/v3/people/@me",
        "displayName" : "chris"
     }
    

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

    Retrieves

    Place[]

    Description

    Return a paginated list of blogs 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:
  • Blog[] Paginated list of matching blogs
  • get(options)
    GET /places/{uri}

    Retrieves

    Place

    Description

    Return a single blog by its URI.

    Options:
    NameTypeRequiredDescription
    uriStringtrueURI of the blog to get
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Blog Representation of the requested blog