Conversion Task

Create asset conversion task

API request

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
taskName	String	Required	Name of the conversion task. Character limit is 100.
description	String	Optional	Description of the conversion task.
location	Object	Required	Destination project and folder within IDMC where the converted assets will be saved. Provide projectId and projectName to identify the target project, and folderId and folderName to specify the folder within that project.
location.projectName	String	Optional	Name of the project in your Informatica Intelligent Cloud Services (IICS) repository where the converted assets will be saved. Must correspond to an existing project accessible to your organization.
location.projectId	String	Optional	Unique identifier for the project in which the conversion task output assets will be stored.
location.folderName	String	Optional	Name of the destination folder within the specified project where the conversion task and its output assets will be stored.
location.folderId	String	Optional	Unique identifier for the folder within the project where the conversion task output will be stored.
runtimeEnv	String	Required	Unique identifier for the Secure Agent group (runtime environment) that executes the conversion task. Corresponds to the runtimeEnvName field.
runtimeEnvName	String	Required	Display name of the Secure Agent group assigned to execute the conversion task. Corresponds to the runtimeEnv ID value and identifies which runtime environment processes the asset conversion.
domainId	String	Required	Unique identifier for the PowerCenter domain associated with the conversion task. Used to locate the source domain from which assets are being migrated.
domainName	String	Required	Name of the PowerCenter domain that contains the repository specified in repoName. Used to identify the source domain from which workflows and mappings are being migrated to IICS.
repoName	String	Required	Name of the PowerCenter repository containing the workflows and folders selected for conversion. Must match an existing repository within the specified domain.
sharedLocation	String	Required	File system path to the shared network location where PowerCenter source files and conversion artifacts are stored and accessed during task execution.
categoryType	String	Optional	Category of assets targeted for conversion in this task. Determines which asset types are processed and which conversion rules apply. Allowed values: MAPPING, PCRS.
connectionMapConfigId	String	Optional	Identifier for the connection map configuration to apply during conversion. References a pre-defined mapping that controls how source connections are translated to target connections in Informatica Intelligent Cloud Services (IICS).
conversionPropertyConfigId	String	Optional	Identifier for the conversion property configuration to apply to this task. References a pre-defined set of conversion properties that controls how source assets are transformed during the conversion process.
folders	Array	Required	List of PowerCenter repository folders to include in the conversion task. Each entry identifies a source folder by name and optionally by ID, and scopes the conversion to specific workflows or assets within that folder. Use workflows to target individual workflow names, or use assets to specify assets by type and name. If neither workflows nor assets is provided, all supported content in the folder is included.
folders.folder	String	Required	Name of the PowerCenter repository folder containing the workflows or assets to include in the conversion task.
folders.workflows	Array	Required	List of workflow names within the specified folder to include in the conversion task. Each entry corresponds to a workflow defined in the PowerCenter repository folder identified by folders[].folder. To convert all workflows in a folder, omit this field or leave the array empty.
folders.id	String	Required	Unique identifier for the folder entry within the folders array, used to reference a specific source folder in the conversion task.
folders.assets	Array	Required	List of asset objects within a folder to include in the conversion task. Each object specifies a type identifying the category of asset and a names array listing the individual asset names of that type to convert.
folders.assets.type	String	Required	Type of asset to include from the specified folder during conversion. Controls which asset category is targeted for conversion within the folder, alongside any explicitly listed workflows.
folders.assets.names	Array	Required	List of asset names within the folder to include in the conversion task. Each entry corresponds to a specific asset of the type defined by the sibling type field.

Request headers

Response parameters

Sample request

Sample response

201 Created

{
"id": "0100000B00000000001A",
"description": "Migrates PowerCenter workflows to IICS",
"orgId": "a1b2c3d4",
"frsId": "frs_00012345",
"createdTime": "2025-03-15T10:30:00Z",
"updatedTime": "2025-03-15T11:45:00Z",
"createdBy": "admin@example.com",
"createdByUserId": "usr_001",
"updatedBy": "admin@example.com"
}

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 conversion task definition

