> For the complete documentation index, see [llms.txt](https://docs.pentaho.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pentaho.com/pdc-api-docs/pdc-api-ref-v2/external-jobs.md). # External Jobs ## Create an External Job > Creates a new external job with plugin and context configuration ```json {"openapi":"3.0.3","info":{"title":"PDC Public API (v3)","version":"v3"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v3/external-jobs":{"post":{"summary":"Create an External Job","tags":["External Jobs"],"description":"Creates a new external job with plugin and context configuration","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["type","plugin"],"properties":{"type":{"type":"string","description":"Job type"},"privacy":{"type":"string","description":"Privacy setting"},"plugin":{"type":"object","additionalProperties":false,"required":["name","url","icon","shortDescription","description","parameters"],"properties":{"name":{"type":"string","description":"Name of the plugin."},"url":{"type":"string","format":"uri","description":"URL for the plugin reference."},"icon":{"type":"string","description":"Filename of the image for display."},"shortDescription":{"type":"string","description":"Short description of the plugin for display."},"description":{"type":"string","description":"Detailed description of what the plugin does."},"parameters":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["name","type","description","required"],"properties":{"name":{"type":"string","description":"Name of the parameter."},"type":{"type":"string","description":"Type of the parameter."},"options":{"type":"array","items":{"type":"string"},"description":"Predefined options for the parameter."},"description":{"type":"string","description":"Description of the parameter."},"required":{"type":"boolean","default":false,"description":"Indicates whether the parameter is required."}}}}}},"context":{"type":"object","additionalProperties":false,"properties":{"inputTypes":{"type":"array","items":{"type":"string"},"description":"Predefined input types for the context."},"actionTypes":{"type":"array","items":{"type":"string"},"description":"Predefined action types for the context."},"outputTypes":{"type":"array","items":{"type":"string"},"description":"Predefined output types for the context."}}}}}}},"required":true},"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"data":{"type":"object","properties":{"_id":{"type":"string","description":"ExternalJob ID"},"type":{"type":"string","description":"Job type for the future extension."},"privacy":{"type":"string","description":"Privacy setting"},"plugin":{"type":"object","properties":{"name":{"type":"string","description":"Name of the plugin."},"url":{"type":"string","format":"uri","description":"URL for the plugin reference."},"icon":{"type":"string","description":"Filename of the image for display."},"shortDescription":{"type":"string","description":"Short description of the plugin for display."},"description":{"type":"string","description":"Detailed description of what the plugin does."},"parameters":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the parameter."},"type":{"type":"string","description":"Type of the parameter."},"options":{"type":"array","items":{"type":"string"},"description":"Predefined options for the parameter."},"description":{"type":"string","description":"Description of the parameter."},"required":{"type":"boolean","default":false,"description":"Indicates whether the parameter is required."}},"required":["name","type","description","required"]},"description":"Parameters required by the plugin."}},"description":"Details about a plugin."},"context":{"type":"object","properties":{"inputTypes":{"type":"array","items":{"type":"string"},"description":"Predefined input types for the context."},"actionTypes":{"type":"array","items":{"type":"string"},"description":"Predefined action types for the context."},"outputTypes":{"type":"array","items":{"type":"string"},"description":"Predefined output types for the context."}},"description":"Predefined input and output types for the context."}}}},"required":["status","data"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"status":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array"},{"type":"object","additionalProperties":true}]}}}}}},"401":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n \tTo access this endpoint:\n\n 1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n 2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n 3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n ","content":{"application/json":{"schema":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n \tTo access this endpoint:\n\n 1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n 2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n 3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n ","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"503":{"description":"Service Unavailable — Connection Refused","content":{"application/json":{"schema":{"description":"Service Unavailable — Connection Refused","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}}}}}}} ``` ## Get External Job by ID > Returns a single external job by its ID ```json {"openapi":"3.0.3","info":{"title":"PDC Public API (v3)","version":"v3"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v3/external-jobs/{id}":{"get":{"summary":"Get External Job by ID","tags":["External Jobs"],"description":"Returns a single external job by its ID","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"External Job ID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"data":{"type":"object","properties":{"_id":{"type":"string","description":"ExternalJob ID"},"type":{"type":"string","description":"Job type for the future extension."},"privacy":{"type":"string","description":"Privacy setting"},"plugin":{"type":"object","properties":{"name":{"type":"string","description":"Name of the plugin."},"url":{"type":"string","format":"uri","description":"URL for the plugin reference."},"icon":{"type":"string","description":"Filename of the image for display."},"shortDescription":{"type":"string","description":"Short description of the plugin for display."},"description":{"type":"string","description":"Detailed description of what the plugin does."},"parameters":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the parameter."},"type":{"type":"string","description":"Type of the parameter."},"options":{"type":"array","items":{"type":"string"},"description":"Predefined options for the parameter."},"description":{"type":"string","description":"Description of the parameter."},"required":{"type":"boolean","default":false,"description":"Indicates whether the parameter is required."}},"required":["name","type","description","required"]},"description":"Parameters required by the plugin."}},"description":"Details about a plugin."},"context":{"type":"object","properties":{"inputTypes":{"type":"array","items":{"type":"string"},"description":"Predefined input types for the context."},"actionTypes":{"type":"array","items":{"type":"string"},"description":"Predefined action types for the context."},"outputTypes":{"type":"array","items":{"type":"string"},"description":"Predefined output types for the context."}},"description":"Predefined input and output types for the context."}}}},"required":["status","data"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"status":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array"},{"type":"object","additionalProperties":true}]}}}}}},"401":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n \tTo access this endpoint:\n\n 1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n 2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n 3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n ","content":{"application/json":{"schema":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n \tTo access this endpoint:\n\n 1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n 2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n 3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n ","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"503":{"description":"Service Unavailable — Connection Refused","content":{"application/json":{"schema":{"description":"Service Unavailable — Connection Refused","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}}}}}}} ``` ## Delete an External Job > Deletes an external job by ID ```json {"openapi":"3.0.3","info":{"title":"PDC Public API (v3)","version":"v3"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v3/external-jobs/{id}":{"delete":{"summary":"Delete an External Job","tags":["External Jobs"],"description":"Deletes an external job by ID","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"External Job ID"}],"responses":{"200":{"description":"External job deleted successfully","content":{"application/json":{"schema":{"description":"External job deleted successfully","type":"object","properties":{"status":{"type":"integer"},"data":{"type":"object"}},"required":["status"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"status":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array"},{"type":"object","additionalProperties":true}]}}}}}},"401":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n \tTo access this endpoint:\n\n 1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n 2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n 3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n ","content":{"application/json":{"schema":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n \tTo access this endpoint:\n\n 1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n 2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n 3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n ","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"503":{"description":"Service Unavailable — Connection Refused","content":{"application/json":{"schema":{"description":"Service Unavailable — Connection Refused","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}}}}}}} ``` ## Update an External Job > Partially updates an existing external job by ID ```json {"openapi":"3.0.3","info":{"title":"PDC Public API (v3)","version":"v3"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v3/external-jobs/{id}":{"patch":{"summary":"Update an External Job","tags":["External Jobs"],"description":"Partially updates an existing external job by ID","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","description":"Job type"},"privacy":{"type":"string","description":"Privacy setting"},"plugin":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the plugin."},"url":{"type":"string","format":"uri","description":"URL for the plugin reference."},"icon":{"type":"string","description":"Filename of the image for display."},"shortDescription":{"type":"string","description":"Short description of the plugin for display."},"description":{"type":"string","description":"Detailed description of what the plugin does."},"parameters":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["name","type","description","required"],"properties":{"name":{"type":"string","description":"Name of the parameter."},"type":{"type":"string","description":"Type of the parameter."},"options":{"type":"array","items":{"type":"string"},"description":"Predefined options for the parameter."},"description":{"type":"string","description":"Description of the parameter."},"required":{"type":"boolean","default":false,"description":"Indicates whether the parameter is required."}}}}}},"context":{"type":"object","additionalProperties":false,"properties":{"inputTypes":{"type":"array","items":{"type":"string"},"description":"Predefined input types for the context."},"actionTypes":{"type":"array","items":{"type":"string"},"description":"Predefined action types for the context."},"outputTypes":{"type":"array","items":{"type":"string"},"description":"Predefined output types for the context."}}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"External Job ID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"data":{"type":"object","properties":{"_id":{"type":"string","description":"ExternalJob ID"},"type":{"type":"string","description":"Job type for the future extension."},"privacy":{"type":"string","description":"Privacy setting"},"plugin":{"type":"object","properties":{"name":{"type":"string","description":"Name of the plugin."},"url":{"type":"string","format":"uri","description":"URL for the plugin reference."},"icon":{"type":"string","description":"Filename of the image for display."},"shortDescription":{"type":"string","description":"Short description of the plugin for display."},"description":{"type":"string","description":"Detailed description of what the plugin does."},"parameters":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the parameter."},"type":{"type":"string","description":"Type of the parameter."},"options":{"type":"array","items":{"type":"string"},"description":"Predefined options for the parameter."},"description":{"type":"string","description":"Description of the parameter."},"required":{"type":"boolean","default":false,"description":"Indicates whether the parameter is required."}},"required":["name","type","description","required"]},"description":"Parameters required by the plugin."}},"description":"Details about a plugin."},"context":{"type":"object","properties":{"inputTypes":{"type":"array","items":{"type":"string"},"description":"Predefined input types for the context."},"actionTypes":{"type":"array","items":{"type":"string"},"description":"Predefined action types for the context."},"outputTypes":{"type":"array","items":{"type":"string"},"description":"Predefined output types for the context."}},"description":"Predefined input and output types for the context."}}}},"required":["status","data"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"status":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array"},{"type":"object","additionalProperties":true}]}}}}}},"401":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n \tTo access this endpoint:\n\n 1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n 2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n 3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n ","content":{"application/json":{"schema":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n \tTo access this endpoint:\n\n 1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n 2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n 3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n ","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"503":{"description":"Service Unavailable — Connection Refused","content":{"application/json":{"schema":{"description":"Service Unavailable — Connection Refused","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}}}}}}} ``` ## Filter External Jobs > Returns a list of all external jobs, optionally filtered by type ```json {"openapi":"3.0.3","info":{"title":"PDC Public API (v3)","version":"v3"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v3/external-jobs/filter":{"post":{"summary":"Filter External Jobs","tags":["External Jobs"],"description":"Returns a list of all external jobs, optionally filtered by type","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","description":"Filter by job type"}}}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","description":"ExternalJob ID"},"type":{"type":"string","description":"Job type for the future extension."},"privacy":{"type":"string","description":"Privacy setting"},"plugin":{"type":"object","properties":{"name":{"type":"string","description":"Name of the plugin."},"url":{"type":"string","format":"uri","description":"URL for the plugin reference."},"icon":{"type":"string","description":"Filename of the image for display."},"shortDescription":{"type":"string","description":"Short description of the plugin for display."},"description":{"type":"string","description":"Detailed description of what the plugin does."},"parameters":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the parameter."},"type":{"type":"string","description":"Type of the parameter."},"options":{"type":"array","items":{"type":"string"},"description":"Predefined options for the parameter."},"description":{"type":"string","description":"Description of the parameter."},"required":{"type":"boolean","default":false,"description":"Indicates whether the parameter is required."}},"required":["name","type","description","required"]},"description":"Parameters required by the plugin."}},"description":"Details about a plugin."},"context":{"type":"object","properties":{"inputTypes":{"type":"array","items":{"type":"string"},"description":"Predefined input types for the context."},"actionTypes":{"type":"array","items":{"type":"string"},"description":"Predefined action types for the context."},"outputTypes":{"type":"array","items":{"type":"string"},"description":"Predefined output types for the context."}},"description":"Predefined input and output types for the context."}}}}},"required":["status","data"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"status":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array"},{"type":"object","additionalProperties":true}]}}}}}},"401":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n \tTo access this endpoint:\n\n 1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n 2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n 3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n ","content":{"application/json":{"schema":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n \tTo access this endpoint:\n\n 1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n 2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n 3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n ","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"503":{"description":"Service Unavailable — Connection Refused","content":{"application/json":{"schema":{"description":"Service Unavailable — Connection Refused","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.pentaho.com/pdc-api-docs/pdc-api-ref-v2/external-jobs.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.