static osapi.jive.corev3.documents

Static class for getting and creating Documents.

Methods

↑
create(document,options)
POST /contents

Retrieves

Document

Description

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

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

 {
  "content":
      {
      "type": "text/html",
      "text": "<body><p>Some interesting text</p></body>"
      },
  "subject": "New Document"
 }

Takes:
  • Document fields describing the new document
Options:
NameTypeRequiredDescription
fieldsStringfalseNames of the fields to be returned
Retrieves:
  • Document describing the newly created document
    • ↑
    get(options)
    GET /contents

    Retrieves

    Content[]

    Description

    Return a paginated list of documents 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. Wildcards can be used, e.g. to search by substring use "*someSubstring*".
    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:
  • Document[] Paginated list of matching documents
    • ↑
    get(options)
    GET /contents/{uri}

    Retrieves

    Content

    Description

    Return a single document by its URI.

    Options:
    NameTypeRequiredDescription
    uriStringtrueURI of the document to get
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Document Representation of the requested document
    • ↑
    getEditable(options)
    GET /contents/{uri}/editable

    Retrieves

    Content

    Description