Metergroups

List MeterGroups

Function name: m3ter_ListMeterGroups Category: READ HTTP method: GET (paginated) Destination: m3ter Retrieve a list of MeterGroup entities

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-
`queryParams`	Query Parameters	KeyValueLookupParameter	No	Query parameters to include in the request	allowedValues: ids

Exits

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

Create MeterGroup

Function name: m3ter_PostMeterGroup Category: WRITE HTTP method: POST Destination: m3ter Create a new MeterGroup.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`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 MeterGroup

Function name: m3ter_GetMeterGroup Category: READ HTTP method: GET Destination: m3ter Retrieve a MeterGroup for the given 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 MeterGroup to retrieve.	-
`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 MeterGroup

Function name: m3ter_PutMeterGroup Category: WRITE HTTP method: PUT Destination: m3ter Update MeterGroup for the given 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 MeterGroup to update.	-
`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 MeterGroup

Function name: m3ter_DeleteMeterGroup Category: WRITE HTTP method: DELETE Destination: m3ter Delete a MeterGroup for the given 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 MeterGroup to delete.	-
`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.

Synthetic functions

Native Functions

List MeterGroups

Parameters

Exits

Create MeterGroup

Parameters

Exits

Retrieve MeterGroup

Parameters

Exits

Update MeterGroup

Parameters

Exits

Delete MeterGroup

Parameters

Exits

​List MeterGroups

​Parameters

​Exits

​Create MeterGroup

​Parameters

​Exits

​Retrieve MeterGroup

​Parameters

​Exits

​Update MeterGroup

​Parameters

​Exits

​Delete MeterGroup

​Parameters

​Exits

List MeterGroups

Parameters

Exits

Create MeterGroup

Parameters

Exits

Retrieve MeterGroup

Parameters

Exits

Update MeterGroup

Parameters

Exits

Delete MeterGroup

Parameters

Exits