Informatica · Schema

JobStopRequest

Request body for stopping a running job.

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 stop. Either taskId or taskName must be provided.
taskName	string	The name of the task to stop. Either taskId or taskName must be provided.
taskType	string	The type of the task to stop.
cleanStop	boolean	When true, allows the job to finish processing the current row before stopping. When false, stops the job immediately.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/JobStopRequest",
  "title": "JobStopRequest",
  "type": "object",
  "description": "Request body for stopping a running job.",
  "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 stop. Either taskId or taskName must be provided.",
      "example": "500123"
    },
    "taskName": {
      "type": "string",
      "description": "The name of the task to stop. Either taskId or taskName must be provided.",
      "example": "example_value"
    },
    "taskType": {
      "type": "string",
      "description": "The type of the task to stop.",
      "enum": [
        "MTT",
        "WORKFLOW",
        "DSS",
        "DRS",
        "PCS"
      ],
      "example": "MTT"
    },
    "cleanStop": {
      "type": "boolean",
      "description": "When true, allows the job to finish processing the current row before stopping. When false, stops the job immediately.",
      "default": false,
      "example": true
    }
  }
}