Querying Associated Work Items (V2)

Function

This API is used to query associated work item information (V2).

Calling Method

For details, see Calling APIs.

URI

GET /v2/issues/inquire-associate

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
page_no	No	Integer	Definition: Page index. Constraints: N/A Value range: Minimum value: 0. Maximum value: 9,999,999,999. Default value: N/A
page_size	No	Integer	Definition: Page size. Constraints: N/A Value range: Minimum value: 0. Maximum value: 9,999,999,999. Default value: N/A
issue_id	Yes	Integer	Definition: Work item ID, which can be obtained from the Performing Advanced Query of Work Items API. The value of the id field in the response message body is the work item ID. Constraints: The value must contain 1 to 10 digits. Value range: Minimum length: 1 character. Maximum length: 10 characters. Default value: N/A
project_id	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

Request Parameters

**Table 2** 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 3** Response body parameters
Parameter	Type	Description
result	result object	Definition: Returned result.
status	String	Definition: Returned status. Value range: success and error

**Table 4** result
Parameter	Type	Description
associateIssues	AssociateIssues object	Definition: Associated project sub-object.

**Table 5** AssociateIssues
Parameter	Type	Description
issues	Array of IssuesAssociate objects	Definition: Associated child work item information.
total_count	Integer	Definition: Total number of associated work items. Value range: N/A

**Table 6** IssuesAssociate
Parameter	Type	Description
identifier	String	Definition: UUID of the project to which the associated work item belongs. Value range: N/A
project_type	String	Definition: Project type. Value range: Scrum
new_status_name	String	Definition: New status name of the associated work item, for example, New. Value range: N/A
status_attribute_name	String	Definition: Status type of the associated work item. Value range: To Do, Doing, and Done.
subject	String	Definition: Title of the associated work item. Value range: N/A
status_name	String	Definition: Status name of the associated work item. Value range: N/A
project_name	String	Definition: Name of the project to which the associated work item belongs. Value range: N/A
status_id	Integer	Definition: Status ID of the associated work item. Value range: N/A
id	Integer	Definition: ID of the associated work item. Value range: N/A
assigned_to	AssignedAssociate object	Definition: Current owner of the associated work item.

**Table 7** AssignedAssociate
Parameter	Type	Description
assigned_user_num_id	Integer	Definition: Digital ID of a user. Value range: N/A
assigned_nick_name	String	Definition: User alias. Value range: N/A
name	String	Definition: Username with tenant information. Value range: N/A
last_name	String	Definition: Username. Value range: N/A
assigned_user_id	String	Definition: 32–character UUID of a user. Value range: N/A
first_name	String	Definition: Username. Value range: N/A

Example Requests

GET http://{endpoint}/v2/issues/inquire-associate??project_id=c15cc54e338d4506afd9bd8103071ff0&issue_id=9132318&page_no=1&page_size=10

Example Responses

Status code: 200

Successful response for querying associated work item information interface.

{
  "result" : {
    "associateIssues" : {
      "total_count" : 2,
      "issues" : [ {
        "identifier" : "c15cc54e338d4506afd9bd8103071ff0",
        "project_type" : "scrum",
        "new_status_name" : "New",
        "status_attribute_name" : "To Do",
        "subject" : "5555",
        "status_name" : "New",
        "project_name" : "Scrum0610ceshi",
        "status_id" : 1,
        "id" : 9184456,
        "assigned_to" : {
          "first_name" : "xxxxxx",
          "assigned_user_num_id" : 1111,
          "assigned_nick_name" : "xxxxxx",
          "name" : "xxxxxx",
          "last_name" : "xxxxxx",
          "assigned_user_id" : "xxxxxx"
        }
      }, {
        "identifier" : "c15cc54e338d4506afd9bd8103071ff0",
        "project_type" : "scrum",
        "new_status_name" : "New",
        "status_attribute_name" : "To Do",
        "subject" : "Test",
        "status_name" : "New",
        "project_name" : "Scrum0610ceshi",
        "status_id" : 1,
        "id" : 9178848,
        "assigned_to" : {
          "first_name" : "xxxxxx",
          "assigned_user_num_id" : 1111,
          "assigned_nick_name" : "xxxxxx",
          "name" : "xxxxxx",
          "last_name" : "xxxxxx",
          "assigned_user_id" : "xxxxxx"
        }
      } ]
    }
  },
  "status" : "success"
}