TAG LINE
TAG LINE
SMALL TITLE

Custom Data Source

(API Version v9)


This entity allows you to retrieve data based on different custom data source views that have been created in the platform.


What can you do with CustomDataSource?



End Points

GETCustomDataSource/ByConnection/{id}
Retrieve an instance of the CustomDataSource object by its ID.
{id}Unique identifier for the CustomDataSource object.
Retrieve an instance of the CustomDataSource object by its ID.
GET CustomDataSource/ByConnection/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {}
}
GETCustomDataSource/ByConnection/{id}/Paged
Retrieve all of the / objects for a specified CustomDataSource in a paged fashion.
{id}Unique identifier for the CustomDataSource object.
Retrieve all of the / objects for a specified CustomDataSource in a paged fashion.
GET CustomDataSource/ByConnection/{id}/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {}
}
GETCustomDataSource/{id}
Retrieve an instance of the CustomDataSource object by its ID.
{id}Unique identifier for the CustomDataSource object.
Retrieve an instance of the CustomDataSource object by its ID.
GET CustomDataSource/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {}
}
GETCustomDataSource/{id}/Metadata
Retrieve all of the Metadata objects for the specified CustomDataSource.
{id}Unique identifier for the CustomDataSource object.
Retrieve all of the Metadata objects for the specified CustomDataSource.
GET CustomDataSource/{id}/Metadata
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {}
}
GETCustomDataSource/{id}/Metadata/sql
Retrieve all of the Metadata/sql objects for the specified CustomDataSource.
{id}Unique identifier for the CustomDataSource object.
Retrieve all of the Metadata/sql objects for the specified CustomDataSource.
GET CustomDataSource/{id}/Metadata/sql
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {}
}
GETCustomDataSource/{id}/Paged
Retrieve all the data from the Custom Data Source in a paged fashion by specifying the {id} of the data source.
{id}Unique identifier for the CustomDataSource object.
Retrieve all the data from the Custom Data Source in a paged fashion by specifying the {id} of the data source.
GET CustomDataSource/{id}/Paged
View Sample Response
HTTP/1.1 200 OK
{
  "pagination": {
    "pageNumber": 1,
    "pageSize": 5000,
    "excludeTotalCount": false
  },
  "pagedResults": {
    "totalCount": 3,
    "items": [
      {
        "accountId": 10000000,
        "accountName": "Anthem Records",
        "parentAccountId": 10000000,
        "parentAccountName": "Anthem Records",
        "topAccountId": 10000000,
        "topAccountName": "Anthem Records"
      },
      {
        "accountId": 10000001,
        "accountName": "tbrown",
        "parentAccountId": 10000000,
        "parentAccountName": "Anthem Records",
        "topAccountId": 10000000,
        "topAccountName": "Anthem Records"
      },
      {
        "accountId": 10000002,
        "accountName": "hsyme",
        "parentAccountId": 10000000,
        "parentAccountName": "Anthem Records",
        "topAccountId": 10000000,
        "topAccountName": "Anthem Records"
      }
    ]
  }
}