REST API Reference > PowerCenter Modernization REST API > Bulk update task
  

Bulk update task

Manage bulk update tasks programmatically.
Use the bulk update REST APIs to programmatically perform the following tasks:

Create bulk update task to export metadata

Creates a bulk update task to export metadata of the converted assets.

API request

To create bulk update task, send a POST request to the following API:
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 as form data. Use the key data and enter the request body in JSON format.
Name
Type
Required or Optional
Description
taskName
string
Required
Name of the bulk update task. Maximum 100 characters.
description
string
Optional
Description of the bulk update task. Used to identify and distinguish the task within the project or folder where it is created.
type
string
Required
Type of task to create. Use the type as BulkUpdateTask to create a bulk update task.
location
object
Optional
Target project and folder where the bulk update task will be created.
Defaults to the default task location.
location.projectName
string
Optional
Name of the project that contains the destination folder where the bulk update task output will be stored.
location.projectId
string
Optional
Unique identifier for the project in which the bulk update task output assets will be stored.
location.folderName
string
Optional
Name of the folder within the project where the bulk update task output will be stored. Corresponds to the folderId field in the same location object.
location.folderId
string
Optional
Unique identifier for the folder within the project where the bulk update task output will be stored.
assetType
string
Required
Type of asset to export the metadata.
Allowed values are MAPPING, TASKFLOW, MAPPING_TASK.
operation
string
Required
Type of bulk update export operation to perform. For more information, see Table 1.
categoryType
string
Required
Type of bulk update task. Allowed values are:
  • - ASSET_EXPORT. Bulk update task to export metadata of the converted assets.
  • - ASSET_UPDATE. Bulk update task to update metadata of the converted assets.
assetsLocations
array
Required
List of project and folder locations that identify which assets to include in the bulk update task.
assetsLocations.projectName
string
Required
Name of the project that contains the assets targeted for bulk update, within the specified folder.
assetsLocations.projectId
string
Required
Unique identifier for the project that contains the assets targeted by the bulk update 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 update 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 update task are located.
Operation ID
Operation Name
OPR_001
Update field details
OPR_002
Update advanced properties
OPR_003
Update connection details
OPR_004
Update in-out parameters
OPR_005
Update mapping SQL queries
OPR_006
Update data task
OPR_007
Update command task
OPR_008
Update decision task
OPR_009
Update assignment task
OPR_010
Update email task
OPR_201
Update general properties
OPR_202
Update source transformation advanced properties
OPR_203
Update target transformation advanced properties
OPR_204
Update lookup transformation advanced properties
OPR_205
Update sequence transformation properties
OPR_206
Update in-out parameters

Request headers

The following table describes the headers that you specify in the API request:
Name
Required or Optional
Description
IDS-SESSION-ID
Required
Session token to authenticate the request.

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 \
"{base_url}/workbench-service/public/api/v2/asset/bulkconversion/task" \
-H "Content-Type: application/json" \
--form data: assetFile: multipart/form-data
--form data: content type: application/json
Key: data
value: {
"taskName": "test",
"description": "Creating bulk export task",
"location": {
"projectName": "Default",
"projectId": "i2DbV1GF8GHjFHTeMntl6z",
"folderName": "",
"folderId": ""
},
"assetsLocations": [
{
"projectName": "Default/test",
"projectId": "12345",
"folderName": "",
"folderId": ""
}
],
"categoryType": "ASSET_EXPORT",
"operation": "OPR_001",
"assetType": "MAPPING"
}

Sample response

201 Created
{
"id": "3SvuoiODdwxjLJWBYlrDwt",
"description": "",
"orgId": "ajJoDSQMhsnhrJ1zxSVP6P",
"frsId": "iO7O3vUUGKXgGhppyF7MoP",
"createdTime": "2026-05-14T05:55:40.429Z",
"updatedTime": "2026-05-14T05:55:40.429Z",
"createdBy": "wb_ml",
"createdByUserId": "4HxQiQ1vRGWiZ9hAtTGUQ2",
"updatedBy": "wb_ml"
}
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"
}

Create bulk update task to update metadata

Creates a bulk update task to update metadata of the converted assets.

API request

To create bulk update task, send a POST request to the following API:
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 as form data. Use the key data and enter the request body in JSON format.
Name
Type
Required or Optional
Description
taskName
string
Required
Name of the bulk update task. Maximum 100 characters.
description
string
Optional
Description of the bulk update task. Used to identify and distinguish the task within the project or folder where it is created.
type
string
Required
Type of task to create. Use the type as BulkUpdateTask to create a bulk update task.
location
object
Optional
Target project and folder where the bulk update task will be created.
Defaults to the default task location.
location.projectName
string
Optional
Name of the project that contains the destination folder where the bulk update task output will be stored.
location.projectId
string
Optional
Unique identifier for the project in which the bulk update task output assets will be stored.
location.folderName
string
Optional
Name of the folder within the project where the bulk update task output will be stored. Corresponds to the folderId field in the same location object.
location.folderId
string
Optional
Unique identifier for the folder within the project where the bulk update task output will be stored.
assetType
string
Required
Type of asset to export the metadata.
Allowed values are MAPPING, TASKFLOW, MAPPING_TASK.
categoryType
string
Required
Type of bulk update task. Allowed values are:
  • - ASSET_EXPORT. Bulk update task to export metadata of the converted assets.
  • - ASSET_UPDATE. Bulk update task to update metadata of the converted assets.
