Data Factory Job Execution API

Introduction

A Data Factory job execution is the execution of a job, owned or shared, in the Data Factory platform on your account.

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

General information

• The payload and the output of a job execution is a JSON object.
• The value inside the payload and output properties may be of any type.
• If a file is present in the payload or output properties, it will be presented as a JSON object as described below:
  • object: Always data_factory_file
  • id: ID of the file
  • createdAt: Creation date of the file (ISO 8601 format)
  • updatedAt: Last update date of the file (ISO 8601 format)
  • url: Direct download URL for the given file
• Rate limit: 50 requests per minute

Create a Job Execution (Run a Job)

Request URL

Path parameters

None

Request parameters

none

Request Headers

Header	Type	Description
accept	string	*/*
Content-Type	string	application/json
X-Api-Key	string	Your account API key

Request Body

{
  "jobId": "65819ba43ad5b963658ab35d"
}

Request Example

curl

curl -X 'POST' \
  'https://api.product-live.com/v1/data_factory/job_executions' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>' \
  -H 'Content-Type: application/json' \
  -d '{
    "jobId": "65819ba43ad5b963658ab35d",
  }'

typescript SDK

import { createConfiguration, ServerConfiguration, JobExecutionApi } 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 jobExecutionApi = new JobExecutionApi(configuration);
    await jobExecutionApi.createJobExecution({
        jobId: 'jobId',
        input: {
            someKey: 'some data'
        }
    });
}

Response Example

{
    "object": "job_execution",
    "jobId": "65819ba43ad5b963658ab35d",
    "id": "658445e23ad5b929948ab731",
    "pipelineId": "6582b5fb7bcba4a7a1147473",
    "createdAt": "2023-12-21T14:04:18.511Z",
    "input": {
        "context": {
            "jobAccountId": "2629",
            "jobId": "65819ba43ad5b963658ab35d",
            "userShardId": "2629",
            "userAccountId": "2629",
            "userId": "5443"
        }
    },
    "startedAt": "2023-12-21T14:04:18.469Z",
    "status": "RUNNING",
    "output": {},
    "info": {
        "title": "Import Schema"
    }
}

Get a Job Execution by Id

Request URL

Path parameters

Parameter	Type	Description
jobExecutionId	string	A job execution id, referenced as id in the Create a Job Execution response

Request parameters

None

Request Headers

Header	Type	Description
accept	string	*/*
X-Api-Key	string	Your account API key

Request Body

None

Request Example

curl

curl -X 'GET' \
  'https://api.product-live.com/v1/data_factory/job_executions/658445e23ad5b929948ab731' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>'

typescript SDK

import { createConfiguration, ServerConfiguration, JobExecutionApi } 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 jobExecutionApi = new JobExecutionApi(configuration);
    const jobExecution = await jobExecutionApi.getJobExecutionById('job execution id');
}

Response Example

{
    "object": "job_execution",
    "jobId": "65819ba43ad5b963658ab35d",
    "id": "658445e23ad5b929948ab731",
    "pipelineId": "6582b5fb7bcba4a7a1147473",
    "createdAt": "2023-12-21T14:04:18.511Z",
    "endedAt": "2023-12-21T14:04:34.359Z",
    "input": {
        "context": {
            "jobAccountId": "2629",
            "jobId": "65819ba43ad5b963658ab35d",
            "userShardId": "2629",
            "userAccountId": "2629",
            "userId": "5443"
        }
    },
    "startedAt": "2023-12-21T14:04:18.469Z",
    "status": "COMPLETED",
    "output": {
        "subWorkflowId": "0cc9caaa-01f7-44cc-be89-2e34181d248e",
        "report": {
            "url": "https://app.product-live.com/data-factory/2629/download/98d345609f420b36b4296849498f5692fe655518110e7b174456d921ab32b4e2/report.xml",
            "filename": "report.xml"
        }
    },
    "info": {
        "title": "Import Schema"
    }
}

List Job Executions

Request URL

Path parameters

None

Request parameters

Parameter	Type	Description
page	integer	Optional The page number to retrieve. Default value if missing : 0
size	integer	Optional The number of items per page. Default value if missing : 20

Request Headers

Header	Type	Description
accept	string	*/*
X-Api-Key	string	Your account API key

Request Body

None

Request Example

curl

curl -X 'GET' \
  'https://api.product-live.com/v1/data_factory/job_executions?size=10&page=0' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>'

typescript SDK

import { createConfiguration, ServerConfiguration, JobExecutionApi } 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 jobExecutionApi = new JobExecutionApi(configuration);
    const jobExecutions = await jobExecutionApi.getJobExecutions();
}

Response Example

{
    "object": "list",
    "data": [
        {
            "object": "job_execution",
            "jobId": "65819ba43ad5b963658ab35d",
            "id": "658445e23ad5b929948ab731",
            "pipelineId": "6582b5fb7bcba4a7a1147473",
            "createdAt": "2023-12-21T14:04:18.511Z",
            "endedAt": "2023-12-21T14:04:34.359Z",
            "input": {
                "context": {
                    "jobAccountId": "2629",
                    "jobId": "65819ba43ad5b963658ab35d",
                    "userShardId": "2629",
                    "userAccountId": "2629",
                    "userId": "5443"
                }
            },
            "startedAt": "2023-12-21T14:04:18.469Z",
            "status": "COMPLETED",
            "output": {
                "subWorkflowId": "0cc9caaa-01f7-44cc-be89-2e34181d248e",
                "report": {
                    "url": "https://app.stage.product-live.com/data-factory/2629/download/98d345609f420b36b4296849498f5692fe655518110e7b174456d921ab32b4e2/report.xml",
                    "filename": "report.xml"
                }
            },
            "info": {
                "title": "Import Schema"
            }
        }
    ],
    "totalElements": 1
}

Find Job Executions

Request URL

Path parameters

None

Request parameters

Parameter	Type	Description
page	integer	Optional The page number to retrieve. Default value if missing : 0
size	integer	Optional The number of items per page. Default value if missing : 10

Request headers

Header	Type	Value
accept	string	application/json
X-Api-Key	string	Your account API key

Request Body

See more details on the find request body in the dedicated page Find request.

Single parameter research

{
    "type": "eq",
    "caseSensitive": true,
    "field": "status",
    "value": "COMPLETED"
}

Multiple parameters research

{
  "type": "and",
  "queries": [
    {
      "type": "eq",
      "caseSensitive": true,
      "field": "status",
      "value": "COMPLETED"
    },
    {
      "type": "greater",
      "caseSensitive": true,
      "field": "createdAt",
     "value": "2023-12-21T00:00:00.000Z"
    }
  ]
}

Request Example

curl -X 'POST' \
  'https://api.product-live.com/v1/job_executions/find?page=0&size=10' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>'
  -d '{
  "type": "and",
  "queries": [
    {
      "type": "eq",
      "caseSensitive": true,
      "field": "status",
      "value": "COMPLETED"
    },
    {
      "type": "greater",
      "caseSensitive": true,
      "field": "createdAt",
     "value": "2023-12-21T00:00:00.000Z"
    }
  ]
}'

Response example

{
    "object": "list",
    "data": [
        {
            "object": "job_execution",
            "jobId": "65819ba43ad5b963658ab35d",
            "id": "658445e23ad5b929948ab731",
            "pipelineId": "6582b5fb7bcba4a7a1147473",
            "createdAt": "2023-12-21T14:04:18.511Z",
            "endedAt": "2023-12-21T14:04:34.359Z",
            "input": {
                "context": {
                    "jobAccountId": "2629",
                    "jobId": "65819ba43ad5b963658ab35d",
                    "userShardId": "2629",
                    "userAccountId": "2629",
                    "userId": "5443"
                }
            },
            "startedAt": "2023-12-21T14:04:18.469Z",
            "status": "COMPLETED",
            "output": {
                "subWorkflowId": "0cc9caaa-01f7-44cc-be89-2e34181d248e",
                "report": {
                    "url": "https://app.product-live.com/data-factory/2629/download/98d345609f420b36b4296849498f5692fe655518110e7b174456d921ab32b4e2/report.xml",
                    "filename": "report.xml"
                }
            },
            "info": {
                "title": "Import Schema"
            }
        }
    ],
    "totalElements": 12
}