Opencell icon

Opencell

Consume Opencell API

Overview

The Opencell - Job: Stop Job operation allows you to stop a running job instance in the Opencell system by specifying its unique job instance code. This is useful for workflow automation scenarios where you need to programmatically halt scheduled or long-running jobs, such as batch processes, data imports/exports, or maintenance tasks.

Practical examples:

  • Stopping a recurring billing job that was started by mistake.
  • Halting a data import job if incorrect data is detected.
  • Automating job management as part of a larger incident response workflow.

Properties

Name Type Meaning
Authentication options Selects the authentication method for connecting to Opencell (Basic Authentication or OAuth2)
Job Instance Code string The unique identifier (code) of the job instance you want to stop. Required.
Body Content Type hidden Internal property; set to "multipart-form-data". Not user-configurable.

Output

  • The node returns a json object containing the API response from Opencell after attempting to stop the specified job instance.
  • The exact structure of the output depends on the Opencell API's response for the stop job endpoint, but typically includes status information and possibly details about the stopped job.

Example output:

{
  "actionStatus": {
    "status": "SUCCESS",
    "message": "Job instance stopped successfully"
  }
}

Note: Actual fields may vary depending on Opencell configuration and version.


Dependencies

  • External Service: Requires access to an Opencell API instance.
  • Authentication: You must configure either Basic Authentication or OAuth2 credentials in n8n for the Opencell node.
  • n8n Configuration: Ensure the Opencell node is properly set up with the correct API base URL and credentials.

Troubleshooting

Common issues:

  • Invalid Job Instance Code: If the provided code does not match any running job, the API will likely return an error indicating the job was not found.
  • Insufficient Permissions: The credentials used must have permission to stop jobs in Opencell.
  • Network/API Errors: Connectivity issues or incorrect API URLs can result in connection errors.

Error messages and resolutions:

  • "Job instance not found": Check that the Job Instance Code is correct and refers to an active/running job.
  • "Authentication failed": Verify your credentials and authentication method.
  • "Permission denied": Ensure your user account has sufficient privileges in Opencell.

Links and References

Discussion