Querying Evaluation Projects

Function

This API is used to query evaluation projects.

URI

GET /v1/{project_id}/evaluation-projects

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
evaluation_project_name	No	String	Evaluation project name (fuzzy search).
evaluation_project_status	No	String	Evaluation project status. Value: COMPLETED PENDING FAILED STOPPED
offset	No	Integer	Offset of the pagination query. Minimum value: 0 Maximum value: 99 Default value: 0.
limit	No	Integer	Number of items displayed per page. Minimum value: 1 Maximum value: 100 Default value: 10

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token obtained from IAM.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_count	Integer	Total number of evaluation projects.
evaluation_projects	Array of Table 5 objects	Evaluation projects on the current page.

**Table 5** EvaluationProject
Parameter	Type	Description
evaluation_project_id	Integer	Evaluation project ID.
evaluation_project_name	String	Evaluation project name.
evaluation_project_status	String	Evaluation project status.
project_status_detail	Table 6 object	Details about the evaluation project status.
source_db_type	String	Source database type.
source_db_version	String	Source database version.
target_db_type	String	Target database type.
target_db_version	String	Target database version.
collect_size	Long	Size of collected SQL statements, in bytes.
resource_id	String	Resource ID.
created_time	String	Creation time.
updated_time	String	Update time.
error_reason	String	Failure cause.

**Table 6** ProjectStatusDetail
Parameter	Type	Description
object_collection_status	String	Collection status.
object_collection_progress	String	Collection progress.
pre_migration_status	String	Evaluation status.
pre_migration_progress	String	Evaluation progress.

Example Request

Querying evaluation projects

GET https://{endpoint}/v1/0ac6eb2c8000d2ee2fd9c006dededbe6/evaluation-projects?offset=0&limit=2

Example Response

Status code: 200

Request succeeded.

{ 
  "evaluation_projects" : [ { 
    "evaluation_project_id" : 187, 
    "evaluation_project_name" : "ugo_best", 
    "evaluation_project_status" : "PENDING", 
    "project_status_detail" : { 
      "object_collection_status" : "COMPLETED", 
      "pre_migration_status" : "COMPLETED" 
    }, 
    "source_db_type" : "ORACLE", 
    "source_db_version" : "11g", 
    "target_db_version" : "", 
    "collect_size" : 4623291, 
    "resource_id" : "826c916c-421d-4d9f-a68c-38bc3a9504ad", 
    "created_time" : "2022-06-23T03:34:39Z", 
    "updated_time" : "2022-06-23T03:34:39Z", 
    "error_reason" : "" 
  }, { 
    "evaluation_project_id" : 129, 
    "evaluation_project_name" : "ugo1_best", 
    "evaluation_project_status" : "PENDING", 
    "project_status_detail" : { 
      "object_collection_status" : "COMPLETED", 
      "pre_migration_status" : "COMPLETED" 
    }, 
    "source_db_type" : "ORACLE", 
    "source_db_version" : "11g", 
    "target_db_version" : "", 
    "collect_size" : 2914875, 
    "resource_id" : "c98da3c4-7afb-4b62-85f3-c8cb5f2393ef", 
    "created_time" : "2022-06-21T06:58:18Z", 
    "updated_time" : "2022-06-21T06:58:18Z", 
    "error_reason" : "" 
  } ], 
  "total_count" : 3 
}