Scheduledevents

Retrieve ScheduledEventConfiguration

Function name: m3ter_GetScheduledEventConfiguration Category: READ HTTP method: GET Destination: m3ter Retrieve a ScheduledEventConfiguration 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 ScheduledEventConfiguration 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 ScheduledEventConfiguration

Function name: m3ter_UpdateScheduledEventConfiguration Category: WRITE HTTP method: PUT Destination: m3ter Update a ScheduledEventConfiguration 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 ScheduledEventConfiguration 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 ScheduledEventConfiguration

Function name: m3ter_DeleteScheduledEventConfiguration Category: WRITE HTTP method: DELETE Destination: m3ter Delete the ScheduledEventConfiguration 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 ScheduledEventConfiguration 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 ScheduledEventConfigurations

Function name: m3ter_ListScheduledEventConfigurations Category: READ HTTP method: GET (paginated) Destination: m3ter Retrieve a list of ScheduledEventConfiguration 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 ScheduledEventConfiguration

Function name: m3ter_CreateScheduledEventConfiguration Category: WRITE HTTP method: POST Destination: m3ter Create a new ScheduledEventConfiguration.

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.

Synthetic functions

Native Functions

Retrieve ScheduledEventConfiguration

Parameters

Exits

Update ScheduledEventConfiguration

Parameters

Exits

Delete ScheduledEventConfiguration

Parameters

Exits

List ScheduledEventConfigurations

Parameters

Exits

Create ScheduledEventConfiguration

Parameters

Exits

​Retrieve ScheduledEventConfiguration

​Parameters

​Exits

​Update ScheduledEventConfiguration

​Parameters

​Exits

​Delete ScheduledEventConfiguration

​Parameters

​Exits

​List ScheduledEventConfigurations

​Parameters

​Exits

​Create ScheduledEventConfiguration

​Parameters

​Exits

Retrieve ScheduledEventConfiguration

Parameters

Exits

Update ScheduledEventConfiguration

Parameters

Exits

Delete ScheduledEventConfiguration

Parameters

Exits

List ScheduledEventConfigurations

Parameters

Exits

Create ScheduledEventConfiguration

Parameters

Exits