Updated on 2025-09-10 GMT+08:00

Querying the Work Type List (V5)

Function

This API is used to query the work type list.

Calling Method

For details, see Calling APIs.

URI

GET /v5/projects/{project_uuid}/work-hours-type

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_uuid

Yes

String

Definition:

32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API.

Constraints:

The value must contain 32 characters. Digits and letters are allowed.

Value range:

N/A

Default value:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

status

No

Integer

Definition:

Whether the work type is valid.

Constraints:

N/A

Value range:

0 (deleted)

1 (valid)

2 (discarded)

Default value:

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token by calling the IAM API forobtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints:

Mandatory.

Value range:

Minimum length: 10 characters. Maximum length: 32,768 characters.

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

result object

Definition:

Returned result.

status

String

Definition:

Returned status.

Value range:

success: Command execution succeeds.

error: Command execution failed.

Table 5 result

Parameter

Type

Description

total_count

Integer

Definition:

Total number of work types.

Value range:

N/A

list

Array of list objects

Definition:

Work type list.

Table 6 list

Parameter

Type

Description

id

Integer

Definition:

Primary key ID of a work type.

Value range:

N/A

project_num_id

Integer

Definition:

Digital ID of a project.

Value range:

N/A

name

String

Definition:

Name of a work type.

Value range:

N/A

created

String

Definition:

Time when a work type is created. The format is yyyy-MM-dd HH:mm:ss.z, for example, 2025-08-06 10:00:51.0.

Value range:

N/A

modified

String

Definition:

Time when the work type is modified. The format is yyyy-MM-dd HH:mm:ss.z, for example, 2025-08-06 10:00:51.0.

Value range:

N/A

position

Integer

Definition:

Position of a work type in the list.

Value range:

N/A

status

Integer

Definition:

Whether the work type is valid.

Value range:

0 (deleted)

1 (valid)

2 (discarded)

in_use

Boolean

Definition:

Whether the work type has been used.

Value range:

true: The work type has been used.

false: The work type has not been used.

Example Requests

GET https://{endpoint}/v5/projects/c15cc54e338d4506afd9bd8103071ff0/work-hours-type?status=1

Example Responses

Status code: 200

Success response of the labor hour type list interface.

{
  "result" : {
    "total_count" : 2,
    "list" : [ {
      "id" : 21,
      "project_num_id" : 6345282,
      "name" : "R&D and design",
      "created" : "2025-08-06 10:00:51.0",
      "modified" : "2025-08-06 10:00:51.0",
      "position" : 1,
      "status" : 1,
      "in_use" : true
    }, {
      "id" : 22,
      "project_num_id" : 6345282,
      "name" : "Backend development",
      "created" : "2025-08-06 10:00:51.0",
      "modified" : "2025-08-06 10:00:51.0",
      "position" : 2,
      "status" : 1
    } ]
  },
  "status" : "success"
}

Status Codes

Status Code

Description

200

Success response of the labor hour type list interface.

Error Codes

See Error Codes.