REST API Reference

Back Next

Get a request body for a new task

A create request needs a request body that defines the task. To get a request body, you can either copy the request body of an existing task, or start from the sample task details.

Copy the request body of an existing task

Perform the following tasks to use the request body of an existing task from the user interface:

Create and save a task in the user interface.

Get the task ID. Use the following request:

GET <baseUrl>/dbmi/public/api/v2/task/fetchId?
taskName={taskName}&projectId={projectId}&folderId={folderId}

For more information, see Get the task ID.

Get the task details. Use the following request:

GET <baseUrl>/dbmi/public/api/v2/task/details?taskId={taskId}

For more information, see Get database or application ingestion and replication task details.

From the response, copy the

dbmiTask

object, starting from the

type

field.

Start from a sample task

Copy a sample request body from Sample request body for creating a task. In the sample, copy the

dbmiTask

object, starting from the

type

field.

Edit the request body

After you copy the request body, change the task name

general.name

. Then, set the properties that are specific to your source and target. You can remove the properties that you do not need, or send the entire request body. For the property fields and descriptions, see the following topics:

Source attributes

Target attributes

Runtime attributes

To send the request body, see Create a database or application ingestion and replication task.