POST api/DashboardBuilder/CreateDataSet
Request Information
URI Parameters
None.
Body Parameters
NewDataSet| Name | Description | Type | Additional information |
|---|---|---|---|
| dataset_name | string |
None. |
|
| query | string |
None. |
|
| DatabaseName | string |
None. |
|
| DatabaseType | string |
None. |
|
| Database_Id | integer |
None. |
|
| Dataset_Id | integer |
None. |
|
| ViewName | string |
None. |
|
| API_DATASET_FIELDS | Collection of string |
None. |
|
| API_COLUMN_DATATYPE | Dictionary of string [key] and string [value] |
None. |
|
| ChartFields | ChartFields |
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:
{
"dataset_name": "sample string 1",
"query": "sample string 2",
"DatabaseName": "sample string 3",
"DatabaseType": "sample string 4",
"Database_Id": 1,
"Dataset_Id": 1,
"ViewName": "sample string 5",
"API_DATASET_FIELDS": [
"sample string 1",
"sample string 2"
],
"API_COLUMN_DATATYPE": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"ChartFields": {
"Names": "sample string 1",
"Values": [
{
"Name": "sample string 1",
"MetricColumnOption": "sample string 2",
"MetricsColumnAggregate": "sample string 3"
},
{
"Name": "sample string 1",
"MetricColumnOption": "sample string 2",
"MetricsColumnAggregate": "sample string 3"
}
]
},
"ISACTIVE": 1,
"USERID": 1,
"CURRENTUSERROLEID": 1,
"CURRENTSCREENID": 6,
"CREATED_BY": 1,
"CREATED_DATE": "2026-01-23T19:34:27.5680523+05:30",
"UPDATED_BY": 1,
"UPDATED_DATE": "2026-01-23T19:34:27.5680523+05:30",
"UNIT_ID": 1,
"LINE_ID": 1,
"PLANT_ID": 1,
"ORG_ID": 1,
"ISCHILDRESULT": true,
"PageSize": 1,
"PageNumber": 1,
"SortBy": "sample string 7",
"SortOrder": "sample string 8",
"SearchFilter": "sample string 9",
"SESSIONID": 1,
"CURRENTSESSIONID": "sample string 10",
"ISLOGGEDIN": true,
"MOB_PLAYERID": "sample string 11",
"ISWEBLOGIN": true,
"OptTime": "sample string 12",
"Date": "sample string 13",
"AuditLogID": 1,
"OperationType": "sample string 14",
"ScreenName": "sample string 15",
"Description": "sample string 16",
"ACTION_USER_NAME": "sample string 17",
"OperationDateTime": "2026-01-23T19:34:27.5680523+05:30",
"SUBSCRIPTION_ID": "sample string 18",
"CONSUMED_TOKEN_CNT": 1,
"TOTAL_TOKEN_SIZE": 1,
"TOTAL_CONSUMED_SIZE": "sample string 19",
"AI_FLAG": 1
}
multipart/form-data
Sample:
{"dataset_name":"sample string 1","query":"sample string 2","DatabaseName":"sample string 3","DatabaseType":"sample string 4","Database_Id":1,"Dataset_Id":1,"ViewName":"sample string 5","API_DATASET_FIELDS":["sample string 1","sample string 2"],"API_COLUMN_DATATYPE":{"sample string 1":"sample string 2","sample string 3":"sample string 4"},"ChartFields":{"Names":"sample string 1","Values":[{"Name":"sample string 1","MetricColumnOption":"sample string 2","MetricsColumnAggregate":"sample string 3"},{"Name":"sample string 1","MetricColumnOption":"sample string 2","MetricsColumnAggregate":"sample string 3"}]},"ISACTIVE":1,"USERID":1,"CURRENTUSERROLEID":1,"CURRENTSCREENID":6,"CREATED_BY":1,"CREATED_DATE":"2026-01-23T19:34:27.5680523+05:30","UPDATED_BY":1,"UPDATED_DATE":"2026-01-23T19:34:27.5680523+05:30","UNIT_ID":1,"LINE_ID":1,"PLANT_ID":1,"ORG_ID":1,"ISCHILDRESULT":true,"PageSize":1,"PageNumber":1,"SortBy":"sample string 7","SortOrder":"sample string 8","SearchFilter":"sample string 9","SESSIONID":1,"CURRENTSESSIONID":"sample string 10","ISLOGGEDIN":true,"MOB_PLAYERID":"sample string 11","ISWEBLOGIN":true,"OptTime":"sample string 12","Date":"sample string 13","AuditLogID":1,"OperationType":"sample string 14","ScreenName":"sample string 15","Description":"sample string 16","ACTION_USER_NAME":"sample string 17","OperationDateTime":"2026-01-23T19:34:27.5680523+05:30","SUBSCRIPTION_ID":"sample string 18","CONSUMED_TOKEN_CNT":1,"TOTAL_TOKEN_SIZE":1,"TOTAL_CONSUMED_SIZE":"sample string 19","AI_FLAG":1}
application/xml, text/xml
Sample:
<NewDataSet 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 17</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:34:27.5680523+05:30</CREATED_DATE>
<CURRENTSCREENID>6</CURRENTSCREENID>
<CURRENTSESSIONID>sample string 10</CURRENTSESSIONID>
<CURRENTUSERROLEID>1</CURRENTUSERROLEID>
<Date>sample string 13</Date>
<Description>sample string 16</Description>
<ISACTIVE>1</ISACTIVE>
<ISCHILDRESULT>true</ISCHILDRESULT>
<ISLOGGEDIN>true</ISLOGGEDIN>
<ISWEBLOGIN>true</ISWEBLOGIN>
<LINE_ID>1</LINE_ID>
<MOB_PLAYERID>sample string 11</MOB_PLAYERID>
<ORG_ID>1</ORG_ID>
<OperationDateTime>2026-01-23T19:34:27.5680523+05:30</OperationDateTime>
<OperationType>sample string 14</OperationType>
<OptTime>sample string 12</OptTime>
<PLANT_ID>1</PLANT_ID>
<PageNumber>1</PageNumber>
<PageSize>1</PageSize>
<SESSIONID>1</SESSIONID>
<SUBSCRIPTION_ID>sample string 18</SUBSCRIPTION_ID>
<ScreenName>sample string 15</ScreenName>
<SearchFilter>sample string 9</SearchFilter>
<SortBy>sample string 7</SortBy>
<SortOrder>sample string 8</SortOrder>
<TOTAL_CONSUMED_SIZE>sample string 19</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:34:27.5680523+05:30</UPDATED_DATE>
<USERID>1</USERID>
<API_COLUMN_DATATYPE xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</API_COLUMN_DATATYPE>
<API_DATASET_FIELDS xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</API_DATASET_FIELDS>
<ChartFields>
<Names>sample string 1</Names>
<Values>
<Value>
<MetricColumnOption>sample string 2</MetricColumnOption>
<MetricsColumnAggregate>sample string 3</MetricsColumnAggregate>
<Name>sample string 1</Name>
</Value>
<Value>
<MetricColumnOption>sample string 2</MetricColumnOption>
<MetricsColumnAggregate>sample string 3</MetricsColumnAggregate>
<Name>sample string 1</Name>
</Value>
</Values>
</ChartFields>
<DatabaseName>sample string 3</DatabaseName>
<DatabaseType>sample string 4</DatabaseType>
<Database_Id>1</Database_Id>
<Dataset_Id>1</Dataset_Id>
<ViewName>sample string 5</ViewName>
<dataset_name>sample string 1</dataset_name>
<query>sample string 2</query>
</NewDataSet>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, multipart/form-data, application/xml, text/xml
Sample:
Sample not available.