Each API endpoint is documented on a separate page. Pages are version controlled.

Page version: 127, last updated:


On this page:

Overview

This page lists every endpoint provided by the Consumer API which is a RESTful API consumed by the Tachyon Explorer UI and other Consumers. Although Tachyon has other APIs, the Consumer API is the only one supported for use by third party Consumers.

The URL used for requests is https://{tachyonConsumerServer}/Consumer/{request}

The text shown in example responses is spaced out for readability, normally they are compacted JSON on a single line with no white space between fields to minimize transmitted data.

API endpoints can be viewed and tested using a tool like the Postman, Fiddler or Advanced REST client extension for Chrome, but your chosen tool must support Windows Authentication.

In lab and test environments it's possible to configure Tachyon to use Basic Authentication over HTTPS using tools that only support this protocol where you would pass credentials explicitly rather than rely on NTLM challenge/response authentication.

This is useful where the account context in which the API call is made is not the account context in which you'd like the call processed. For example, when interacting with subsystems such as Workflow you may wish to make calls in the context of the requester and the responder but without having to switch interactive desktop sessions as the caller.

Exploring the API using the web browser

Although the Tachyon Consumer API is documented in the child pages to this page, you can also explore it using the inbuilt API documentation. This is available through your browser and managed through the Swagger subsystem by browsing to:

https://<tachyon server>/Consumer/swagger

Where <tachyon server> is the URL of your Tachyon Server, which redirects to the API reference page.

Each API is expandable, by clicking on it, you can view additional information about the API.

Tool settings

Postman

In Postman this setting and support for Windows Authentication, varies from version to version. For example, in the Chrome App version it's done automatically when No Auth option is selected.

In new standalone application, you should select 'NTLM Authentication (Beta)' and fill in the 'UserName', 'Password' and 'Domain' fields.

Fiddler

In Fiddler check Automatically Authenticate on the Composer->Options tab.

Advanced REST client

Google App Runtime for Chrome (ARC) requires the XHR extension turned on (the triple dot menu, top right of the window).

Error Conditions

If an error occurs, for example you use /Consumer/InstructionDefinitions/33333 when there are only 23 instruction definitions, the Consumer API returns a 404 error and XML error message, for example:

HTTP/1.1 404 Not Found 
 Cache-Control: no-cache 
 Pragma: no-cache 
 Content-Type: application/xml; charset=utf-8 
 Expires: -1 
 Server: Microsoft-IIS/10.0 
 X-AspNet-Version: 4.0.30319 
 Persistent-Auth: true 
 X-Powered-By: ASP.NET 
 Date: Thu, 04 Feb 2016 11:34:59 GMT 
 Content-Length: 142 
{ 
  "Message": "No HTTP resource was found that matches the request URI ' https://tachyondogfood.1e.local/Consumer/InstructionDefinitions/33333 '."
 }

Consumer API SDK assembly

From v1.7 Tachyon provides an assembly to consume Consumer API. This assembly is versioned and wraps all the consumer API end points available in a version.

Release Notes

Api changes between Tachyon 4.0 and 4.1

There have been no API endpoints introduced, deprecated or removed in version 4.1.

