API v3 Endpoint Overview

This article is a follow up to API v3 Overview, expanding on the definition and usage of Endpoints within a TMMData Foundation Platform API v3 request. The Endpoint represents the object, or collection of objects, that the request is intended to interact with.  Endpoints are the core to any v3 API request.  The Endpoint determines what aspect of the TMMData Foundation Platform will be interacted with/modified by the API request.  For each Endpoint, there are extensive lists of Getters, Setters and Actions. Each list is unique to its Endpoint.

Endpoint:

In the above example, the Endpoint in the 'Example API Request' is [ User ]. This will limit what can be done with the API request to actions that are specifically designed to manipulate [ User ] data objects.

ID/GUID:

The Endpoint ID or GUID is the representation of a specific unique data object within the aforementioned Endpoint.  This can be represented by two different, yet equally effective, values:

  • Endpoint ID: The Endpoint ID is the value which identifies a unique data object within the TMMData Foundation Platform internally.  In the above example, the Endpoint ID is [ 13 ].  This is always an unsigned integer value. The above example uses the Endpoint ID.
  • Endpoint GUID: Like the ID, the Endpoint GUID is also a unique identifier that represents a specific data object within the TMMData Foundation Platform. This GUID consists of a unique string of characters and is sometimes also referred to as a 'Key'. The GUID can be found within the TMMData Foundation Platform by opening the 'Edit' modal for the desired object.


API Request to Return All Actions For an Endpoint:

At any point an API request can be made that will return a list of all Actions available to a specific Endpoint. The request is as follows:

