Creating an Evaluation Project

Function

This API is used to create an evaluation project. An evaluation project consists of two phases: data collection and database evaluation.

URI

POST /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.

Request Parameters

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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
evaluation_project_name	Yes	String	Evaluation project name. The name can contain 5 to 50 characters, starts with a letter, and ends with a letter or digit. Underscores (_) and hyphens (-) are allowed. The name must be unique. Minimum length: 5 characters Maximum length: 50 characters
source_db_info	Yes	Table 4 object	Source database information.
schemas_info	Yes	Table 5 object	Schemas in the source database.
objects_type_info	Yes	Table 6 object	Object types in the source database.

**Table 4** SourceDBInfo
Parameter	Mandatory	Type	Description
connection_string	Yes	String	Connection string.
user_name	Yes	String	Username.
password	Yes	String	User password.
source_db_type	Yes	String	Database type. Value: ORACLE
source_db_version	Yes	String	Database version. CAUTION: This parameter must be used with source_db_type to form a source database type and version. Currently, the following source database types and versions are supported: ORACLE-11g, ORACLE-12c, ORACLE-18c, and ORACLE-19c. Valid value: 11g 12c 18c 19c

**Table 5** SchemaInfo
Parameter	Mandatory	Type	Description
is_select_all_schemas	Yes	Boolean	Whether to select all schemas.
schemas_list	No	Array of strings	Source database schemas to be evaluated. This parameter is mandatory when is_select_all_schemas is set to false.

**Table 6** ObjectTypeInfo
Parameter	Mandatory	Type	Description
is_select_all_objects_type	Yes	Boolean	Whether to select all object types. If the value is set to true, USER is not included.
objects_type_list	No	Array of strings	Object types to be evaluated. This parameter is mandatory when is_select_all_objects_type is set to false.

Response Parameters

None.

Example Request

Creating an evaluation project named best_UGO to collect all schemas and supported object types (The source database is Oracle 11g.)

POST https://{endpoint}/v1/0ac6eb2c8000d2ee2fd9c006dededbe6/evaluation-projects 
 
{ 
  "evaluation_project_name" : "best_UGO", 
  "source_db_info" : { 
    "user_name" : "ugo", 
    "password" : "Ugo@123", 
    "connection_string" : "100.xx.xxx.xxx:1521:ORCL", 
    "source_db_type" : "ORACLE", 
    "source_db_version" : "11g" 
  }, 
  "schemas_info" : { 
    "is_select_all_schemas" : true, 
    "schemas_list" : [ ] 
  }, 
  "objects_type_info" : { 
    "is_select_all_objects_type" : true, 
    "objects_type_list" : [ ] 
  } 
}