Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.

static osapi.jive.corev3.ideas

Methods

↑
Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.
create(idea,options)
POST /idea-type-plugin/v1/contents

Retrieves

Idea

Description

Create a new idea with specified characteristics, and return an entity representing the newly created idea.

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

 {
  "content":
      {
      "type": "text/html",
      "text": "<body><p>This is a fantastic idea</p></body>"
      },
  "subject": "Eat cookies for breakfast"
 }

If you wish to create this idea within a place, include a parent field that contains that place's URI.

Takes:
  • Idea fields describing the new discussion
Options:
NameTypeRequiredDescription
fieldsStringfalseNames of the fields to be returned
Retrieves:
  • Idea describing the newly created discussion
    • ↑
    Requires ModuleWhat's this?
    This capability is implemented by a Jive Module.
    This feature may not be available on all Jive instances.
    get(options)
    GET /idea-type-plugin/v1/contents

    Retrieves

    Content[]

    Description

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

    Options:
    NameTypeRequiredDescription
    authorStringfalseURI of a person, limiting results to objects authored by this person
    countIntegerfalseMaximum number of objects to return (default is 25)
    fieldsStringfalseNames of the fields to be returned
    placeStringfalseURI of a place, limiting results to objects contained in that place
    searchStringfalseOne or more search terms separated by commas, limiting results to objects that match the terms
    startIndexIntegerfalseZero-relative index of the first content object to be returned
    tagStringfalseComma delimited list of tag values, limiting results to objects with one of those tags
    Retrieves:
  • Idea[] Paginated list of matching ideas
    • ↑
    Requires ModuleWhat's this?
    This capability is implemented by a Jive Module.
    This feature may not be available on all Jive instances.
    get(options)
    GET /idea-type-plugin/v1/contents/{uri}

    Retrieves

    Content

    Description

    Return a single idea by its URI.

    Options:
    NameTypeRequiredDescription
    uriStringtrueURI of the idea to get
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Idea Representation of the requested idea
    • ↑
    Requires ModuleWhat's this?
    This capability is implemented by a Jive Module.
    This feature may not be available on all Jive instances.
    getEditable(options)
    GET /idea-type-plugin/v1/contents/{uri}/editable

    Retrieves

    Content

    Description