Data Source

What can you do with DataSource?


Properties

Property Details
id
"id": 649
Type: Number
This is the unique numeric identifier for the DataSource
name
"name": "Hello World"
Type: String
dataSourceTypeId
"dataSourceTypeId": 237
Type: Number
Unique identifier for the associated DataSourceType object.
viewName
"viewName": "Hello World"
Type: String
previewThreshold
"previewThreshold": 691
Type: Number
generateThreshold
"generateThreshold": 989
Type: Number


Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the DataSource object.

Standard PATCH objects:


End Points

GETapi/v1/DataSource
Retrieve all of the DataSource objects.
GETapi/v1/DataSource/Metadata
Retrieve all of the meta data details of the DataSource object.
GETapi/v1/DataSource/Metadata/{option}
Retrieve all the meta data details of the DataSource object based on provided options.
{option}Metadata options for the DataSource object.
GETapi/v1/DataSource/Paged
Retreive all of the DataSource objects in a paged fashion.
GETapi/v1/DataSource/Paged/Detail
Retreive all of the DataSource objects in a paged fashion with all object details.
GETapi/v1/DataSource/{id:int}
Retrieve an instance of the DataSource object by it's ID.
{id:int}Unique identifier for the DataSource object.
GETapi/v1/DataSource/{id:int}/Detail
Retreive all of the Detail objects for the specified DataSource.
{id:int}Unique identifier for the DataSource object.
PATCHapi/v1/DataSource/{id:int}
Update the DataSource object and optionally make changes to any child objects.