Querying Field Templates
Function
This API is used to query field templates by work item type.
Calling Method
For details, see Calling APIs.
URI
GET /v1/ipdprojectservice/projects/{project_id}/categories/{category_id}/field/templates
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Description: 32-bit UUID of a project, which uniquely identifies a project. You can obtain the project ID by calling the API for querying the project list. The value of project_id in the response body is the project ID. Constraints: regular expression, ^[A-Za-z0-9]{32}$ Default value: N/A |
category_id |
Yes |
String |
Definition: 5-digit ID of the work item type. Constraints: Regular expression: ^[\d]{5} Options: IPD-system device: 10021 (RR), 10065 (SF), 10020 (IR), 10022 (SR), 10029 (AR), 10027 (task), and 10033 (bug) IPD-standalone software: 10021 (RR), 10065 (SF), 10020 (IR), 10023 (US), 10027 (task), and 10033 (bug) IPD-self-operated software/cloud service: 10001 (epic), 10028 (FE), 10021 (RR), 10023 (US), 10027 (task), and 10033 (bug) Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
page |
Yes |
Integer |
Definition: Page number. Constraints: Regular expression: ^(100|[1-9][0-9]?|1) Value range: [1, 100] Default value: N/A |
size |
Yes |
Integer |
Definition: Number of records on each page. Constraints: Regular expression: ^(1000|[1-9][0-9]{1,2}|10) Value range: [10, 1000] Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
Definition: User token. Obtain the token by calling theObtaining a User TokenIAM API. In the returned response header, X-Subject-Token is the desired user token. Constraints: Mandatory. Range: Minimum length: 10 character. Maximum length: 32,768 characters. Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
page |
PageVO object |
Description: pagination information. |
result |
Array of FieldVO objects |
Description: returned data. |
Parameter |
Type |
Description |
---|---|---|
page |
String |
Definition: Current page. Options: N/A |
size |
String |
Definition: Number of records on each page. Options: N/A |
count |
String |
Definition: Total number of data records. Options: N/A |
Parameter |
Type |
Description |
---|---|---|
display_name |
String |
Definition: Field name. Options: N/A |
created_by |
String |
Definition: Field creator. Options: N/A |
field_type |
String |
Definition: Field type. Options: N/A |
show_on_card |
Boolean |
Definition: Whether to display on the creation page. Options: true (yes) and false (no) |
optional |
Boolean |
Definition: Mandatory or not. Options: true (mandatory) and false (optional) |
all_options |
Array of OptionEntity objects |
Definition: Field options. Options: N/A |
default_value |
String |
Definition: Default value. Options: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Option ID. Options: N/A |
code |
String |
Definition: Code value of an option. Options: N/A |
display_value |
String |
Definition: Option display name. Options: N/A |
value |
String |
Definition: Unique option ID. Options: N/A |
level |
Integer |
Definition: Number of option levels. Options: The maximum number of levels is 4. |
sequence |
Integer |
Definition: Option sequence. Options: N/A |
parent_id |
String |
Definition: Parent option ID. Options: N/A |
Example Requests
GEThttps://{endpoint}/v1/ipdprojectservice/projects/05c7d8bcf3db4829bc841e4ba93aaea5/categories/10021/field/templates?page=1&size=10
Example Responses
Status code: 200
Success response.
{ "page" : { "page" : 1, "size" : 10, "count" : 15 }, "result" : [ { "display_name" : "Priority", "created_by" : "System", "field_type" : "pick", "show_on_card" : false, "optional" : true, "all_options" : [ { "id" : "1135144056192544813", "code" : "High", "display_value" : "High", "value" : "High", "level" : 1, "sequence" : 1 } ], "default_value" : "" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Success response. |
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