assetsLocations
array
Required
List of project and folder locations that identify which assets to include in the bulk update task.
assetsLocations.projectName
string
Required
Name of the project that contains the assets targeted for bulk update, within the specified folder.
assetsLocations.projectId
string
Required
Unique identifier for the project that contains the assets targeted by the bulk update 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 update 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 update task are located.
uiUploadedFile
boolean
Required
Set to true to upload the BulkUpdateTaskTemplate.xlsx file that you have exported using the API. Else, set to false to specify the shared location of the template file and the runtime environment.
Note:
To upload the file, you must specify the template file name in the fileName parameter and upload the file form data body using the following parameters:
Content Type: xlsx
Key: "assetFile"
value: <template_file_name>.xlsx
fileName
string
Required
Name of the bulk update template file.
sharedLocation
string
Required
Shared file system path where bulk update template file is located.
runtimeEnvName
string
Required
Display name of the runtime environment.

Request headers

The following table describes the headers that you specify in the API request:
Name
Required or Optional
Description
IDS-SESSION-ID
Required
Session token to authenticate the request.

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 \
"{base_url}/workbench-service/public/api/v2/asset/bulkconversion/task" \
-H "Content-Type: application/json" \
--form data: multipart/form-data
--form data:
Content Type: xlsx
Key: "assetFile"
value: File.xlsx

--form data: content type: application/json
Key: "data"
value: {
"taskName": "test",
"description": "Creating bulk upload task",
"runtimeEnv" : "12345",
"runtimeEnvName": "abc",
"location": {
"projectName": "Default",
"projectId": "i2DbV1GF8GHjFHTeMntl6z",
"folderName": "",
"folderId": ""
},
"categoryType": "ASSET_UPDATE",
"operation": "OPR_001",
"assetType": "MAPPING",
"fileName": "f.xlsx",
"sharedLocation": "/opt/f.xlsx"
}

Sample response

201 Created
{
"id": "3SvuoiODdwxjLJWBYlrDwt",
"description": "",
"orgId": "ajJoDSQMhsnhrJ1zxSVP6P",
"frsId": "iO7O3vUUGKXgGhppyF7MoP",
"createdTime": "2026-05-14T05:55:40.429Z",
"updatedTime": "2026-05-14T05:55:40.429Z",
"createdBy": "wb_ml",
"createdByUserId": "4HxQiQ1vRGWiZ9hAtTGUQ2",
"updatedBy": "wb_ml"
}
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"
}

Get bulk update task metadata

Retrieves the design-time metadata for a bulk update task.

API request

To retrieve bulk update task metadata, send a GET request to the following API:
GET /workbench-service/public/api/v2/asset/bulkconversion/task('{taskId}')

Request parameters

Path parameters
The following table describes the path parameters that you specify in the API request:
Name
Type
Required or Optional
Description
taskId
String
Required
Unique identifier for the bulk update task to retrieve metadata.
Query parameters
No parameter.
Body Parameters
No parameter.

Request headers

The following table describes the headers that you specify in the API request:
Name
Required or Optional
Description
IDS-SESSION-ID
Optional
Session token to authenticate the request.

Response parameters

The following table describes the parameters that are returned by the API:
Name
Type
Description
assetType
String
Type of asset targeted by the bulk update task, such as MAPPING_TASK.
assetsLocations
Array
List of project and folder locations containing the assets included in the bulk update task.
categoryType
String
Type of bulk update task.
createdBy
String
Username of the user who created the bulk update task.
createdByUserId
String
Unique identifier for the user who created the bulk update task.
description
String
Description of the bulk update task.
id
String
Unique identifier for the bulk update task.
location
Object
Project and folder location where the bulk update task itself is stored.
operation
String
Operation code identifying the specific bulk update operation performed by the task.
orgId
String
Unique identifier for the organization that owns the bulk update task.
taskName
String
Display name assigned to the bulk update task.
type
String
Resource type of the task, returned as BulkUpdateTask.
uiUploadedFile
Boolean
Indicates whether the task was created by uploading the bulk update template file, false if the template file was located in a shared location.

Sample request

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

curl -X GET \
"https://qa-pod1-idms.rel.infaqa.com/workbench-service/public/api/v2/asset/bulkconversion/task('1AoP3YdPHyEjPphgdNaFQR')" \
-H "IDS-SESSION-ID: eyJraW********"

Sample response

200 OK
{
"assetType": "MAPPING_TASK",
"assetsLocations": [
{
"folderId": "",
"folderName": "",
"projectId": "6m6kTRuSgsSiDT0zCyQaSm",
"projectName": "36374"
}
],
"categoryType": "ASSET_EXPORT",
"createdBy": "John",
"createdByUserId": "aAMp82ldq24j5x0tgG3cEd",
"description": "",
"id": "1AoP3YdPHyEjPphgdNaFQR",
"location": {
"folderId": "",
"folderName": "",
"projectId": "iAjocWQPcMiiNsWcfQEkgV",
"projectName": "Default"
},
"operation": "OPR_201",
"orgId": "6SkMNqHiaLviL1UZGWngct",
"taskName": "BulkUpdateTask-94630",
"type": "BulkUpdateTask",
"uiUploadedFile": false
}

Run bulk update task

Runs a bulk update task by ID.

API request

To run a bulk update task, send a POST request to the following API:
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 or Optional
Description
taskId
String
Required
Unique identifier for the bulk update task to run.
Query parameters
No parameter.
Body Parameters
No parameter.

Request headers

The following table describes the headers that you specify in the API request:
Name
Required or Optional
Description
IDS-SESSION-ID
Required
Session token to authenticate the request.

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 \
"{base_url}/workbench-service/public/api/v2/asset/bulkconversion/runtime/task('3SvuoiODdwxjLJWBYlrDwt')"

Sample response

200 OK
{
"runId": "1",
"message": "Task Submitted Successfully"
}
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"
}