Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ ThirdParty/ Obtaining E2E Settings of a Project
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Obtaining E2E Settings of a Project

Function

This API is used to obtain the E2E settings of a project.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsrepo::getProjectSetting

Read

-

codeartsrepo:ProjectId

-

-

URI

GET https://{hostURL}/v4/projects/{project_id}/e2e-setting

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

You can obtain the unique project identifier, 32-character project UUID, by calling the API used to query the project list.

Range

String length: 32 characters.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

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

Constraints

N/A

Range

1–100,000 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

e2e_policies

E2ePolicyDto object

Definition:

E2E common settings

req

ReqSettingDto object

Definition:

CodeArts Req settings that can be integrated.

link

LinkSettingDto object

Definition:

Link settings that can be integrated.
Table 4 E2ePolicyDto

Parameter

Type

Description

auto_extract

Boolean

Definition:

Whether to enable automatic extraction of IDs.

Value range:

true: yes; false: no

prefix_symbol

String

Definition:

Set of ID prefixes for automatic extraction separated by commas (,)

Value range:

A prefix can contain a maximum of 200 characters. A maximum of 10 prefixes can be configured.

separator

String

Definition:

Separator for automatic extraction

suffix_symbol

String

Definition:

ID suffix of automatic extraction
Table 5 ReqSettingDto

Parameter

Type

Description

active

Boolean

Definition:

Whether to enable integration with CodeArts Req.

Value range:

true: yes; false: no

branches

String

Definition:

Enable branch list that can be excluded and associated with specified categories. The branch refers to the target branch of the merge request. Multiple branches can be separated by commas (,) or regular expressions. Only regular expressions can be configured at the project and repository group levels.

branches_type

String

Definition:

Branch type, which can be text or regular expression.

Value range:

plain: text; regex: regular expression

Enumeration values:

  • plain

  • regex

project_type

String

Definition:

Type of the associated CodeArts Req project

Value range:

scrum: Scrum project; ipd: IPD project; xboard: Kanban project

Enumeration values:

  • scrum

  • ipd

  • xboard

categories

String

Definition:

List of association types, separated by commas (,)

category_codes

String

Definition:

List of associable type codes, which are separated by commas (,)

exclude_statuses

String

Definition:

List of excluded states, separated by commas (,)

exclude_status_codes

String

Definition:

List of excluded state codes, separated by commas (,)
Table 6 LinkSettingDto

Parameter

Type

Description

active

Boolean

Definition:

Whether to enable the integration with Link.

Value range:

true: yes; false: no

url

String

Definition:

Interconnection address of the Link service

app_auth_type

String

Definition:

AK/SK for interconnecting with Link. ak_sk: AK and SK are used for authentication.

Enumeration values:

  • ak_sk

app_ak

String

Definition:

AK for interconnecting with Link

app_sk

String

Definition:

SK for interconnecting with Link. If the SK has been configured, the mask in the format of ************ is returned.

categories

String

Definition:

List of association types, separated by commas (,).

exclude_statuses

String

Definition:

List of excluded states, separated by commas (,).

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

GET https://{endpoint}/v4/projects/a642c851d4dc4853b595e5c8a5e56df7/e2e-setting

Example Responses

Status code: 200

OK

{
  "e2e_policies" : {
    "auto_extract" : true,
    "prefix_symbol" : "TicketNo",
    "separator" : ";",
    "suffix_symbol" : "\\\\n"
  },
  "req" : {
    "active" : true,
    "branches" : "dev",
    "branches_type" : "plain",
    "categories" : "Epic,Story",
    "category_codes" : "5,7",
    "exclude_statuses" : "New, resolved",
    "exclude_status_codes" : "1,3",
    "project_type" : "scrum"
  },
  "link" : {
    "active" : true,
    "url" : "https://demo.com",
    "app_auth_type" : "ak_sk",
    "app_ak" : "testak",
    "app_sk" : "************",
    "categories" : "IR",
    "exclude_statuses" : "First release"
  }
}

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Bad Request

Error Codes

See Error Codes.

Parent topic: ThirdParty