Returns source field usages

curl --request GET \
  --url http://10.2.4.166:8080/composer/api/sources/{sourceId}/fields/{fieldName}/usage \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "http://10.2.4.166:8080/composer/api/sources/{sourceId}/fields/{fieldName}/usage"

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('http://10.2.4.166:8080/composer/api/sources/{sourceId}/fields/{fieldName}/usage', 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}/fields/{fieldName}/usage",
  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: Basic <encoded-value>"
  ],
]);

$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 := "http://10.2.4.166:8080/composer/api/sources/{sourceId}/fields/{fieldName}/usage"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/sources/{sourceId}/fields/{fieldName}/usage")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "visuals": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "derivedFields": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "customMetrics": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "globalSettings": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "keySets": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "filterSets": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "fieldLinks": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "rowSecurityFilters": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "actions": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "sourceJoins": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "hierarchies": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "partitions": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "globalFilters": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "inDashboardVisuals": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "snippets": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "uniqueKey": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  }
}

{
  "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": {}
    }
  ]
}

Returns source field usages

curl --request GET \
  --url http://10.2.4.166:8080/composer/api/sources/{sourceId}/fields/{fieldName}/usage \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "http://10.2.4.166:8080/composer/api/sources/{sourceId}/fields/{fieldName}/usage"

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('http://10.2.4.166:8080/composer/api/sources/{sourceId}/fields/{fieldName}/usage', 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}/fields/{fieldName}/usage",
  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: Basic <encoded-value>"
  ],
]);

$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 := "http://10.2.4.166:8080/composer/api/sources/{sourceId}/fields/{fieldName}/usage"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/sources/{sourceId}/fields/{fieldName}/usage")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "visuals": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "derivedFields": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "customMetrics": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "globalSettings": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "keySets": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "filterSets": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "fieldLinks": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "rowSecurityFilters": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "actions": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "sourceJoins": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "hierarchies": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "partitions": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "globalFilters": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "inDashboardVisuals": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "snippets": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  },
  "uniqueKey": {
    "total": 123,
    "accessible": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "SOURCE",
        "parent": "<unknown>"
      }
    ]
  }
}

{
  "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

fieldName

string

required

Response

The field usage was retrieved

Source field usage resource

visuals

object

Show child attributes

derivedFields

object

Show child attributes

customMetrics

object

Show child attributes

globalSettings

object

Show child attributes

keySets

object

Show child attributes

filterSets

object

Show child attributes

fieldLinks

object

Show child attributes

rowSecurityFilters

object

Show child attributes

actions

object

Show child attributes

sourceJoins

object

Show child attributes

hierarchies

object

Show child attributes

partitions

object

Show child attributes

globalFilters

object

Show child attributes

inDashboardVisuals

object

Returns usage of IN-DASHBOARD visuals usage. accessible.id - dashboard id and accessible.name - widget name if visual used in the dashboard. accessible.id - visual id if visual not used in any dashboard.

Show child attributes

snippets

object

Show child attributes

uniqueKey

object

Show child attributes

Release Notes

Administer

Connect to Data

Present Data

Embed and Extend

Reference

Returns source field usages

Authorizations

Path Parameters

Response