Describe the layout for processing Dataset object data in JavaScript Object Notation (JSON) format.
Dataset JSON layout
The Dataset JSON is composed in the following format:
Item | Required |
---|---|
version | O |
Parameters | X |
Datasets | X |
version
Specify the version of the Dataset Layout.
"version" : "1.0",
Parameters
Specify the parameter values.
"Parameters": [ {"id": "ErrorCode", "value":0}, {"id": "ErrorMsg", "value":""}, {"id": "param1", "value":0}, {"id": "param2", "value":"0", "type":"string"} ]
Item | Required | Description |
---|---|---|
id | O | "Set the parameter name. ""ErrorCode"" and ""ErrorMsg"" are reserved keywords. If the ""ErrorCode"" field is not specified, the value will be treated as 0. If the ""ErrorMsg"" field is not specified, the ""ErrorCode"" value will be treated as ""SUCCESS"" if it is 0, or ""FAILED:"" otherwise." |
value | X | Integer, Float, String |
type | X | Set the data type. Refer to the typefield. |
"* ""ErrorCode"" and ""ErrorMsg"" are reserved keywords.
If the ""ErrorCode"" field is not specified, the value will be treated as 0.
If the ""ErrorMsg"" field is not specified, the ""ErrorCode"" value will be treated as ""SUCCESS"" if it is 0, or ""FAILED:"" otherwise."
Datasets
A Dataset is an element that includes Dataset object information, and it contains datasets in the form of objects in the arrangement.
Dataset
This is an element that contains information on one Dataset object and includes the ColumnInfo to represent the structure of the Dataset object and rows that contain the actual data of the Dataset object.
Item | Required | |
---|---|---|
id | O | |
ColumnInfo | O | |
ConstColumn | X | |
Column | O | |
Rows | O |
Dataset format details
Describe each item in the Dataset.
id
"id":"inData"
Item | Required | Description |
---|---|---|
id | O | This is the Dataset object IDd property value. |
ColumnInfo > ConstColumn
"ColumnInfo": { "ConstColumn": [ {"id":"ConstCol1", "value":10}, {"id":"ConstCol2", "type":"string", "size":"256", "value":10}, {"id":"ConstCol3"} ] }
Item | Required | Description |
---|---|---|
id | O | This is the ID value to be used as the Const Column ID in the Dataset object. |
type | X | Set the data type. Refer to the type field. |
size | X | "Set the maximum data size. If omitted, it will be treated as a threshold based on the type. However, if the type is ""STRING,"" it will be treated as 255." |
value | X | "Set a fixed value. If it is not set, it will be treated as an undefined value." |
ColumnInfo > Column
"ColumnInfo": { "Column" : [ {"id":"Column0"}, {"id":"Column1", "type":"string", "size":"256"}, {"id":"Column2", "type":"string", "size":"256"} ] }
Item | Required | Description |
---|---|---|
id | O | This is the ID value to be used as the Column ID in the Dataset. |
type | X | Set the data type. If omitted, it will be treated as "STRING." Refer to the type field. |
size | X | "Set the maximum data size. If omitted, it will be treated as a threshold based on the type. However, if the type is ""STRING,"" it will be treated as 255." |
prop | X | Sets the value of the prop property of the ColumnInfo object. |
sumtext | X | Sets the value of the sumtext property of the ColumnInfo object. |
Rows
"Rows": [ {"_RowType_":"U", "Column0":"", "Column1":"zzz", "Column2":""}, {"_RowType_":"O", "Column0":"", "Column2":""}, {"_RowType_":"N", "Column0":"A", "Column1":"B", "Column2":""}, {"_RowType_":"D", "Column0":"a", "Column1":"b", "Column2":"c"}, {"_RowType_":"I", "Column0":"", "Column1":"", "Column2":""} ] "Rows": [ {"Column0":"A", "Column1":"B"}, {"Column0":"a", "Column1":"b", "Column2":"c"}, {"Column0":"", "Column1":"", "Column2":""} ]
Item | Required | Description |
---|---|---|
_RowType_ | X | Set the record type. N: Normal Record (Default) I: Inserted Record U: Updated Record D: Deleted Record O: Original Record (This is the original record of the Update Record) |
<ConstColumn id> | X | Set the ConstColumn value. |
<Column id> | O | Set the Column value. |
"* There is meaning to the order of the row data.
If the _RowType_ property value is ""O,"" for example, it means that it is the original row of the immediately preceding row.
It will only work if the value of the _RowType_ property of the immediately preceding row is ""U.""
If the value of the _RowType_ property is ""O"" and the value of the _RowType_ property of the immediately preceding row is not ""U,"" the row will be ignored. Also, if the value of the _RowType_ property of the first row is ""O,"" the row will be ignored."
Note
type
The following values can be used for the type fields in Parameters, ConstColumn, and Column.
If Parameters and ConstColumn are not set, the type will be treated as "INT" and "FLOAT" in the case of Integer and Float, depending on the value, and as "STRING" in other cases.
Type | Description |
---|---|
STRING | The string is limited to 2 GB in size, which is the size that the system can allocate at once. The maximum size can be used regardless of the size of the column. |
INT | Integer (-231 ~ 231-1) |
FLOAT, DECIMAL | Real number (±2.2X10-308 ~ ±1.7X10308) |
BIGDECIMAL | Real number (saved as a string) (±10-1056 ~ ±10+1056) |
DATE | Date YYYYMMDD (-8192/01/01 ~ 8191/12/31) |
DATETIME | YYYYMMDDHHmmssuuu (may include msec) |
TIME | 6-digit HHmmssuuu (may include msec) |
BLOB | Binary data |
JSON example
{ "version" : "1.0", "Parameters": [ {"id":"ErrorCode", "value":0}, {"id":"ErrorMsg", "value":""}, {"id":"param1", "value":0}, {"id":"param2", "value":"0", "type":"string"} ], "Datasets" : [ { "id":"indata", "ColumnInfo": { "ConstColumn": [ {"id":"ConstCol1", "value":10}, {"id":"ConstCol2", "type":"string", "size":"256", "value":10}, {"id":"ConstCol3"} ], "Column" : [ {"id":"Column0"}, {"id":"Column1", "type":"string", "size":"256"}, {"id":"Column2", "type":"string", "size":"256"} ] }, "Rows": [ {"_RowType_":"U", "Column0":"", "Column1":"zzz", "Column2":""}, {"_RowType_":"O", "Column0":"", "Column2":""}, {"_RowType_":"N", "Column0":"A", "Column1":"B", "Column2":""}, {"_RowType_":"D", "Column0":"a", "Column1":"b", "Column2":"c"}, {"_RowType_":"I", "Column0":"", "Column1":"", "Column2":""} ] }, { "id": "indata2", "ColumnInfo": { "Column": [ {"id":"Column0"}, {"id":"Column1", "type":"string", "size":"256"}, {"id":"Column2", "type":"string", "size":"256"} ] }, "Rows": [ {"Column0":"A", "Column1":"B"}, {"Column0":"a", "Column1":"b", "Column2":"c"}, {"Column0":"", "Column1":"", "Column2":""} ] } ] }