IncidentUserGroups¶

IncidentUserGroups - Create¶

Creates a new incident user group in a Fabric-enabled LogPoint

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/IncidentUserGroups

Parameter

Field	Label in UI	Type	Description
selected_usergroups	Select User Groups	[String]	List of usergroup(s) to be added to Incident Usergroup. Mandatory Field

Request Example

{
    "data": {
        "selected_usergroups": [
            "5faa0b4ebba538fa29cc7b52"
        ]
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

IncidentUserGroups - FetchIncidentUserGroup¶

Fetches Incident User Groups List.

DEPRECATED ! Will be removed in future version. Use <b>IncidentUserGroups - List</b> API instead.

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/IncidentUserGroups/fetch

Request Example

{
    "data": {}
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}/{data_node}"
}

IncidentUserGroups - Get¶

Fetches a Incident UserGroup with given ID.

GET

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/IncidentUserGroups/{id}

Parameter

Field	Label in UI	Type	Description
id	-	String	ID of the existing incident usergroup that you want to fetch.

Success Response

{
    "id": "4fd04565f39d16242ad557cb",
    "name": "usergroup1",
    "tid": "",
    "user": "admin",
    "usergroup": "4fcf16418b3e5c5027f18dbb",
    "users": [
        "4fcf176789f54399b15ef23a",
        "4fcf17c189f54399b15ef240"
    ]
}

IncidentUserGroups - List¶

Lists all existing Incident UserGroups.

GET

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/IncidentUserGroups

Success Response

[
    {
        "id": "4fd04565f39d16242ad557cb",
        "name": "usergroup1",
        "tid": "",
        "user": "admin",
        "usergroup": "4fcf16418b3e5c5027f18dbb",
        "users": [
            "4fcf176789f54399b15ef23a",
            "4fcf17c189f54399b15ef240"
        ]
    }
]

IncidentUserGroups - Trash¶

Removes the incident user group with given ID.

DELETE

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/IncidentUserGroups/{id}

Parameter

Field	Label in UI	Type	Description
id	-	String	ID of the existing incident user group that you want to delete. Mandatory Field

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

Helpful?