POST api/DashboardBuilder/TestConnection

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DB_Server_ID	integer	None.
DatabaseName	string	None.
DatabaseType	string	None.
ServerType	string	None.
ServerName	string	None.
AuthenticationType	string	None.
UserName	string	None.
Password	string	None.
Port	integer	None.
ServiceName	string	None.
IntegratedSecurity	boolean	None.
CREATED_BY_USERNAME	string	None.
CREATED_BY_USER	string	None.
UPDATED_BY_USERNAME	string	None.
UPDATED_BY_USER	string	None.
UsedInDataset	integer	None.
API_TOKEN	string	None.
Dataset_Id	integer	None.
columnName	string	None.
ISACTIVE	integer	None.
USERID	integer	None.
CURRENTUSERROLEID	integer	None.
CURRENTSCREENID	integer	None.
CREATED_BY	integer	None.
CREATED_DATE	date	None.
UPDATED_BY	integer	None.
UPDATED_DATE	date	None.
UNIT_ID	integer	None.
LINE_ID	integer	None.
PLANT_ID	integer	None.
ORG_ID	integer	None.
ISCHILDRESULT	boolean	None.
PageSize	integer	None.
PageNumber	integer	None.
SortBy	string	None.
SortOrder	string	None.
SearchFilter	string	None.
SESSIONID	integer	None.
CURRENTSESSIONID	string	None.
ISLOGGEDIN	boolean	None.
MOB_PLAYERID	string	None.
ISWEBLOGIN	boolean	None.
OptTime	string	None.
Date	string	None.
AuditLogID	integer	None.
OperationType	string	None.
ScreenName	string	None.
Description	string	None.
ACTION_USER_NAME	string	None.
OperationDateTime	date	None.
SUBSCRIPTION_ID	string	None.
CONSUMED_TOKEN_CNT	integer	None.
TOTAL_TOKEN_SIZE	integer	None.
TOTAL_CONSUMED_SIZE	string	None.
AI_FLAG	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "DB_Server_ID": 1,
  "DatabaseName": "sample string 1",
  "DatabaseType": "sample string 2",
  "ServerType": "sample string 3",
  "ServerName": "sample string 4",
  "AuthenticationType": "sample string 5",
  "UserName": "sample string 6",
  "Password": "sample string 7",
  "Port": 1,
  "ServiceName": "sample string 8",
  "IntegratedSecurity": true,
  "CREATED_BY_USERNAME": "sample string 9",
  "CREATED_BY_USER": "sample string 10",
  "UPDATED_BY_USERNAME": "sample string 11",
  "UPDATED_BY_USER": "sample string 12",
  "UsedInDataset": 13,
  "API_TOKEN": "sample string 14",
  "Dataset_Id": 1,
  "columnName": "sample string 15",
  "ISACTIVE": 1,
  "USERID": 1,
  "CURRENTUSERROLEID": 1,
  "CURRENTSCREENID": 16,
  "CREATED_BY": 1,
  "CREATED_DATE": "2026-01-23T19:35:23.1176114+05:30",
  "UPDATED_BY": 1,
  "UPDATED_DATE": "2026-01-23T19:35:23.1176114+05:30",
  "UNIT_ID": 1,
  "LINE_ID": 1,
  "PLANT_ID": 1,
  "ORG_ID": 1,
  "ISCHILDRESULT": true,
  "PageSize": 1,
  "PageNumber": 1,
  "SortBy": "sample string 17",
  "SortOrder": "sample string 18",
  "SearchFilter": "sample string 19",
  "SESSIONID": 1,
  "CURRENTSESSIONID": "sample string 20",
  "ISLOGGEDIN": true,
  "MOB_PLAYERID": "sample string 21",
  "ISWEBLOGIN": true,
  "OptTime": "sample string 22",
  "Date": "sample string 23",
  "AuditLogID": 1,
  "OperationType": "sample string 24",
  "ScreenName": "sample string 25",
  "Description": "sample string 26",
  "ACTION_USER_NAME": "sample string 27",
  "OperationDateTime": "2026-01-23T19:35:23.1176114+05:30",
  "SUBSCRIPTION_ID": "sample string 28",
  "CONSUMED_TOKEN_CNT": 1,
  "TOTAL_TOKEN_SIZE": 1,
  "TOTAL_CONSUMED_SIZE": "sample string 29",
  "AI_FLAG": 1
}

multipart/form-data

Sample:

