> ## Documentation Index
> Fetch the complete documentation index at: https://docs.m3ter.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Resourcegroups

## List ResourceGroup permission policies

**Function name:** `m3ter_GetResourceGroupPermissions`
**Category:** READ
**HTTP method:** GET (paginated)
**Destination:** m3ter

Retrieve a list of permission policies for a ResourceGroup

### Parameters

| Name                       | Label           | Type                   | Required | Description                           | Constraints                                                           |
| -------------------------- | --------------- | ---------------------- | :------: | ------------------------------------- | --------------------------------------------------------------------- |
| `integrationCredentialsId` | Credentials     | M3terEntityParameter   |    Yes   | The m3ter credentials to use.         | m3terEntity: IntegrationCredentials, authType: M3TER\_SIGNED\_REQUEST |
| `type`                     | type            | LookupParameter        |    Yes   | The type of resource                  | -                                                                     |
| `resourceGroupId`          | resourceGroupId | LookupParameter        |    Yes   | UUID of the ResourceGroup             | -                                                                     |
| `statePath`                | State Path      | StateVariableParameter |    No    | State variable to store the response. | -                                                                     |

### Exits

| Exit    | Description                                                                      |
| ------- | -------------------------------------------------------------------------------- |
| `NEXT`  | The API call succeeded.                                                          |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## Remove item

**Function name:** `m3ter_RemoveResourceFromGroup`
**Category:** WRITE
**HTTP method:** POST
**Destination:** m3ter

Remove an item from a ResourceGroup.

### Parameters

| Name                       | Label           | Type                   | Required | Description                                            | Constraints                                                           |
| -------------------------- | --------------- | ---------------------- | :------: | ------------------------------------------------------ | --------------------------------------------------------------------- |
| `integrationCredentialsId` | Credentials     | M3terEntityParameter   |    Yes   | The m3ter credentials to use.                          | m3terEntity: IntegrationCredentials, authType: M3TER\_SIGNED\_REQUEST |
| `resourceGroupId`          | resourceGroupId | LookupParameter        |    Yes   | The UUID of the ResourceGroup to remove the item from. | -                                                                     |
| `type`                     | type            | LookupParameter        |    Yes   | The type of resource                                   | -                                                                     |
| `requestPath`              | Request Path    | StateVariableParameter |    Yes   | State variable containing the request.                 | -                                                                     |
| `statePath`                | State Path      | StateVariableParameter |    No    | State variable to store the response.                  | -                                                                     |

### Exits

| Exit    | Description                                                                      |
| ------- | -------------------------------------------------------------------------------- |
| `NEXT`  | The API call succeeded.                                                          |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## Retrieve ResourceGroup

**Function name:** `m3ter_GetResourceGroup`
**Category:** READ
**HTTP method:** GET
**Destination:** m3ter

Retrieve the ResourceGroup for the UUID

### Parameters

| Name                       | Label       | Type                   | Required | Description                                | Constraints                                                           |
| -------------------------- | ----------- | ---------------------- | :------: | ------------------------------------------ | --------------------------------------------------------------------- |
| `integrationCredentialsId` | Credentials | M3terEntityParameter   |    Yes   | The m3ter credentials to use.              | m3terEntity: IntegrationCredentials, authType: M3TER\_SIGNED\_REQUEST |
| `id`                       | id          | LookupParameter        |    Yes   | The UUID of the ResourceGroup to retrieve. | -                                                                     |
| `type`                     | type        | LookupParameter        |    Yes   | The type of resource                       | -                                                                     |
| `statePath`                | State Path  | StateVariableParameter |    No    | State variable to store the response.      | -                                                                     |

### Exits

| Exit    | Description                                                                      |
| ------- | -------------------------------------------------------------------------------- |
| `NEXT`  | The API call succeeded.                                                          |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## Update ResourceGroup

**Function name:** `m3ter_PutResourceGroup`
**Category:** WRITE
**HTTP method:** PUT
**Destination:** m3ter

Update the ResourceGroup for the UUID

### Parameters

| Name                       | Label        | Type                   | Required | Description                              | Constraints                                                           |
| -------------------------- | ------------ | ---------------------- | :------: | ---------------------------------------- | --------------------------------------------------------------------- |
| `integrationCredentialsId` | Credentials  | M3terEntityParameter   |    Yes   | The m3ter credentials to use.            | m3terEntity: IntegrationCredentials, authType: M3TER\_SIGNED\_REQUEST |
| `id`                       | id           | LookupParameter        |    Yes   | The UUID of the ResourceGroup to update. | -                                                                     |
| `type`                     | type         | LookupParameter        |    Yes   | The type of resource                     | -                                                                     |
| `requestPath`              | Request Path | StateVariableParameter |    Yes   | State variable containing the request.   | -                                                                     |
| `statePath`                | State Path   | StateVariableParameter |    No    | State variable to store the response.    | -                                                                     |

### Exits

| Exit    | Description                                                                      |
| ------- | -------------------------------------------------------------------------------- |
| `NEXT`  | The API call succeeded.                                                          |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## Delete ResourceGroup

**Function name:** `m3ter_DeleteResourceGroup`
**Category:** WRITE
**HTTP method:** DELETE
**Destination:** m3ter

Delete a ResourceGroup for the UUID

### Parameters

