Moogsoft Docs

getWorkflowEngineMoolets

A Graze API GET request that returns a list of Workflow Engine Moolets and the functions available in each. This endpoint returns an empty list if Moogfarmd is not running.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint getWorkflowEngineMoolets takes the following request argument:

Endpoint getWorkflowEngineMoolets takes no other arguments because this endpoint returns data on all the Workflow Engine Moolets and the workflows associated with them.

Response

Endpoint getWorkflowEngineMoolets returns the following response:

Successful requests return an array of JSON objects containing the following:

Type

Description

List of JSON Objects

A list of Workflow Engine Moolets and information about them.

Examples

The following examples demonstrate typical use of endpoint getWorkflowEngineMoolets:

Request example

Example cURL request to return information on all the workflows in all the Workflow Engine Moolets in Moogsoft AIOps:

curl -X GET -u graze:graze -k -v "https://localhost/graze/v1/getWorkflowEngineMoolets"

Response example

Example response returning information on all the Workflow Engine Moolets in Moogsoft AIOps:

[
    {
        "active": true,
        "last_updated": 1567420771,
        "moolet_name": "Alert Workflows",
        "functions": {
            "alertInSituation": {
                "decision": true,
                "validators": null,
                "name": "alertInSituation",
                "description": "Check if the alert is in an active Situation.",
                "arguments": [],
                "actionOnAssociated": true,
                "type": [
                    "alert"
                ]
            },
            "alertNotInSituation": {
                "decision": true,
                "validators": null,
                "name": "alertNotInSituation",
                "description": "Check if the alert is not in an active Situation.",
                "arguments": [],
                "actionOnAssociated": true,
                "type": [
                    "alert"
                ]
            },
            "between": {
                "decision": true,
                "validators": null,
                "name": "between",
                "description": "Check to see if the trigger falls between two times, and optionally on specific days.",
                "arguments": [
                    {
                        "name": "from",
                        "validator": {
                            "regex": "^[0-9]{2}:[0-9]{2}:[0-9]{2}$"
                        },
                        "description": "The 'from' time in hh:mm:ss 24hr format",
                        "type": "string",
                        "required": true
                    },
                    {
                        "name": "to",
                        "validator": {
                            "regex": "^[0-9]{2}:[0-9]{2}:[0-9]{2}$"
                        },
                        "description": "The 'to' time in hh:mm:ss 24hr format",
                        "type": "string",
                        "required": true
                    },
                    {
                        "name": "days",
                        "description": "The optional list of days in short form (Mon,Tue,Wed...), for all days use a blank list []",
                        "type": "object",
                        "required": true
                    }
                ],
                "actionOnAssociated": false,
                "type": [
                    "alert",
                    "situation"
                ]
            },
            "contains": {
                "decision": true,
                "validators": null,
                "name": "contains",
                "description": "Check whether the specified object field contains any of the listed values. Define values as an array, for example [ a ] or [ a, b, c ].",
                "arguments": [
                    {
                        "name": "field",
                        "description": "The name of the object field to check values in (including custom_info).",
                        "type": "string",
                        "required": true
                    },
                    {
                        "name": "values",
                        "description": "The list of values to check for, any intersection is valid.",
                        "type": "object",
                        "required": true
                    }
                ],
                "actionOnAssociated": true,
                "type": [
                    "event",
                    "alert",
                    "situation"
                ]
            },
            "containsAll": {
                "decision": true,
                "validators": null,
                "name": "containsAll",
                "description": "Check whether the specified object field contains all of the listed values. Define values as an array, for example [ a ] or [ a, b, c ].",
                "arguments": [
                    {
                        "name": "field",
                        "description": "The name of the object field to check values in (including custom_info).",
                        "type": "string",
                        "required": true
                    },
                    {
                        "name": "values",
                        "description": "The list of values to check for, all must be included to be valid.",
                        "type": "object",
                        "required": true
                    }
                ],
                "actionOnAssociated": true,
                "type": [
                    "event",
                    "alert",
                    "situation"
                ]
            },
            "doesNotContain": {
                "decision": true,
                "validators": null,
                "name": "doesNotContain",
                "description": "Check whether the specified object field does not contain any of the listed values. Define values as an array, for example [ a ] or [ a, b, c ].",
                "arguments": [
                    {
                        "name": "field",
                        "description": "The name of the object field to check values in (including custom_info).",
                        "type": "string",
                        "required": true
                    },
                    {
                        "name": "values",
                        "description": "The list of values to check for, any intersection will count.",
                        "type": "object",
                        "required": true
                    }
                ],
                "actionOnAssociated": true,
                "type": [
                    "event",
                    "alert",
                    "situation"
                ]
            }
        },
       "moolet_type": "alert"
    },
    {
        "active": true,
        "last_updated": 1567420777,
        "moolet_name": "Enrichment Workflows",
        "functions": {
            "alertInSituation": {
                "decision": true,
                "validators": null,
                "name": "alertInSituation",
                "description": "Check if the alert is in an active Situation.",
                "arguments": [],
                "actionOnAssociated": true,
                "type": [
                    "alert"
                ]
            },
            "alertNotInSituation": {
                "decision": true,
                "validators": null,
                "name": "alertNotInSituation",
                "description": "Check if the alert is not in an active Situation.",
                "arguments": [],
                "actionOnAssociated": true,
                "type": [
                    "alert"
                ]
            },
            "between": {
                "decision": true,
                "validators": null,
                "name": "between",
                "description": "Check to see if the trigger falls between two times, and optionally on specific days.",
                "arguments": [
                    {
                        "name": "from"
,                        "validator": {
                            "regex": "^[0-9]{2}:[0-9]{2}:[0-9]{2}$"
                        },
                        "description": "The 'from' time in hh:mm:ss 24hr format",
                        "type": "string",
                        "required": true
                    },
                    {
                        "name": "to",
                        "validator": {
                            "regex": "^[0-9]{2}:[0-9]{2}:[0-9]{2}$"
                        },
                        "description": "The 'to' time in hh:mm:ss 24hr format",
                        "type": "string",
                        "required": true
                    },
                    {
                        "name": "days",
                        "description": "The optional list of days in short form (Mon,Tue,Wed...), for all days use a blank list []",
                        "type": "object",
                        "required": true
                    }
                ],
                "actionOnAssociated": false,
                "type": [
                    "alert",
                    "situation"
                ]
            },
       "moolet_type": "alert"
    },
]