Read a descriptor only when the actor may use the source.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://example.com/api/workspace/data-sources/example"), Headers = { { "Authorization", "Bearer <token>" }, },};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/data-sources/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/workspace/data-sources/example \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Responses
Section titled “Responses”OK
object
Full runtime descriptor detail for one data source.
object
Runtime catalog metadata for one data source.
object
Opaque runtime catalog item identifier.
Stable data-source identifier supplied by the provider.
Human-readable data-source key supplied by the provider.
Represents display text with an invariant default value and optional locale-specific translations.
object
The invariant default text.
Optional locale-specific translations keyed by locale code.
object
Represents display text with an invariant default value and optional locale-specific translations.
object
The invariant default text.
Optional locale-specific translations keyed by locale code.
object
Identifies the authoring surface that provides a DataSource.
Owning module key, when the source belongs to a module.
Descriptor fingerprint used for published-definition compatibility.
Provider descriptor version.
Current workspace categories, ordered for source selection.
A workspace-owned source classification.
object
Defines the shape returned by a DataSource execution.
Renderer kinds supported by this source’s validated schema.
Describes a DataSource contract that can be bound to dashboard and report definitions.
object
Represents display text with an invariant default value and optional locale-specific translations.
object
The invariant default text.
Optional locale-specific translations keyed by locale code.
object
Represents display text with an invariant default value and optional locale-specific translations.
object
The invariant default text.
Optional locale-specific translations keyed by locale code.
object
Identifies the authoring surface that provides a DataSource.
Describes a single DataSource parameter.
object
Defines the logical type of a DataSource parameter.
Represents display text with an invariant default value and optional locale-specific translations.
object
The invariant default text.
Optional locale-specific translations keyed by locale code.
object
Describes a DataSource output schema.
object
Defines the shape returned by a DataSource execution.
Describes a field in a DataSource output payload.
object
Defines a logical field value type in a DataSource output schema.
Represents display text with an invariant default value and optional locale-specific translations.
object
The invariant default text.
Optional locale-specific translations keyed by locale code.
object
Describes a renderer that can consume a DataSource output.
object
Defines renderer families that can consume a DataSource output.
Describes a drilldown/link target that can be produced by a DataSource.
object
Defines link target families that can be emitted by DataSources.
Describes host execution limits and capabilities for a DataSource.
object
Default page size for paged results when the caller does not supply a page.
object
object
object
object
Example
{ "Data": { "CatalogItem": { "SourceKind": 0, "OutputShape": 1, "RendererKinds": [ 1 ] }, "Descriptor": { "SourceKind": 0, "Parameters": [ { "Type": 1 } ], "OutputSchema": { "Shape": 1, "Fields": [ { "ValueType": 1 } ] }, "RendererCapabilities": [ { "RendererKind": 1 } ], "DrilldownCapabilities": [ { "TargetKind": 1 } ] } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Full runtime descriptor detail for one data source.
object
Runtime catalog metadata for one data source.
object
Opaque runtime catalog item identifier.
Stable data-source identifier supplied by the provider.
Human-readable data-source key supplied by the provider.
Represents display text with an invariant default value and optional locale-specific translations.
object
The invariant default text.
Optional locale-specific translations keyed by locale code.
object
Represents display text with an invariant default value and optional locale-specific translations.
object
The invariant default text.
Optional locale-specific translations keyed by locale code.
object
Identifies the authoring surface that provides a DataSource.
Owning module key, when the source belongs to a module.
Descriptor fingerprint used for published-definition compatibility.
Provider descriptor version.
Current workspace categories, ordered for source selection.
A workspace-owned source classification.
object
Defines the shape returned by a DataSource execution.
Renderer kinds supported by this source’s validated schema.
Describes a DataSource contract that can be bound to dashboard and report definitions.
object
Represents display text with an invariant default value and optional locale-specific translations.
object
The invariant default text.
Optional locale-specific translations keyed by locale code.
object
Represents display text with an invariant default value and optional locale-specific translations.
object
The invariant default text.
Optional locale-specific translations keyed by locale code.
object
Identifies the authoring surface that provides a DataSource.
Describes a single DataSource parameter.
object
Defines the logical type of a DataSource parameter.
Represents display text with an invariant default value and optional locale-specific translations.
object
The invariant default text.
Optional locale-specific translations keyed by locale code.
object
Describes a DataSource output schema.
object
Defines the shape returned by a DataSource execution.
Describes a field in a DataSource output payload.
object
Defines a logical field value type in a DataSource output schema.
Represents display text with an invariant default value and optional locale-specific translations.
object
The invariant default text.
Optional locale-specific translations keyed by locale code.
object
Describes a renderer that can consume a DataSource output.
object
Defines renderer families that can consume a DataSource output.
Describes a drilldown/link target that can be produced by a DataSource.
object
Defines link target families that can be emitted by DataSources.
Describes host execution limits and capabilities for a DataSource.
object
Default page size for paged results when the caller does not supply a page.
object
object
object
object
Example
{ "Data": { "CatalogItem": { "SourceKind": 0, "OutputShape": 1, "RendererKinds": [ 1 ] }, "Descriptor": { "SourceKind": 0, "Parameters": [ { "Type": 1 } ], "OutputSchema": { "Shape": 1, "Fields": [ { "ValueType": 1 } ] }, "RendererCapabilities": [ { "RendererKind": 1 } ], "DrilldownCapabilities": [ { "TargetKind": 1 } ] } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}