UploadFile

Copies a file from this incident to the specified incident. The file is recorded as an entry in the specified incident’s War Room.

python · Cortex REST API

Source

from CommonServerPython import *


def upload_file(incident_id: str, entry_id: str, body: str = "", using: str = "", as_incident_attachment: bool = True):
    service_name = "incident" if as_incident_attachment else "entry"
    return demisto.executeCommand(
        "core-api-multipart", {"uri": f"{service_name}/upload/{incident_id}", "entryID": entry_id, "body": body, "using": using}
    )


def upload_file_command(args: dict) -> list[CommandResults]:
    command_results: list[CommandResults] = []
    incident_id = args.get("incID", "")
    entry_ids = argToList(args.get("entryID", ""))
    body = args.get("body", "")
    target = args.get("target", "war room entry")
    using = args.get("using", "")
    for entry_id in entry_ids:
        response = upload_file(incident_id, entry_id, body, using, "attachment" in target)
        if is_error(response[0]):
            raise DemistoException(f"There was an issue uploading the file. Error received: {response[0]['Contents']}")

        uploaded_entry_id = demisto.dt(response, "Contents.response.entries.id")
        readable = "File uploaded successfully."
        # in case the file uploaded as war room entry
        if uploaded_entry_id:
            readable += f" Entry ID is {uploaded_entry_id}"
        if body:
            readable += f". Comment is:{body}"
        command_results.append(CommandResults(readable_output=readable, raw_response=response))
    return command_results


def main():
    try:
        return_results(upload_file_command(demisto.args()))
    except Exception as err:
        return_error(str(err))


if __name__ in ["__main__", "builtin", "builtins"]:
    main()

README

Copies a file from this incident to the specified incident. The file is recorded as an entry in the specified incident’s War Room.

Script Data


Name Description
Script Type python3
Tags DemistoAPI
Cortex XSOAR Version 5.0.0

Dependencies


This script uses the following commands and scripts.

  • core-api-multipart

Inputs


Argument Name Description
entryID File entry ID.
incidentID Incident ID to upload the file to.
body Request body.
target Where to upload the file
- Available options are:
- `war room entry`: the file will be uploaded as War Room entry.
- `incident attachment`: the file will be uploaded as incident attachment.
- default are `war room entry`
using Integration instance to use to run the command.

Outputs


There are no outputs for this script.

Troubleshooting

Multi-tenant environments should be configured with the Cortex Rest API instance when using this
automation. Make sure the Use tenant parameter (in the Cortex Rest API integration) is checked
to ensure that API calls are made to the current tenant instead of the master tenant.