`static` osapi.jive.corev3.documents

Static class for getting and creating Documents.

Methods

create(document,options)
POST /contents

Document

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"
 }

Name	Type	Required	Description
fields	String	false	Names of the fields to be returned

Document describing the newly created document

get(options)
GET /contents

Content[]

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

Name	Type	Required	Description
author	String	false	URI of a person, limiting results to objects authored by this person
count	Integer	false	Maximum number of objects to return (default is 25)
fields	String	false	Names of the fields to be returned
place	String	false	URI of a place, limiting results to objects contained in that place
search	String	false	One or more search terms separated by commas, limiting results to objects that match the terms
startIndex	Integer	false	Zero-relative index of the first content object to be returned
tag	String	false	Comma delimited list of tag values, limiting results to objects with one of those tags

Document[] Paginated list of matching documents

get(options)
GET /contents/{uri}

Content

Return a single document by its URI.

Name	Type	Required	Description
uri	String	true	URI of the document to get
fields	String	false	Names of the fields to be returned

Document Representation of the requested document