ユーザー定義フィールド (UDF) へのアクセス

REST APIを使用して、UDFにアクセスして操作できます。

フィールドメタデータの使用

フィールドメタデータを使用して、UDFのリストを表示できます。

例: ユーザー定義フィールドのみを一覧表示するには、is_user_defined属性を使用してフィールドメタデータをクエリします。 

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

トップに戻る

応答にUDFを含める

パフォーマンスを最適化するために、エンティティをGETする場合、UDFは応答に含まれません。UDFを表示するには、fields句を使用してUDFを明示的にリクエストする必要があります。

例: MyUDFと呼ばれる不具合のユーザー定義フィールドを表示するには:

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

トップに戻る

UDFの値を変更する

他のフィールドと同じように、REST APIを使用してUDFの値を更新できます。

この例は、特定のエピック1412について、needsdocs_udfというUDFの文字列値を "no"から "yes"に更新する方法を示しています。

コンテキスト リクエスト
ワークスペース (非共有)

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

"needsdocs_udf": "yes"}

スペース (共有エンティティ)

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

"needsdocs_udf": "yes"}

トップに戻る