Querying Detailed Workloads of a User
Function
This API is used to query detailed workloads of a user.
Calling Method
For details, see Calling APIs.
URI
POST /v3/work-hours/get-member-work-hours
Request 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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
page_no |
No |
String |
Definition: Page index. Constraints: N/A Value range: N/A Default value: N/A |
page_size |
No |
String |
Definition: Page size. Constraints: N/A Value range: N/A Default value: N/A |
project_uuid |
No |
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 |
staff_id |
No |
String |
Definition: User ID (both the user digital ID and user UUID are supported). You can query user ID information using the Obtaining the Current User Information API. The returned user_id is the user UUID, and user_num_id is the user ID. Constraints: N/A Value range: N/A Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
result |
result object |
Definition: Returned result. |
status |
String |
Definition: Returned status. Value range: success: Command execution succeeds. error: Command execution failed. |
Parameter |
Type |
Description |
---|---|---|
dataList |
Array of dataList objects |
Definition: List of workloads of project members. |
total |
Integer |
Definition: Total number of workloads in the returned list. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: Digital ID of a work item. Value range: N/A |
subject |
String |
Definition: Work item title. Value range: N/A |
summary |
String |
Definition: Workload content. Value range: N/A |
created_on |
String |
Definition: Creation time in timestamp format, for example, 1747065600000. Value range: N/A |
work_date |
String |
Definition: Workload date, in the timestamp format, for example, 1747065600000. Value range: N/A |
work_hours |
String |
Definition: Workloads (unit: person-hour). Constraints: N/A Value range: N/A Default value: N/A |
assigned_to |
assigned_to object |
Definition: Workload creator. |
tracker |
Tracker object |
Definition: Work item type. |
Parameter |
Type |
Description |
---|---|---|
assigned_nick_name |
String |
Definition: User alias. Value range: N/A |
name |
String |
Definition: Username with tenant information, in the format of Tenant name_Username. Value range: N/A |
image_id |
String |
Definition: User avatar. Value range: N/A |
first_name |
String |
Definition: Username. Value range: N/A |
id |
Integer |
Definition: Digital ID of a user. Value range: N/A |
Example Requests
POST https://{endpoint}/v3/work-hours/get-member-work-hours { "page_no" : 1, "page_size" : 10, "project_uuid" : "a8ac165097ff4e42bcfb234dd27d30a6", "staff_id" : "1111" }
Example Responses
Status code: 200
Response to the project member workload list.
{ "result" : { "total" : 1, "dataList" : [ { "work_date" : "1747065600000", "created_on" : "1747065600000", "subject" : "TEST", "work_hours" : 22, "tracker" : { "name" : "Story", "id" : 7 }, "id" : 9079052, "assigned_to" : { "first_name" : "xxxxxx", "image_id" : "xxxxxx", "assigned_nick_name" : "xxxxxx", "name" : "xxxxxx", "id" : "1111" } } ] }, "status" : "success" }
Status Codes
Status Code |
Description |
---|---|
200 |
Response to the project member workload list. |
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