Querying the Work Hour Type

Function

This API is used to query the work hour type.

Calling Method

For details, see Calling APIs.

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 Querying the IPD Project List API. The value of id in the response message body is the project ID. Constraints: N/A Value range: N/A Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
display_value	No	String	Definition: Display name. Fuzzy search is supported. Constraints: Minimum length: 0 characters. Maximum length: 30 characters. Options: 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: Returned status. Value range: success: The response is successful. error: The response failed.
message	String	Definition: Message. Options: N/A
result	Array of WorkHourCategoryVO objects	Definition: Work type.

**Table 4** WorkHourCategoryVO
Parameter	Type	Description
id	String	Definition: Work type ID. Options: N/A
value	String	Definition: Unique value of the work type. Options: R&D design, backend development, frontend development (web), frontend development (applet), frontend development (app), test and verification, defect rectification, UI design, meeting, public affairs, training, study, reassignment and leave, and other.
code	String	Definition: Unique code of the work type. Options: R&D design, backend development, frontend development (web), frontend development (applet), frontend development (app), test and verification, defect rectification, UI design, meeting, public affairs, training, study, reassignment and leave, and other.
sequence	String	Definition: Sorting order. Options: N/A
display_value	String	Definition: Display name. Options: R&D design, backend development, frontend development (web), frontend development (applet), frontend development (app), test and verification, defect rectification, UI design, meeting, public affairs, training, study, reassignment and leave, and other.
value_py	String	Definition: Work type name abbreviation. Options: N/A

Status code: 400

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

Example Requests

Searching for work hour types whose name contain development

{url}/v1/ipdprojectservice/projects/693d17d43d6340d782da7356efc584a7/work-hour/options?display_value=development

Example Responses

Status code: 200

Work hour type response body.

{
  "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"
  } ]
}