รายการ Method ทั้งหมดของ REST API และคำอธิบายการทำงานของฟังก์ชันการทำงานของ API

Login

ก่อนที่จะทำการเรียกใช้ API อื่น ๆ ฝั่ง client จำเป็นที่จะต้องเข้า Login เข้าสู่ ONEWEB ก่อนเพราะเหตุผลทางด้านความปลอดภัย โดยตัว API ของ App Runtime จะทำการประยุกต์ใช้ JWT ซึ่งเซิฟเวอร์แอปพลิเคชันจะถูกตั้งค่าให้ตรวจสอบ JWT ขาเข้าว่าถูกสร้างโดยเซิฟเวอร์หรือไม่เพื่อรับรองความถูกต้อง ตัวอย่างของคำขอ client ได้แก่

URL: http://[SERVER]:[PORT]/eaf-rest/login 
HTTP Method: POST 
HTTP Request Header: Content-Type : application/json 
HTTP Request: { 
  "username" : [String: User Name], 
  "password" : [String: Password], 
  "ldapproviderurl" : [String: Empty value], 
  "clientId" : [String: key generate from client Ex. "93370c42-0d98-40ca-9a3d-36917a758b04"] 
} 
HTTP Response: { 
    "timestamp": [String: timestamp value Ex. "1510363014419"], 
    "validity": [Long: validity value Ex. 86400], 
    "id_token": [String: token value Ex. "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJkbXBzeXN0ZW0iLCJjbGllbnRJZCI6ImFiYyIsImV4cCI6MTUxMTIyNzAxNCwiaXNzIjoiY29tLmF2YWxhbnQuand0In0.UXR5LbqWruWy3rJur2Lx2E1nfI73JX3QBQXA4c2u2_CTSSzceRRMyziGevhtRe16AzAgZGKhny3PdfNltIT5Hw"] 
} 

Search Entity

API ชุดนี้จะทำการค้นหาข้อมูลจากฐานข้อมูล โดยระบุ entity id และ search parameter.

URL: http://[SERVER]:[PORT]/eaf-rest/entity/[Entity ID]/search?handleForm=Y&page=1&volumePerPage=10&cbMethod=searchHandler 
HTTP Method: GET 
HTTP Request Header: Content-Type : application/json, Authorization : "Bearer "+[Token], clientId : [Key generate from client] 
HTTP Request: N/A 
HTTP Response:searchHandler({ 
"ALL_VOLUME":"[Number of Record]", 
"DATA":[{ 
"[Column Name 1]":"[Column Value 1]" 
"[Column Name 2]":"[Column Value 2]" 
.. 
"[Column Name n]":"[Column Value n]" 
"KEY":{"ID":"[Key Value]"} 
}] 
}); 
 

Get Entity

หลังจากที่ผู้ใช้งานใช้ search API ผู้ใช้งานสามารถที่จะเลือกแถวเพื่อที่จะดูรายละเอียด ซึ่ง API ชุดนี้จะคืนค่าข้อมูลทั้งหมดจากฐานข้อมูลโดยอิงจาก entity id จากนั้น ผู้ใช้งานจะสามารถแก้ไข อัปเดตหรือทำการลบข้อมูลจากหน้าจอได้

URL: http://[SERVER]:[PORT]/eaf-rest/entity/[Entity ID]/get?ID=[Key ID]&cbMethod=getRecordHandler 
HTTP Method: GET 
HTTP Request Header: Content-Type : application/json, Authorization : "Bearer "+[Token], clientId : [Key generate from client] 
HTTP Request: N/A 
HTTP Response: getRecordHandler({ 
"DATA":{ 
"ENTITY_ID":"[Entity ID]", 
"MODULE_ID":{"[Module ID]":[{ 
"UPDATE":{ 
"[Table Name]":{ 
"[Column Name 1]":"Column Value 1", 
"[Column Name 2]":"Column Value 2", 
.. 
"[Column Name n]":"Column Value n", 
"KEY":{"Key Column Name 1":"[Key Value 1]","Key Column Name":"[Key Value]"} 
} 
} 
}]}, 
"MAIN_KEYTAB":{"MainTab Key Column Name":"[Key Value]"} 
} 
}); 
 

Update Entity

API ชุดนี้จะทำการส่งข้อมูลที่ถูกอัปเดตไปยังฐานข้อมูลหลังจากที่มีการแก้ไขข้อมูลจากหน้าจอ

HTTP Method: POST 
HTTP URL: http://[SERVER]:[PORT]/eaf-rest/entity/[Entity ID]/save?handleForm=Y&cbMethod=saveSuccessHandler 
HTTP Header: Content-Type : application/json, Authorization : "Bearer "+[Token], clientId : [Key generate from client] 
HTTP Request: { 
  "[Module ID]": [{ 
      "UPDATE": { 
        "[Table Name]": { 
  "[Column Name 1]": "[Value 1]", 
          "[Column Name 2]": "[Value 2]", 
          .. 
          "[Column Name n]": "[Value n]" 
        } 
      } 
    }] 
} 
HTTP Response: saveSuccessHandler({"MESSAGE":"Ok Save.","STATUS":"Success.","[Key Column Name]":"[Key Value]"}); 
 

Delete Entity

HTTP Method: POST 
HTTP URL: http://[SERVER]:[PORT]/eaf-rest/entity/[Entity ID]/get?handleForm=Y&cbMethod=searchHandler&ID=[Primary key] 
HTTP Header: Content-Type : application/json, Authorization : "Bearer "+[Token], clientId : [Key generate from client] 
HTTP Request:N/A 
HTTP Response:N/A 

Save Entity

API ที่ใช้สำหรับป้อนข้อมูลเข้าสู่ฐานข้อมูล หลังจากที่ผู้ใช้งานทำการป้อนข้อมูลใหม่จากหน้าจอ แล้วมีการกดบันทึก

URL: http://[SERVER]:[PORT]/eaf-rest/entity/[Entity ID]/save?handleForm=Y&cbMethod=saveSuccessHandler 
HTTP Method: POST 
HTTP Request Header: Content-Type : application/json, Authorization : "Bearer "+[Token], clientId : [Key generate from client] 
HTTP Request: { 
  "[Module ID]": [{ 
      "INSERT": { 
        "[Table Name]": { 
  "[Column Name 1]": "[Value 1]", 
          "[Column Name 2]": "[Value 2]", 
          .. 
          "[Column Name n]": "[Value n]" 
        } 
      } 
    }] 
} 
HTTP Response: saveSuccessHandler({"MESSAGE":"Ok Save.","STATUS":"Success.","[Key Column Name]":"[Key Value]"}); 

Upload File

HTTP Method: POST 
HTTP URL: http://[SERVER]:[PORT]/eaf-rest/entity/[Entity ID]/get?handleForm=Y&cbMethod=searchHandler&ID=[Primary key] 
HTTP Header: Content-Type : application/json, Authorization : "Bearer "+[Token], clientId : [Key generate from client] 
HTTP Request: [form-data] N/A 
HTTP Response:N/A 

Download File

HTTP Method: GET 
HTTP URL: http://[SERVER]:[PORT]/eaf-rest/file/[File ID]/download?mimetype=[Mimetype] 
HTTP Header: Content-Type : application/json, Authorization : "Bearer "+[Token], clientId : [Key generate from client] 
HTTP Request: N/A 
HTTP Response: [Object File] N/A 

Note: Mimetype มี 2 ทางเลือกคือ 1. "application/octet-stream" 2. "application/base64"