Get CustomField - Gofive OpenAPI

ดึงฟิลด์กำหนดเองของพนักงาน

ดึงนิยามของฟิลด์กำหนดเอง (custom field) ที่ tenant สร้างไว้สำหรับข้อมูลพนักงาน
ใช้ก่อนส่งค่า custom field เข้ามาทาง POST /api/v1/employees/custom-fields
เพื่อให้รู้ว่าฟิลด์ไหนบังคับ ชนิดอะไร และมีตัวเลือกอะไรบ้าง

⚠️ ข้อควรรู้

Options มีเฉพาะฟิลด์ชนิดที่ต้องเลือกจากรายการ (20002 / 20003 / 20004)

RegularExpression มีเฉพาะฟิลด์ข้อความที่ตั้ง TextBoxType = 5 (Custom)

ทั้งสองฟิลด์ หายไปจาก JSON เมื่อไม่มีค่า

endpoint นี้ใช้ envelope Result<T> — อ่านสถานะจาก Status.Code ไม่ใช่ StatusCode

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

สำเร็จ — Data คือนิยามฟิลด์กำหนดเองทั้งหมดของ tenant

Bodyapplication/json

Example

{
    "Status": {
        "Code": "1000",
        "Description": "Success!"
    },
    "Data": [
        {
            "FieldName": "รหัสพนักงานระบบเก่า",
            "CustomFieldsType": 20001,
            "TextBoxType": 2,
            "IsRequire": false,
            "IsSelfUpdate": false,
            "DisplaySection": 2
        },
        {
            "FieldName": "ขนาดเสื้อยูนิฟอร์ม",
            "CustomFieldsType": 20004,
            "TextBoxType": 1,
            "IsRequire": true,
            "IsSelfUpdate": true,
            "DisplaySection": 3,
            "Options": [
                {
                    "Sequence": "1",
                    "Option": "S"
                },
                {
                    "Sequence": "2",
                    "Option": "M"
                },
                {
                    "Sequence": "3",
                    "Option": "L"
                }
            ]
        }
    ]
}

🟢204No Content

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests

🔴500Server Error