Retrieve External Entities from Destination - m3ter Documentation

Retrieve External Entities from Destination

cURL

curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/externalmappingconfiguration/values/{destination}/{entityType} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.m3ter.com/organizations/{orgId}/externalmappingconfiguration/values/{destination}/{entityType}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.m3ter.com/organizations/{orgId}/externalmappingconfiguration/values/{destination}/{entityType}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.m3ter.com/organizations/{orgId}/externalmappingconfiguration/values/{destination}/{entityType}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {

url := "https://api.m3ter.com/organizations/{orgId}/externalmappingconfiguration/values/{destination}/{entityType}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

HttpResponse<String> response = Unirest.get("https://api.m3ter.com/organizations/{orgId}/externalmappingconfiguration/values/{destination}/{entityType}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.m3ter.com/organizations/{orgId}/externalmappingconfiguration/values/{destination}/{entityType}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

Response Codes

• 200: Success
• 4XX: Client Error
• 5XX: Server Error

Response Structure

[
  {
    "externalId": "<string>",
    "externalName": "<string>"
  }
]

{
  "message": "<string>"
}

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)
  The unique identifier (UUID) of your organization, representing your company as a direct customer of our service.

• destination: string (required)
  The name of the destination system from where the external entities are to be retrieved.

• entityType: string (required)
  The m3ter entity type.

Query Parameters

• externalTable: string
  Name of the target external table.

Detailed Response

200 application/json: Returns a list of the external systems entities.

• externalId: string
• externalName: string