[ https://my.tmmlog.in/api/3/[endpoint]/?userkey=[userkey] ]

Just replace the [endpoint] with the specific Endpoint and [userkey] with an actual user GUID.  A JSON object will be returned containing all Actions for the Endpoint as well as all Attributes.

Current Endpoints and Descriptions:

API Request to Return All Endpoints:

At any point an API request can be made that will return a list of all Endpoints. The request is as follows:

[ https://my.tmmlog.in/api/3/?userkey=[userkey] ]

Just replace the [userkey] with an actual user GUID.  A JSON object will be returned containing a list of all available Endpoints.  The available Endpoints at the time that this article was written are as follows:

AutoImportConf
AutoImportConf is used to create/read/interact with Auto Import Configurations (defined as Auto Import Wizard within the Foundation Platform)
Blob
The Blob Endpoint is used to store and retrieve files that are stored as the 'file' field type within the Foundation Platform.
BusinessRule
The BusinessRule Endpoint is used to create/view/interact with Business Rules.
BusinessRuleGroup
The BusinessRuleGroup is used to create/view/interact with Business Rule Groups.
BusinessRuleTrigger
BusinessRuleTrigger allows the API request to create new Business Rule Triggers or read, modify, delete or execute existing Business Rule Triggers.
Connection
The Connection Endpoint allows the API request to create new Connections or read, modify, or delete existing Connections.
Customer
The Customer Endpoint allows the API request to create new Customers or read, modify or delete existing Customers.
Dashboard
The Dashboard Endpoint allows the API request to create new Dashboards or read, modify or delete existing Dashboards.
Dashboard Element
The DashboardElement Endpoint allows the API request to create new Dashboard Elements. It also permits reading, modifying or deletion of existing Dashboards Elements.
DDLCondition
Deprecated.
DDLRule
Deprecated.
EmailAccount
The EmailAccount allows the API request to create new Email Accounts or read, modify or delete existing Email Accounts.
ErrorLog
The ErrorLog Endpoint is used to read the Error Logs.
FieldFormat
The FieldFormat Endpoint allows the API request to interact with system defined Field Formats. For example a Text field can have a format of 'URL'.
FieldType
The FieldType Endpoint allows the API request to create new Custom Fields or read, modify or delete existing Custom Fields.
FieldTypeTrigger
The FieldTypeTrigger Endpoint allows the API request to create new Field Type Triggers or read, modify, delete or execute existing Field Type Triggers.
FileImporterLocations
The FileImporterLocations Endpoint is used to create new or read/interact with the locations that the File Import Scheduler uses.
Flow
The Flow Endpoint allows interaction with Flows. Flows can be created, modified and deleted. Flow data can be retrieved and a Flow can be manually executed via the v3 API.
Form
The Form Endpoint is used to create new Forms, modify or delete existing Forms. Form data can also be retrieved via the API.
FormElement
The FormElement Endpoint allows the API request to create new Form Elements. It also permits reading, modifying or deletion of existing Form Elements.
Job
The Job Endpoint is used to create new Jobs.
KVStore
The KVStore Endpoint is for key-value storage. The Endpoint allows creation, modification, reading or deletion of key-value pairs.
Mashup
The Mashup Endpoint is for internal System use.
PerformanceLog
The PerformanceLog Endpoint is used to read the performance logs.
Plugin
The Plugin Endpoint allows the API request to modify an existing plugin and read plugin data (including listing available plugins).
ProfileLog
The ProfileLog Endpoint is used to read the history of the Profiler.
SavedAPI
The SavedAPI Endpoint controls saved Exports.
ScheduledJob
The ScheduledJob Endpoint interacts with Scheduled Jobs. It allows the API request to create, start and stop Scheduled Jobs. (To change tasks in a Scheduled Job, it must be done within the TMMData Foundation Platform)
Source
The Source Endpoint is used to interact with Sources(Tables). New Tables can be created. Existing Tables can be modified, read or deleted.
SourceChart
The SourceChart Endpoint is used to create, read, modify or delete Charts.
SourceConditional
The SourceConditional Endpoint is used to create, modify or delete Table conditional formatting.
SourceConnection
The SourceConnection Endpoint is used to read or modify Source Connections that are tied to a Table.
SourceExportOption
The SourceExportOption Endpoint is used to create, read and interact with stored Export Connector settings.
SourceField
The SourceField Endpoint is used to create, modify or delete Table fields.
SourceInterface
The SourceInterface Endpoint is used to draw the grid.
SourceJoin
The SourceJoin Endpoint is used to work with joins. This corresponds to the "add join" dialog when creating/editing a mashup table. Each item created there is a single "join" with its own unique ID.
SourceNote
The SourceNote Endpoint is used to create, read, modify or delete Table notes.
SourcePivot
Deprecated.
SourceProfile
The SourceProfile Endpoint is used to create, read or interact with the profiles that are created by the Profiler.
SourceStatsLog
The SourceStatsLog Endpoint is used to read the historical stats of a Table. (size, records, etc.)
SourceTemplate
The SourceTemplate Endpoint is used to create, read or modify Table Templates.
SourceType
The SourceType Endpoint is used to interact with Folders. New Folders can be created. Existing Folders can be modified, read or deleted.
SourceView
The SourceView Endpoint is used to interact with Views. New Views can be created. Existing Views can be modified, read or deleted.
Stats
The Stats Endpoint is used to create, read, modify or delete customer statistic information.
Theme
The Theme Endpoint is used to create, read, modify or delete Themes. (Forms, Dashboards, UI)
TreeInfo
The TreeInfo Endpoint is used internally by the TreeImporter. System use only.
User
The User Endpoint is used to interact with Users. It allows the API request to create, read, modify or delete Users.
UserType
The UserType Endpoint is used to create, read, modify or delete user groups for system governance.
VersionControl
The VersionControl Endpoint is used to create or modify HBase version control settings for a Table. The Endpoint also contains the methods for pushing data to and pulling data from HBase.
Workspace
The Workspace Endpoint is used to interact with Workspaces. It allows an API request to create, read, modify or delete Workspaces.
WorkspaceElement
The WorkspaceElement Endpoint is used to create, read, modify or delete elements within a Workspace. (Tables, Forms, Dashboards, etc.)