Data Source / Default

What can you do with DataSource?


Properties

Property Details
id
"id": 123
Type: Number
This is the unique numeric identifier for the DataSource
name
"name": "Hello World"
Type: String
dataSourceTypeId
"dataSourceTypeId": 931
Type: Number
Unique identifier for the associated DataSourceType object.
viewName
"viewName": "Hello World"
Type: String
previewThreshold
"previewThreshold": 549
Type: Number
generateThreshold
"generateThreshold": 435
Type: Number


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • dataSourceTypeId
  • viewName
  • previewThreshold
  • generateThreshold

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:

DataFlow PATCH objects:


End Points

DELETEapi/v1/DataSource/Default/{id:int}
Delete an instance of the DataSource object.
GETapi/v1/DataSource/Default
Retrieve all of the DataSource objects.
GETapi/v1/DataSource/Default/Metadata
Retrieve all of the meta data details of the DataSource object.
GETapi/v1/DataSource/Default/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/Default/Paged
Retreive all of the DataSource objects in a paged fashion.
GETapi/v1/DataSource/Default/Paged/Detail
Retreive all of the DataSource objects in a paged fashion with all object details.
GETapi/v1/DataSource/Default/{id:int}
Retrieve an instance of the DataSource object by it's ID.
{id:int}Unique identifier for the DataSource object.
GETapi/v1/DataSource/Default/{id:int}/Detail
Retreive all of the Detail objects for the specified DataSource.
{id:int}Unique identifier for the DataSource object.
PATCHapi/v1/DataSource/Default/{id:int}
Update the DataSource object and optionally make changes to any child objects.
POSTapi/v1/DataSource/Default
Create a new instance of the DataSource object.
PUTapi/v1/DataSource/Default/{id:int}
Update an existing instance of the DataSource object.