Platform API

<back to all web services

GetDataSources

Gets a list of integration data sources

Requires Authentication
The following routes are available for this service:
All Verbs/api/datasources
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Gets a list of integration data sources
    */
    @Api(Description="Gets a list of integration data sources")
    public static class GetDataSources
    {
        
    }

    public static class GetDataSourcesResponse
    {
        public ArrayList<ListDataItem> DataSources = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<ListDataItem> getDataSources() { return DataSources; }
        public GetDataSourcesResponse setDataSources(ArrayList<ListDataItem> value) { this.DataSources = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetDataSourcesResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class ListDataItem
    {
        public UUID Id = null;
        public String Name = null;
        public String Description = null;
        public String ShortName = null;
        public String DefaultName = null;
        public Boolean IsDefault = null;
        public Integer Order = null;
        public UUID ListItemTrafficLightId = null;
        public UUID PrimaryListItemImageId = null;
        public String PrimaryListItemImageUrl = null;
        public String PrimaryImageThumbnailUrl = null;
        public UUID OwnerContactId = null;
        public String RecordStatus = null;
        public String Tags = null;
        public UUID ListId = null;
        public Boolean MarkAsChecked = null;
        public UUID RelatedObjectId = null;
        public Boolean CanEdit = null;
        public Boolean IsOwner = null;
        public ArrayList<Object> ExtraValues = null;
        public ArrayList<ListItemFilter> ListItemFilters = null;
        
        public UUID getId() { return Id; }
        public ListDataItem setId(UUID value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public ListDataItem setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public ListDataItem setDescription(String value) { this.Description = value; return this; }
        public String getShortName() { return ShortName; }
        public ListDataItem setShortName(String value) { this.ShortName = value; return this; }
        public String getDefaultName() { return DefaultName; }
        public ListDataItem setDefaultName(String value) { this.DefaultName = value; return this; }
        public Boolean getIsDefault() { return IsDefault; }
        public ListDataItem setIsDefault(Boolean value) { this.IsDefault = value; return this; }
        public Integer getOrder() { return Order; }
        public ListDataItem setOrder(Integer value) { this.Order = value; return this; }
        public UUID getListItemTrafficLightId() { return ListItemTrafficLightId; }
        public ListDataItem setListItemTrafficLightId(UUID value) { this.ListItemTrafficLightId = value; return this; }
        public UUID getPrimaryListItemImageId() { return PrimaryListItemImageId; }
        public ListDataItem setPrimaryListItemImageId(UUID value) { this.PrimaryListItemImageId = value; return this; }
        public String getPrimaryListItemImageUrl() { return PrimaryListItemImageUrl; }
        public ListDataItem setPrimaryListItemImageUrl(String value) { this.PrimaryListItemImageUrl = value; return this; }
        public String getPrimaryImageThumbnailUrl() { return PrimaryImageThumbnailUrl; }
        public ListDataItem setPrimaryImageThumbnailUrl(String value) { this.PrimaryImageThumbnailUrl = value; return this; }
        public UUID getOwnerContactId() { return OwnerContactId; }
        public ListDataItem setOwnerContactId(UUID value) { this.OwnerContactId = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public ListDataItem setRecordStatus(String value) { this.RecordStatus = value; return this; }
        public String getTags() { return Tags; }
        public ListDataItem setTags(String value) { this.Tags = value; return this; }
        public UUID getListId() { return ListId; }
        public ListDataItem setListId(UUID value) { this.ListId = value; return this; }
        public Boolean isMarkAsChecked() { return MarkAsChecked; }
        public ListDataItem setMarkAsChecked(Boolean value) { this.MarkAsChecked = value; return this; }
        public UUID getRelatedObjectId() { return RelatedObjectId; }
        public ListDataItem setRelatedObjectId(UUID value) { this.RelatedObjectId = value; return this; }
        public Boolean isCanEdit() { return CanEdit; }
        public ListDataItem setCanEdit(Boolean value) { this.CanEdit = value; return this; }
        public Boolean getIsOwner() { return IsOwner; }
        public ListDataItem setIsOwner(Boolean value) { this.IsOwner = value; return this; }
        public ArrayList<Object> getExtraValues() { return ExtraValues; }
        public ListDataItem setExtraValues(ArrayList<Object> value) { this.ExtraValues = value; return this; }
        public ArrayList<ListItemFilter> getListItemFilters() { return ListItemFilters; }
        public ListDataItem setListItemFilters(ArrayList<ListItemFilter> value) { this.ListItemFilters = value; return this; }
    }

    public static class ListItemFilter
    {
        public UUID ListItemFilterId = null;
        public String FilterName = null;
        public UUID ListId = null;
        public UUID ListItemId = null;
        public Boolean ListItemIsInFilter = null;
        
        public UUID getListItemFilterId() { return ListItemFilterId; }
        public ListItemFilter setListItemFilterId(UUID value) { this.ListItemFilterId = value; return this; }
        public String getFilterName() { return FilterName; }
        public ListItemFilter setFilterName(String value) { this.FilterName = value; return this; }
        public UUID getListId() { return ListId; }
        public ListItemFilter setListId(UUID value) { this.ListId = value; return this; }
        public UUID getListItemId() { return ListItemId; }
        public ListItemFilter setListItemId(UUID value) { this.ListItemId = value; return this; }
        public Boolean isListItemIsInFilter() { return ListItemIsInFilter; }
        public ListItemFilter setListItemIsInFilter(Boolean value) { this.ListItemIsInFilter = value; return this; }
    }

}

Java GetDataSources DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/datasources HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"DataSources":[{"Id":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","DefaultName":"String","IsDefault":false,"Order":0,"ListItemTrafficLightId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageUrl":"String","PrimaryImageThumbnailUrl":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String","Tags":"String","ListId":"00000000-0000-0000-0000-000000000000","MarkAsChecked":false,"RelatedObjectId":"00000000-0000-0000-0000-000000000000","CanEdit":false,"IsOwner":false,"ExtraValues":[{}],"ListItemFilters":[{"ListItemFilterId":"00000000-0000-0000-0000-000000000000","FilterName":"String","ListId":"00000000-0000-0000-0000-000000000000","ListItemId":"00000000-0000-0000-0000-000000000000","ListItemIsInFilter":false}]}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}