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

export class ListItemFilter
{
    public ListItemFilterId: string;
    public FilterName: string;
    public ListId: string;
    public ListItemId: string;
    public ListItemIsInFilter: boolean;

    public constructor(init?: Partial<ListItemFilter>) { (Object as any).assign(this, init); }
}

export class ListDataItem
{
    public Id: string;
    public Name: string;
    public Description: string;
    public ShortName: string;
    public DefaultName: string;
    public IsDefault: boolean;
    public Order: number;
    public ListItemTrafficLightId: string;
    public PrimaryListItemImageId: string;
    public PrimaryListItemImageUrl: string;
    public PrimaryImageThumbnailUrl: string;
    public OwnerContactId: string;
    public RecordStatus: string;
    public Tags: string;
    public ListId: string;
    public MarkAsChecked: boolean;
    public RelatedObjectId: string;
    public CanEdit: boolean;
    public IsOwner: boolean;
    public ExtraValues: Object[];
    public ListItemFilters: ListItemFilter[];

    public constructor(init?: Partial<ListDataItem>) { (Object as any).assign(this, init); }
}

export class GetDataSourcesResponse
{
    public DataSources: ListDataItem[];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetDataSourcesResponse>) { (Object as any).assign(this, init); }
}

/** @description Gets a list of integration data sources */
// @Api(Description="Gets a list of integration data sources")
export class GetDataSources
{

    public constructor(init?: Partial<GetDataSources>) { (Object as any).assign(this, init); }
}

TypeScript GetDataSources DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	DataSources: 
	[
		{
			Name: String,
			Description: String,
			ShortName: String,
			DefaultName: String,
			IsDefault: False,
			Order: 0,
			PrimaryListItemImageUrl: String,
			PrimaryImageThumbnailUrl: String,
			RecordStatus: String,
			Tags: String,
			MarkAsChecked: False,
			CanEdit: False,
			IsOwner: False,
			ExtraValues: 
			[
				{
					
				}
			],
			ListItemFilters: 
			[
				{
					FilterName: String,
					ListItemIsInFilter: False
				}
			]
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}