{"DB_Server_ID":1,"DatabaseName":"sample string 1","DatabaseType":"sample string 2","ServerType":"sample string 3","ServerName":"sample string 4","AuthenticationType":"sample string 5","UserName":"sample string 6","Password":"sample string 7","Port":1,"ServiceName":"sample string 8","IntegratedSecurity":true,"CREATED_BY_USERNAME":"sample string 9","CREATED_BY_USER":"sample string 10","UPDATED_BY_USERNAME":"sample string 11","UPDATED_BY_USER":"sample string 12","UsedInDataset":13,"API_TOKEN":"sample string 14","Dataset_Id":1,"columnName":"sample string 15","ISACTIVE":1,"USERID":1,"CURRENTUSERROLEID":1,"CURRENTSCREENID":16,"CREATED_BY":1,"CREATED_DATE":"2026-01-23T19:35:23.1176114+05:30","UPDATED_BY":1,"UPDATED_DATE":"2026-01-23T19:35:23.1176114+05:30","UNIT_ID":1,"LINE_ID":1,"PLANT_ID":1,"ORG_ID":1,"ISCHILDRESULT":true,"PageSize":1,"PageNumber":1,"SortBy":"sample string 17","SortOrder":"sample string 18","SearchFilter":"sample string 19","SESSIONID":1,"CURRENTSESSIONID":"sample string 20","ISLOGGEDIN":true,"MOB_PLAYERID":"sample string 21","ISWEBLOGIN":true,"OptTime":"sample string 22","Date":"sample string 23","AuditLogID":1,"OperationType":"sample string 24","ScreenName":"sample string 25","Description":"sample string 26","ACTION_USER_NAME":"sample string 27","OperationDateTime":"2026-01-23T19:35:23.1176114+05:30","SUBSCRIPTION_ID":"sample string 28","CONSUMED_TOKEN_CNT":1,"TOTAL_TOKEN_SIZE":1,"TOTAL_CONSUMED_SIZE":"sample string 29","AI_FLAG":1}

application/xml, text/xml

Sample:

<DatabaseServer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPMS.FT.Business.Entities.ViewModel">
  <ACTION_USER_NAME>sample string 27</ACTION_USER_NAME>
  <AI_FLAG>1</AI_FLAG>
  <AuditLogID>1</AuditLogID>
  <CONSUMED_TOKEN_CNT>1</CONSUMED_TOKEN_CNT>
  <CREATED_BY>1</CREATED_BY>
  <CREATED_DATE>2026-01-23T19:35:23.1176114+05:30</CREATED_DATE>
  <CURRENTSCREENID>16</CURRENTSCREENID>
  <CURRENTSESSIONID>sample string 20</CURRENTSESSIONID>
  <CURRENTUSERROLEID>1</CURRENTUSERROLEID>
  <Date>sample string 23</Date>
  <Description>sample string 26</Description>
  <ISACTIVE>1</ISACTIVE>
  <ISCHILDRESULT>true</ISCHILDRESULT>
  <ISLOGGEDIN>true</ISLOGGEDIN>
  <ISWEBLOGIN>true</ISWEBLOGIN>
  <LINE_ID>1</LINE_ID>
  <MOB_PLAYERID>sample string 21</MOB_PLAYERID>
  <ORG_ID>1</ORG_ID>
  <OperationDateTime>2026-01-23T19:35:23.1176114+05:30</OperationDateTime>
  <OperationType>sample string 24</OperationType>
  <OptTime>sample string 22</OptTime>
  <PLANT_ID>1</PLANT_ID>
  <PageNumber>1</PageNumber>
  <PageSize>1</PageSize>
  <SESSIONID>1</SESSIONID>
  <SUBSCRIPTION_ID>sample string 28</SUBSCRIPTION_ID>
  <ScreenName>sample string 25</ScreenName>
  <SearchFilter>sample string 19</SearchFilter>
  <SortBy>sample string 17</SortBy>
  <SortOrder>sample string 18</SortOrder>
  <TOTAL_CONSUMED_SIZE>sample string 29</TOTAL_CONSUMED_SIZE>
  <TOTAL_TOKEN_SIZE>1</TOTAL_TOKEN_SIZE>
  <UNIT_ID>1</UNIT_ID>
  <UPDATED_BY>1</UPDATED_BY>
  <UPDATED_DATE>2026-01-23T19:35:23.1176114+05:30</UPDATED_DATE>
  <USERID>1</USERID>
  <API_TOKEN>sample string 14</API_TOKEN>
  <AuthenticationType>sample string 5</AuthenticationType>
  <CREATED_BY_USER>sample string 10</CREATED_BY_USER>
  <CREATED_BY_USERNAME>sample string 9</CREATED_BY_USERNAME>
  <DB_Server_ID>1</DB_Server_ID>
  <DatabaseName>sample string 1</DatabaseName>
  <DatabaseType>sample string 2</DatabaseType>
  <Dataset_Id>1</Dataset_Id>
  <IntegratedSecurity>true</IntegratedSecurity>
  <Password>sample string 7</Password>
  <Port>1</Port>
  <ServerName>sample string 4</ServerName>
  <ServerType>sample string 3</ServerType>
  <ServiceName>sample string 8</ServiceName>
  <UPDATED_BY_USER>sample string 12</UPDATED_BY_USER>
  <UPDATED_BY_USERNAME>sample string 11</UPDATED_BY_USERNAME>
  <UsedInDataset>13</UsedInDataset>
  <UserName>sample string 6</UserName>
  <columnName>sample string 15</columnName>
</DatabaseServer>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, multipart/form-data, application/xml, text/xml

Sample:

Sample not available.