TIX 6 System API

Private API for controlling the internals in the TIX.

POST /system/alarm-processing

The endpoint allows the alarm process to be paused, no alarms will be triggered when the process is paused.

Parameter

Description

action

The action to take on the queues

Value	Description
pause	Pause all alarm processing
resume	Resumes all alarm processing

query

POST /system/alarm-processing?action=pause

alarm-processing: paused

POST /system/clearCache

Clear one or more cache

Parameter

Description

cache

Name of the cache to clear

Value	Description
GNS	Clear GNS cache
MDS	Clear master data cache
MAPPING	Clear organization mapping

query

POST /system/clearCache?cache=GNS

Cache [GNS] cleared.

POST /system/clearLocks

Clear all locks for specific node in case of stuck locks

Parameter	Description
confirmation	confirmation code required to execute the clear	query
nodeId	node to clear	query

POST /system/clearLocks?nodeId=0800001908000077&confirmation=452afc829e7f4b1d9250d353ba7f3183dcee96c

Node GAN[0800001908000077] locks have been cleared.

POST /system/queues

Parameter

Description

action

The action to take on the queues

Value	Description
pause	Pause all queues in the TIX
resume	Resumes all queues

query

POST /system/queues?action=pause

<queues-state>
  <paused>true</paused>
  <since>2013-07-29T11:07:03.928+02:00</since>
</queues-state>

POST /system/queues?action=resume

<queues-state>
  <paused>true</paused>
</queues-state>

POST /system/remote-replication

This endpoint makes it possible to enable remote replication where all imports are replicated to a remote TIX instance.

Parameter

Description

action

The action to take on the synchronous imports

Value	Description
pause	Pause all subscription processing
resume	Resumes, enables all subscription processing

query

remote.connection-factory

the name of the remote connection factory to use, ignored if action parameter is not resume

query

remote.context-factory

the name of the context factory, ignored if action parameter is not resume

query

remote.provider-url

the URL to the other TIX, ignored if action parameter is not resume

query

remote.username

the username to use when creating a connection, ignored if action parameter is not resume

query

remote.password

the password to use when creating a connection, ignored if action parameter is not resume

query

remote.queue-name

the name of the remote queue to send messages to, ignored if action parameter is not resume

query

POST /system/remote-replication?action=resume&remote.provider-url=remote://0.0.0.0:5247&remote.username=jmsuser&remote.password=jmspassword&remote.queue-name=jms/queue/RemotePreImportQueue&remote.context-factory=org.jboss.naming.remote.client.InitialContextFactory

remote-replication: resumed

POST /system/remote-replication?action=pause

remote-replication: paused

POST /system/subscription-processing

The endpoint allows subscription process to be paused, the subscription last record time will be updated but new events found by the subscription will not be sent to the subscribers.

Parameter

Description

action

The action to take on the synchronous imports

Value	Description
pause	Pause all subscription processing
resume	Resumes, enables all subscription processing

query

POST /system/subscription-processing?action=pause

subscription-processing: paused

POST /system/synchronous-import

The endpoint allow all synchronous imports to be disabled, all synchronous API resources will return 503 Service Unavailable when synchronous imports are paused.

Parameter

Description

action

The action to take on the synchronous imports

Value	Description
pause	Pause all synchronous imports
resume	Resumes, enables all synchronous imports

query

POST /system/synchronous-import?action=pause

synchronous-import: paused

Following resources will be affected by pausing synchronous imports.

Resource	Method
`/admin/dataAccess`	`POST`
`/admin/event`	`POST`
`/admin/object`	`POST`
`/alarm`	`DELETE, POST`
`/event/imediate`	`POST`
`/event/subscription/subscribe`	`GET`
`/event/subscription/unsubscribe`	`GET`
`EPCISServicePortTypeService`	`subscribe, unsubscribe`

POST /system/tabulaRasa

Calling system/tabulaRasa will clear all data belonging to a TIX node.

Calling without confirmation code will cause a confirmation code to be returned. This has a limited lifetime and must be provided in order to erase data. This endpoint is asynchronous, and will return a link to the audit log where the progress of the eraze can be view. The tabulaRasa is finished when the audits contains an audit where the newValue is tabulaRasa_COMPLETED.

