Update Task Soar icon

Update Task Soar

Update Task in Soar

Overview

This node, named "Update Task Soar," is designed to update a task in a Soar API service. It sends an HTTP PUT request to a specified Soar API endpoint with detailed task information such as type, name, code, department, case, user, priority, SLA, description, status, attachments, and tenancy code.

Common scenarios for this node include:

  • Automating updates to tasks managed by a Soar platform within an incident response or security orchestration workflow.
  • Integrating task management updates into broader automation pipelines where task details need to be programmatically modified.
  • Synchronizing task states or metadata from other systems into the Soar environment.

Practical example:

  • After processing an alert or investigation step, automatically update the corresponding task in Soar with new status, description, or attachments to reflect progress.

Properties

Name Meaning
Url of Soar API The endpoint URL for the Soar API service (e.g., http://192.168.143.73:2025/api/tasks/{taskId}) where the task will be updated.
Type Numeric type identifier of the task (e.g., 0).
Name Name of the task to update.
Code Code identifier of the task.
Department Code Department code associated with the task.
Case Code Case code linked to the task.
Username Username of the user performing the update.
Catalog Priority Code Priority code assigned to the task.
SLA Code Service Level Agreement code related to the task.
Description Textual description of the task.
Status Numeric status code of the task (e.g., 0).
Attachment IDs JSON string representing an array of attachment IDs associated with the task (e.g., [422]).
Tenancy Code Optional tenancy code for the task.

Output

The node outputs an array of JSON objects, one per input item processed. Each output object contains:

  • success: Boolean indicating if the update was successful.
  • response: The full response returned by the Soar API after the update (only present on success).
  • taskName: The name of the task that was updated.
  • error: Error message string if the update failed (only present on failure).

No binary data is output by this node.

Dependencies

  • Requires an API authentication token credential to access the Soar API.
  • The Soar API endpoint must be reachable and accept PUT requests with the specified payload structure.
  • The node expects the Soar API to support a token header for authentication and accepts the "Accept-Language": "vi" header.

Troubleshooting

  • Common issues:

    • Invalid or unreachable Soar API URL causing connection errors.
    • Incorrect or expired API token leading to authentication failures.
    • Malformed JSON in the Attachment IDs property causing parsing errors.
    • Missing required properties resulting in incomplete payloads and API errors.

  • Error messages:

    • Errors during HTTP request will be logged and can cause the node to fail unless "Continue On Fail" is enabled.
    • Parsing errors for attachmentIds if the input is not valid JSON.
    • API error responses may be included in the response field on failure; check these for specific API-side issues.

  • Resolutions:

    • Verify the Soar API URL and network connectivity.
    • Ensure the API token credential is correctly configured and valid.
    • Provide valid JSON strings for the Attachment IDs property.
    • Use "Continue On Fail" option to allow partial processing when some items fail.

Links and References

  • No direct external links are provided in the source code.
  • For more information, consult the documentation of the Soar API service you are integrating with.

Discussion