Limiting which fields are returned

Limiting which fields are returned by the API

The API consumer doesn't always need the full representation of a resource. The ability select and chose returned fields goes a long way in letting the API consumer minimize network traffic and speed up their own usage of the API.

Use a fields query parameter that takes a comma separated list of fields to include. For example, the following request would retrieve just enough information to display a sorted listing of open tickets:

GET /tickets?fields=id,subject,customer_name,updated_at&state=open&sort=-updated_at

Kết quả (Việt) 1:

Hạn chế các lĩnh vực mà được trả về bởi APINgười tiêu dùng API không luôn luôn cần sự hiện diện đầy đủ của một nguồn tài nguyên. Khả năng chọn và đã chọn quay trở lại trường đi một chặng đường dài trong cho phép người tiêu dùng API giảm thiểu lưu lượng mạng và tăng tốc độ của riêng họ sử dụng các API.Sử dụng một tham số truy vấn các trường có dấu phẩy ngăn cách danh sách bao gồm các lĩnh vực. Ví dụ: các yêu cầu sau đây sẽ lấy vừa đủ thông tin để hiển thị một danh sách được sắp xếp của vé mở:GET /tickets? lĩnh vực = id, chủ đề, customer_name, updated_at & bang = mở & = updated_at sắp xếp

Kết quả (Việt) 2:

Hạn chế đó được trả về bởi các API

Người tiêu dùng API không phải lúc nào cũng cần sự đại diện đầy đủ của một tài nguyên. Khả năng lựa chọn và chọn các lĩnh vực quay đi một chặng đường dài trong việc để người tiêu dùng API giảm thiểu lưu lượng mạng và tăng tốc độ sử dụng của riêng của họ về API.

Sử dụng một số lĩnh vực truy vấn mà mất một dấu phẩy danh sách các lĩnh vực tách ra để bao gồm. Ví dụ, các yêu cầu sau đây sẽ lấy vừa đủ thông tin để hiển thị một danh sách được sắp xếp vé mở:

? GET / vé lĩnh vực = id, chủ đề, customer_name, updated_at & state = mở & sort = -updated_at