Skip to main content
POST
/
organizations
/
{orgId}
/
resourcegroups
/
{type}
/
{resourceGroupId}
/
removeresource
Remove item
curl --request POST \
  --url https://api.m3ter.com/organizations/{orgId}/resourcegroups/{type}/{resourceGroupId}/removeresource \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "targetId": "06f6b50c-a868-4ca6-XXXX-448e507d5248",
  "targetType": "item"
}
'
{
  "id": "<string>",
  "version": 123,
  "name": "<string>",
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>"
}

Authorizations

Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

orgId
string
required

UUID of the organization

resourceGroupId
string
required

The UUID of the ResourceGroup to remove the item from.

type
string
required

The type of resource

Body

application/json
targetId
string
required

The id of the item or group you want to:

  • Add Item call: add to a Resource Group.
  • Remove Item call: remove from the Resource Group.
Minimum string length: 1
targetType
enum<string>
required

When adding to or removing from a Resource Group, specify whether a single item or group:

  • item
    • Add Item call: use to add a single meter to a Resource Group
    • Remove Item call: use to remove a single from a Resource Group.
  • group
    • Add Item call: use to add a Resource Group to another Resource Group and form a nested Resource Group
    • Remove Item call: use remove a nested Resource Group from a Resource Group.
Available options:
ITEM,
GROUP
version
integer<int64>

The version number of the group.

Response

Return the ResourceGroup

id
string
required

The UUID of the entity.

version
integer<int64>

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
name
string

The name of the Resource Group.

dtCreated
string<date-time>

The date and time (in ISO-8601 format) when the Resource Group was created.

dtLastModified
string<date-time>

The date and time (in ISO-8601 format) when the Resource Group was last modified.

createdBy
string

The unique identifier (UUID) of the user who created this Resource Group.

lastModifiedBy
string

The unique identifier (UUID) of the user who last modified this Resource Group.