Learning Center

Data Factory Task Execution API ​

Introduction ​

A Data Factory Task Execution is the execution of a Data Factory Task within the Data Factory platform.

The Data Factory Task Executions API Swagger definition is available on our Product-Live API portal here.

General information ​

  • Rate limit: 50 requests per minute

Get a custom Task Execution by Id ​

Request URL

Path parameters

ParameterTypeDescription
taskExecutionIdstringMandatory A Task execution id in the response of the Poll Data Factory to start custom Task execution call

Request parameters

None

Request Headers

HeaderTypeDescription
acceptstring*/*
X-Api-KeystringYour account API key

Request Body

None

Request Example

bash
curl -X 'GET' \
  'https://api.product-live.com/v1/data_factory/task_executions/6584633de0d9331b1fe07784' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: [REDACTED]'
ts
import { createConfiguration, ServerConfiguration, TaskExecutionApi } from '@product-live/api-sdk';

export async function main(): Promise<void> {
    const configuration = createConfiguration({
        baseServer: new ServerConfiguration(process.env.API_BASE_PATH || '', {}),
        authMethods: {
            ApiKeyAuthHeader: process.env.API_ACCESS_TOKEN
        }
    });

    const taskExecutionApi = new TaskExecutionApi(configuration);
    const taskExecution = await taskExecutionApi.getTaskExecutionById('task execution id');
}

Response Example

json
{
  "object": "task_execution",
  "id": "658468663ad5b9123d8ab732",
  "taskId": "6584633de0d9331b1fe07784",
  "createdAt": "2020-01-01T12:00:00.000Z",
  "updatedAt": "2020-01-01T12:00:00.000Z",
  "status": "IN_PROGRESS",
  "input": {
    "string": "string"
  },
  "output": {
    "string": "string"
  }
}

Update a custom Task Execution ​

TIP

It is up to your custom Task to update the Data Factory Task execution with the status and the generated output so that Data Factory can continue the job execution.

The only fields that can be updated are status and output. status can be updated to COMPLETED or FAILED.

Request URL

Path parameters

ParameterTypeDescription
taskExecutionIdstringMandatory The Task execution id from the response of the Poll Data Factory to start custom Task execution call

Request parameters

None

Request Headers

HeaderTypeDescription
acceptstring*/*
Content-Typestringapplication/json
X-Api-KeystringYour account API key

Request Body

json
{
  "id": "658468663ad5b9123d8ab732",
  "status": "COMPLETED",
  "output": {}
}

Request Example

bash
curl -X 'PATCH' \
  'https://api.product-live.com/v1/data_factory/task_executions/[task execution id]' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: [REDACTED]' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "658468663ad5b9123d8ab732",
    "status": "COMPLETED",
    "output": {}
  }'
ts
import { createConfiguration, ServerConfiguration, TaskExecutionApi } from '@product-live/api-sdk';

export async function main(): Promise<void> {
    const configuration = createConfiguration({
        baseServer: new ServerConfiguration(process.env.API_BASE_PATH || '', {}),
        authMethods: {
            ApiKeyAuthHeader: process.env.API_ACCESS_TOKEN
        }
    });

    const taskExecutionApi = new TaskExecutionApi(configuration);
    const taskExecution = await taskExecutionApi.patchTaskExecution('task execution id', {
        id: 'task execution id',
        status: 'COMPLETED',
        output: {}
    });
}

Response Example

json
{
  "object": "task_execution",
  "id": "658468663ad5b9123d8ab732",
  "taskId": "6584633de0d9331b1fe07784"
  "createdAt": "2020-01-01T12:00:00.000Z",
  "updatedAt": "2020-01-01T12:00:00.000Z",
  "status": "COMPLETED",
  "input": {
    "someKey": "some data"
  },
  "output": {},
}