Summary
Integrate software with Tachyon using public facing Application Programming Interfaces (API).
In this section...
Introduction
How you can integrate software with Tachyon using public facing Application Programming Interfaces (API).
Tachyon RunInstruction command-line tool
Tachyon RunInstruction command-line tool is a stand-alone command line (CLI) tool that supports submission of a Tachyon instruction, question or action to a set of computers.
Consumer API reference
Each API endpoint is documented on a separate page. Pages are version controlled.
- ApplicableOperations — Entity - Role Based Access Control - Interrogates the SecurableType table in the database
- Approvals — Entity - Approvals - Handles instruction approval
- AuditLogs — Entity - Approvals - Handles audit log entries
- Authentication — Entity - Authentication - Handles user authentication
- ComponentHealthManager
- Consumers — Entity - Consumers - Handles Consumers within the system
- CustomProperties — Entity - Custom property
- CustomPropertyTypes — Entity - Custom property type
- CustomPropertyValues — Entity - Custom property value
- DataExport — Entity - Data Export - Exports information from the system
- Deploy — Entity - Deployment - Interrogates the AgentDeploymentJob and AgentDeploymentDevice tables
- Devices — Entity - Devices - Interrogates the Devices table in the database
- EventSource
- EventSubscriptionAssignments — Entity - EventSubscriptionAssignments - handles Event Subscription Assignments
- EventSubscriptions — Entity - EventSubscriptions - handles Event Subscriptions
- Expressions — Entity - Expressions - Provides services pertaining expressions
- Fragments
- Information (default) — Entity - Information - Consumer API information (default)
- InstructionDefinitions — Entity - Instruction Definitions - Interrogates the InstructionDefinition table
- InstructionHierarchies — Entity - InstructionHierarchies - Interrogates related instruction definitions
- Instructions — Entity - Instructions (Questions and Actions) - Interrogates the Instruction table
- InstructionSets — Entity - InstructionSets - handles instruction set management
- InstructionStatistics — Entity - Instruction Statistics - handles instruction statistics
- ManagementGroups — Entity - ManagementGroups - handles management groups
- Notifications — Entity - Notifications - handles system notifications
- Permissions — Entity - Role Based Access Control - Interrogates the Permission table in the database
- Policies
- Policy
- PolicyAssignments
- PrincipalRoleManagementGroups — Entity - Role Based Access Control - Interrogates the PrincipalRoleManagementGroup table in the database
- PrincipalRoles — Entity - Role Based Access Control - Interrogates the PrincipalRole table in the database
- Principals — Entity - Role Based Access Control - Interrogates the Principal table in the database
- PrincipalSearch — Entity - Role Based Access Control - Interrogates the User and Groups in Active Directory
- ProductPacks — Entity - Product Packs
- RelatedInstructionDefinitions — Entity - Related Instruction Definitions
- ResponseErrors — Entity - Response Errors
- Responses — Entity - Response
- ResponseTemplates — Entity - ResponseTemplates - handles Response Templates
- Role — Entity - Role Based Access Control - Interrogates the Roles table in the database
- Rules
- ScheduledInstructions — Entity - ScheduledInstructions - Interrogates the ScheduledInstruction table
- SecurableTypes — Entity - Role Based Access Control - Interrogates the SecurableType table in the database
- Settings — Entity - Global Settings - Interrogates Global Settings table
- SystemInformation — Entity - System Information - Returns information about the system
- SystemStatistics — Entity - System Statistics - Interrogates the instrumentation statistics of the system
- Tasks — Entity - Tasks- handles Tasks and Task Groups
- TriggerTemplates
Using scope and filter expressions
How to use create Expression objects used by many API endpoints as filter or scope definitions.
How to guides
Section describing some basic and common Tachyon operations using the Consumer API and Consumer SDK.
- Add and remove Instruction Definitions and organize them into Instruction Sets
- Find the right instruction definition
- Getting data from Tachyon clients
- Handling errors returned by Tachyon
- Issue an instruction, track its progress and retrieve responses
- Set up in instruction to be executed on a schedule
- Set up Principals, Roles and Permissions, for Tachyon version 8.0 and later
- Set up Principals, Roles and Permissions, up to and including Tachyon version 5.2