Skip to main content
GET
/
organizations
/
{orgId}
/
dataexports
/
destinations
/
{id}
Retrieve ExportDestination
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/dataexports/destinations/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "version": 123,
  "name": "<string>",
  "code": "<string>",
  "destinationType": "S3",
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>",
  "bucketName": "<string>",
  "prefix": "<string>",
  "iamRoleArn": "<string>",
  "partitionOrder": "TYPE_FIRST"
}

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 ExportDestination to retrieve.

Response

Returns the Export Destination

​
id
string
required

The UUID of the entity.

​
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 Destination.

​
code
string

The code of the data Export Destination.

​
destinationType
enum<string>
Available options:
S3,
GCS
​
dtCreated
string<date-time>

The DateTime when the Export Destination was created.

​
dtLastModified
string<date-time>

The DateTime when the Export Destination was last modified.

​
createdBy
string

The id of the user who created the Export Destination.

​
lastModifiedBy
string

The id of the user who last modified the Export Destination.

​
bucketName
string

Name of the S3 bucket for the Export Destination.

​
prefix
string

Location in specified S3 bucket for the Export Destination. If no prefix is specified, then the root of the bucket is used.

​
iamRoleArn
string

The specified IAM role ARN with PutObject permission for the specified bucketName, which allows the service to upload Data Exports to your S3 bucket.

​
partitionOrder
enum<string>
Available options:
TYPE_FIRST,
TIME_FIRST