抓取單元資料 | API文件 | db2sys-智能雲端資料庫管理系統

curl https://www.db2sys.com.tw/api/v1/{Project_token}/{ProjectUnit_token}/{security_code}/list

Project_token

專案資源識別碼

ProjectUnit_token

單元資源識別碼

security_code

檢查碼

Path

/api/v1/{Project_token}/{ProjectUnit_token}/list

Http Method

GET｜POST

Content-type

application/form-data

query-param｜form-data
skip
（int）
略過前N筆資料；0~N；預設值0（選用）

take
（int）
取N筆資料；0~N；預設值10（選用）

sort
（string）
欄位資料排序；預設值為主索引鍵(id)（選用）
Note：URL Encode string if Http Method is GET

EX：降序
price desc
EX：升序
age asc
EX：
price desc,age
EX：隨機
random()
filter
（string）
篩選欄位；json string（選用）
key 欄位KEY；KEY不存在不比對

value 比對值；空值不比對

operator 比對運算子；預設值'='；使用'='或'<'或'>'或'<='或'>='或'!='或'like'

logical 邏輯運算；選用；預設值'&&'；使用'&&'或'||'或'AND'或'OR'
Note：URL Encode json string if Http Method is GET
EX：
var filter = [
    {
        'key': 'sex',
        'value': '1',
        'operator': '=',
        'logical': '&&'
    },
    {
        'key': 'name',
        'value': 'aa%',
        'operator': 'like',
        'logical': '&&'
    },
    {
        'key': 'age',
        'value': '3',
        'operator': '>=',
        'logical': '&&'
    },
];
JSON.stringify(filter);
columns
（string）
要讀取的欄位Key；json string（選用）
預設：讀取所有的欄位Key
Note：URL Encode json string if Http Method is GET
EX：
var columns = [ "name", "age", "sex" ];
JSON.stringify(columns);
key
API金鑰；設定如勾選[驗證金鑰]時為必要（選用｜必要）
請勿於公開資訊端使用API金鑰。若於Client公開資訊端使用，請自行評估其風險及可行性或將程式碼混淆加密壓縮。

application/json

Example Value

{
    "result": true,
    "message": "",
    "data": [
        {
            "id": "1",
            "token": "08e12d5e5dc447098cf015dbe9ae838d",
            "applyDate": "2020-05-28T00:52:17",
            "modifyDate": "2020-05-28T00:52:17",
            "modifyMember": "user@demo-mail.com",
            "field_1": "科目一",
            "field_2": ["222","333"],
            "field_2$item": {
                "Selected": [
                    {
                        "text": "bbb",
                        "value": "222"
                    },
                    {
                        "text": "ccc",
                        "value": "333"
                    }
                ],
                "List": [
                    {
                        "text": "aaa",
                        "value": "111"
                    },
                    {
                        "text": "bbb",
                        "value": "222"
                    },
                    {
                        "text": "ccc",
                        "value": "333"
                    }
                ]
            },
            "field_3": "slider1.jpg",
            "field_3$file": null
        },
        {
            "id": "2",
            "token": "477f507aa6c94be29273d53c3400c2b7",
            "applyDate": "2020-05-28T00:52:29",
            "modifyDate": "2020-05-28T00:52:29",
            "modifyMember": "user@demo-mail.com",
            "field_1": "科目二",
            "field_2": ["111","333"],
            "field_2$item": {
                "Selected": [
                    {
                        "text": "aaa",
                        "value": "111"
                    },
                    {
                        "text": "ccc",
                        "value": "333"
                    }
                ],
                "List": [
                    {
                        "text": "aaa",
                        "value": "111"
                    },
                    {
                        "text": "bbb",
                        "value": "222"
                    },
                    {
                        "text": "ccc",
                        "value": "333"
                    }
                ]
            },
            "field_3": "slider-test.jpg",
            "field_3$file": {
                "Name": "8c13e3dbdbad444ba07d4ad154823e0d/97166837de30412b8f64e533042e75fc/1/6_111.jpg",
                "Length": 102990,
                "ContentType": "image/jpeg",
                "Uri": "https://www.db2sys.com.tw/file/0000000000/8c13e3dbdbad444ba07d4ad154823e0d/97166837de30412b8f64e533042e75xx/1/6"
            }
        }
    ],
    "resultCount": 2,
    "originalCount": 2,
    "validResult": true,
    "validMessage": "",
    "StatusCode": 200,
    "fields": []
}

result

true：回傳狀態成功｜false：回傳狀態失敗（bool）

message

回傳狀態失敗訊息（string）

data

回傳資料（array[object]）

resultCount

回傳分頁資料筆數（int）

originalCount

回傳非分頁資料筆數（int）

validResult

true：form-data驗證成功｜false：form-data驗證失敗（bool）

validMessage

form-data欄位驗證失敗訊息（string）

StatusCode

回傳狀態碼（int）

fields

form-data欄位驗證失敗訊息（array[object]）

[
    {
        "Key": "key",
        "Value": {
            "key": "key",
            "name": "API金鑰",
            "value": null,
            "result": false,
            "message": "缺少API金鑰欄位參數"
        }
    }
]


curl https://www.db2sys.com.tw/api/v1/{Project_token}/{ProjectUnit_token}/{security_code}/list?skip=0&take=10&sort=age+desc&columns=%5B%22name%22%2C%22age%22%5D&filter=%5B%7B%22key%22%3A%22sex%22%2C%22value%22%3A%221%22%2C%22operator%22%3A%22%3D%22%2C%22logical%22%3A%22%26%26%22%7D%2C%7B%22key%22%3A%22name%22%2C%22value%22%3A%22aa%25%22%2C%22operator%22%3A%22like%22%2C%22logical%22%3A%22%26%26%22%7D%2C%7B%22key%22%3A%22age%22%2C%22value%22%3A%223%22%2C%22operator%22%3A%22%3E%3D%22%2C%22logical%22%3A%22%26%26%22%7D%5D


var formdata = new FormData();
var filter = [
    {
        'key': 'sex',
        'value': '1',
        'operator': '=',
        'logical': '&&'
    },
    {
        'key': 'name',
        'value': 'aa%',
        'operator': 'like',
        'logical': '&&'
    },
    {
        'key': 'age',
        'value': '3',
        'operator': '>=',
        'logical': '&&'
    }
];
var columns = [ "name", "age" ];
formdata.append('skip', '0');
formdata.append('take', '10');
formdata.append('sort', 'age desc');
formdata.append('filter', JSON.stringify(filter));
formdata.append('columns', JSON.stringify(columns));
$.ajax({
	url: 'https://www.db2sys.com.tw/api/v1/{Project_token}/{ProjectUnit_token}/{security_code}/list',
	type: 'POST',
	processData: false,
	contentType: false,
	data: formdata,
	success: function(response) {
		if (response.result)
		{
			//執行成功
			callback(response.data);
		}
		else
		{
			//取得失敗資訊
			alert(response.message);
			//取得欄位驗證資訊
			$.each(response.fields, function(index, field) {
				console.log(field);
			});
		}
	},
	error: function(xhr, ajaxOptions, thrownError) {
		console.log(xhr.status + '：' + thrownError);
	}
});


var formdata = new FormData();
var filter = [
    {
        'key': 'sex',
        'value': '1',
        'operator': '=',
        'logical': '&&'
    },
    {
        'key': 'name',
        'value': 'aa%',
        'operator': 'like',
        'logical': '&&'
    },
    {
        'key': 'age',
        'value': '3',
        'operator': '>=',
        'logical': '&&'
    },
];
var columns = [ "name", "age" ];
formdata.append('skip', '0');
formdata.append('take', '10');
formdata.append('sort', 'age desc');
formdata.append('filter', JSON.stringify(filter));
formdata.append('columns', JSON.stringify(columns));
axios
.post('https://www.db2sys.com.tw/api/v1/{Project_token}/{ProjectUnit_token}/{security_code}/list', formdata)
.then(response => {
    if (response.data.result) {
        //執行成功
        callback(response.data.data);
    }
    else {
        //取得失敗資訊
		alert(response.data.message);
		//取得欄位驗證資訊
		$.each(response.data.fields, function(index, field) {
			console.log(field);
		});
    }

})
.catch(function (error) {
    console.log(error);
});