Help Center/ CodeArts Req/ API Reference/ APIs/ Work Items of the Scrum Project/ Querying the Work Item Transfer Configuration of a Scrum Project

Updated on 2023-06-12 GMT+08:00

View PDF

Querying the Work Item Transfer Configuration of a Scrum Project

Function

URI

GET /v4/projects/{project_id}/issues/workflow/config

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the 32-bit ID of the devcloud project. Minimum: 32 Maximum: 32

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
tracker_id	Yes	Integer	Work item type ID [2,3,4,5,6,7]

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. Minimum: 10 Maximum: 32768

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
workflows	Array of ScrumStatusFlowVo objects	Data Transfer APIs

**Table 5** ScrumStatusFlowVo
Parameter	Type	Description
id	String	UUID of the transferred data.
name	String	Event Name
status_id	Integer	Status ID.
direct_to	Array of ScrumStatusFlowDirectToVo objects	Data Transferred to

**Table 6** ScrumStatusFlowDirectToVo
Parameter	Type	Description
id	String	UUID of the transferred data.
status_id	Integer	Status ID.
name	String	Status
enabled	Boolean	Indicates whether to enable flow transfer.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Example Requests

GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issues/workflow/config?tracker_id=7

GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issues/workflow/config?tracker_id=7

Example Responses

Status code: 200

{
  "workflows" : [ {
    "id" : "2e645dbab6874a3eafa77ef06b97ea75",
    "name" : "",
    "status_id" : 1,
    "direct_to" : [ {
      "id" : "2e645dbab6874a3eafa77ef06b97ea75",
      "status_id" : 2,
      "name" : "",
      "enabled" : true
    } ]
  } ]
}