Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

/social/share/search

Searches the share collection
A detailed explanation of the share object can be found here.

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

Note: All of the following arguments are optional.

searchby
V0 release supports "community" or "person". The latter is only supported for admin users (except for obtaining only your shares, see below). If "searchby" is not specified, searches across all joined communities.

id
Comma separated list of community IDs, or a community regex (for "searchby=community"), or a list of email addresses or a list of ids (for "searchby=person"). If this is not specified for "person", it defaults to the calling user.

type
Comma separated list of (arbitrary string) share types. Example values: "dataset", "feed", "source", "query". "binary".

skip
Number of results to skip.

limit
Number of results to return.

Example

http://infinite.ikanow.com/api/share/search
http://infinite.ikanow.com/api/share/search?type=feed

http://infinite.ikanow.com/api/share/search?searchby=person&id=user1@test.com,user2@test.com

http://infinite.ikanow.com/api/share/search?searchby=community&id=4c927585d591d31d7b37097a&skip=0&limit=10

http://infinite.ikanow.com/api/share/search?searchby=community&id=*system

http://infinite.ikanow.com/api/share/search?searchby=community&id=4c927585d591d31d7b37097a&skip=0&limit=10

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!"
				}
			]
		}
	 ]
}
  • No labels