Help Center/ CodeArts Req/ API Reference/ API/ IPD Feature/Feature Set Management/ Querying the Snapshot Version of a Feature Set
Updated on 2026-10-13 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Snapshot Version of a Feature Set

Function

This API is used to query the snapshot version list of all feature sets in a project.

Calling Method

For details, see Calling APIs.

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

codeartsreq:featureSet:getBaseline

Read

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

GET /v1/ipdprojectservice/projects/{project_id}/snapshots/version

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

32-character ID of a project, which must be unique. Obtain the value by calling the API for querying the IPD project list. The value of id in the response message body is the project ID.

Constraints

N/A

Range

A string of 32 characters consisting of letters and digits.

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 for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

10 to 32,768 characters

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Definition

Response status.

Range

  • success: The feature set snapshot version is successfully queried.

  • error: Failed to query the feature set snapshot version.

message

String

Definition

Returned message.

Range

N/A

result

Array of SnapshotsTitleVO objects

Definition

Feature set snapshot version list data.
Table 4 SnapshotsTitleVO

Parameter

Type

Description

id

String

Definition

Feature set snapshot version ID. Obtain the value of this parameter using the Querying Feature Set Snapshot Version API. The value of id in the response body is the snapshot version ID.

Range

A string of 18 to 19 digits.

title

String

Definition

Snapshot version title of a feature set, which is used to identify and distinguish different snapshot versions.

Range

0 to 512 characters.

created_by

UserEntity object

Definition

Creator information of a snapshot version, including the user ID, username, and nickname.

modified_by

UserEntity object

Definition

Latest modifier information of a snapshot version, including the user ID, username, and nickname.

created_date

String

Definition

Timestamp when a snapshot version is created.

Range

A string of 13 to 14 digits.

modified_date

String

Definition

Latest modification timestamp of a snapshot version.

Range

A string of 13 to 14 digits.
Table 5 UserEntity

Parameter

Type

Description

id

String

Definition

User ID. Obtain it by calling the API for querying project members. The value of id in the response message body is the user ID.

Range

N/A

name

String

Definition

Username.

Range

2 to 64 characters.

nick_name

String

Definition

User alias.

Range

2 to 30 characters

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error description, which is a supplement to error_code.

Range

N/A

Example Requests

Querying all feature set snapshot versions in a project

GET https://{endpoint}/v1/ipdprojectservice/projects/b7262b36cfa84b09a27f7896e1fdefc6/snapshots/version

Example Responses

Status code: 200

{
  "status" : "success",
  "message" : null,
  "result" : [ {
    "id" : "981644868612829184",
    "title" : "1-2-1 Snapshot",
    "created_by" : {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_01",
      "nick_name" : "Test account"
    },
    "modified_by" : {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_01",
      "nick_name" : "Test account"
    },
    "created_date" : "1711971974000",
    "modified_date" : "1711971974000"
  }, {
    "id" : "981645326705139713",
    "title" : "1-2-2 Snapshot",
    "created_by" : {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_01",
      "nick_name" : "Test account"
    },
    "modified_by" : {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_01",
      "nick_name" : "Test account"
    },
    "created_date" : "1711972083000",
    "modified_date" : "1711972083000"
  }, {
    "id" : "982005155140513792",
    "title" : "Equivalent to the Current Version",
    "created_by" : {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_01",
      "nick_name" : "Test account"
    },
    "modified_by" : {
      "id" : "a360371833bf4c558f796fd707b44daf",
      "name" : "devcloud_devcloud_01",
      "nick_name" : "Test account"
    },
    "created_date" : "1712057873000",
    "modified_date" : "1712057873000"
  } ]
}

Status code: 400

{
  "error_code" : "PM.02174103",
  "error_msg" : "No permission."
}

Status Codes

Status Code

Description

200

The feature set snapshot version is successfully queried.

400

Response upon a request failure. For example, the user does not have the operation permission or the project does not exist.

Error Codes

See Error Codes.