Accessing user-defined fields (UDFs)

You can access and work with UDFs using the REST API.

Use field metadata

You can use the field metadata to see a list of UDFs.

Example: To list only user-defined fields, query the field metadata with the is_user_defined attribute: 

GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/metadata/fields?query="is_user_defined EQ true"

Back to top

Include UDFs in responses

For performance optimization, when getting entities, UDFs are not included in the response. To see UDFs, you have to explicitly request the UDFs using the fields clause.

Example: To see a user-defined field for defects called MyUDF:

GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/defects?fields=MyUDF

Back to top

Change the value of a UDF

You can use the REST API to update the values of UDFs as you would any other field.

This example demonstrates how to update, for a particular epic 1412, the string value of a UDF called needsdocs_udf from "no" to "yes".

Context Request
Workspace (non-shared)

PUT http[s]://<server>:<port>/api/shared_spaces/<space_id>/workspaces/<workspace_id>/epics/1412

"needsdocs_udf": "yes"}

Space (shared entities)

PUT http[s]://<server>:<port>/api/shared_spaces/<space_id>/shared_area/epics/1412

"needsdocs_udf": "yes"}

Back to top