REST API Reference

Back Next

Create a database or application ingestion and replication task

Use the task resource to create a

database ingestion and replication

task or

application ingestion and replication

task in a specified project and folder.

To create a task, send a POST request to the following resource:

/dbmi/public/api/v2/task/create

For the steps to get a request body and create a task, see Get a request body for a new task.

Task type and payload requirements

The request payload must include the

taskType

field to specify the type of task that you want to create:

appmi

. Creates an

application ingestion and replication

task.

dbmi

. Creates a

database ingestion and replication

task.

If you omit the value for the

taskType

field, it defaults to

dbmi

The following payload specifies an

application ingestion and replication

task:

{
  "taskType": "appmi",
  ...
}

The following payload specifies a

database ingestion and replication

task:

{
  "taskType": "dbmi",
  ...
}

Request payload

The following table describes the attributes that you can set within the

general

object for a

database ingestion and replication

task or

application ingestion and replication

task:

Field	Type	Description
name	String	Name of the task.
description	String	An optional description that provides context about the purpose of the task.
location	String	Project or project folder that contains the task definition.
runtimeEnvironment	String	The name of the runtime environment where the task runs.
type	String	Type of load operation that the task performs. Options are: initial . Loads source data read at a single point in time to a target. After the data is loaded, the ingestion and replication job ends. cdc . Loads data changes continuously or until the ingestion and replication job is stopped or ends. The ingestion and replication job loads the changes that have occurred since the last time it ran or from a specific start point. combined . Performs an initial load of point-in-time data to the target and then automatically switches to replicating incremental data changes made to the same source objects on a continuous basis.

The source, target, and runtime attributes for the task in the request payload depend on the task type and on the specific source and target connector. For the connector-specific source and target attributes, see the Source attributes, Target attributes, and Runtime attributes tables.

Post request and response examples

For sample post requests and responses, including the required payload fields and expected output, see the following examples:

Example: Create a Salesforce to Snowflake task

Example: Create an Oracle to Snowflake task

Successful post response

If the task is created successfully, the API returns a 201 Created success code. The response typically includes the following header:

Content-Type: application/json;charset=UTF-8
HTTP/2 201 Created

The response also includes the following information about the task:

Field	Type	Description
location	String	Project and folder name in which the task is created.
taskId	String	ID generated for the newly created task.
frsId	String	FRS reference ID.
name	String	Name of the task.
description	String	Description for the task.
createdBy	String	User ID who created the task.
documentType	String	Type of document: DBMI_TASK or APPMI_TASK based on the taskType value specified in the request.
parentInfo	String	Parent project and structure details.

Failed responses and error codes

If the request fails, the API might return one of the following HTTP error codes:

HTTP status code	Error code	Error message
401	CDIR_AUTH_UNAUTHORIZED	Authentication failed. Access token is missing or expired.
403	CDIR_AUTHZ_FORBIDDEN	You do not have the required permissions for this request.
500	CDIR_INTERNAL_ERROR	An unexpected internal error occurred with this job.
503	CDIR_SERVICE_UNAVAILABLE	Service is temporarily unavailable.

The following example shows a sample error response when a connection specified in the request does not exist:

{
    "error": {
        "httpStatus": 404,
        "code": "CDIR_CONNECTION_DOES_NOT_EXIST",
        "message": "Connection with name Oracle_19RDS_yk-CDC23 does not exist.",
        "details": [
            {
                "taskName": "ora_2_snflk_api_agust5_case3"
            }
        ],
        "traceId": "b2bca519-8c6c-4a63-a882-9b3f4b6a852b"
    }
}

Database and Application Ingestion and Replication REST API

Source attributes

Target attributes

Runtime attributes

Example: Create a Salesforce to Snowflake task

Example: Create an Oracle to Snowflake task

Download Guide

Watch

Comments

Communities

Knowledge Base

Success Portal