REST API Reference > Cloud Data Integration for PowerCenter (CDI-PC) REST API > Assessment
  

Assessment

Enter a short description of the concept here (required).
This is the start of the concept.

Retrieve assessment status

Enter a short description of the reference here (required).
Enter the actual information in this section (optional).

Retrieve assessment summary for folders

Retrieves the assessment summary for folders within a specified repository.

API request

To retrieve assessment summary for folders, send a POST request to the following API endpoint:
POST /public/api/v2/assessment/summary/folder

Request parameters

Path parameters
No parameter.
Query parameters
No parameter.
Body Parameters
The following table describes the parameters that you specify in the API request body:
Name
Type
Required or Optional
Description
domain
string
Required
Unique identifier for the domain that contains the assessed repository.
repo
string
Required
Identifier for the repository within the specified domain to retrieve folder assessment summaries for. For example, PC_REPO_DEV.
page
integer
Required
Zero-based index of the page to retrieve in the paginated folder list response.
pageSize
integer
Required
Number of folder resources to return per page. Use this value together with page to paginate through large result sets.
sortFields
array
Required
List of sort criteria applied to the folder summary results. Each entry specifies a field to sort by and a direction of either ASC or DESC.
sortFields[].field
string
Required
Field name used to sort the folder list results. Accepted value: folder.
sortFields[].direction
string
Required
Sort direction for the field specified in field. Allowed values: ASC (ascending) and DESC (descending).
filters
array
Required
List of filters to narrow the folder results returned in the response. Each filter object includes a type field identifying the filter category and a values array containing the terms to match against. Use the folders type to restrict results to folders whose names match the specified values.
filters[].type
string
Required
Category of filter to apply to the folder list results. Accepted value: folders.
filters[].values
array
Required
List of folder name patterns used to narrow results to matching folders within the assessed repository. Each value is matched against folder names, allowing you to scope the response to specific folder groups such as "Sales_ or "Finance_".

Request headers

The following table describes the headers that you specify in the API request:
Name
Required or Optional
Description
Accept
Optional
Response media types, e.g., application/json.

Response parameters

The following table describes the parameters that are returned by the API:
Name
Type
Description
total
Integer
Total number of folders matching the query across all pages.
folders
Array
List of folders in the assessed repository matching the request criteria.
folders.folderName
String
Name of the assessed folder within the repository.
folders.auto
Integer
Number of assets in the folder with an automatic migration assessment.
folders.manual
Integer
Number of assets in the folder requiring manual migration effort.
folders.partial
Integer
Number of assets in the folder with a partial migration assessment.
folders.totalAssets
Integer
Total number of assessed assets contained in the folder.
folders.taskId
String
Unique identifier for the assessment task associated with the folder.
folders.runId
Integer
Unique identifier for the assessment run that produced the folder summary.

Sample request

The following is a sample request based on the values provided:

curl -X POST \
"/workbench-service/public/api/v2/assessment/summary/folder" \
-H "Content-Type: application/json" \
-d '{"domain": "DOM_12345", "repo": "PC_REPO_DEV", "page": 0, "pageSize": 20, "sortFields": [{"field": "folder", "direction": "ASC"}], "filters": [{"type": "folders", "values": ["Sales_", "Finance_"]}]}'

Sample response

200 OK
{
"total": 42,
"folders": [
{
"folderName": "Sales_Workflows",
"auto": 15,
"manual": 3,
"partial": 7,
"totalAssets": 25,
"taskId": "0100000B00000000001A",
"runId": 1001
}
]
}
400 Bad Request
{
"message": "Bad request \u2013 invalid parameters"
}
401 Unauthorized
{
"message": "Unauthorized \u2013 missing or invalid session credentials"
}
500 Internal Server Error
{
"message": "Internal server error"
}

Retrieve assessment summary for a repository

Retrieves the assessment summary for a specified repository.

API request

To retrieve assessment summary for a repository, send a GET request to the following API endpoint:
GET /public/api/v2/assessment/summary/repo

Request parameters

