Preview-execute one data source from the catalog.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://example.com/api/workspace/admin/data-sources/example/execute"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"Parameters\": \"example\", \"ExpectedSchemaFingerprint\": \"example\", \"Page\": { \"PageNumber\": 1, \"PageSize\": 1 }, \"Sort\": { \"FieldKey\": \"example\", \"Direction\": 1 } }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};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/admin/data-sources/example/execute';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"Parameters":"example","ExpectedSchemaFingerprint":"example","Page":{"PageNumber":1,"PageSize":1},"Sort":{"FieldKey":"example","Direction":1}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/workspace/admin/data-sources/example/execute \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "Parameters": "example", "ExpectedSchemaFingerprint": "example", "Page": { "PageNumber": 1, "PageSize": 1 }, "Sort": { "FieldKey": "example", "Direction": 1 } }'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.
Request Body
Section titled “Request Body”Request to preview-execute a data source.
object
Typed parameter JSON payload for the provider.
Descriptor fingerprint expected by the caller.
Represents a paging request for table and list DataSource outputs.
object
Represents a sort request for table and list DataSource outputs.
object
Defines sort direction for table and list DataSource requests.
Request to preview-execute a data source.
object
Typed parameter JSON payload for the provider.
Descriptor fingerprint expected by the caller.
Represents a paging request for table and list DataSource outputs.
object
Represents a sort request for table and list DataSource outputs.
object
Defines sort direction for table and list DataSource requests.
Request to preview-execute a data source.
object
Typed parameter JSON payload for the provider.
Descriptor fingerprint expected by the caller.
Represents a paging request for table and list DataSource outputs.
object
Represents a sort request for table and list DataSource outputs.
object
Defines sort direction for table and list DataSource requests.
Responses
Section titled “Responses”OK
object
Successful data-source execution result plus source metadata.
object
Catalog item identifier.
Stable data-source identifier.
Data-source key.
Descriptor fingerprint used for this execution.
Represents the result of a DataSource execution.
object
Defines the shape returned by a DataSource execution.
Represents paging metadata returned by a table or list DataSource.
object
Represents a warning emitted by DataSource execution.
object
Represents a typed link emitted by DataSource execution.
object
Defines link target families that can be emitted by DataSources.
object
object
object
object
object
object
Example
{ "Data": { "Result": { "Shape": 1, "Links": [ { "TargetKind": 1 } ] } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Successful data-source execution result plus source metadata.
object
Catalog item identifier.
Stable data-source identifier.
Data-source key.
Descriptor fingerprint used for this execution.
Represents the result of a DataSource execution.
object
Defines the shape returned by a DataSource execution.
Represents paging metadata returned by a table or list DataSource.
object
Represents a warning emitted by DataSource execution.
object
Represents a typed link emitted by DataSource execution.
object
Defines link target families that can be emitted by DataSources.
object
object
object
object
object
object
Example
{ "Data": { "Result": { "Shape": 1, "Links": [ { "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
Successful data-source execution result plus source metadata.
object
Catalog item identifier.
Stable data-source identifier.
Data-source key.
Descriptor fingerprint used for this execution.
Represents the result of a DataSource execution.
object
Defines the shape returned by a DataSource execution.
Represents paging metadata returned by a table or list DataSource.
object
Represents a warning emitted by DataSource execution.
object
Represents a typed link emitted by DataSource execution.
object
Defines link target families that can be emitted by DataSources.
object
object
object
object
object
object
Example
{ "Data": { "Result": { "Shape": 1, "Links": [ { "TargetKind": 1 } ] } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}