{ "opencollection": "1.0.0", "info": { "name": "m3ter Account ExportSchedule API", "version": "1.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "ExportSchedule", "type": "folder" }, "items": [ { "info": { "name": "Retrieve Schedule", "type": "http" }, "http": { "method": "GET", "url": "https://api.m3ter.com/organizations/:orgId/dataexports/schedules/:id", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "UUID of the organization" }, { "name": "id", "value": "", "type": "path", "description": "The UUID of the Schedule to retrieve." } ] }, "docs": "Retrieve a Data Export Schedule for the given UUID. Each Schedule can be configured for exporting *only one* of either Usage or Operational data.\n" }, { "info": { "name": "Update Schedule", "type": "http" }, "http": { "method": "PUT", "url": "https://api.m3ter.com/organizations/:orgId/dataexports/schedules/:id", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "UUID of the organization" }, { "name": "id", "value": "", "type": "path", "description": "The UUID of the Schedule to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Data Export Schedule for the given UUID. Each Schedule can be configured for exporting *only one* of either Usage or Operational data:\n\n**Operational Data Exports**.\n* Use the `operationalDataTypes` parameter to specify the entities whose operational data you want to include in the export each time the Export Schedule runs.\n* For each of the entity types you select, each time the Export Schedule runs a separate file is compiled containing the operational data for all entities of that ty" }, { "info": { "name": "Delete Schedule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.m3ter.com/organizations/:orgId/dataexports/schedules/:id", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "UUID of the organization" }, { "name": "id", "value": "", "type": "path", "description": "The UUID of the Schedule to delete." } ] }, "docs": "Delete the Data Export Schedule for the given UUID. Each Schedule can be configured for exporting *only one* of either Usage or Operational data." }, { "info": { "name": "List Schedules", "type": "http" }, "http": { "method": "GET", "url": "https://api.m3ter.com/organizations/:orgId/dataexports/schedules", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "UUID of the organization" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of schedules to retrieve per page" }, { "name": "nextToken", "value": "", "type": "query", "description": "`nextToken` for multi page retrievals" }, { "name": "ids", "value": "", "type": "query", "description": "Data Export Schedule IDs to filter the returned list by." } ] }, "docs": "Retrieve a list of Data Export Schedules created for your Organization. You can filter the response by Schedules `ids`.\n\nThe response will contain an array for both the operational and usage Data Export Schedules in your Organization." }, { "info": { "name": "Create Schedule", "type": "http" }, "http": { "method": "POST", "url": "https://api.m3ter.com/organizations/:orgId/dataexports/schedules", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "UUID of the organization" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Data Export Schedule. Each Schedule can be configured for exporting *only one* of either Usage or Operational data:\n\n**Operational Data Exports**.\n* Use the `operationalDataTypes` parameter to specify the entities whose operational data you want to include in the export each time the Export Schedule runs.\n* For each of the entity types you select, each time the Export Schedule runs a separate file is compiled containing the operational data for all entities of that type that exist i" } ] } ], "bundled": true }