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.events

Methods

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

Retrieves

Event

Description

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

Takes:
  • Event fields describing the new Event
Options:
NameTypeRequiredDescription
fieldsStringfalseNames of the fields to be returned
Retrieves:
  • Event describing the newly created Event
    • ↑
    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 /event-type-plugin/v3/contents

    Retrieves

    Content[]

    Description

    Return a paginated list of events 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:
  • Event[] 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 /event-type-plugin/v3/contents/{uri}

    Retrieves

    Content

    Description

    Return a single event by its URI.

    Options:
    NameTypeRequiredDescription
    uriStringtrueURI of the event to get
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Event Representation of the requested event
    • ↑
    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 /event-type-plugin/v3/contents/{uri}/editable

    Retrieves

    Content

    Description