Querying Custom Field Values
Function
This API is used to query custom field values.
Calling Method
For details, see Calling APIs.
URI
GET /v2/custom-field/query-custom-field
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
No |
String |
Definition: 32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API. Constraints: N/A Value range: N/A Default value: N/A |
tracker_id |
No |
String |
Definition: Work item type. Constraints: N/A Value range: 2 (task) 3 (bug) 5 (epic) 6 (feature) 7 (story) Default value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
result |
result object |
Definition: Response result of querying the value of a custom field. |
status |
String |
Definition: Status of the response body for querying custom fields. Value range: success: successful error: failed |
Parameter |
Type |
Description |
---|---|---|
custom_field |
Array of custom_field objects |
Definition: List of custom fields. |
Parameter |
Type |
Description |
---|---|---|
tracker_list |
Array of strings |
Definition: List of custom fields. Value range: N/A |
region |
String |
Definition: Region of the project. Value range: N/A |
id |
Integer |
Definition: Unique ID of a custom field. Value range: N/A |
project_id |
Integer |
Definition: ID of the project to which the custom field belongs. Value range: N/A |
tracker_id |
Integer |
Definition: Type ID of the work item to which a custom field belongs. Value range: 2 (task) 3 (bug) 5 (epic) 6 (feature) 7 (story) |
custom_field |
String |
Definition: Name of a custom field. Value range: N/A |
type |
String |
Definition: Custom field type. Value range: N/A |
name |
String |
Definition: Display name of a custom field. Value range: N/A |
sort |
Integer |
Definition: Sequence number of a field, which is used to determine the field display sequence on the GUI. Value range: N/A |
memo |
String |
Definition: Additional information about a custom field. Value range: N/A |
created |
String |
Definition: Time when a custom field is created. Format: YYYY-MM-DD HH:mm:ss (Example: 2025-07-28 14:47:38) Value range: N/A |
modified |
String |
Definition: Time when a custom field is modified. Format: YYYY-MM-DD HH:mm:ss (DateTime format: 2025-07-28 14:47:38) Value range: N/A |
is_delete |
Boolean |
Definition: Whether a customized field is deleted. Value range: true: deleted false: not deleted |
Example Requests
{endpoint}/v2/custom-field/query-custom-field?project_id=5192de5eb435430c8cd41c6ae6028848&tracker_id=3
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
200 |
OK (The request has succeeded). |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot