REST API Reference > Cloud Data Integration for PowerCenter (CDI-PC) REST API > Bulk Conversion Task
  

Bulk Conversion Task

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

Create bulk conversion export task

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

Create bulk conversion update task

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

Create bulk conversion task

Creates a bulk conversion task targeting one or more assets within a specified project and folder location.

API request

To create bulk conversion task, send a POST request to the following API endpoint:
POST /public/api/v2/asset/bulkconversion/task

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
User-defined name for the bulk conversion task. Used to identify and distinguish the task within the project. Maximum 100 characters.
description
string
Required
Human-readable label for the bulk conversion task. Used to identify and distinguish the task within the project or folder where it is created.
type
string
Required
Type of bulk conversion task to create. This value determines the processing behavior applied to the assets included in the task. For example, BULK_UPDATE_TASK indicates a bulk update operation targeting the specified asset locations.
location
object
Required
Target project and folder where the bulk conversion task will be created. Contains projectName, projectId, folderName, and folderId to identify the destination within the organizational hierarchy.
location.projectName
string
Required
Name of the project that contains the destination folder where the bulk conversion task output will be stored.
location.projectId
string
Required
Unique identifier for the project in which the bulk conversion task output assets will be stored.
location.folderName
string
Required
Name of the folder within the project where the bulk conversion task output will be stored. Corresponds to the folderId field in the same location object.
location.folderId
string
Required
Unique identifier for the folder within the project where the bulk conversion task output will be stored.
createdBy
string
Required
Email address or username of the user who created the bulk conversion task.
runtimeEnv
string
Required
Identifier of the runtime environment used to execute the bulk conversion task, such as a Secure Agent or Secure Agent group.
workflows
array
Required
List of workflow identifiers associated with the bulk conversion task. Each entry references a workflow to be included in the conversion process.
runOptions
object
Required
Set of boolean flags that control which processing steps are executed during the bulk conversion task. Each flag defaults to false and can be set independently. Set exportMetadata to true to export asset metadata, uploadPCXML to upload PowerCenter XML, xmlPreProcessing to run XML pre-processing, repointing to apply connection repointing, conversion to perform asset conversion, generateParameterFile to produce a parameter file, and mrsConversion to execute MRS conversion.
runOptions.exportMetadata
boolean
Required
Controls whether asset metadata is exported as part of the bulk conversion task run. Set to true to include metadata export in the task execution; set to false to skip this step.
runOptions.uploadPCXML
boolean
Required
Controls whether the Power Center XML (PCXML) file is uploaded as part of the bulk conversion task run. Set to true to include PCXML upload in the task execution; set to false to skip this step.
runOptions.xmlPreProcessing
boolean
Required
Controls whether XML pre-processing is performed as part of the bulk conversion run. Set to true to enable XML pre-processing during task execution. Defaults to false.
runOptions.repointing
boolean
Required
Controls whether asset repointing is included as a step when the bulk conversion task runs. Set to true to enable repointing; set to false to skip this step.
runOptions.conversion
boolean
Required
Controls whether asset conversion is performed as part of the bulk task run. Set to true to enable conversion processing for the selected assets; set to false to skip conversion.
runOptions.generateParameterFile
boolean
Required
Controls whether a parameter file is generated as part of the bulk conversion task run. Set to true to enable parameter file generation during task execution; set to false to skip this step.
runOptions.mrsConversion
boolean
Required
Controls whether MRS (Mapping Recovery Service) conversion is performed as part of the bulk task run. Set to true to enable MRS conversion; defaults to false.
id
string
Required
Unique identifier for the bulk conversion task. Assigned by the system at creation and used to reference the task in subsequent operations.
orgId
string
Required
Unique identifier for the organization associated with the bulk conversion task.
assetType
string
Required
Type of asset targeted by the bulk conversion task. Accepted values correspond to supported asset categories within the project, such as Mapping.
operation
string
Required
Operation to perform on the selected assets during the bulk conversion task. Controls how the task processes the target assets. Allowed values vary by categoryType and assetType configuration, such as UPDATE.
categoryType
string
Required
Category classification that determines how the bulk conversion task is processed. Controls the grouping and handling logic applied to the assets included in the task. Example value: ASSET_UPDATE.
createdByUserId
string
Required
Unique identifier of the user who created the bulk conversion task.
sharedLocation
string
Required
Shared file system path where bulk conversion input files are staged for processing. Used when the source file is not uploaded directly through the UI but is instead pre-placed in a shared location accessible to the runtime environment.
assetsLocations
array
Required
List of project and folder locations that identify which assets to include in the bulk conversion task. Each entry specifies a projectName, projectId, folderName, and folderId to scope the operation to one or more folders across one or more projects.
assetsLocations[].projectName
string
Required
Name of the project that contains the assets targeted for bulk conversion, within the specified folder.
assetsLocations[].projectId
string
Required
Unique identifier for the project that contains the assets targeted by the bulk conversion task. Corresponds to the projectId of the project specified in assetsLocations[].projectName.
assetsLocations[].folderName
string
Required
Name of the folder within the project where the assets targeted for bulk conversion are located. Corresponds to the folderName in the top-level location object but scoped to an individual asset source entry within the assetsLocations array.
assetsLocations[].folderId
string
Required
Unique identifier for the folder within the project where the assets targeted by the bulk conversion task are located.
fileName
string
Required
Name of the asset file associated with the bulk conversion task. Used when the task references an externally prepared file, such as an Excel spreadsheet containing asset definitions or update instructions, uploaded to the shared location specified in sharedLocation.
uiUploadedFile
boolean
Required
Indicates whether the asset file was uploaded through the user interface. Set to true if the file was uploaded via the UI; set to false if the file is referenced from a shared location specified in sharedLocation.
runtimeEnvName
string
Required
Display name of the runtime environment associated with the bulk conversion task. Corresponds to the runtimeEnv ID field and is used for human-readable identification of the environment in which the task runs.

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
id
String
Unique identifier assigned to the bulk conversion task.
description
String
Human-readable description of the bulk conversion task.
orgId
String
Unique identifier for the organization that owns the task.
frsId
String
Unique identifier for the associated FRS resource.
createTime
String
ISO 8601 timestamp indicating when the task was created.
updateTime
String
ISO 8601 timestamp indicating when the task was last updated.
createdBy
String
Username or email address of the user who created the task.
createdByUserId
String
Unique identifier for the user who created the task.
updatedBy
String
Username or email address of the user who last updated the task.

Sample request

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

curl -X POST \
"/workbench-service/public/api/v2/asset/bulkconversion/task" \
-H "Content-Type: application/json" \
-d '{"taskName": "string", "description": "string", "type": "string", "location": {"projectName": "string", "projectId": "string", "folderName": "string", "folderId": "string"}, "createdBy": "string", "runtimeEnv": "string", "workflows": ["string"], "runOptions": {"exportMetadata": false, "uploadPCXML": false, "xmlPreProcessing": false, "repointing": false, "conversion": false, "generateParameterFile": false, "mrsConversion": false}, "id": "string", "orgId": "string", "assetType": "string", "operation": "string", "categoryType": "string", "createdByUserId": "string", "sharedLocation": "string", "assetsLocations": [{"projectName": "string", "projectId": "string", "folderName": "string", "folderId": "string"}], "fileName": "string", "uiUploadedFile": false, "runtimeEnvName": "string"}'

Sample response

201 Created
{
"id": "string",
"description": "string",
"orgId": "string",
"frsId": "string",
"createTime": "string",
"updateTime": "string",
"createdBy": "string",
"createdByUserId": "string",
"updatedBy": "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"
}

Execute bulk conversion task

Submits a bulk conversion task for execution by task ID.

API request

To execute bulk conversion task, send a POST request to the following API endpoint:
POST /public/api/v2/asset/bulkconversion/runtime/task('{taskId}')

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 bulk conversion task to execute. This value determines which task is submitted for processing and is returned as runId in the response.
Query parameters
No parameter.
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
runId
String
Unique identifier assigned to the submitted bulk conversion task run.
message
String
Status message confirming the outcome of the task submission request.

Sample request

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

curl -X POST \
"/workbench-service/public/api/v2/asset/bulkconversion/runtime/task('string')"

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