Skip to main content
GET
/
organizations
/
{orgId}
/
dataexports
/
schedules
/
{id}
Retrieve Schedule
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/dataexports/schedules/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "version": 123,
  "name": "<string>",
  "code": "<string>",
  "sourceType": "<unknown>",
  "destinationIds": [
    "<string>"
  ],
  "scheduleType": "<unknown>",
  "period": 123,
  "offset": 123,
  "cronExpression": "<string>",
  "exportFileFormat": "<unknown>",
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>",
  "operationalDataTypes": [
    "BILLS"
  ]
}

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.

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

​
id
string
required

The UUID of the Schedule to retrieve.

Response

Returns the requested Export Schedule

Response representing an operational data export configuration.

​
id
string
required

The id of the schedule.

​
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 Data Export Schedule.

​
code
string

Unique short code of the Data Export Schedule.

​
sourceType
any
​
destinationIds
string[]

The Export Destination ids.

​
scheduleType
any
​
period
integer<int32>

Defines the Schedule frequency for the Data Export to run in Hours, Days, or Minutes. Used in conjunction with the scheduleType parameter.

​
offset
integer<int32>

Offset indicating starting point of the export within the configured scheduleType. For DAY, offset is in hours. For HOUR, offset is in minutes. Offset is not valid for MINUTE.

​
cronExpression
string

A cron expression (https://en.wikipedia.org/wiki/Cron) describing the frequency of the expression. Executions cannot be more frequent than every 15 minutes.

​
exportFileFormat
any
​
dtCreated
string<date-time>

The DateTime when the Data Export Schedule was created.

​
dtLastModified
string<date-time>

The DateTime when the Schedule was last modified.

​
createdBy
string

The id of the user who created this Schedule.

​
lastModifiedBy
string

The id of the user who last modified this Data Export Schedule.

​
operationalDataTypes
enum<string>[]

A list of the entities whose operational data is included in the data export.

Available options:
BILLS,
COMMITMENTS,
ACCOUNTS,
BALANCES,
CONTRACTS,
ACCOUNT_PLANS,
AGGREGATIONS,
PLANS,
PRICING,
PRICING_BANDS,
BILL_LINE_ITEMS,
METERS,
PRODUCTS,
COMPOUND_AGGREGATIONS,
PLAN_GROUPS,
PLAN_GROUP_LINKS,
PLAN_TEMPLATES,
BALANCE_TRANSACTIONS,
TRANSACTION_TYPES,
CHARGES