Entity - Consumers - Handles Consumers within the system

Page version: , last updated:



VerbRequestNotesPermissions requires
GET/Consumer/Consumers

This endpoint can be used to retrieve all consumers in the system.

This will return a collection of objects, each of which will have following fields:

Field nameDescription
Idthe ID of the consumer
NameName of the Consumer
OffloadTargetUrloffload address: the URL where the Responses shall be POSTed (including the http:// or https:// prefix)
OffloadPostTimeoutSecondsMaximum time in seconds that Tachyon will wait for the OffloadTarget to respond
OffloadUseWindowsAuthboolean flag defining whether Windows Authentification will be used by the Tachyon Core when connecting to the OffloadTarget
ApplicationUrla web Url where that consumer can be found. This field is optional and is mostly applicable to web based consumers
IsEnabledboolean flag defining if the consumer is enabled or not
SystemConsumerboolean flag defining if this is a system consumer.
MaximumSimultaneousInFlightInstructionsmaximum number of instructions issued by this consumer that can be 'in-flight' at any one time


Requires 'Read' permission on 'Consumer'
GET/Consumer/Consumers/Id/{Id}

This endpoint can be used to retrieve a single consumer by its Id.

Return object as above

Requires 'Read' permission on 'Consumer'
GET/Consumer/Consumers/Name/{Name}

This endpoint can be used to retrieve a single consumer by its Name (string must be Base64 encoded).

Return object as above

Requires 'Read' permission on 'Consumer'
POST/Consumer/Consumers/Search

Minimum API version 4.0

Returns consumers that fulfil parameters passed in the request body:

  • filter - filter expression.To learn about how to define filter check Using scope and filter expressions page.
  • sort - sort expression. To learn about how to define sort criteria check Sort Definition page.
  • start - starting index to support pagination. It begins from 1.
  • pagesize - number of results to fetch

Allowed filter columns:

  • Name
  • Enabled
  • MaximumSimultaneousInstructions
  • OffloadTargetUrl
  • SystemConsumer

Allowed sort columns:

  • Name
  • Enabled
  • MaximumSimultaneousInstructions
  • SystemConsumer
Requires 'Read' permission on 'Consumer'
POST/Consumer/Consumers

This endpoint can be used to add a new Consumer to the system.

Post body:

 Field NameDescriptionRequired?Notes
NameName of the ConsumerYes
  • Must be unique.
  • Must be alpha numeric without spaces.
OffloadTargetUrlOffload address: the URL where the Responses shall be POSTed (including the http:// or https:// prefix)NoIf provided must be a valid Url syntax-wise.
OffloadPostTimeoutSecondsMaximum time in seconds that Tachyon will wait for the OffloadTarget to respondNo 
OffloadUseWindowsAuthBoolean flag defining whether Windows Authentification will be used by the Tachyon Core when connecting to the OffloadTargetNo 
ApplicationUrlA web Url where that consumer can be found. This field is optional and is mostly applicable to web based consumersNoIf provided must be a valid Url syntax-wise.
IsEnabledBoolean flag defining if the consumer is enabled or notNoIf not provided will default to false, which will mean the consumer will be disabled.
MaximumSimultaneousInFlightInstructionsMaximum number of instructions issued by this consumer that can be 'in-flight' at any one timeYesMust be lower than global limit defined in the GlobalSettings table in the database.


Requires 'Write' permission on 'Consumer'
PUT/Consumer/Consumers 

This endpoint can be used to modify an existing Consumer within the system.

Put body:

 DescriptionRequired?Notes
IdId of the Consumer to be modifiedYes

Must be a valid consumer Id

NameName of the ConsumerYes
  • Must be unique.
  • Must be alpha numeric without spaces.
OffloadTargetUrlOffload address: the URL where the Responses shall be POSTed (including the http:// or https:// prefix)NoIf provided must be a valid Url syntax-wise.
OffloadPostTimeoutSecondsMaximum time in seconds that Tachyon will wait for the OffloadTarget to respondNo 
OffloadUseWindowsAuthBoolean flag defining whether Windows Authentification will be used by the Tachyon Core when connecting to the OffloadTargetNo 
ApplicationUrlA web Url where that consumer can be found. This field is optional and is mostly applicable to web based consumersNoIf provided must be a valid Url syntax-wise.
IsEnabledBoolean flag defining if the consumer is enabled or notNoIf not provided will default to false, which will mean the consumer will be disabled.
MaximumSimultaneousInFlightInstructionsMaximum number of instructions issued by this consumer that can be 'in-flight' at any one timeYes*
  • This value must be provided for non-system consumers.
  • Must be lower than global limit defined in the GlobalSettings table in the database.


Requires 'Write' permission on 'Consumer'
 DELETE/Consumer/Consumers/{Id} 

Deletes the consumer.

Preconditions: The Consumer cannot be in use by an Instruction or a Scheduled Instruction. System Consumers cannot be deleted.

Requires 'Write' permission on 'Consumer'
DELETE/Consumer/Consumers

Minimum API version 4.0

Deletes multiple consumers.

System consumers cannot be deleted. Consumers with scheduled instructions cannot be deleted.

Body of the request should contain an array of Consumer Ids.

Requires 'Write' permission on 'Consumer'