Social - Share - Update - Reference

Owned by Craig Vitter (Unlicensed)
Last updated: May 19, 2015 by andrew johnston (Unlicensed)
/social/share/update/ref/{id}/{type}/{database}/{documentid}/{title}/{description}

Update a reference to a 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

id (required)
ID of share to update

database (required)
Type of object shared, the following values are supported:

  • document.doc_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

http://infinite.ikanow.com/api/social/share/update/ref/4e1e4412233064033437d882/doc_metadata.metadata/4e1e4412233064033437d883/Test Feed Share/Just a test

Example Response
{
	response: {
		action: "New Share"
		success: true
		message: "New share added successfully."
		time: 10
	}
}