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

Querying All Severities

Function

This API is used to query all severities.

Calling Method

For details, see Calling APIs.

URI

GET /v2/issue-severity/all

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain the token by calling theObtaining a User TokenIAM API. In the returned response header, X-Subject-Token is the desired user token.

Constraints:

Mandatory.

Range:

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

Default value:

N/A

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

result

result object

Definition:

Returned result.

status

String

Definition:

Returned status.

Value range:

success: The modification is successful.

error: The modification fails.

Table 3 result

Parameter

Type

Description

severities

Array of severities objects

Definition:

Severity.

Table 4 severities

Parameter

Type

Description

id

Integer

Definition:

Enumerated ID of severity.

Value range:

N/A

name

String

Definition:

Severity level.

Value range:

Critical, Major, Minor, and Trivial

position

Integer

Definition:

Enumerated position of severity.

Value range:

N/A

isDefault

Boolean

Definition:

Whether the severity is the default value.

Value range:

true (default value)

false (not the default value)

type

String

Definition:

Severity type.

Value range:

Critical, Major, Minor, and Trivial

active

Boolean

Definition:

Whether the severity is common.

Value range:

false (uncommon)

true (common)

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

GET https://{endpoint}/v2/issue-severity/all

Example Responses

Status code: 200

This API is used to query the JSON strings of all severities.

{
  "result" : {
    "severities" : [ {
      "id" : 10,
      "name" : "Critical",
      "position" : 1,
      "isDefault" : false,
      "type" : "Severity",
      "active" : true
    }, {
      "id" : 11,
      "name" : "Major",
      "position" : 1,
      "isDefault" : false,
      "type" : "Severity",
      "active" : true
    }, {
      "id" : 12,
      "name" : "Minor",
      "position" : 1,
      "isDefault" : true,
      "type" : "Severity",
      "active" : true
    }, {
      "id" : 13,
      "name" : "Trivial",
      "position" : 1,
      "isDefault" : false,
      "type" : "Severity",
      "active" : true
    } ]
  },
  "status" : "success"
}

Status Codes

Status Code

Description

200

This API is used to query the JSON strings of all severities.

400

Bad Request

401

Unauthorized

403

Forbidden

Error Codes

See Error Codes.