Informatica · Schema

JobStartRequest

Request body for starting a job. You can identify the task by taskId or taskName, and must specify the task type.

Address VerificationB2B GatewayCloud ServicesData GovernanceData IntegrationData ProfilingData QualityEnterprise SoftwareETLIDMCIICSMaster Data ManagementReference Data Management

Properties

Name	Type	Description
@type	string	The resource type identifier. Must be set to "job".
taskId	string	The ID of the task to run. Either taskId or taskName must be provided.
taskName	string	The name of the task to run. Either taskId or taskName must be provided.
taskType	string	The type of the task to run. Supported values include MTT (mapping task), WORKFLOW (taskflow), DSS (synchronization task), DRS (data replication task), and PCS (PowerCenter task).
callbackUrl	string	An optional URL that receives a callback when the job completes.
runtime	object	Optional runtime configuration for the job execution.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/JobStartRequest",
  "title": "JobStartRequest",
  "type": "object",
  "description": "Request body for starting a job. You can identify the task by taskId or taskName, and must specify the task type.",
  "required": [
    "@type",
    "taskType"
  ],
  "properties": {
    "@type": {
      "type": "string",
      "description": "The resource type identifier. Must be set to \"job\".",
      "const": "job",
      "example": "example_value"
    },
    "taskId": {
      "type": "string",
      "description": "The ID of the task to run. Either taskId or taskName must be provided.",
      "example": "500123"
    },
    "taskName": {
      "type": "string",
      "description": "The name of the task to run. Either taskId or taskName must be provided.",
      "example": "example_value"
    },
    "taskType": {
      "type": "string",
      "description": "The type of the task to run. Supported values include MTT (mapping task), WORKFLOW (taskflow), DSS (synchronization task), DRS (data replication task), and PCS (PowerCenter task).",
      "enum": [
        "MTT",
        "WORKFLOW",
        "DSS",
        "DRS",
        "PCS"
      ],
      "example": "MTT"
    },
    "callbackUrl": {
      "type": "string",
      "format": "uri",
      "description": "An optional URL that receives a callback when the job completes.",
      "example": "https://www.example.com"
    },
    "runtime": {
      "type": "object",
      "description": "Optional runtime configuration for the job execution.",
      "properties": {
        "@type": {
          "type": "string",
          "description": "The runtime object type identifier."
        },
        "runtimeEnvironmentId": {
          "type": "string",
          "description": "Override the runtime environment for this execution."
        }
      },
      "example": "example_value"
    }
  }
}