API.TOC.md

CM-Well API: Table of Contents

The following list shows general topics relating to many CM-Well API calls:

• Input and Output Formats
• Query Parameters
• Field Condition Syntax
• Field Name Formats
• From and To Datetime Formatting
• Paging through Results with Offset and Length Parameters
• Sorting Results with the sort-by Flag
• Using the recursive Flag
• Using the with-data Flag
• Using the with-history Flag
• Using the with-deleted Flag
• Traversing Outbound and Inbound Links with xg and yg
• Return Codes

The following table shows all the CM-Well API calls:

Category	Function
Login	Login
Get	Get Single Infoton by URI
	Get Multiple Infotons by URI
	Get Single Infoton by UUID
Query	Query for Infotons Using Field Conditions
	Apply SPARQL to Query Results
	Apply SPARQL to Entire Graph
	Apply Gremlin to Query Results
	Query for Data Statistics
	Query for Quads by their Label
Stream	Stream Infotons
Bulk Download	Create Iterator
	Get Next Chunk
	Consume Next Bulk
	Create Consumer
	Consume Next Chunk
Subscribe	Subscribe for Push Updates
	Subscribe for Pull Updates
	Pull New Data
	Terminate an Active Subscription
Update	Add Infotons and Fields
	Replace Field Values
	Delete a Single Infoton
	Delete Multiple Infotons
	Delete Fields
	Delete Specific Field Values
	Add Infotons and Fields to a Named Sub-Graph
	Delete and Replace Values in a Named Sub-Graph
	Purge a Single Infoton's Versions
	Add a File Infoton
	Add a Link Infoton
	Track Updates