Interface TheHiveProjectNodeParameters

Source
interface TheHiveProjectNodeParameters {
    addTo?: "case" | "alert";
    alertId?: {
        mode: "id" | "list" | "url";
        value: string;
    };
    allCases?: boolean;
    allTasks?: boolean;
    analyzers?: unknown[];
    attachmentId?: string;
    attachmentsUi?: { values: { field?: string }[] };
    caseId?: { mode: "id" | "list" | "url"; value: string };
    category?: string;
    commentId?: { mode: "id" | "list"; value: string };
    content?: string;
    createIn?: "case" | "alert";
    data?: string;
    dataType?: string;
    filters?: {
        values: {
            field?: string;
            from?: string;
            operator?:
                | "_between"
                | "_like"
                | "_endsWith"
                | "_eq"
                | "_gt"
                | "_gte"
                | "_in"
                | "_lt"
                | "_lte"
                | "_match"
                | "_ne"
                | "_startsWith";
            to?: string;
            value?: string;
            values?: string;
        }[];
    };
    id?: | { mode: "id"
    | "list"
    | "url"; value: string }
    | { mode: "id" | "list"; value: string };
    limit?: number;
    location?: "case" | "knowledgeBase";
    logId?: { mode: "id" | "list"; value: string };
    message?: string;
    observableId?: { mode: "id" | "list"; value: string };
    observableUi?: {
        values: {
            binaryProperty?: string;
            data?: string;
            dataType?: string;
            message?: string;
            tags?: string;
        }[];
    };
    operation?: | "create"
    | "get"
    | "update"
    | "add"
    | "search"
    | "status"
    | "executeQuery"
    | "deleteTask"
    | "executeResponder"
    | "deleteAlert"
    | "merge"
    | "promote"
    | "addAttachment"
    | "deleteAttachment"
    | "deleteCase"
    | "getAttachment"
    | "getTimeline"
    | "deleteComment"
    | "deleteLog"
    | "deleteObservable"
    | "executeAnalyzer"
    | "deletePage";
    options?: | {
        includeSimilarAlerts?: boolean;
        includeSimilarCases?: boolean;
    }
    | {
        extraData?: | string
        | (
            | "permissions"
            | "seen"
            | "isOwner"
            | "links"
            | "shareCount"
            | "shares"
        )[]
        | (
            | "case"
            | "shareCount"
            | "actionRequired"
            | "actionRequiredMap"
            | "caseId"
            | "caseTemplate"
            | "caseTemplateId"
        )[]
        | (
            | "status"
            | "caseNumber"
            | "importDate"
            | "procedureCount"
        )[]
        | (
            | "status"
            | "permissions"
            | "alerts"
            | "isOwner"
            | "shareCount"
            | "actionRequired"
            | "procedureCount"
            | "alertCount"
            | "attachmentCount"
            | "contributors"
            | "computed.handlingDuration"
            | "computed.handlingDurationInDays"
            | "computed.handlingDurationInHours"
            | "computed.handlingDurationInMinutes"
            | "computed.handlingDurationInSeconds"
            | "observableStats"
            | "similarAlerts"
            | "taskStats"
        )[]
        | "links"[]
        | ("task" | "case" | "actionCount" | "taskId")[];
        returnCount?: boolean;
    }
    | { caseTemplate?: string }
    | { canRename?: boolean }
    | { dataPropertyName?: string; fileName?: string }
    | { category?: string; order?: number; title?: string };
    pageId?: { mode: "id" | "list"; value: string };
    queryJson?: string;
    resource?:
        | "comment"
        | "query"
        | "page"
        | "task"
        | "case"
        | "log"
        | "alert"
        | "observable";
    responder?: string;
    returnAll?: boolean;
    searchIn?: "all"
    | "case"
    | "alert";
    searchInKnowledgeBase?: boolean;
    sort?: {
        fields: {
            direction?: "asc" | "desc";
            field?: string;
        }[];
    };
    status?: string;
    taskId?: { mode: "id"
    | "list"; value: string };
    title?: string;
}

Properties§

Source§

readonly addTo?: "case" | "alert"

Default: "alert"

Source§

readonly alertId?: { mode: "id" | "list" | "url"; value: string }

Default: {"mode":"list","value":""}

Source§

readonly allCases?: boolean

Whether to search in all cases or only in a selected case Default: true

Source§

readonly allTasks?: boolean

Whether to search in all tasks or only in selected task Default: true

Source§

readonly analyzers?: unknown[]

Choose from the list, or specify IDs using an expression Default: [] Type options: {"loadOptionsDependsOn":["observableId.value","dataType"],"loadOptionsMethod":"loadAnalyzers"}

Source§

readonly attachmentId?: string

ID of the attachment. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"loadCaseAttachments"}

Source§

readonly attachmentsUi?: { values: { field?: string }[] }

Array of supported attachments to add to the message Default: {} Type options: {"multipleValues":true}

Source§

readonly caseId?: { mode: "id" | "list" | "url"; value: string }

