osapi.jive.corev3.contents.ContentVersion

An entity representing a version of a document.

Example:

Example JSON

JSON with the most important data for a ContentVersion. See the table below for a list of all fields.

{
    "type": "contentVersion",
    "status": "archived",
    "author": {
        "name": {
            "formatted": "Administrator"
        },
        "type": "person",
        "displayName": "Administrator",
        "id": "1"
    },
    "content": {
        // a document representing the content of this version
    },
    "versionNumber": 1,
    "published": "2012-07-11T23:49:37.929+0000"
 }

Properties

author
content
id
minorVersion
published
resources
status
type
updated
versionNumber

Methods

get
restore
toURI

Properties

Property	Type	Mode †	Description
`author`	`Person`	read-only	↑ Author of this document version.
`content`	`Object`	read-only	↑ Document corresponding to this version.
`id`	`String`	read-only	↑ Identifier (unique within an object type and Jive instance) of this object. This field is internal to Jive and should not be confused with contentID or placeID used in URIs.
`minorVersion`	`Boolean`	read-only	↑ Flag indicating that this is a minor version.
`published`	`ISO 8601 Date`	read-only	↑ Date and time at which this document version was originally created.
`resources`	`Object`	read-only	↑ Resource links (and related permissions for the requesting person) relevant to this object.
`status`	`String`	optional	↑ Published status of this content object.
`type`	`String`	read-only	↑ The object type of this object ("documentVersion").
`updated`	`ISO 8601 Date`	read-only	↑ Date and time this document version was most recently updated.
`versionNumber`	`Integer`	read-only	↑ One-relative version number of this version.

Methods

↑

get(options)
GET /versions/1234/1

Retrieves

ContentVersion

Description

Return an updated version of this version of a content.

Options:

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

Retrieves:

ContentVersion describing this content object

↑

restore(options)
POST /versions/1234/1

Retrieves

ContentVersion

Description

Restore a content version by creating a copy of the version to restore as the newest content version and returning that content version.

Options:

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

Retrieves:

ContentVersion describing this content object

↑

toURI()

Retrieves

String

Description

Retrieves:

A URI representing this entity, or undefined if no such URI exists.