Plangrouplinks

Retrieve PlanGroupLink

Function name: m3ter_GetPlanGroupLink Category: READ HTTP method: GET Destination: m3ter

Retrieve a PlanGroupLink 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 PlanGroupLink 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 PlanGroupLink

Function name: m3ter_PutPlanGroupLink Category: WRITE HTTP method: PUT Destination: m3ter

Update PlanGroupLink 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 PlanGroupLink 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 PlanGroupLink

Function name: m3ter_DeletePlanGroupLink Category: WRITE HTTP method: DELETE Destination: m3ter

Delete a PlanGroupLink 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 PlanGroupLink 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.

List PlanGroupLinks

Function name: m3ter_ListPlanGroupLinks Category: READ HTTP method: GET (paginated) Destination: m3ter

Retrieve a list of PlanGroupLink 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: planGroup,plan,ids

Exits

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

Create PlanGroupLink

Function name: m3ter_PostPlanGroupLink Category: WRITE HTTP method: POST Destination: m3ter

Create a new PlanGroupLink.

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.