Project

General

Profile

Rest CustomFields » History » Version 1

Jean-Philippe Lang, 2013-09-29 12:18

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
+Examples+:
12
13
<pre>
14
GET /custom_fields.xml
15
</pre>
16
17
+Response+:
18
19
<pre>
20
<?xml version="1.0" encoding="UTF-8"?>
21
<custom_fields type="array">
22
  <custom_field>
23
    <id>1</id>
24
    <name>Affected version</name>
25
    <customized_type>issue</customized_type>
26
    <field_format>list</field_format>
27
    <regexp/>
28
    <min_length/>
29
    <max_length/>
30
    <is_required>true</is_required>
31
    <is_filter>true</is_filter>
32
    <searchable>true</searchable>
33
    <multiple>true</multiple>
34
    <default_value/>
35
    <visible>false</visible>
36
    <possible_values type="array">
37
      <possible_value>
38
        <value>0.5.x</value>
39
      </possible_value>
40
      <possible_value>
41
        <value>0.6.x</value>
42
      </possible_value>
43
  <custom_field>
44
  <custom_field>
45
    ...
46
  </custom_field>
47
</custom_fields>
48
</pre>
49
50
The @customized_type@ attribute indicates which type of object the custom field applies to (eg. issue, project, time_entry...).