Moogsoft Docs

getToolShares

A MoogDb v2 method that returns the shared access for a tool.

Request arguments

Method getToolShares takes the following request arguments:

Name

Type

Required

Description

tool_id

Number

Yes

ID of the tool that you want to retrieve its shared access for.

Response

Method getToolShares returns the following response:

Type

Description

Object

A Javascript object containing the tool ID, the domain, and an array of all the domain IDs that can access the tool.

Examples

The following examples demonstrate typical use of method getToolShares:

Request example

Example request to retrieve all the domain IDs that have access to tool 15 :

var actions = moogdb.getToolShares(15);
Response example

Example response returning that tool ID 15 can be accessed by team ID 3:

{
    "tool_id": 15,
    "domain_ids": [
        3
    ],
    "domain": "team"
}