REST API Reference

Back Next

Converting an asset to a data transfer task

Use the convert resource to convert a

synchronization

task to a

data transfer

task. The

synchronization

task still exists after the conversion, but you can delete it.

POST request

To convert a

synchronization

task, include the asset ID of the

synchronization

task in the following URI:

/dtt/dss/convert/<assetId>

Include the following fields in the request:

Field	Type	Required	Description
projectId	String	Yes	Project or folder where you want the data transfer task to reside.
skipSchedulerJob	Boolean	--	Whether to exclude the schedule settings from the synchronization task in the data transfer task. Use one of the following values: true: Don't include the schedule settings. false: Include the schedule settings. Default is false.

POST response

The following table describes the fields in the POST response:

Field	Type	Description
originalAssetId	String	ID of the synchronization task that was converted.
originalAssetName	String	Name of the synchronization task that was converted.
status	String	Status of the conversion, such as SUCCESS or FAILED.
newAssetId	String	Asset ID of the new data transfer task.
newAssetName	String	Name of the data transfer task, which is the same as the synchronization task used in the conversion.
newAssetType	String	Value will always be DTT.
errors	String	If the status is FAILED, reason for the failure.

POST example

The following request converts a

synchronization

task to a

data transfer

task:


POST <server URL>/dtt/dss/convert/0001R291234567891234
Content-Type: application/json
Accept:application/json
IDS-SESSION-ID:2l0oeVx22Rujiej7y1234T

{
    "projectId": "8Fhm0Ovp4Dhfl3yNr1234G",
    "skipSchedulerJob" : false
}

If successful, you receive the following response:

{
    "originalAssetId": "0100000I00000000000H",
    "originalAssetName": "Sync Task 1",
    "status": "SUCCESS",
    "newAssetId": "8Fhm0Ovp4Dhfl3yNr2345G",
    "newAssetName": "Sync Task 1",
    "newAssetType": "Data Transfer Task"
}

If the request isn't successful, you receive the following response:

{
    "originalAssetId": "0100000I00000000000H",
    "originalAssetName": "Sync Task 1",
    "status": "FAIL",
    "errors": [
        "Multiple sorting conditions are not supported"
    ]
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Converting an asset to a data transfer task

Converting an asset to a data transfer task

POST request

POST response

POST example