List Templates

ดึงรายการรายงานที่ API Key เข้าถึงได้ พร้อมรายการ filter ของแต่ละรายงาน

ใช้ API นี้เพื่อค้นหาว่ามีรายงานใดให้เลือกสร้างได้บ้าง และแต่ละรายงานรับ filter อะไร ก่อนเรียก Submit Report

Endpoint


GET /api/v1/open-apis/report-builder/reports/templates

Request Parameters

ไม่มี parameters

สิทธิ์ที่ต้องการ: API Key ต้องมีสิทธิ์ การสร้างรายงาน (report:generate) จึงจะเห็นรายงานในรายการ — หากไม่มีสิทธิ์นี้ รายการ reports จะเป็น array ว่าง (ไม่ใช่ HTTP 403)

Code Examples

cURL


curl -X GET "https://openapi.humansoft.co.th/api/v1/open-apis/report-builder/reports/templates" \
  -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY"

JavaScript


const url = 'https://openapi.humansoft.co.th/api/v1/open-apis/report-builder/reports/templates'
 
const response = await fetch(url, {
  method: 'GET',
  headers: {
    'Ocp-Apim-Subscription-Key': 'YOUR_API_KEY'
  }
})
 
const data = await response.json()
data.reports.forEach(r => {
  console.log(`${r.id} - ${r.name.th}`)
})

Python


import requests
 
url = "https://openapi.humansoft.co.th/api/v1/open-apis/report-builder/reports/templates"
headers = {
    "Ocp-Apim-Subscription-Key": "YOUR_API_KEY"
}
 
response = requests.get(url, headers=headers)
data = response.json()
 
for r in data["reports"]:
    print(f"{r['id']} - {r['name']['th']}")

PHP


<?php
$url = "https://openapi.humansoft.co.th/api/v1/open-apis/report-builder/reports/templates";
 
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Ocp-Apim-Subscription-Key: YOUR_API_KEY"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
 
$response = curl_exec($ch);
$data = json_decode($response, true);
 
foreach ($data["reports"] as $r) {
    echo "{$r['id']} - {$r['name']['th']}\n";
}
 
curl_close($ch);
?>

Response Format

Success Response (HTTP 200)


{
  "reports": [
    {
      "id": "net_total_month_custom",
      "name": {
        "th": "รายงานผลการคำนวณเงินเดือนสุทธิงวดปกติ Custom",
        "en": "Net Salary Monthly (Custom)"
      },
      "filter_fields": [
        { "key": "year_month", "type": "string", "required": true },
        { "key": "department_lists", "type": "string[]" },
        { "key": "keyword", "type": "string" }
      ]
    },
    {
      "id": "payroll_period_summary",
      "name": {
        "th": "สรุปงวดเงินเดือน",
        "en": "Payroll Period Summary"
      },
      "filter_fields": [
        { "key": "year_month", "type": "string", "required": true },
        { "key": "round_flag", "type": "string", "required": true, "allowed_values": ["Full", "Split"] },
        { "key": "master_salary_split_seq", "type": "number", "allowed_values": [1, 2, 3, 4] },
        { "key": "department_lists", "type": "string[]" },
        { "key": "keyword", "type": "string" }
      ]
    },
    {
      "id": "payroll_attendance_detail",
      "name": {
        "th": "รายละเอียดการลงเวลารายวัน",
        "en": "Payroll Attendance Detail"
      },
      "filter_fields": [
        { "key": "work_date_start", "type": "string", "required": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}$" },
        { "key": "work_date_end", "type": "string", "required": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}$" },
        { "key": "department_lists", "type": "string[]" },
        { "key": "keyword", "type": "string" }
      ]
    },
    {
      "id": "master_employee",
      "name": {
        "th": "ทะเบียนพนักงาน",
        "en": "Employee Master"
      },
      "filter_fields": [
        { "key": "year_month", "type": "string", "required": true },
        { "key": "department_lists", "type": "string[]" },
        { "key": "keyword", "type": "string" }
      ]
    },
    {
      "id": "leave_transaction",
      "name": {
        "th": "รายการการลา",
        "en": "Leave Transactions"
      },
      "filter_fields": [
        { "key": "year", "type": "string", "required": true, "pattern": "^\\d{4}$" },
        { "key": "date_from", "type": "string", "required": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}$" },
        { "key": "date_to", "type": "string", "required": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}$" },
        { "key": "leave_type_code", "type": "string[]" },
        { "key": "keyword", "type": "string" }
      ]
    }
  ]
}

Response Fields

Field	Type	Description
`reports`	array	รายการรายงานที่ API Key เข้าถึงได้
`reports[].id`	string	Report ID — ใช้เป็นค่า `report` ตอนเรียก Submit Report
`reports[].name.th`	string	ชื่อรายงาน (ภาษาไทย)
`reports[].name.en`	string	ชื่อรายงาน (ภาษาอังกฤษ)
`reports[].filter_fields`	array	รายการ filter ที่รายงานรองรับ
`reports[].filter_fields[].key`	string	ชื่อ filter
`reports[].filter_fields[].type`	string	ประเภทข้อมูล — `string`, `string[]` หรือ `number`
`reports[].filter_fields[].required`	boolean	มีค่า `true` เมื่อ filter นั้นจำเป็นต้องส่ง
`reports[].filter_fields[].allowed_values`	array	มีเมื่อ filter รับเฉพาะค่าที่กำหนด
`reports[].filter_fields[].pattern`	string	มีเมื่อค่าต้องตรงรูปแบบ regex (เช่น `^\d{4}$` สำหรับ `year`, `^\d{4}-\d{2}-\d{2}$` สำหรับวันที่) — ต้อง match ทั้งค่า สำหรับ `string[]` ทุก element ต้อง match

Error Responses

Status Codes

Code	ความหมาย
`200`	สำเร็จ (อาจคืน `reports` เป็น array ว่างหากไม่มีสิทธิ์)
`401`	ไม่ได้ส่ง API Key หรือ Key ไม่ถูกต้อง
`500`	เกิดข้อผิดพลาดระหว่างประมวลผลบนเซิร์ฟเวอร์

Available Columns - คอลัมน์ที่เลือกแสดงได้ของแต่ละรายงาน
Submit Report - ส่งคำขอสร้างรายงาน