API request

Request parameters

Path parameters

The following table describes the path parameters that you specify in the API request:

Name	Type	Required	Description
taskId	String	Required	Unique identifier for the conversion task whose definition you want to retrieve.

Query parameters

No parameter.

Body Parameters

This endpoint does not require any body parameters.

Request headers

Response parameters

Sample request

Sample response

200 OK

{
"taskName": "Migration_Task_01",
"description": "Migrates PowerCenter workflows from domain X to IICS",
"type": "CONVERSION",
"location": {
"projectName": "string",
"projectId": "string",
"folderName": "string",
"folderId": "string"
},
"createdBy": "admin@example.com",
"createdByUserId": "usr_001",
"runtimeEnv": "01000025000000000002",
"runtimeEnvName": "US_West_Agent_Group",
"sharedDirectoryLocation": "/shared/infa/conversion",
"domainId": "DOM_12345",
"domainName": "InfaDomain",
"repoName": "PC_REPO_DEV",
"folders": [
{
"folder": "string",
"workflows": [
"string"
],
"id": "string",
"assets": [
{
"type": "string",
"names": [
"string"
]
}
]
}
]
}

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"
}

Update conversion task

API request

Request parameters

Path parameters

The following table describes the path parameters that you specify in the API request:

Name	Type	Required	Description
taskId	String	Required	Unique identifier for the conversion task to update.

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
taskName	string	Required	Updated name for the conversion task. Use a descriptive, unique name to distinguish this task from others in the same project or folder.
description	string	Required	Human-readable description of the conversion task update. Captures the purpose or scope of the changes being made, such as updated migration targets or revised folder selections.
location	object	Required	Destination location for the conversion task within the organizational hierarchy. Contains the target project and folder where the task is stored, identified by both name and ID fields (projectName, projectId, folderName, folderId).
location.projectName	string	Required	Name of the project where the conversion task is saved. Must correspond to a valid, existing project in your organization.
location.projectId	string	Required	Unique identifier for the project in which the updated conversion task is located.
location.folderName	string	Required	Name of the destination folder within the specified project where the conversion task is saved or organized.
location.folderId	string	Required	Unique identifier for the folder within the project where the conversion task is located.
runtimeEnv	string	Required	Unique identifier for the Secure Agent group (runtime environment) that executes the conversion task. Determines which agent group processes the task workload.
runtimeEnvName	string	Required	Display name of the runtime environment or agent group assigned to execute the conversion task. Corresponds to the runtimeEnv ID field and is used to identify the target execution environment by name.
connectionMapConfigId	string	Required	Identifier for the connection map configuration to apply to this conversion task. Controls how source connections are mapped to target connections during the conversion process.
conversionPropertyConfigId	string	Required	Identifier for the conversion property configuration to apply to this task. Controls which property settings govern the conversion behavior during execution.
folders	array	Required	List of source folders and their associated assets to include in the conversion task update. Each entry identifies a folder by name and optionally scopes the conversion to specific workflows or assets within that folder. Use folder to specify the folder name, workflows to list individual workflow names, id to reference the folder by its unique identifier, and assets to define asset types and their names for more granular scoping.
folders[].folder	string	Required	Name of the source folder within the conversion task that contains the workflows or assets to be converted. Maps to a folder in the connected source environment, such as a PowerCenter repository folder.
folders[].workflows	array	Required	List of workflow names within the specified folder to include in the conversion task. Each entry corresponds to a workflow that will be processed during conversion. When provided, only the listed workflows are targeted; omit this field or leave it empty to include all workflows in the folder.
folders[].id	string	Required	Unique identifier for the folder entry within the folders array. Used to reference a specific folder when updating its configuration as part of the conversion task.
folders[].assets	array	Required	List of asset objects within a folder that define the specific asset types and their names to include in the conversion task. Each object contains a type field identifying the asset category and a names array listing the individual asset names of that type.
folders[].assets[].type	string	Required	Asset type within the folder entry that scopes which assets are included in the conversion task. Identifies the category of assets (such as workflows or mappings) to be converted from the specified folder.
folders[].assets[].names	array	Required	List of asset names within the specified asset type to include in the conversion task folder. Each entry corresponds to a named asset of the type defined in assets[].type.

