Jump to

• Request
• Response

Execute Job

post

[host-url]/dt-rest/v2/jobs/submit

Handles the execution of a job based on the provided parameters.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

JSON containing a job submission payload indicating action to perform on a job.

Show Source

• action(required): string
  Allowed Values: [ "RUN" ]

  Enumerates the possible actions that can be performed on a job.

  • Run: To Execute a job.
• ignorePreviousRunningJob: boolean
• isSynchronous: boolean
• jobName: string
• jobVariables: object jobVariables
  Additional Properties Allowed: additionalProperties
• objectId(required): string
• objectName: string
• objectType(required): string
  Allowed Values: [ "DATAFLOW", "WORKFLOW", "DATALOAD", "JOB" ]

  Enumerates the possible design object types that can be submitted for execution.

  • Data flow: Submit the data flow job for execution.
  • Workflow: Submit the workflow job for execution.
  • Data load: Submit the data load job for execution.
  • Job: Submit the job for execution.

{
    "type":"object",
    "description":"JSON containing a job submission payload indicating action to perform on a job.",
    "required":[
        "action",
        "objectId",
        "objectType"
    ],
    "properties":{
        "action":{
            "$ref":"#/components/schemas/Action"
        },
        "objectType":{
            "$ref":"#/components/schemas/ExecutionObjectType"
        },
        "objectId":{
            "type":"string"
        },
        "objectName":{
            "type":"string"
        },
        "isSynchronous":{
            "type":"boolean"
        },
        "ignorePreviousRunningJob":{
            "type":"boolean"
        },
        "jobName":{
            "type":"string"
        },
        "jobVariables":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "example":{
        "action":"RUN",
        "objectType":"DATAFLOW",
        "objectId":"objectId_example",
        "objectName":"objectName_example",
        "isSynchronous":true,
        "ignorePreviousRunningJob":true,
        "jobName":"jobName_example",
        "jobVariables":{
        }
    }
}

Example:

{
    "action":"RUN",
    "objectType":"DATAFLOW",
    "objectId":"objectId_example",
    "objectName":"objectName_example",
    "isSynchronous":true,
    "ignorePreviousRunningJob":true,
    "jobName":"jobName_example",
    "jobVariables":{
    }
}

Nested Schema : jobVariables

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A response indicating the outcome of the job execution.

Body ()

Root Schema : RuntimeJobDTO

Match All

JSON that represents a job during runtime with additional job metadata, such as execution statistics, record statistics, and job variables.

Show Source

• object RuntimeJobBaseDTO
  Represents a job during runtime.
• object RuntimeJobDTO-allOf[1]
  JSON that represents a job during runtime with additional job metadata, such as execution statistics, record statistics, and job variables.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/RuntimeJobBaseDTO"
        },
        {
            "type":"object",
            "description":"JSON that represents a job during runtime with additional job metadata, such as execution statistics, record statistics, and job variables.",
            "properties":{
                "executionStatistics":{
                    "type":"object",
                    "description":"Complex object: ExecutionStatisticsDTO"
                },
                "recordStatistics":{
                    "type":"object",
                    "description":"Complex object: RecordStatisticsDTO"
                },
                "synchronous":{
                    "type":"boolean"
                },
                "errorMessage":{
                    "type":"string"
                },
                "jobVariables":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            }
        }
    ]
}

Nested Schema : RuntimeJobBaseDTO

Type: object

Represents a job during runtime.

Show Source

• endDate: string (date-time)
• jobId: string
• jobName(required): string
• jobNumber: integer (int64)
• startDate: string (date-time)
• status: string
  Allowed Values: [ "WAITING", "ERROR", "RUNNING", "DONE", "WARNING", "QUEUED", "NOT_STARTED", "PREPARING", "VALID", "INVALID" ]

  Enumerates the possible statuses of a job.

  • Waiting: The Job is waiting to be executed.
  • Error: The Job terminated due to an error.
  • Running: The Job is being executed.
  • Done: The Job executed successfully.
  • Warning: The Job completed successfully but errors have been detected during the data quality check.
  • Queued: The Job is waiting for an agent to be available for its execution.
  • Not started: The Job has not started.
  • Preparing: The Job is preparing to be executed.
  • Valid: The Job is valid to be executed.
  • Invalid: The Job is not valid to be executed.

{
    "type":"object",
    "description":"Represents a job during runtime.",
    "required":[
        "jobName"
    ],
    "properties":{
        "status":{
            "$ref":"#/components/schemas/JobStatus"
        },
        "jobName":{
            "type":"string"
        },
        "jobNumber":{
            "type":"integer",
            "format":"int64"
        },
        "jobId":{
            "type":"string"
        },
        "startDate":{
            "type":"string",
            "format":"date-time"
        },
        "endDate":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : RuntimeJobDTO-allOf[1]

Type: object

JSON that represents a job during runtime with additional job metadata, such as execution statistics, record statistics, and job variables.

Show Source

• errorMessage: string
• executionStatistics: object executionStatistics
  Complex object: ExecutionStatisticsDTO
• jobVariables: object jobVariables
  Additional Properties Allowed: additionalProperties
• recordStatistics: object recordStatistics
  Complex object: RecordStatisticsDTO
• synchronous: boolean

{
    "type":"object",
    "description":"JSON that represents a job during runtime with additional job metadata, such as execution statistics, record statistics, and job variables.",
    "properties":{
        "executionStatistics":{
            "type":"object",
            "description":"Complex object: ExecutionStatisticsDTO"
        },
        "recordStatistics":{
            "type":"object",
            "description":"Complex object: RecordStatisticsDTO"
        },
        "synchronous":{
            "type":"boolean"
        },
        "errorMessage":{
            "type":"string"
        },
        "jobVariables":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : executionStatistics

Type: object

Complex object: ExecutionStatisticsDTO

Nested Schema : jobVariables

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : recordStatistics

Type: object

Complex object: RecordStatisticsDTO

500 Response

Internal Server Error

Back to Top