Parameter	Description
confirmation	confirmation code required to execute the erase	query
nodeId	the node to clear	query

POST /system/tabulaRasa?nodeId=0800001908000077&confirmation=233eea34e278c650cc877f28398710b6ceca8bf

Location: /tix/api/xml/admin/auditlog?nodeId=0800001908000077&entityId=233eea34e278c650cc877f28398710b6ceca8bf

GET /tix/api/xml/admin/auditlog?nodeId=0800001908000077&entityId=233eea34e278c650cc877f28398710b6ceca8bf

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ns7:audits xmlns:ns7="http://www.tracetracker.com/audits">
  <ns7:audit>
    <ns7:created>2013-11-18T18:06:37.056+01:00</ns7:created>
    <ns7:entityId>233eea34e278c650cc877f28398710b6ceca8bf-1384794396602</ns7:entityId>
    <ns7:field>/system/tabulaRasa</ns7:field>
    <ns7:oldValue>tabulaRasa_REPUBLISH</ns7:oldValue>
    <ns7:newValue>tabulaRasa_COMPLETED</ns7:newValue>
    <ns7:username>administrator</ns7:username>
    <ns7:node>0800001908000077</ns7:node>
  </ns7:audit>
  <ns7:audit>
    <ns7:created>2013-11-18T18:06:36.998+01:00</ns7:created>
    <ns7:entityId>233eea34e278c650cc877f28398710b6ceca8bf-1384794396602</ns7:entityId>
    <ns7:field>/system/tabulaRasa</ns7:field>
    <ns7:oldValue>tabulaRasa_REMOVE_ALL</ns7:oldValue>
    <ns7:newValue>tabulaRasa_REPUBLISH</ns7:newValue>
    <ns7:username>administrator</ns7:username>
    <ns7:node>0800001908000077</ns7:node>
  </ns7:audit>
  <ns7:audit>
    <ns7:created>2013-11-18T18:06:36.955+01:00</ns7:created>
    <ns7:entityId>233eea34e278c650cc877f28398710b6ceca8bf-1384794396602</ns7:entityId>
    <ns7:field>/system/tabulaRasa</ns7:field>
    <ns7:oldValue>tabulaRasa_CLEAR_VOCABULARY_CACHE</ns7:oldValue>
    <ns7:newValue>tabulaRasa_REMOVE_ALL</ns7:newValue>
    <ns7:username>administrator</ns7:username>
    <ns7:node>0800001908000077</ns7:node>
  </ns7:audit>
  <ns7:audit>
    <ns7:created>2013-11-18T18:06:36.773+01:00</ns7:created>
    <ns7:entityId>233eea34e278c650cc877f28398710b6ceca8bf-1384794396602</ns7:entityId>
    <ns7:field>/system/tabulaRasa</ns7:field>
    <ns7:oldValue>tabulaRasa_CLEAR_QUEUE</ns7:oldValue>
    <ns7:newValue>tabulaRasa_CLEAR_VOCABULARY_CACHE</ns7:newValue>
    <ns7:username>administrator</ns7:username>
    <ns7:node>0800001908000077</ns7:node>
  </ns7:audit>
  <ns7:audit>
    <ns7:created>2013-11-18T18:06:36.717+01:00</ns7:created>
    <ns7:entityId>233eea34e278c650cc877f28398710b6ceca8bf-1384794396602</ns7:entityId>
    <ns7:field>/system/tabulaRasa</ns7:field>
    <ns7:newValue>tabulaRasa_CLEAR_QUEUE</ns7:newValue>
    <ns7:username>administrator</ns7:username>
    <ns7:node>0800001908000077</ns7:node>
  </ns7:audit>
  <ns7:audit>
    <ns7:created>2013-11-18T18:06:36.603+01:00</ns7:created>
    <ns7:entityId>233eea34e278c650cc877f28398710b6ceca8bf-1384794396602</ns7:entityId>
    <ns7:field>/system/tabulaRasa</ns7:field>
    <ns7:newValue>tabulaRasa_QUEUED</ns7:newValue>
    <ns7:username>administrator</ns7:username>
    <ns7:node>0800001908000077</ns7:node>
  </ns7:audit>
</ns7:audits> 