Create Data model (ivnCreateDataModel)
§ |
This web service is invoked to create a data model for accessing the data using the connection defined in Intelliview NXT. |
§ |
User requires “Admin” privilege (User parameter in ivnInitialize) for the execution of this API. |
Web Service Request:
public string ivnCreateDataModel(string SessionToken, int CompanyID, string DataModelName, int ConnectionID, int ScheduleRefreshTimeOption, int TimeOut, int DataModelType, string DataModelQuery)
Web Service Request Parameters:
Parameters |
Data Type |
Description |
Remarks |
SessionToken |
String |
The unique Identification assigned |
|
CompanyID |
Integer |
The unique Identification assigned |
|
DataModelName |
String |
Name of the Data Model |
|
ConnectionID |
Integer |
The unique Identification assigned |
|
ScheduleRefreshTimeOption |
Integer |
Defines the data refresh interval in |
|
TimeOut |
Integer |
SQL Query Time out |
|
DataModelType |
Integer |
Data Model Type |
Valid Values” |
DataModelQuery |
String |
Data Model Query |
|
Web Service Response (Success):
<ResponseMessage>
<Message ID='SYN_REP_INFO_7553'/>
<Response Message= 'Data model creation is successful'/>
<Datamodel ID='6'/>
<Company ID='23'/>
<Version No='1.3.1.1'/>
</ResponseMessage>
Web Service Response (Error):
<ResponseMessage>
<Message ID='SYN_REP_ERROR_7519'/>
<Response Message= 'Datamodel name is not valid'/>
<Company ID='23'/>
<Version No='1.3.1.1'/>
</ResponseMessage>
Web Service Return Parameters:
Parameters |
Data Type |
Description |
Remarks |
Message ID |
String |
The unique identification assigned to the |
|
ResponseMessage |
String |
response message in Intelliview NXT. |
Only English Language is |
Datamodel ID |
Integer |
The Response Message is received |
Returned on success; |
Company ID |
Integer |
The unique Identification assigned to the |
|
Version No |
String |
The unique Identification assigned to the |
|
|
|
The last digit after the third decimal point |
|
Response Messages:
Srl.No. |
Message ID |
Message |
1 |
SYN_REP_ERROR_3076 |
Datamodel already exists |
2 |
SYN_REP_ERROR_7501 |
Intelliview NXT session is expired or not initialized or |
3 |
SYN_REP_ERROR_7511 |
Company ID is not valid |
4 |
SYN_REP_ERROR_7519 |
Datamodel name is not valid |
5 |
SYN_REP_ERROR_7520 |
Datamodel type is not valid |
6 |
SYN_REP_ERROR_7521 |
Datamodel query is not valid |
7 |
SYN_REP_INFO_7553 |
Datamodel creation is successful |
8 |
SYN_REP_ERROR_7556 |
Connection ID is not valid |
9 |
SYN_REP_ERROR_7566 |
Unable to create Datamodel |
10 |
SYN_REP_ERROR_5035 |
Exception has occurred. Contact your Administrator |
<< Get Connection Details (ivnGetConnectionDetails) | Update Datamodel (ivnUpdateDataModel) >>