Moogsoft Docs

getProcesses

A MoogDb v2 method that returns a list of processes from the database.

Request arguments

Method getProcesses takes the following request arguments:

Name

Type

Required

Description

limit

Integer

No

Maximum number of processes to return. Default is 1000.

query

String

Yes

A JSON or SQL like filter of the process name.

exact_match

Boolean

No

If true, the query performs an exact match on the process name. If false, the query checks for contains only on the process name. Default is false.

Response

Method getProcesses returns the following response:

Type

Description

Object

A list of strings describing the requested processes, or a null value if there is an error.

Examples

The following examples demonstrate typical use of method getProcesses:

Request example

Example request to return the first thousand process names containing "Network":

var actions = moogdb.getProcesses(1000, “Network”, false);
Response example

Example response returning returning details of all process names containing "Network":

[
    {
        "process_id": 1,
        "name": "Network LON",
        "description": "Network London"
    },
    {
        "process_id": 2,
        "name": "NY Network A",
        "description": "Network New York A"
    },
    {
        "process_id": 3,
        "name": "NY Network B",
        "description": "Network New York B"
    }
]