createTeam

A MoogDb v2 method that creates a new team, by passing an object containing team information.

Request arguments

Method createTeam takes the following request arguments:

Name	Type	Required	Description
`teamObj`	Object	Yes	An object containing the following parameters.
`name`	String	Yes	New team name. Must be unique.
`alert_filter`	JSON Object	No	An SQL-like or JSON filter that alerts must match to be assigned to the team. See Filter Search Data for more information on creating SQL-like filters.
`sig_filter`	JSON Object	No	An SQL-like or JSON filter that Situations must match to be assigned to the team. See Filter Search Data for more information on creating SQL-like filters.
`active`	Boolean	No	Set to `true` if the team is active; set to `false` if the team is inactive. Default is `true`.
`services`	Array of Numbers or Strings	No	List of the team service names or IDs.
`users`	Array of Numbers or Strings	No	List of users in the team, either usernames or IDs.
`description`	String	No	Team description.
`landing_page`	String	No	Default landing page for the team.

Response

Method createTeam returns the following response:

Type	Description
`Integer`	ID of the new team, or null if an error occurred.

Examples

The following examples demonstrate typical use of method createTeam:

Request example

Example request to create a team "myTeam":

{
    "name": "myTeam",
    "alert_filter": "{ \"column\": \"count\", \"op\": 1, \"value\": 1, \"type\": \"LEAF\" }",
    "sig_filter": "{ \"column\": \"severity\", \"op\": 1, \"value\": 5, \"type\": \"LEAF\" }",
    "active": true,
    "services": [1, 2, 4],
    "users": ["user1", "user4"],
    "description": "myDescription",
    "landing_page": ""
}

Response example

Example response returning the new team ID:

In this section: