Updated on 2026-10-13 GMT+08:00

Querying the Work Hour Type

Function

This API is used to query the work hour type.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
codeartsreq:configuration:get	Read	-	codeartsreq:Model codeartsreq:ProjectId	-	-

URI

GET /v1/ipdprojectservice/projects/{project_id}/work-hour/options

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition 32-character ID of a project, which must be unique. Obtain the value by calling the API for querying the IPD project list. The value of id in the response message body is the project ID. Constraints N/A Range A string of 32 characters consisting of letters and digits. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
display_value	No	String	Definition Display name. Fuzzy search is supported. Constraints 0 to 30 characters. Range N/A Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
status	String	Definition Response status. Range success: The response is successful. error: The response failed.
message	String	Definition Message. Range N/A
result	Array of WorkHourCategoryVO objects	Definition Work type.

**Table 4** WorkHourCategoryVO
Parameter	Type	Description
id	String	Definition Workload type ID. Range A string of 18 to 19 digits.
value	String	Definition Unique ID of a workload type, which is used to transfer parameters through the API. Range R&D design Backend development Frontend development (web) Frontend development (mini program) Frontend development (app) Test and verification Defect fixing UI design Meetings Public affairs Training Research Others Replacement leave Custom workload type
code	String	Definition Unique code of the work type. Range The value is the same as that of the value field.
sequence	Integer	Definition Display sequence number of a workload type. Range N/A
display_value	String	Definition Display name of the workload type, which is used for page display. Range R&D design Backend development Frontend development (web) Frontend development (mini program) Frontend development (app) Test and verification Defect fixing UI design Meetings Public affairs Training Research Others Replacement leave Custom workload type
value_py	String	Definition Abbreviation of the workload type display name. Range N/A

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code. Range N/A
error_msg	String	Definition Error description, which is a supplement to error_code. Range N/A

Example Requests

Searching for work hour types whose name contain development

GET https://{endpoint}/v1/ipdprojectservice/projects/693d17d43d6340d782da7356efc584a7/work-hour/options?display_value=Development

Example Responses

Status code: 200

{
  "status" : "success",
  "message" : null,
  "result" : [ {
    "id" : "977516004109099010",
    "value" : "Backend development",
    "code" : "Backend development",
    "sequence" : 0,
    "display_value" : "Backend development",
    "value_py" : "hdkf"
  }, {
    "id" : "977516004109099016",
    "value" : "Frontend development (web)",
    "code" : "Frontend development (web)",
    "sequence" : 0,
    "display_value" : "Frontend development (web)",
    "value_py" : "qdkfw"
  }, {
    "id" : "977516004109099008",
    "value" : "Frontend development (applet)",
    "code" : "Frontend development (applet)",
    "sequence" : 0,
    "display_value" : "Frontend development (applet)",
    "value_py" : "qdkfc"
  }, {
    "id" : "977516004109099011",
    "value" : "Frontend development (app)",
    "code" : "Frontend development (app)",
    "sequence" : 0,
    "display_value" : "Frontend development (app)",
    "value_py" : "qdkfa"
  } ]
}

Status Codes

Status Code	Description
200	Work hour type response body.
400	Failure response body.

Error Codes

See Error Codes.

Parent topic: IPD Workload Management