Versions Compared

Old Version 11

changes.mady.by.user AlexI

Saved on

compared with

New Version 12

changes.mady.by.user AlexI

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
/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 Infinit.e 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.

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:

  • 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

title (required)
Display title for share

description (required)
Display description for share

Example

http://infinite.ikanow.com/api/share/add/ref/feed/4e1e4412233064033437d883/Test Feed Share/Just a testTODO

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