Trường tùy chỉnh

Trường Tùy chỉnh trong Requirements & Systems Portal - Tài liệu API

Giới thiệu

Trong Requirements & Systems Portal, Trường Tùy chỉnh cung cấp một cách mạnh mẽ để mở rộng chức năng của nền tảng bằng cách cho phép người dùng tạo thêm các trường liên kết với các yêu cầu và các lần chạy kiểm thử. Những trường này có thể lưu trữ nhiều loại dữ liệu khác nhau, chẳng hạn như ngày tháng, văn bản và các lựa chọn. Tài liệu API này trình bày quy trình tạo, cập nhật và quản lý Trường Tùy chỉnh cùng các tùy chọn của chúng bằng lập trình.

Định nghĩa Trường Tùy chỉnh

Trường Tùy chỉnh trong Requirements & Systems Portal có thể được tạo bằng endpoint /data/custom-field/ với cú pháp sau:

CustomField{
  "projects": [uniqueItems: true integer],
  "target_content_type": integer,
  "name": string,
  "type": integer,
  "multi": boolean
}

• projects: Danh sách các mã định danh duy nhất của dự án nơi Trường Tùy chỉnh sẽ khả dụng.

• target_content_type: Loại nội dung đích cho Trường Tùy chỉnh. Dùng 120 cho yêu cầu và 291 cho lần chạy kiểm thử.

• name: Tên của Trường Tùy chỉnh.

• type: Dùng 0 cho Văn bản, 1 cho Lựa chọn và 2 cho Ngày tháng.

• multi: Đặt là true cho lựa chọn nhiều khi định nghĩa kiểu Lựa chọn.

Tạo Trường Tùy chỉnh

Để tạo một Trường Tùy chỉnh, hãy dùng phương thức PUT cho endpoint /data/custom-field/. Ví dụ:

{
  "projects": [136],
  "target_content_type": 120,
  "name": "New Selection Column",
  "type": 1
}

Định nghĩa Tùy chọn của Trường Tùy chỉnh

Khi tạo Trường Tùy chỉnh kiểu Lựa chọn, bạn cũng phải định nghĩa các tùy chọn khả dụng bằng endpoint /data/custom-field-options/ với mô hình sau:

CustomFieldOption{
  "custom_field": integer,
  "titlename": string,
  "position": number
}

• custom_field: Mã định danh duy nhất của Trường Tùy chỉnh mà tùy chọn đang được tạo cho nó.

• titlename: Tên của tùy chọn.

• position: Trường tùy chọn để xác định vị trí của tùy chọn trong danh sách tùy chọn.

Tạo Tùy chọn cho Trường Tùy chỉnh

Để tạo một Tùy chọn của Trường Tùy chỉnh, hãy dùng phương thức PUT cho endpoint /data/custom-field-options/. Ví dụ:

{
  "custom_field": 58,
  "name": "New Option"
}

Thêm dữ liệu vào Trường Tùy chỉnh

Để thêm dữ liệu vào một Trường Tùy chỉnh, hãy dùng endpoint /data/custom-field-row/ với mô hình sau:

CustomFieldRow{
  "referenced_object_id": integer,
  "custom_field": integer,
  "value": string
}

• referenced_object_id: Mã định danh duy nhất của đối tượng (yêu cầu hoặc lần chạy kiểm thử) mà dữ liệu thuộc về.

• custom_field: Mã định danh duy nhất của Trường Tùy chỉnh mà dữ liệu đang được thêm vào.

• value: Dữ liệu cần thêm. Với Văn bản, dùng chuỗi văn bản tự do; với Lựa chọn đơn, dùng id của tùy chọn; với Lựa chọn nhiều, dùng danh sách id của các tùy chọn; với Ngày tháng, dùng ngày ở định dạng chuỗi.

Thêm dữ liệu vào Trường Tùy chỉnh - Lần nhập đầu tiên

Đối với lần nhập dữ liệu đầu tiên vào Trường Tùy chỉnh của một đối tượng nhất định, hãy dùng phương thức POST cho endpoint /data/custom-field-row/bulk-create/. Ví dụ:

{
  "referenced_object_id": 33803,
  "custom_field": 58,
  "value": 29
}

Cập nhật dữ liệu trong Trường Tùy chỉnh

Để cập nhật dữ liệu hiện có cho Trường Tùy chỉnh của một đối tượng nhất định, hãy dùng phương thức POST cho endpoint /data/custom-field-row/bulk-update/. Ví dụ:

{
  "614": {
    "value": 30
  }
}

Xóa dữ liệu khỏi Trường Tùy chỉnh

Để xóa dữ liệu liên kết với một Trường Tùy chỉnh và đối tượng cụ thể, hãy dùng cùng phương thức cập nhật hàng loạt với "value": null. Ví dụ:

{
  "614": {
    "value": null
  }
}

Kết luận

Trường Tùy chỉnh trong Requirements & Systems Portal cho phép bạn nâng cao khả năng của nền tảng và điều chỉnh cho phù hợp với nhu cầu cụ thể của dự án. Bằng cách sử dụng các endpoint API được cung cấp, bạn có thể tạo Trường Tùy chỉnh, định nghĩa các tùy chọn và thêm dữ liệu bằng lập trình, giúp Requirements & Systems Portal trở thành một công cụ linh hoạt cho nhu cầu quản lý và phân tích dự án của bạn.