Default: {"mode":"list","value":""}

Source§

readonly category?: string

Source§

readonly commentId?: { mode: "id" | "list"; value: string }

Default: {"mode":"list","value":""}

Source§

readonly content?: string

Type options: {"rows":2}

Source§

readonly createIn?: "case" | "alert"

Default: "case"

Source§

readonly data?: string

Source§

readonly dataType?: string

Choose from the list, or specify an ID using an expression Default: "file" Type options: {"loadOptionsMethod":"loadObservableTypes"}

Source§

readonly filters?: {
    values: {
        field?: string;
        from?: string;
        operator?:
            | "_between"
            | "_like"
            | "_endsWith"
            | "_eq"
            | "_gt"
            | "_gte"
            | "_in"
            | "_lt"
            | "_lte"
            | "_match"
            | "_ne"
            | "_startsWith";
        to?: string;
        value?: string;
        values?: string;
    }[];
}

Default: {} Type options: {"multipleValues":true}

Source§

readonly id?:
    | { mode: "id"
    | "list"
    | "url"; value: string }
    | { mode: "id" | "list"; value: string }

Default: {"mode":"list","value":""}

Source§

readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1}

Source§

readonly location?: "case" | "knowledgeBase"

Default: "case"

Source§

readonly logId?: { mode: "id" | "list"; value: string }

Default: {"mode":"list","value":""}

Source§

readonly message?: string

Type options: {"rows":2}

Source§

readonly observableId?: { mode: "id" | "list"; value: string }

Default: {"mode":"list","value":""}

Source§

readonly observableUi?: {
    values: {
        binaryProperty?: string;
        data?: string;
        dataType?: string;
        message?: string;
        tags?: string;
    }[];
}

Default: {} Type options: {"multipleValues":true}

Source§

readonly operation?:
    | "create"
    | "get"
    | "update"
    | "add"
    | "search"
    | "status"
    | "executeQuery"
    | "deleteTask"
    | "executeResponder"
    | "deleteAlert"
    | "merge"
    | "promote"
    | "addAttachment"
    | "deleteAttachment"
    | "deleteCase"
    | "getAttachment"
    | "getTimeline"
    | "deleteComment"
    | "deleteLog"
    | "deleteObservable"
    | "executeAnalyzer"
    | "deletePage"

Default: "create"

Source§

readonly options?:
    | {
        includeSimilarAlerts?: boolean;
        includeSimilarCases?: boolean;
    }
    | {
        extraData?: | string
        | (
            | "permissions"
            | "seen"
            | "isOwner"
            | "links"
            | "shareCount"
            | "shares"
        )[]
        | (
            | "case"
            | "shareCount"
            | "actionRequired"
            | "actionRequiredMap"
            | "caseId"
            | "caseTemplate"
            | "caseTemplateId"
        )[]
        | (
            | "status"
            | "caseNumber"
            | "importDate"
            | "procedureCount"
        )[]
        | (
            | "status"
            | "permissions"
            | "alerts"
            | "isOwner"
            | "shareCount"
            | "actionRequired"
            | "procedureCount"
            | "alertCount"
            | "attachmentCount"
            | "contributors"
            | "computed.handlingDuration"
            | "computed.handlingDurationInDays"
            | "computed.handlingDurationInHours"
            | "computed.handlingDurationInMinutes"
            | "computed.handlingDurationInSeconds"
            | "observableStats"
            | "similarAlerts"
            | "taskStats"
        )[]
        | "links"[]
        | ("task" | "case" | "actionCount" | "taskId")[];
        returnCount?: boolean;
    }
    | { caseTemplate?: string }
    | { canRename?: boolean }
    | { dataPropertyName?: string; fileName?: string }
    | { category?: string; order?: number; title?: string }

Default: {}

Source§

readonly pageId?: { mode: "id" | "list"; value: string }

Default: {"mode":"list","value":""} Type options: {"loadOptionsDependsOn":["caseId"]}

Source§

readonly queryJson?: string

Search for objects with filtering and sorting capabilities Default: "=[\n {\n "_name": "listOrganisation"\n }\n]" Type options: {"rows":10}

Source§

readonly resource?:
    | "comment"
    | "query"
    | "page"
    | "task"
    | "case"
    | "log"
    | "alert"
    | "observable"

Default: "alert"

Source§

readonly responder?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsDependsOn":["id","id.value"],"loadOptionsMethod":"loadResponders"}

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly searchIn?: "all" | "case" | "alert"

Whether to search for comments in all alerts and cases or in a specific case or alert Default: "all"

Source§

readonly searchInKnowledgeBase?: boolean

Whether to search in knowledge base or only in the selected case Default: true

Source§

readonly sort?: { fields: { direction?: "asc" | "desc"; field?: string }[] }

Default: {} Type options: {"multipleValues":true}

Source§

readonly status?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"loadAlertStatus"}

Source§

readonly taskId?: { mode: "id" | "list"; value: string }

Default: {"mode":"list","value":""}

Source§

readonly title?: string