Update KPI - Gofive OpenAPI

อัปเดตค่าความคืบหน้าของ KPI

ส่งค่าปัจจุบันของ KPI หนึ่งรหัสเข้ามาเพื่อบันทึกเป็น check-in

🧭 โหมดการทำงาน (ระบบเลือกจาก EmployeeRefId)

ไม่ส่ง EmployeeRefId → อัปเดต Corporate KPI ตาม Code ระบบจะอัปเดตทุกแถวที่ใช้รหัสนี้ ทั้งใน Master KPI และในรอบประเมินที่กำลังใช้งาน (แยก check-in ทีละรอบ) หากอัปเดตได้อย่างน้อยหนึ่งรอบถือว่าสำเร็จ

ส่ง EmployeeRefId → อัปเดต Individual KPI ของพนักงานคนนั้นภายในบริษัทที่ระบุ

📋 ต้องมีข้อมูลก่อนเรียก

KPI รหัส Code ต้องถูกสร้างไว้แล้วในบริษัท CompanyName และต้องอยู่ในรอบประเมินที่ใช้งานอยู่ ณ วันที่เรียก

โหมด Individual ต้องมี KPI รายบุคคลของ EmployeeRefId คนนั้นด้วย

ถ้ายังไม่มีจะได้ 400 พร้อม Data.message = KPI not found

⚠️ ข้อควรรู้

วันที่มีผลของ check-in คือเวลาที่เรียก API

ส่ง isCheckIn: false ระบบจะบันทึกหมายเหตุกำกับว่าค่านี้มาจาก Open API (ไม่ใช่การ check-in ด้วยตนเอง) — ค่าเริ่มต้นเมื่อไม่ส่งคือ true

🔐 ต้องมีสิทธิ์ Open API โมดูล Goals ระดับ ReadAndWrite

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Header Params

Body Params application/jsonRequired

Examples

อัปเดต Corporate KPI (ไม่ส่ง employeeRefId)อัปเดต Individual KPI ของพนักงานหนึ่งคน

{
    "Code": "KPI-REV-001",
    "CompanyName": "Acme",
    "CurrentPoint": 82.5,
    "IsCheckIn": false
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

บันทึกค่า KPI สำเร็จ — ตรวจ Data.result เพื่อยืนยันผลจากชั้นธุรกิจอีกชั้นหนึ่ง

Bodyapplication/json

Example

{
    "StatusCode": 200,
    "Message": "OK",
    "Data": {
        "result": true,
        "message": "สำเร็จ",
        "message_EN": "Success."
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests

🔴500Server Error