Path parameters
No parameter.
Query parameters
The following table describes the query parameters that you specify in the API request:
Name
Type
Required
Description
domain
String
Optional
Unique identifier for the domain to which the assessed repository belongs. Used to scope the assessment summary response to a specific domain.
repo
String
Optional
Name of the repository for which assessment summary results are retrieved. Use this parameter to scope the response to a specific assessed repository within the specified domain.
Body Parameters
This endpoint does not require any body parameters.

Request headers

The following table describes the headers that you specify in the API request:
Name
Required or Optional
Description
Accept
Optional
Response media types, e.g., application/json.

Response parameters

The following table describes the parameters that are returned by the API:
Name
Type
Description
orgId
String
Unique identifier for the organization that owns the assessed repository.
domainId
String
Unique identifier for the domain to which the assessed repository belongs.
domainName
String
Name of the domain to which the assessed repository belongs.
repoName
String
Name of the assessed repository.
taskId
String
Unique identifier for the assessment task associated with this repository.
runId
Integer
Unique identifier for the specific assessment run.
assessmentResult
Object
Object containing the aggregated assessment results for the repository.
assessmentResult.totalAssets
Integer
Total number of assets evaluated during the assessment run.
assessmentResult.assessmentStatus
Object
Object containing the count of assets broken down by assessment completion status.

Sample request

The following is a sample request based on the values provided:

curl -X GET \
"/workbench-service/public/api/v2/assessment/summary/repo?domain=string repo=string"

Sample response

200 OK
{
"orgId": "a1b2c3d4",
"domainId": "DOM_12345",
"domainName": "InfaDomain",
"repoName": "PC_REPO_DEV",
"taskId": "0100000B00000000001A",
"runId": 1001,
"assessmentResult": {
"totalAssets": 0,
"assessmentStatus": {
"auto": 0,
"partial": 0,
"manual": 0
}
}
}
400 Bad Request
{
"message": "Bad request \u2013 invalid parameters"
}
401 Unauthorized
{
"message": "Unauthorized \u2013 missing or invalid session credentials"
}
404 Not Found
{
"message": "Resource not found"
}
500 Internal Server Error
{
"message": "Internal server error"
}

Retrieve Assessment Status of a PC or MRS Repository

Retrieves the current assessment status for a PowerCenter (PC) or Metadata Repository Service (MRS) repository.

API request

To retrieve Assessment Status of a PC or MRS Repository, send a GET request to the following API endpoint:
GET /public/api/v2/assessment/status

Request parameters

Path parameters
No parameter.
Query parameters
The following table describes the query parameters that you specify in the API request:
Name
Type
Required
Description
domain
String
Optional
Unique identifier of the domain to which the assessed repository belongs. When provided, results are scoped to repositories within that domain.
repo
String
Optional
Name of the PowerCenter (PC) or Metadata Repository Service (MRS) repository for which to retrieve assessment status. When provided, results are scoped to the specified repository within the given domain.
Body Parameters
This endpoint does not require any body parameters.

Request headers

The following table describes the headers that you specify in the API request:
Name
Required or Optional
Description
Accept
Optional
Response media types, e.g., application/json.

Response parameters

The following table describes the parameters that are returned by the API:
Name
Type
Description
domains
Array
List of domains containing assessed repositories and their current assessment status.
domains.domainId
String
Unique identifier for the domain to which the assessed repositories belong.
domains.name
String
Display name of the domain.
domains.repos
Array
List of repositories within the domain and their individual assessment details.

Sample request

The following is a sample request based on the values provided:

curl -X GET \
"/workbench-service/public/api/v2/assessment/status?domain=string repo=string"

Sample response

200 OK
{
"domains": [
{
"domainId": "string",
"name": "string",
"repos": [
{
"name": "string",
"status": "string",
"runId": 0,
"taskId": "string",
"assetView": false,
"isActive": 0
}
]
}
]
}
400 Bad Request
{
"message": "Bad request \u2013 invalid parameters"
}
401 Unauthorized
{
"message": "Unauthorized \u2013 missing or invalid session credentials"
}
404 Not Found
{
"message": "Resource not found"
}
500 Internal Server Error
{
"message": "Internal server error"
}