REST API Reference

Back Next

Get the task ID

Before you deploy a task, you need to retrieve the task ID.

Use the following GET request to retrieve the task ID:

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

You can include the following optional attributes in the request:

Field	Type	Description
projectId	string	The ID of the project where the task resides.
folderId	string	The ID of the folder where the task resides in the project.
taskName	string	Name of the task.

Get the project ID, folder ID, and task name

You can get the project ID, folder ID, and task name for the task that you want to deploy by using one of the following methods:

Use the FRS API to get the folder ID and project ID by filtering documents with the task name.

GET /frs/api/v1/Documents?$filter=name eq 'taskName'

For example:

https://pod.ics.dev:444/frs/api/v1/Documents?$filter=name eq 'zendeskToSlfk'

Alternatively, you can get the details from the task user interface as follows:

To find the project ID where your task resides, go to

Explore

and select the project. The project ID is visible in the URL.

To find the folder ID, select the folder in the project. The folder ID appears in the URL.

Sample request

Use the following sample as a reference to get the task ID:

GET https://pod-ing.ics.dev:11447/dbmi/public/api/v2/task/fetchId?projectId=1lHbX3urKB8dHJ071tXV8Fg&folderId=5GX14m3CuFAeVWqnsSX9mC&taskName=zendeskToSlfk

Sample response

A successful response returns a summary including the task name and task ID similar to the following example:

{
    "totalCount": 1,
    "pageNo": 0,
    "pageSize": 25,
    "documents": [
        {
            "name": "check_comb_case2_feb4",
            "parentInfo": [
                {
                    "parentId": "7cCn5thwWFLhiZoSosphKL",
                    "parentName": "REG",
                    "parentType": "Space"
                },
                {
                    "parentId": "33YxQayEoi1d5QgU02OQGV",
                    "parentName": "Oracle",
                    "parentType": "Project"
                },
                {
                    "parentId": "77uOlq0PAQWl3z2lDjAtWk",
                    "parentName": "Snowflake",
                    "parentType": "Folder"
                }
            ],
            "taskId": 593603
        }
    ]
}

Pagination attributes

To paginate the results, you can include the following pagination attributes in your GET request:

GET /dbmi/public/api/v2/task/fetchId?orderBy={nameOfThecolumn}&pageNo={int}&pageSize={int}

You can include the following pagination attributes in the request:

Fields	Type	Description
orderBy	string	Column name to sort the results. You can use one of the following column names to specify the sorting order: name createdTime lastUpdatedTime lastAccessedTime
pageNo	Integer	Page number to retrieve after pagination.
pageSize	Integer	Number of records per page.

For more information about the request and response sample and attributes for pagination, see Get database or application ingestion and replication task 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.
403	CDIR_AUTHZ_FORBIDDEN	You do not have the required permissions to perform this job.
404	CDIR_TASK_NOT_FOUND	Task{TaskId} was not found.
500	CDIR_INTERNAL_ERROR	Unexpected error occurred during deployment.
503	CDIR_SERVICE_ UNAVAILABLE	Service is temporarily unavailable.

The following example shows a sample error response when you pass an invalid taskName in the request:

{
    "error": {
        "httpStatus": 404,
        "code": "CDIR_TASK_NOT_FOUND",
        "message": "Task {ora_2_snflk_api2_sn3_sep16AS} was not found.",
        "details": [
            {
                "taskId": "ora_2_snflk_api2_sn3_sep16AS"
            }
        ],
        "traceId": "705922f2-87c0-4efe-8a03-438148562cab"
    }
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Get the task ID

Get the task ID

Get the project ID, folder ID, and task name

Sample request

Sample response

Pagination attributes

Failed responses and error codes