ApexERPHost

<back to all web services

GetDynamicDSList

Requires Authentication
The following routes are available for this service:
GET/Core/Dynamic/DataSources
GetDynamicDSList Parameters:
NameParameterData TypeRequiredDescription
CatIdqueryGuid?No
GetDynamicDSListResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<DynamicDataSource>No
DynamicDataSource Parameters:
NameParameterData TypeRequiredDescription
DsIdformGuidNo
NameformstringNo
DescriptionformstringNo
QueryformstringNo
HasDatesformboolNo
CategoryIdformGuidNo
ParamsformList<DynamicDataSourceParam>No
HccrtformstringNo
Usedformbool?No
HasParamsformbool?No
HCodeformstringNo
DynamicDataSourceParam Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
DescriptionformstringNo
DataSourceIdformGuidNo
DbTypeformstringNo
SizeformintNo
QueryIdformGuid?No
FormatformstringNo
IsNullableformboolNo
OrderIndexformintNo

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.

GET /Core/Dynamic/DataSources HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Result: 
	[
		{
			DsId: 00000000000000000000000000000000,
			Name: String,
			Description: String,
			Query: String,
			HasDates: False,
			CategoryId: 00000000000000000000000000000000,
			Params: 
			[
				{
					Id: 00000000000000000000000000000000,
					Name: String,
					Description: String,
					DataSourceId: 00000000000000000000000000000000,
					DbType: String,
					Size: 0,
					QueryId: 00000000000000000000000000000000,
					Format: String,
					IsNullable: False,
					OrderIndex: 0
				}
			],
			Hccrt: String,
			Used: False,
			HasParams: False,
			HCode: String
		}
	]
}