Project

General

Profile

Rest CustomFields » History » Version 3

Mischa The Evil, 2021-09-02 15:28
Add syntax-highlighting to example response.

1 1 Jean-Philippe Lang
h1. Custom Fields
2
3
{{>toc}}
4
5
h2. /custom_fields.:format
6
7
h3. GET
8
9
Returns all the custom fields definitions.
10
11 2 Mischa The Evil
This endpoint requires admin privileges.
12
13 1 Jean-Philippe Lang
+Examples+:
14
15
<pre>
16
GET /custom_fields.xml
17
</pre>
18
19
+Response+:
20
21 3 Mischa The Evil
<pre><code class="xml">
22 1 Jean-Philippe Lang
<?xml version="1.0" encoding="UTF-8"?>
23
<custom_fields type="array">
24
  <custom_field>
25
    <id>1</id>
26
    <name>Affected version</name>
27
    <customized_type>issue</customized_type>
28
    <field_format>list</field_format>
29
    <regexp/>
30
    <min_length/>
31
    <max_length/>
32
    <is_required>true</is_required>
33
    <is_filter>true</is_filter>
34
    <searchable>true</searchable>
35
    <multiple>true</multiple>
36
    <default_value/>
37
    <visible>false</visible>
38
    <possible_values type="array">
39
      <possible_value>
40
        <value>0.5.x</value>
41
      </possible_value>
42
      <possible_value>
43
        <value>0.6.x</value>
44
      </possible_value>
45
  <custom_field>
46
  <custom_field>
47
    ...
48
  </custom_field>
49
</custom_fields>
50 3 Mischa The Evil
</code></pre>
51 1 Jean-Philippe Lang
52
The @customized_type@ attribute indicates which type of object the custom field applies to (eg. issue, project, time_entry...).