| Name                       | Label       | Type                   | Required | Description                              | Constraints                                                           |
| -------------------------- | ----------- | ---------------------- | :------: | ---------------------------------------- | --------------------------------------------------------------------- |
| `integrationCredentialsId` | Credentials | M3terEntityParameter   |    Yes   | The m3ter credentials to use.            | m3terEntity: IntegrationCredentials, authType: M3TER\_SIGNED\_REQUEST |
| `id`                       | id          | LookupParameter        |    Yes   | The UUID of the ResourceGroup to delete. | -                                                                     |
| `type`                     | type        | LookupParameter        |    Yes   | The type of resource                     | -                                                                     |
| `statePath`                | State Path  | StateVariableParameter |    No    | State variable to store the response.    | -                                                                     |

### Exits

| Exit    | Description                                                                      |
| ------- | -------------------------------------------------------------------------------- |
| `NEXT`  | The API call succeeded.                                                          |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## List ResourceGroups

**Function name:** `m3ter_ListResourceGroups`
**Category:** READ
**HTTP method:** GET (paginated)
**Destination:** m3ter

Retrieve a list of ResourceGroup entities

### Parameters

| Name                       | Label       | Type                   | Required | Description                           | Constraints                                                           |
| -------------------------- | ----------- | ---------------------- | :------: | ------------------------------------- | --------------------------------------------------------------------- |
| `integrationCredentialsId` | Credentials | M3terEntityParameter   |    Yes   | The m3ter credentials to use.         | m3terEntity: IntegrationCredentials, authType: M3TER\_SIGNED\_REQUEST |
| `type`                     | type        | LookupParameter        |    Yes   | The type of resource                  | -                                                                     |
| `statePath`                | State Path  | StateVariableParameter |    No    | State variable to store the response. | -                                                                     |

### Exits

| Exit    | Description                                                                      |
| ------- | -------------------------------------------------------------------------------- |
| `NEXT`  | The API call succeeded.                                                          |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## Create ResourceGroup

**Function name:** `m3ter_PostResourceGroup`
**Category:** WRITE
**HTTP method:** POST
**Destination:** m3ter

Create a ResourceGroup for the UUID

### Parameters

| Name                       | Label        | Type                   | Required | Description                            | Constraints                                                           |
| -------------------------- | ------------ | ---------------------- | :------: | -------------------------------------- | --------------------------------------------------------------------- |
| `integrationCredentialsId` | Credentials  | M3terEntityParameter   |    Yes   | The m3ter credentials to use.          | m3terEntity: IntegrationCredentials, authType: M3TER\_SIGNED\_REQUEST |
| `type`                     | type         | LookupParameter        |    Yes   | The type of resource                   | -                                                                     |
| `requestPath`              | Request Path | StateVariableParameter |    Yes   | State variable containing the request. | -                                                                     |
| `statePath`                | State Path   | StateVariableParameter |    No    | State variable to store the response.  | -                                                                     |

### Exits

| Exit    | Description                                                                      |
| ------- | -------------------------------------------------------------------------------- |
| `NEXT`  | The API call succeeded.                                                          |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## List ResourceGroup items

**Function name:** `m3ter_ListResourceGroupsForId`
**Category:** WRITE
**HTTP method:** POST
**Destination:** m3ter

Retrieve a list of items for a ResourceGroup

### Parameters

| Name                       | Label           | Type                   | Required | Description                           | Constraints                                                           |
| -------------------------- | --------------- | ---------------------- | :------: | ------------------------------------- | --------------------------------------------------------------------- |
| `integrationCredentialsId` | Credentials     | M3terEntityParameter   |    Yes   | The m3ter credentials to use.         | m3terEntity: IntegrationCredentials, authType: M3TER\_SIGNED\_REQUEST |
| `type`                     | type            | LookupParameter        |    Yes   | The type of resource                  | -                                                                     |
| `resourceGroupId`          | resourceGroupId | LookupParameter        |    Yes   | UUID of the ResourceGroup             | -                                                                     |
| `statePath`                | State Path      | StateVariableParameter |    No    | State variable to store the response. | -                                                                     |

### Exits

| Exit    | Description                                                                      |
| ------- | -------------------------------------------------------------------------------- |
| `NEXT`  | The API call succeeded.                                                          |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## Add item

**Function name:** `m3ter_AddResourceToGroup`
**Category:** WRITE
**HTTP method:** POST
**Destination:** m3ter

Add an item to a ResourceGroup.

### Parameters

| Name                       | Label           | Type                   | Required | Description                                                                     | Constraints                                                           |
| -------------------------- | --------------- | ---------------------- | :------: | ------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `integrationCredentialsId` | Credentials     | M3terEntityParameter   |    Yes   | The m3ter credentials to use.                                                   | m3terEntity: IntegrationCredentials, authType: M3TER\_SIGNED\_REQUEST |
| `resourceGroupId`          | resourceGroupId | LookupParameter        |    Yes   | The UUID of the ResourceGroup to add the item to.                               | -                                                                     |
| `type`                     | type            | LookupParameter        |    Yes   | The type of resource the Resource Group is for, such as a Meter Resource Group. | -                                                                     |
| `requestPath`              | Request Path    | StateVariableParameter |    Yes   | State variable containing the request.                                          | -                                                                     |
| `statePath`                | State Path      | StateVariableParameter |    No    | State variable to store the response.                                           | -                                                                     |

### Exits

| Exit    | Description                                                                      |
| ------- | -------------------------------------------------------------------------------- |
| `NEXT`  | The API call succeeded.                                                          |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |
