Nhảy tới nội dung

Thông tin cần nắm được

Thông tin liên quan đến method GET​

Query Parameters: là những thông tin sẽ được truyền qua header của một api

Fields​

Những thông tin mà người dùng có thể lấy ra

Example​

{
  "fields": "info1,info2" // Sẽ có 2 thông tin là info1, info2 trong kết quả trả về
}

Filtering​

Những thông tin mà người dùng có thể làm điều kiện lọc để lấy dữ liệu

Condition Operation​

OperationDescription
eqBằng
isLà giá trị
inTrong mảng
not_inKhông trong mảng
containsChứa ký tự
betweenTrong khoảng
not_betweenKhông trong khoảng
gteLớn hơn hoặc bằng
gtLớn hơn
lteNhỏ hơn hoặc bằng
ltNhỏ hơn

Example​

{
  "filtering": {
    "info1:eq": 1,  // Nếu info1 bằng với giá trị 1
    "info1:is": 1,  // Nếu info1 là giá trị 1
    "info1:in": [1,2,3],  // Nếu info1 có giá trị trong mảng [1,2,3]
    "info1:not_in": [1,2,3],  // Nếu info1 không có giá trị trong mảng [1,2,3]
    "info1:contains": "info", // Nếu info1 có chứa giá trị info
    "info1:between": [1,10],  // Nếu info1 có giá trị trong khoảng từ 1 -> 10
    "info1:not_between": [1,10],  // Nếu info1 không có giá trị trong khoảng từ 1 -> 10
    "info1:gte": 1, // Nếu info1 có giá trị lớn hơn hoặc bằng 1
    "info1:gt": 1,  // Nếu info1 có giá trị lớn hơn 1
    "info1:lte": 1, // Nếu info1 có giá trị nhỏ hơn hoặc bằng 1
    "info1:lt": 1,  // Nếu info1 có giá trị nhỏ hơn 1
  }
}

Sort​

Thông tin sẽ được sắp xếp

Example​

{
  "sort": "info1" // Kết quả trả về sẽ được sắp xếp theo thông tin info1
}

Nếu không có Direction thì mặc định sẽ là asc

Direction​

Hướng sắp xếp của dữ liệu

DirectionDescription
ascTừ nhỏ đến lớn
descTừ lớn đến nhỏ

Example​

{
  "direction": "asc" // Kết quả trả về sẽ được sắp xếp từ nhỏ tới lớn
}

Đi kèm với Sort

Limit​

Lấy giới hạn kết quả trả về

Example​

{
  "limit": 5 // Sẽ có 5 kết quả được trả về
}

Offset​

Xác định vị bắt đầu của kết quả trả về

Example​

{
  "offset": 5 // Sẽ bỏ qua 5 kết quả đầu và lấy bắt đầu từ kết quả thứ 6
}

Thông tin liên quan đến method POST, PUT​

Body Parameters: là những thông tin sẽ được truyền qua body của một api

Thông tin liên quan đến Custom Fields (Định nghĩa dữ liệu)​

  • Định nghĩa dữ liệu là những thông tin do người dùng cài đặt riêng mà trước đó chưa tồn tại trong hệ thống
  • Có thể định nghĩa dữ liệu cho từng tính năng riêng biệt
  • Có thể lấy danh sách định nghĩa dữ liệu qua api sau: api/v6/tentinhnang/custom_fields
  • Những thông tin của định nghĩa dữ liệu có thể thêm kèm với thông tin chính

Example​

{
  "custom_fields": {
    "custom_field_1": "info 1" // Đây là một thông tin trong định nghĩa dữ liệu mà hệ thống không có sẵn, tự người dùng có thể cài đặt
  } 
}