Welcome to TSS REST API’s documentation!¶
The TSS REST API provides methods of accessing and manipulating repositories, entities (data sources), and business rules.
The methods also support working with the Rules Library and data relationships like joins, keys, and dependencies.
All access is secured using SSL, so all endpoints are only available using https://[hostname]/[endpoint]. Access also requires an authenticated connection.
TSS REST API Guidelines¶
Note the following when working with the TSS REST APIs:
The APIs are designed using the Hypermedia as the Engine of Application State (HATEOAS) Restful architecture. HATEOAS is a constraint of the REST application architecture that gives you the ability to drill-down via hypermedia links from the returned URLs. A REST client needs no prior knowledge of how to interact with an application or server beyond a basic understanding of hypermedia.
- The TSS REST APIs receive and deliver data in Java Script Object Notation (JSON) format. JSON separates the request into different packets. Requests consist of:
- A key-value pair, which is a set of two linked data items. The key is a unique data identifier. The value is either the data that is identified or a pointer to the data location.
- An ordered list (or array) of values.
Many requests require a GET command and include ID fields for repositories, entities (data sources), and business rules. For example: GET https://host_name:3000/api/repositories/repID/entities
Some requests use a POST command when filtering is required. For example, if you want to include a command to return a list of business rules with a certain threshold.
Reference¶
Repository Management¶
Connections¶
| Show all | Show all connections in the repository |
| Show | Show a single connection |
| Get | Get a filtered list of loader connections |
| Add | Add a new loader connection |
| Edit | Edit an existing connection |
| Enable/Disable | Enable or disable a connection |
Repositories¶
| Show all | Show all repositories |
| Get | Get a filtered list of repositories |
| Add | Add a new repository |
| Edit | Edit an existing repository |
| Delete | Delete a repository |
| Users | Show the users authorised to access a repository |
Loader Settings¶
| Loader Cache | Get Loader cache using get |
| Get Loader Cache | Get loader cache using post |
| Edit Loader Cache | Edit loader cache |
Repositories¶
Miscellaneous¶
| Version | Current product version and build number |
| Show all | Show all repositories |
| Show | Show a repository |
| Show all functions | Show a list of available functions |
| Check expression | Check a humanised expression |
| Check predicate | Check a humanised predicate |
| Unmask a value | Apply a mask to a value and get the unmasked response |
| Show Export Encodings | Show supported export encodings |
| Show Locale | Show repository locale |
Scheduler¶
| Jobs | Show all jobs |
| Job status | Show the status of a job |
File Uploads¶
| Upload file | Upload a file |
| Download file | Download a file |
| List files | Show files uploaded to the server |
Loader Connections¶
| Show all | Show all loader connections |
| Show | Show a single loader connection |
| Encodings | Show encodings supported by a loader connection |
Datasources¶
| Show all | Show all datasources for a connection |
| Show some datasources | Show filtered list of datasources for a connection |
| Show data schemas | Show all dataschemas for a connection |
| Show dataschema preview | Show dataschema preview for a connection |
Entities¶
| Count | Show number of entities in the repository |
| Show all | Show all entities |
| Show | Show a single entity |
| Show some | Show filtered list of entities |
| Raw Preview | Raw preview an entity |
| Export | Export a list of entities in the repository |
| Preview | Preview an entity |
| Create | Create an entity |
| Load | Load data to an entity |
| Upload | Upload a file for an entity |
| Edit | Edit an entity |
| Delete | Delete an entity |
| Check XML expression | Check an XML expression |
| Check XML predicate | Check an XML predicate |
| Associated Library Entities | Show Library entities associated with an entity |
Entity Data Rows¶
| Rows | List rows in an entity |
| Maximum length | Length of the longest row(s) |
| Minimum length | Length of the shortest rows(s) |
| Longest row(s) | The longest row(s) |
| Shortest row(s) | The shortest row(s) |
| Duplicate keys | Show duplicate keys in an entity |
| Dependencies | Show dependency conflicts in an entity |
| Row details | Attributes and values of a single row; |
| Duplicate Rows Indicator | Duplicate rows indicator; |
| Duplicate Rows | Duplicate rows; |
Attributes¶
| Show All | Show all attributes in an entity |
| Show Some | Show a filtered list of attributes in an entity |
| Export | Export a list of attributes in an entity |
| Edit | Edit name and description of an attribute in an entity |
| Metadata | Metadata for a single attribute |
| Values | Values found in an attribute |
| Matching Data Rows | Data rows that match the attribute value in an entity |
| Strings | String values found in an attribute |
| Integers | Integer values found in an attribute |
| Decimals | Decimal values found in an attribute |
| Nulls | Null values found in an attribute |
| Spaces | Attribute value contains only spaces |
| Masks | Masks found in an attribute |
| Metaphones | Metaphones found in an attribute |
| Soundexes | Soundexes found in an attribute |
| Patterns | Patterns found in an attribute |
| Phrases | Phrases found in an attribute |
| Deviations | Deviations found in an attribute |
| Recode Values | Recode Values |
| Recode Masks | Recode Masks |
Entity Business Rules¶
| Show all | Show all business rules for an entity |
| Show some | Show a filtered list of business rules |
| Show | Show a single business rule |
| Edit | Edit a single business rule |
| Run | Run analysis a single business rule |
| Delete | Delete a single business rule |
| Permissions | Show permissions for a business rule |
| All passing rows | Show all rows that passed a business rule |
| Some passing rows | Show some passing rows for a rule |
| Export passing rows | Export some or all passing rows |
| All failing rows | Show all rows that failed a business rule |
| Some failing rows | Show some failing rows for a rule |
| Export failing rows | Export some or all failing rows |
| Groups | Show groups found in a business rule |
| All Group passing rows | Show all rows in a group that have passed the business rule |
| Some Group passing rows | Show some rows in a group that have passed the business rule |
| Export Group passing rows | Export rows in a group that have passed the business rule |
| All Group failing rows | Show all rows in a group that have failed the business rule |
| Some Group failing rows | Show some rows in a group that have failed the business rule |
| Export Group failing rows | Export rows in a group that have failed the business rule |
| Passing rules | Show all passing rules for an entity |
| Failing rules | Show all failing rules for an entity |
| Enabled rules | Show all enabled rules in the entity |
Business Rules¶
| Count | Show number of business rules in the repository |
| Entity Business Rule Count | Show number of business rules in the repository that are associated to an entity |
| Show | Show business rules in the repository |
| Priorities | List business rule priorities |
| Aggregate methods | Show available aggregating methods |
Library¶
| Count | Show number of rules in the library |
| Show | Show all rules in the library |
| Export | Export all rules in the library |
| List | Get a list of rules for any library entity |
| Run | Run analysis for a list of rules for any library entity |
| Check Expression | Check an expression against a library entity |
| Check Predicate | Check a predicate against a library entity |
Entities¶
| Count | Show number of library entities |
| Show All | Show all library entities |
| Show Some | Show a filtered list of library entities |
| Show | Show the metadata for a library entity |
| Add | Add a library entity |
| Delete | Delete a library entity |
| Associate | Associate an entity with a library entity |
| Disassociate | Disassociate an entity from a library entity |
| Promote | Promote entity business rules to the library |
| Import | Import library entity business rules |
| Export | Export library entities |
| Remove Attributes | Remove unused attributes from a library entity |
| Permissions | Show permissions for all library entities |
| Associated Entities | Show entities associated with a library entity |
| Associated Rules | Show business rules associated with a library entity rule |
| Associated Entities Mapping | Show attribute mappings between an entity and a library entity |
| Edit Mappings | Edit attribute mappings |
| Business Rules | Business rules in the library entity |
| Business Rule | Show a particular business rule in the library entity |
| Add Business Rule | Add a business rule in the library entity |
| Edit Business Rule | Edit a business rule in the library entity |
| Delete Business Rule | Delete a business rule from the library entity |
Attributes¶
| Show All | Show all library entity attributes |
| Show Some | Show a filtered list of library entity attributes |
| Add | Add an attribute to a library entity |
| Edit | Edit a library attribute |
| Delete | Delete a library attribute |
Groups¶
| Show | Show all groups |
| Rename | Rename a group |
| Delete | Delete a group |
| Show Group Rules | Show library rules in a group |
| Add to Group | Add library rules to a group |
| Run | Run analysis for all library rules in a group |
| Delete | Delete library rule from group |
| Results | Show results for library rules in a group |
Joins¶
| Count | Show number of joins in the repository |
| Show All | Show all joins in the repository |
| Show Some | Show filtered list of joins in the repository |
| Show One | Show a single join |
| All Permanent Joins | Show all permanent joins |
| All Discovered Joins | Show all discovered joins |
| Entity Joins | Show all joins in an entity |
| Edit | Change join status |
| Delete | Delete joins |
| Discover | Discover joins |
| Create | Create joins |
| Entity Permanent Joins | Show all permanent joins in an entity |
| Entity Discovered Joins | Show all discovered joins in an entity |
| All Attribute Joins | Show all joins for an attribute |
| Left Non-Matching Rows | Rows on the left hand side that did not join |
| Right Non-Matching Rows | Rows on the right hand side that did not join |
| Inner Joined Rows | Lists rows in the inner join |
| Outer Joined Rows | Lists rows in the outer join |
| Left Outer Joined Rows | Lists rows in the left outer join |
| Right Outer Joined Rows | Lists rows in the right outer join |
| Venn Diagram Information | Lists information for a particular join venn diagram |
| Join Matching Values | Lists distinct joined rows |
| Left Non-Matching Values | List of values on the left hand side that did not join |
| Right Non-Matching Values | List of values on the right hand side that did not join |
Join Jobs¶
| Count | Show number of join jobs in the repository |
| Show All | Show all join jobs |
| Show Some | Show filtered list of join jobs |
| Delete | Delete list of join jobs |
| Export | Export all join jobs |
Keys¶
| Entity Keys | All keys for an entity |
| Create Key | Create a key for the entity |
| Discover Keys | Discover keys for the entity |
| Delete Single Key | Delete a key in the entity |
| Delete Multiple Keys | Delete multiple keys in the entity |
| Permanent Keys | Permanent keys for an entity |
| Discovered Keys | Discovered key for an entity |
| Change Single Status | Edit status of a key in the entity |
| Change Multiple Status | Edit status of multiple keys in the entity |
| Duplicate Keys | Duplicate values in a key of an entity |
| Attribute Keys | All keys for an attribute |
Dependencies¶
| All | All dependencies for an entity or an attrtibute |
| Create | Create dependency |
| Discover | Discover dependencies |
| Delete | Delete dependencies |
| Permanent | All permanent dependencies for an entity or an attribute |
| Discovered | All discovered dependencies for an entity or an attribute |
| Conflicts | All conflicts for a particular entity/attribute and key |
| Resolve Conflicts | Resolve conflicts |
| Normal Form Decomposition | All normalised rows for a given dependency key(s) |
| Corrections | All corrections for a given dependency key(s) |
| Verify | Verify dependency key(s) |
| Change Entity Dependency Status | Edit status of a dependency in the entity |
| Change Attribute Dependency Status | Edit status of a dependency in the attribute |
Notes¶
| All Notes Count | Show number of entity-level and attribute-level notes for an entity |
| Entity-Level Notes Count | Show number of entity-level notes for an entity |
| Attribute-Level Notes Count | Show number of attribute-level notes for an entity |
| Show All Notes | Show all entity-level and attribute-level notes for an entity |
| Show All Entity-Level Notes | Show all entity-level notes for an entity |
| Show Single Entity-Level Note | Show a single entity-level note for an entity |
| Show All Attribute-Level Notes | Show all attribute-level notes for an entity |
| Show Single Attribute-Level Note | Show a single attribute-level note for an entity |
| Add Note | Add a new note |
| Edit Note | Edit an existing note |
| Delete Notes | Delete notes from the repository |