Get Custom Group Using GET

Get Custom Group Using GET

Get a custom group with or without policy

Request
URI
GET
https://{api_host}/suite-api/api/resources/groups/{groupId}
COPY
Path Parameters
string
groupId
Required

Group identifier

Query Parameters
boolean
includePolicy
Optional

Flag that controls the retrieval of policy identifier applied to group

Authentication
This operation uses the following authentication methods.
Responses
200

The custom group with sought identifier

Returns custom-group of type(s) application/json 
{
    "autoResolveMembership": false,
    "id": "string",
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "membershipDefinition": {
        "custom-group-properties": [
            {
                "exclusionValue": "string",
                "inclusionValue": "string",
                "name": "string",
                "type": "string"
            }
        ],
        "excludedResources": [
            "string"
        ],
        "includedResources": [
            "string"
        ],
        "rules": [
            {
                "propertyConditionRules": [
                    {
                        "compareOperator": "string",
                        "doubleValue": "number",
                        "key": "string",
                        "stringValue": "string"
                    }
                ],
                "relationshipConditionRules": [
                    {
                        "compareOperator": "string",
                        "name": "string",
                        "relation": "string",
                        "travesalSpecId": "string"
                    }
                ],
                "resourceKindKey": {
                    "adapterKind": "string",
                    "resourceKind": "string"
                },
                "resourceNameConditionRules": [
                    {
                        "compareOperator": "string",
                        "name": "string"
                    }
                ],
                "resourceTagConditionRules": [
                    {
                        "category": "string",
                        "compareOperator": "string",
                        "stringValue": "string"
                    }
                ],
                "statConditionRules": [
                    {
                        "compareOperator": "string",
                        "doubleValue": "number",
                        "key": "string",
                        "stringValue": "string"
                    }
                ]
            }
        ]
    },
    "policy": "string",
    "resourceKey": {
        "adapterKindKey": "string",
        "extension": {
            "anyObjects": [
                {}
            ]
        },
        "links": [
            {
                "description": "string",
                "href": "string",
                "name": "string",
                "rel": "string"
            }
        ],
        "name": "string",
        "resourceIdentifiers": [
            {
                "identifierType": {
                    "dataType": "string",
                    "extension": {
                        "anyObjects": [
                            {}
                        ]
                    },
                    "isPartOfUniqueness": false,
                    "links": [
                        {
                            "description": "string",
                            "href": "string",
                            "name": "string",
                            "rel": "string"
                        }
                    ],
                    "name": "string"
                },
                "key": "string",
                "links": [
                    {
                        "description": "string",
                        "href": "string",
                        "name": "string",
                        "rel": "string"
                    }
                ],
                "name": "string",
                "uniquelyIdentifying": false,
                "value": "string"
            }
        ],
        "resourceKindKey": "string"
    }
}
boolean
autoResolveMembership
Optional

Automatically update membership

string As uuid As uuid
id
Required

Identifier of custom group

array of link
links
Optional

links

custom-group-membership
membershipDefinition
Required

membershipDefinition

string As uuid As uuid
policy
Optional

Policy identifier

resource-key
resourceKey
Required

resourceKey


On This Page
Resources Operations
POST
Add Group Type Using POST
POST
Add Stats For Resources Using POST
POST
Add Stats For Resources Using Push Adapter Kind Using POST
POST
Create Custom Group Using POST
POST
Create Custom Profile Using POST
POST
Create Resource Using Adapter Instance Using POST
POST
Create Resource Using Adapter Kind Using POST
DELETE
Delete Custom Group Using DELETE
DELETE
Delete Custom Profile Using DELETE
DELETE
Delete Group Type Using DELETE
DELETE
Delete Resources Using DELETE
GET
Get Custom Group Members Using GET
GET
Get Custom Groups Using GET
GET
Get Custom Group Using GET
GET
Get Custom Profiles Using GET
GET
Get Custom Profile Using GET
GET
Get Group Types Using GET
GET
Get Latest Stats Of Resources Using GET
POST
Get Matching Resources Using POST
GET
Get Resource Properties List Using GET
POST
Get Resources Relationships Using POST
GET
Get Resources Using GET
GET
Get Stat Keys Of Resources Using GET
POST
Get Stats And DT For Resources Using POST
POST
Get Stats For Resources Using POST
GET
Get Stats Of Resources Using GET
GET
Get Top N Stats Of Resources Using GET
PUT
Mark Resources As Being Maintained Using PUT
PUT
Modify Custom Group Using PUT
PUT
Modify Custom Profile Using PUT
POST
Query Latest Properties Of Resources Using POST
POST
Query Latest Stats Of Resources Using POST
PUT
Start Monitoring Resources Using PUT
PUT
Stop Monitoring Resources Using PUT
DELETE
Unmark Resources As Being Maintained Using DELETE
PUT
Update Resource Using PUT