Path

/api/v1/{Project_token}/{ProjectUnit_token}/get

Http Method

GET｜POST

Content-type

application/form-data

query-param｜form-data

token

（string）
即將讀取此單筆資料的唯一鍵值（必要）

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公開資訊端使用，請自行評估其風險及可行性或將程式碼混淆加密壓縮。

Responses

application/json

Example Value

{
    "result": true,
    "message": "",
    "data": {
        "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": "111",
        "field_3$item": {
            "Selected": {
                "text": "aaa",
                "value": "111"
            },
            "List": [
                {
                    "text": "aaa",
                    "value": "111"
                },
                {
                    "text": "bbb",
                    "value": "222"
                }
            ]
        },
        "field_4": "slider-test.jpg",
        "field_4$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"
        },
        "field_5": 81,
        "field_6": false
    },
    "validResult": true,
    "validMessage": "",
    "StatusCode": 200,
    "fields": [
        {
            "Key": "token",
            "Value": {
                "key": "token",
                "name": "token",
                "value": "477f507aa6c94be29273d53c3400c2b7",
                "result": true,
                "message": ""
            }
        }
    ]
}

result

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

message

回傳狀態失敗訊息（string）

data

回傳資料（object）

resultCount

回傳分頁資料筆數（int）

originalCount

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

validResult

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

validMessage

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

StatusCode

回傳狀態碼（int）

fields

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

EX：

[
    {
        "Key": "key",
        "Value": {
            "key": "key",
            "name": "API金鑰",
            "value": null,
            "result": false,
            "message": "缺少API金鑰欄位參數"
        }
    },
    {
        "Key": "token",
        "Value": {
            "key": "token",
            "name": "資料鍵值",
            "value": "5a08aecbf0ab4a679b676e06ae9e7c92",
            "result": true,
            "message": ""
        }
    }
]

Example Code

• Url Get
• jQuery Ajax
• Vue Axios

curl https://www.db2sys.com.tw/api/v1/{Project_token}/{ProjectUnit_token}/{security_code}/get?token={token}&columns={columns}
                                    

var formdata = new FormData();
formdata.append('token', '[token]欄位值'); //欄位【token】設定值；即將讀取此單筆資料的唯一鍵值
var columns = [ "name", "age" ];
formdata.append('columns', JSON.stringify(columns));

$.ajax({
	url: 'https://www.db2sys.com.tw/api/v1/{Project_token}/{ProjectUnit_token}/{security_code}/get',
	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();
formdata.append('token', '[token]欄位值'); //欄位【token】設定值；即將讀取此單筆資料的唯一鍵值
var columns = [ "name", "age" ];
formdata.append('columns', JSON.stringify(columns));
axios
.post('https://www.db2sys.com.tw/api/v1/{Project_token}/{ProjectUnit_token}/{security_code}/get', 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);
});