Data Sync - Check Sync State Table

URI

https://164.99.19.131:8443/SentinelRESTServices/datasync/syncstatetable

Supported Methods

GET

This checks to see if a sync state table exists in a destination database.

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Response

URL Parameters

Required

ParameterTypeDescription
password String The password of the user.
schemaName String This is the schema the sync state table is to be checked. If this parameter is missing it defaults to the schema of the database user specified in the "userName" parameter.

Optional

ParameterTypeDefault ValueDescription
hostName String localhost Name or IP address of database system where the sync state table is to be checked. If this parameter is missing, the default value will be "localhost".
port int 5432 Port for communicating with the database system where the sync state table is to be checked. If this parameter is missing, the default value will be "5432".
database String SIEM The name of the database in the database system where the sync state table is to be checked. If this parameter is missing, the default value will be "SIEM".
userName String appuser Name of the database user to login to the database system where the sync state table is to be checked. If this parameter is missing, the default value will be "appuser".
dbPlatform String postgresql This is the platform of the database system where the sync state table is to be checked. It may be <strong>postgresql</strong>, <strong>oracle11g</strong> or <strong>mssql2008</strong>. If this parameter is missing, the default value will be "postgresql".

Success Codes

Fault Codes

Response Data

Object type: Database syncstate table
Information about the database syncstate table
FieldDescription
valueContains a boolean flag ("true" or "false") indicating whether the sync state table exists.

Sample Request

GET /datasync/syncstatetable?hostName=164.99.19.125&port=5432&userName=appuser&password=star1111&dbPlatform=postgresql&schemaName=my_schema
Sample Response for application/json
Status: 200
{&#10;"value": "true"{&#10;}&#10;