Api changes between Tachyon 4.1 and 5.0

  • Consumer/PrincipalSearch method using GET verb is now deprecated and will be removed in a future version. Please use Consumer/PrincipalSearch using POST verb instead.
  • Consumer/PrincipalSearch method using POST verb has been added to augment Active Directory user and group search with the capability to request limiting the number of results returned, define sorting and explicitly specify type of AD objects to search (users, groups or both)
  • Consumer/SystemInformation/IsConsumerLicensed/Name/{name} method using GET verb has been added to allow checking consumer's licensed status by consumer name.
  • Consumer/SystemInformation/IsConsumerLicensed/Id/{id} method using GET verb has been added to allow checking consumer's licensed status by consumer Id.
  • Consumer/SystemInformation/LicensedConsumers method using GET verb has been added to allow retrieval of all licensed consumers.
  • Consumer/EventSubscriptionAssignments API has been introduced. It has 5 methods. This API and its methods have been introduced to support eventing mechanism.
  • Consumer/EventSubscriptions API has been introduced. It has 10 methods. This API and its methods have been introduced to support eventing mechanism.


 Click here to expand...

  • ApplicableOperations

    Entity - Role Based Access Control - Interrogates the SecurableType table in the database

    Page version: 28 , last updated:


  • Approvals

    Entity - Approvals - Handles instruction approval

    Page version: 21, last updated:


  • AuditLogs

    Entity - Approvals - Handles audit log entries

    Page version: 6, last updated:


  • Authentication

    Entity - Authentication - Handles user authentication

    Page version: 8, last updated:


  • ComponentHealthManager

    Minimum API version 5.1

    WebRequestNotesPermission Required
    GET/Consumer/ComponeneHealthManagerReturns all information about component health for the entire system'Read' on 'Infrastructure'
  • Consumers

    Entity - Consumers - Handles Consumers within the system

    Page version: 20, last updated:


  • CustomProperties

    Entity - Custom property

    Page version: 14, last updated:


  • CustomPropertyTypes

    Entity - Custom property type

    Page version: 10, last updated:


  • CustomPropertyValues

    Entity - Custom property value

    Page version: 10, last updated:


  • DataExport

    Entity - Data Export - Exports information from the system

    Page version: 22, last updated:


  • Deploy

    Entity - Deployment - Interrogates the AgentDeploymentJob and AgentDeploymentDevice tables

    Page version: 46, last updated:


  • Devices

    Entity - Devices - Interrogates the Devices table in the database

    Page version: 51, last updated:


  • EventSource

    Entity - EventSource - handles Event Sources

    Minimum API version 5.1

    VerbRequestNotesPermissions required
  • EventSubscriptionAssignments

    Entity - EventSubscriptionAssignments - handles Event Subscription Assignments

    Page version: 9, last updated:

    Minimum API version 5.0

  • EventSubscriptions

    Entity - EventSubscriptions - handles Event Subscriptions

    Page version: 12, last updated:

    Minimum API version 5.0

  • Expressions

    Entity - Expressions - Provides services pertaining expressions

    Page version: 16, last updated:


  • Fragments

    Entity - Fragments

    Minimum API version 4.0

    VerbRequestNotesPermission required
  • Information (default)

    Entity - Information - Consumer API information (default)

    Page version: 16, last updated:


  • InstructionDefinitions

    Entity - Instruction Definitions - Interrogates the InstructionDefinition table

    Page version: 40, last updated:


  • InstructionHierarchies

    Entity - InstructionHierarchies - Interrogates related instruction definitions

    Page version: 6, last updated:


  • Instructions

    Entity - Instructions (Questions and Actions) - Interrogates the Instruction table

    Page version: 44, last updated:


  • InstructionSets

    Entity - InstructionSets - handles instruction set management

    Page version: 12, last updated:

    Minimum API version 3.1 


  • InstructionStatistics

    Entity - Instruction Statistics - handles instruction statistics

    Page version: 9, last updated:


  • ManagementGroups

    Entity - ManagementGroups - handles management groups

    Page version: 33, last updated:

    Minimum API version 3.3 


  • Notifications

    Entity - Notifications - handles system notifications

    Page version: 6, last updated:


  • Permissions

    Entity - Role Based Access Control - Interrogates the Permission table in the database

    Page version: 25, last updated:


  • Policies

    Entity - Policies

    Minimum API version 4.0

    VerbRequestNotesPermissions required
  • Policy

    Entity - Policy

    Minimum API version 4.0

    VerbRequestNotesPermissions required
  • PolicyAssignments

    Entity - Policy Assignments

    Minimun API version 4.0

    VerbRequestNotesPermissions required
  • PrincipalRoles

    Entity - Role Based Access Control - Interrogates the PrincipleRole table in the database

    Page version: 15, last updated:


  • Principals

    Entity - Role Based Access Control - Interrogates the Principal table in the database

    Page version: 15, last updated:


  • PrincipalSearch

    Entity - Role Based Access Control - Interrogates the User and Groups in Active Directory

    Page version: 19, last updated:


  • ProductPacks

    Entity - Product Packs

    Page version: 20, last updated:


  • RelatedInstructionDefinitions

    Entity - Related Instruction Definitions

    Page version: 13, last updated:


  • ResponseErrors

    Entity - Response Errors

    Page version: 21, last updated:


  • Responses

    Entity - Response

    Page version: 22, last updated:


  • ResponseTemplates

    Entity - ResponseTemplates - handles Response Templates

    Page version: 7, last updated:


  • Role

    Entity - Role Based Access Control - Interrogates the Roles table in the database

    Page version: 19, last updated:


  • Rules

    Entiry - Rules

    Minimum API version 4.0

    VerbRequestNotesPermissions Required
  • ScheduledInstructions

    Entity - ScheduledInstructions - Interrogates the ScheduledInstruction table

    Page version: 22, last updated:


  • SecurableTypes

    Entity - Role Based Access Control - Interrogates the SecurableType table in the database

    Page version: 17, last updated:


  • Settings

    Entity - Global Settings - Interrogates Global Settings table

    Page version: 5, last updated:


  • SystemInformation

    Entity - System Information - Returns information about the system

    Page version: 25, last updated:


  • SystemStatistics

    Entity - System Statistics - Interrogates the instrumentation statistics of the system

    Page version: 18, last updated:


  • Tasks

    Entity - Tasks- handles Tasks and Task Groups

    Page version: 6, last updated:


  • TriggerTemplates

    Entity - Trigger templates

    Minimum API version 4.0

    VertRequestNotesPermissions required