Page Comparison

...

/social/share/add/

...

ref/{type}/{database}/{documentid}/{title}/{description}

...

Info

Add a reference to a document (pointer to a document in a database collection).JSON document from one of the platform databases - when it is requested via the get or search API calls, the current value of that referenced document is returned. Currently the following are supported: the document metadata collection, the aggregated entity or association objects, or the first record in a custom collection (ie the custom collection is treated differently from the others, see below). A simple web-based utility is available for performing many share management activities. For references to custom collections, only the first object in the collection is displayed.

Authentication

Required, see Auth - Login

Arguments

type (required)
The share "type", an arbitrary string that is used in the search API call - ie it is treated identically as for normal JSON shares.

database (required)
Type of object shared: Query, Dataset, Url, etc.id, the following values are supported:

• doc_metadata.metadata
• feature.entity
• feature.association
• custommr.customlookup

documentid (required)
ID of document to share, from the database specified by the "database" field above (the value of "_id" field)

title (required)
Display title for share

description (required)
Display description for share

Example

curl -XGET 'http://infinite.ikanow.com/api/social/share/add/ref/

...

ReferenceType/

...

custommr.customlookup/5e175bfeb8ed6403f48ea7b4/My+reference+share/No+Description'

Example Response

{
{    	response: {
		
        action: "New Share"
		        success: true
		
        message: "New share added successfully."
		        time: 10
   	 },
    data: "4e175bfeb8ed6403f48ea7e2"
 }

...