static osapi.jive.corev3.publications

Static class for getting and creating Publications.

Methods

↑
create(publication,options)
POST /publications

Retrieves

Publication

Description

Create a new publication, and return a Publication representing the new object.

The minimum information needed to create a new publication is as follows:

 {
     "name" : "{name}"
 }
Availability:

Available to Jive admins only

Takes:
Options:
NameTypeRequiredDescription
fieldsStringfalseNames of the fields to be returned
Retrieves:
  • Publication describing the newly created publication
    • ↑
    delete(publication)
    DELETE /publications/{publicationID}

    Retrieves

    --

    Description

    Delete the specified publication.

    Availability:

    Available to Jive admins only

    Options:
    NameTypeRequiredDescription
    publicationIDStringtrueURI of the publication to be deleted
    ↑
    get(options)
    GET /publications

    Retrieves

    Publication[]

    Description

    Return a paginated list of publications defined in this Jive instance.

    Availability:

    Available to Jive admins only

    Options:
    NameTypeRequiredDescription
    countIntegerfalseThe maximum number of publications to return (default is 25)
    fieldsStringfalseThe names of the fields to be returned
    startIndexIntegerfalseZero-relative index of the first publication to return (default is 0)
    Retrieves:
  • Publication[]
    • ↑
    get(options)
    GET /publications/{uri}

    Retrieves

    Publication

    Description

    Return the specified publication by its URI.

    Availability:

    Available to Jive admins only

    Options:
    NameTypeRequiredDescription
    uriStringtrueURI of the requested publication
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Publication describing the specified publication
    • ↑
    subscribers(options)
    GET /publications/{publicationID}/subscriptions/{subscriptionID}/subscribers

    Retrieves

    Person[]

    Description

    Get a list of unique users across all subscribers for a given subscription.

    Availability:

    Available to Jive admins only

    Options:
    NameTypeRequiredDescription
    publicationIDIntegertrueURI of the publication
    subscriptionIDIntegertrueURI of the subscription
    startIndexIntegerfalseZero-relative index of the first matching publication to be returned (default value is 0)
    countIntegerfalseMaximum number of publications to be returned (default value is 25)
    fieldsStringfalseFields to be returned for each publication (default value is @standard)
    ↑
    update(publication,options)
    PUT /publications/{publicationID}

    Retrieves

    Publication

    Description

    Update an existing publication, based on the specified information.

    Availability:

    Available to Jive admins only

    Options:
    NameTypeRequiredDescription
    publicationIDStringtrueURI of the publication to be updated
    fieldsStringfalseFields to be included in the response (default is @all)