External Jobs

Create an External Job

post

Creates a new external job with plugin and context configuration

Authorizations

bearerAuth

AuthorizationstringRequired

Insert the JWT token here

Body

application/json

typestringRequired

Job type

privacystringOptional

Privacy setting

Responses

201

Default Response

application/json

statusintegerRequiredExample: 201

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

post/api/public/v3/external-jobs

HTTPcURLJavaScriptPython

POST /api/public/v3/external-jobs HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 685

{
  "type": "PDI",
  "plugin": {
    "name": "Database to S3",
    "url": "https://pentaho.carte.com:8082/runJob?job=database-to-s3.kjb",
    "icon": "img/database_to_s3.png",
    "shortDescription": "Transfer data from a database to S3 location.",
    "description": "This plugin allows transferring data from a known database to an known S3 bucket, optionally fronting it with a Snowflake table.",
    "parameters": [
      {
        "name": "output_format",
        "type": "list",
        "options": [
          "CSV File",
          "Parquet File",
          "Parquet File fronted by Snowflake"
        ],
        "description": "Output format for the data extract.",
        "required": true
      }
    ]
  },
  "context": {
    "inputTypes": [
      "ORACLE",
      "POSTGRES",
      "SNOWFLAKE",
      "MSSQL",
      "MYSQL"
    ],
    "actionTypes": [
      "MOVE",
      "COPY"
    ],
    "outputTypes": [
      "AWS"
    ]
  }
}

{
  "status": 201,
  "data": {
    "_id": "text",
    "type": "text",
    "privacy": "text",
    "plugin": {
      "name": "text",
      "url": "https://example.com",
      "icon": "text",
      "shortDescription": "text",
      "description": "text",
      "parameters": [
        {
          "name": "text",
          "type": "text",
          "options": [
            "text"
          ],
          "description": "text",
          "required": false
        }
      ]
    },
    "context": {
      "inputTypes": [
        "text"
      ],
      "actionTypes": [
        "text"
      ],
      "outputTypes": [
        "text"
      ]
    }
  }
}

Get External Job by ID

get

Returns a single external job by its ID

Authorizations

bearerAuth

AuthorizationstringRequired

Insert the JWT token here

Path parameters

idstringRequired

External Job ID

Responses

200

Default Response

application/json

statusintegerRequiredExample: 200

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

get/api/public/v3/external-jobs/{id}

HTTPcURLJavaScriptPython

GET /api/public/v3/external-jobs/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": 200,
  "data": {
    "_id": "text",
    "type": "text",
    "privacy": "text",
    "plugin": {
      "name": "text",
      "url": "https://example.com",
      "icon": "text",
      "shortDescription": "text",
      "description": "text",
      "parameters": [
        {
          "name": "text",
          "type": "text",
          "options": [
            "text"
          ],
          "description": "text",
          "required": false
        }
      ]
    },
    "context": {
      "inputTypes": [
        "text"
      ],
      "actionTypes": [
        "text"
      ],
      "outputTypes": [
        "text"
      ]
    }
  }
}

Delete an External Job

delete

Deletes an external job by ID

Authorizations

bearerAuth

AuthorizationstringRequired

Insert the JWT token here

Path parameters

idstringRequired

External Job ID

Responses

200

External job deleted successfully

application/json

External job deleted successfully

statusintegerRequiredExample: 200

dataobjectOptional

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

delete/api/public/v3/external-jobs/{id}

HTTPcURLJavaScriptPython

DELETE /api/public/v3/external-jobs/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": 200,
  "data": {}
}

Update an External Job

patch

Partially updates an existing external job by ID

Authorizations

bearerAuth

AuthorizationstringRequired

Insert the JWT token here

Path parameters

idstringRequired

External Job ID

Body

application/json

typestringOptional

Job type

privacystringOptional

Privacy setting

Responses

200

Default Response

application/json

statusintegerRequiredExample: 200

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

patch/api/public/v3/external-jobs/{id}

HTTPcURLJavaScriptPython

PATCH /api/public/v3/external-jobs/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 328

{
  "type": "text",
  "privacy": "text",
  "plugin": {
    "name": "text",
    "url": "https://example.com",
    "icon": "text",
    "shortDescription": "text",
    "description": "text",
    "parameters": [
      {
        "name": "text",
        "type": "text",
        "options": [
          "text"
        ],
        "description": "text",
        "required": false
      }
    ]
  },
  "context": {
    "inputTypes": [
      "text"
    ],
    "actionTypes": [
      "text"
    ],
    "outputTypes": [
      "text"
    ]
  }
}

{
  "status": 200,
  "data": {
    "_id": "text",
    "type": "text",
    "privacy": "text",
    "plugin": {
      "name": "text",
      "url": "https://example.com",
      "icon": "text",
      "shortDescription": "text",
      "description": "text",
      "parameters": [
        {
          "name": "text",
          "type": "text",
          "options": [
            "text"
          ],
          "description": "text",
          "required": false
        }
      ]
    },
    "context": {
      "inputTypes": [
        "text"
      ],
      "actionTypes": [
        "text"
      ],
      "outputTypes": [
        "text"
      ]
    }
  }
}

Filter External Jobs

post

Returns a list of all external jobs, optionally filtered by type

Authorizations

bearerAuth

AuthorizationstringRequired

Insert the JWT token here

Body

application/json

typestringOptional

Filter by job type

Responses

200

Default Response

application/json

statusintegerRequiredExample: 200

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

post/api/public/v3/external-jobs/filter

HTTPcURLJavaScriptPython

POST /api/public/v3/external-jobs/filter HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "type": "text"
}

{
  "status": 200,
  "data": [
    {
      "_id": "text",
      "type": "text",
      "privacy": "text",
      "plugin": {
        "name": "text",
        "url": "https://example.com",
        "icon": "text",
        "shortDescription": "text",
        "description": "text",
        "parameters": [
          {
            "name": "text",
            "type": "text",
            "options": [
              "text"
            ],
            "description": "text",
            "required": false
          }
        ]
      },
      "context": {
        "inputTypes": [
          "text"
        ],
        "actionTypes": [
          "text"
        ],
        "outputTypes": [
          "text"
        ]
      }
    }
  ]
}