Social - Share - Get

Owned by Craig Vitter (Unlicensed)
Last updated: Sept 30, 2015 by Caleb Burch (Unlicensed)
2 min read
/social/share/get/{shareid}

Retrieves a specified share document by ID.
A detailed explanation of the share object can be found here.

Setting nocontent will return just the metadata about a share.

Normally you will not set this parameter and get the actual content of a share.  If a share is not a binary file the content will be returned in the response.data.share field of the json.  If the share contains a binary file and nocontent is not set, then in place of returning the metadata of a share, the actually binary bytes will be returned as a response. NOTE: there will be no json response with the success header.  The mediatype of the response bytes will be set to what the share has for share.mediaType

Authentication

Required, see Auth - Login.  You must be a member of one of the communities associated with a share to be able to access that share.

Arguments

shareid (optional)
Share ID to search on

nocontent (optional)
Set parameter to true if you want just the metadata of a share

nometa (optional)
Set parameter to true (JSON shares only) to return the share itself in the "data" field of the reply, rather than the database object consisting of share metadata with the share itself encoded as a string in the "data.share" field.

filename(optional)
if you are returning the content of a binary share, will name the download what you pass in here (e.g. my_file.txt)

Example

http://infinite.ikanow.com/api/social/share/get/4e175bfeb8ed6403f48ea7e2
http://infinite.ikanow.com/api/social/share/get/4e175bfeb8ed6403f48ea7e2?nocontent=true
http://infinite.ikanow.com/api/social/share/get/4e175bfeb8ed6403f48ea7e2?filename=my_file.txt

Example Response
{
	response: 
	{
		action: "Share"
		success: true
		message: "Share returned successfully"
		time: 41
	}
	data: 
	{
		_id: "4e175bfeb8ed6403f48ea7e2"
		created: "Jul 8, 2011 11:35:26 AM"
		modified: "Jul 10, 2011 9:27:36 AM"
		owner: 
		{
			_id: "4d88d0f1f9a624a4b0c8bd71"
			email: "jdoe@ikanow.com"
			displayName: "John Doe"
		}
		type: "test"
		title: "Test Share"
		description: "Just a test of share functionality"
		share: "random stuff that gets put in share"
		communities: [
			{
				_id: "4d88d0f1f9a624a4b0c8bd71"
				name: "John Doe's Personal Community"
			}
 			{
				_id: "4c927585d591d31d7b37097a"
				name: "Infinit.e System"
				comment: "Share with everyone!"
			}
		]
	}
}