Validates a custom metric

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics/validate \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
{
  "expression": "<string>"
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics/validate"

payload = { "expression": "<string>" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify({expression: '<string>'})
};

fetch('http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics/validate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics/validate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'expression' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/vnd.composer.v3+json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics/validate"

	payload := strings.NewReader("{\n  \"expression\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/vnd.composer.v3+json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics/validate")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"expression\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics/validate")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n  \"expression\": \"<string>\"\n}"

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

{
  "valid": true,
  "referencedFields": [
    "<string>"
  ],
  "error": {
    "type": "DUPLICATED",
    "message": "<string>"
  }
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "timestamp": "2023-11-07T05:31:56Z",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "path": "<string>"
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

Validates a custom metric

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics/validate \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
{
  "expression": "<string>"
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics/validate"

payload = { "expression": "<string>" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify({expression: '<string>'})
};

fetch('http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics/validate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics/validate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'expression' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/vnd.composer.v3+json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics/validate"

	payload := strings.NewReader("{\n  \"expression\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/vnd.composer.v3+json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics/validate")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"expression\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics/validate")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n  \"expression\": \"<string>\"\n}"

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

{
  "valid": true,
  "referencedFields": [
    "<string>"
  ],
  "error": {
    "type": "DUPLICATED",
    "message": "<string>"
  }
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "timestamp": "2023-11-07T05:31:56Z",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "path": "<string>"
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

HTTP Basic authentication using global administrator credentials (username and password).

Path Parameters

sourceId

string

required

Body

application/vnd.composer.v3+json

expression

string

required

Minimum string length: 1

Response

Custom metric was validated successfully

Custom metric validation result

valid

boolean

referencedFields

string[]

error

object

Option 1
Option 2

Show child attributes

Release Notes

Administer

Connect to Data

Present Data

Embed and Extend

Reference

Validates a custom metric

Authorizations

Path Parameters

Body

Response