osapi.jive.corev3.contents.Attachment
Representation of a file attachment. The url field can point to a file of any type hosted anywhere that is visible to your Jive instance. Attachments can be on Documents, Blog Posts, and Discussions. If you create an object with an attachment, the file will be automatically uploaded and hosted on your Jive instance. An example JSON representation looks like this:
{ "name" : "MyPicture.png", "doUpload" : true, "type" : "attachment", "size" : 7971, "contentType" : "img/png", "url" : "http://mydomain.com/spreadsheets/MyPicture.png", "id" : "1074" }
Example:
Example of minimum JSON required to create an attachment (for example when creating a document):
{ "attachments": [ { "doUpload" : true, "url" : "http://mydomain.com/spreadsheets/MyPicture.png" } ] }
Properties
Property | Type | Mode † | Description |
---|---|---|---|
contentType | String | required | ↑ The content type of this attachment. |
doUpload | Boolean | required | ↑ An indicator of whether an attachment is new and should be uploaded. |
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. |
name | String | optional | ↑ Filename of this attachment. |
resources | Object | read-only | ↑ Resource links (and related permissions for the requesting person) relevant to this object. |
size | Integer | read-only | ↑ The size (in bytes) of this attachment. |
type | String | read-only | ↑ |
url | String | required | ↑ The URL to retrieve the binary content of this attachment. |
Methods
get(options)
GET /attachments/1234
Retrieves
Attachment
Description
Return an updated version of this attachment.
Options:
Name | Type | Required | Description |
---|---|---|---|
fields | String | false | Names of the fields to be returned |
toURI()
Retrieves
String