Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
DataArts Fabric
IoT
IoT Device Access
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
Huawei Cloud Astro Canvas
Huawei Cloud Astro Zero
CodeArts Governance
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance (CCI)
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Cloud Transformation
Well-Architected Framework
Cloud Adoption Framework
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Blockchain
Blockchain Service
Web3 Node Engine Service
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

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

Table 1 Path Parameters

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

Table 2 Query Parameters

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

Table 3 Request header 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

Table 4 Response body parameters

Parameter

Type

Description

page

PageVO object

Description: pagination information.

result

Array of FieldVO objects

Description: returned data.

Table 5 PageVO

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

Table 6 FieldVO

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

Table 7 OptionEntity

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.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback