REST API Reference

10.5
- 10.5.3
- 10.5.2
- 10.5.1
- 10.4.1
- 10.4.0

Back Next

Jobs

The POST jobs request generates or runs a specific workflow.

Resource URL

/tdm/v1/jobs

HTTP Request

POST http(s)://<host>:<port>/api/public/tdm/v1/jobs

Request Header

The request header includes the following headers:

Header	Description
accept	Use the following value: application/json
Authorization	Required. Use the following value: Basic <user name>
Content-Type	Format to submit forms that can contain files. Use the following value: Multipart/form-data

Request Body

The request body includes the following properties as form data:

Property	Data Type	Description
type	String	Required. You can choose from the following options: Generate. Choose if you want to generate a workflow. Execute. Choose if you want to run a workflow.
projectId	String	Required. ID of the project that contains the workflow.
planId	String	Required. ID of the plan for which you want to generate or run a workflow.
integrationServiceName	String	Name of the Integration Service to run the job.
scheduleOn	String	Date and time at which you want to schedule the job to run. Enter the time in milliseconds.
file	File	Select a parameter file.

Sample Request

POST http://<host>:6605/api/public/tdm/v1/jobs

Sample Response

{
  "id": 19,
  "name": "Execute Workflow",
  "description": "Plan: REL_DIC, Workflow:  ",
  "startDate": 1540983189063,
  "endDate": 1540983261197,
  "status": "SUCCESS",
  "jobType": "LOAD_WORKFLOW",
  "createdByName": "Administrator",
  "creationDate": 1540983161005,
  "lastUpdatedDate": 1540983161005,
  "lastUpdatedByName": "Administrator",
  "scheduleOn": 1540983161005,
  "pausedAtStep": 0,
  "percentComplete": 100,
  "jobActionType": null,
  "childJobId": -1
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Jobs

Jobs

Resource URL

HTTP Request

Request Header

Request Body

Sample Request

Sample Response