{ "opencollection": "1.0.0", "info": { "name": "m3ter Account Aggregation API", "version": "1.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Aggregation", "type": "folder" }, "items": [ { "info": { "name": "List Aggregations", "type": "http" }, "http": { "method": "GET", "url": "https://api.m3ter.com/organizations/:orgId/aggregations", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of Aggregations to retrieve per page." }, { "name": "nextToken", "value": "", "type": "query", "description": "`nextToken` for multi-page retrievals." }, { "name": "productId", "value": "", "type": "query", "description": "The UUIDs of the Products to retrieve Aggregations for." }, { "name": "ids", "value": "", "type": "query", "description": "List of Aggregation IDs to retrieve." }, { "name": "codes", "value": "", "type": "query", "description": "List of Aggregation codes to retrieve. These are unique short codes to identify each Aggregation." } ] }, "docs": "Retrieve a list of Aggregations that can be filtered by Product, Aggregation ID, or Code." }, { "info": { "name": "Create Aggregation", "type": "http" }, "http": { "method": "POST", "url": "https://api.m3ter.com/organizations/:orgId/aggregations", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service. " } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Aggregation." }, { "info": { "name": "Retrieve Aggregation", "type": "http" }, "http": { "method": "GET", "url": "https://api.m3ter.com/organizations/:orgId/aggregations/:id", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service." }, { "name": "id", "value": "", "type": "path", "description": "The UUID of the Aggregation to retrieve." } ] }, "docs": "Retrieve the Aggregation with the given UUID." }, { "info": { "name": "Update Aggregation", "type": "http" }, "http": { "method": "PUT", "url": "https://api.m3ter.com/organizations/:orgId/aggregations/:id", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service." }, { "name": "id", "value": "", "type": "path", "description": "The UUID of the Aggregation to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Aggregation with the given UUID.\n\n**Note:** If you have created Custom Fields for an Aggregation, when you use this endpoint to update the Aggregation use the `customFields` parameter to preserve those Custom Fields. If you omit them from the update request, they will be lost." }, { "info": { "name": "Delete Aggregation", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.m3ter.com/organizations/:orgId/aggregations/:id", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service." }, { "name": "id", "value": "", "type": "path", "description": "The UUID of the Aggregation to delete." } ] }, "docs": "Delete the Aggregation with the given UUID." } ] } ], "bundled": true }