Request headers

Response parameters

Sample request

Sample response

201 Created

{
"id": "0100000B00000000001A",
"description": "Migrates PowerCenter workflows to IICS",
"orgId": "a1b2c3d4",
"createTime": "2025-03-15T10:30:00Z",
"updateTime": "2025-03-15T11:45:00Z",
"createdBy": "admin@example.com",
"createdByUserId": "usr_001",
"updatedBy": "admin@example.com"
}

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"
}

Run conversion task

API request

Request parameters

Path parameters

The following table describes the path parameters that you specify in the API request:

Name	Type	Required	Description
taskId	String	Required	Unique identifier for the conversion task to be submitted for execution.

Query parameters

No parameter.

Body Parameters

This endpoint does not require any body parameters.

Request headers

Response parameters

Sample request

Sample response

200 OK

{
"runId": "string",
"message": "string"
}

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 Runtime Configuration for a Conversion Task Run

API request

Request parameters

Path parameters

The following table describes the path parameters that you specify in the API request:

Name	Type	Required	Description
taskId	String	Required	Unique identifier for the conversion task whose run configuration you want to retrieve.
runId	String	Required	Unique identifier for the specific run of the conversion task. Used with taskId to scope the runtime configuration response to a single task execution instance.

Query parameters

No parameter.

Body Parameters

This endpoint does not require any body parameters.

Request headers

Response parameters

Sample request

Sample response

200 OK

{
"taskName": "Migration_Task_01",
"type": "CONVERSION",
"location": {
"projectName": "string",
"projectId": "string",
"folderName": "string",
"folderId": "string"
},
"runtimeEnv": "01000025000000000002",
"domainId": "DOM_12345",
"domainName": "InfaDomain",
"repoName": "PC_REPO_DEV",
"connectionMapConfigId": "cfg_conn_001",
"conversionPropertyConfigId": "cfg_prop_001",
"folders": [
{
"folder": "string",
"workflows": [
"string"
],
"id": "string",
"assets": [
{
"type": "string",
"names": [
"string"
]
}
]
}
]
}

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 Conversion Asset Metrics for a Task Run

API request

Request parameters

Path parameters

The following table describes the path parameters that you specify in the API request:

Name	Type	Required	Description
taskId	String	Required	Unique identifier for the conversion task whose run-level asset metrics you want to retrieve.
runId	String	Required	Unique identifier for the specific execution instance of the conversion task. Used alongside taskId to scope the asset metrics response to a single task run.

Query parameters

No parameter.

Body Parameters

This endpoint does not require any body parameters.

Request headers

Response parameters

Sample request

Sample response

200 OK

{
"repoType": "string",
"objectsProcessed": 0,
"metrics": [
{
"assetType": "string",
"assetCount": 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"
}

Delete task by ID

API request

Request parameters

Path parameters

The following table describes the path parameters that you specify in the API request:

Name	Type	Required	Description
taskId	String	Required	Unique identifier for the task to be deleted.

Query parameters

No parameter.

Body Parameters

This endpoint does not require any body parameters.

Request headers

Response parameters

Sample request

Sample response

200 OK

{
"message": "Task deleted successfully"
}

400 Bad Request

{
"message": "Bad request \u2013 invalid task id or running instance present"
}

401 Unauthorized

{
"message": "Unauthorized \u2013 missing or invalid session credentials"
}

404 Not Found

{
"message": "Task not found"
}

500 Internal Server Error

{
"message": "Internal server error while deleting task"
}