DocCloud API

<back to all web services

GetTableDefaultViewQuery

Requires Authentication
The following routes are available for this service:
GET/view/{objectType}
GetTableDefaultViewQuery Parameters:
NameParameterData TypeRequiredDescription
ObjectTypepathintNo
BaseSingleResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ResultformTNo
TableViewDto Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
ObjectTypeformintNo
IsDefaultformboolNo
PropertiesIdformulong?No
PropertiesformTableViewPropertiesDtoNo
SortformList<TableViewSortDto>No
FiltersformList<TableViewFilterDto>No
BaseKeyLongDto Parameters:
NameParameterData TypeRequiredDescription
CreatedByIdformuintNo
ModifiedByIdformuintNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
IdformulongNo
TableViewPropertiesDto Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
ObjectTypeformintNo
DataJsonformstringNo
IsDefaultformboolNo
TableViewSortDto Parameters:
NameParameterData TypeRequiredDescription
PropertyformstringNo
IsAscendingformboolNo
OrderformfloatNo
IsDeletedformboolNo
TableViewFilterDto Parameters:
NameParameterData TypeRequiredDescription
OperatorformintNo
PropertyformstringNo
ValueformstringNo
IsDeletedformboolNo

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 /view/{objectType} HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		title: String,
		objectType: 0,
		isDefault: False,
		propertiesId: 0,
		properties: 
		{
			title: String,
			objectType: 0,
			dataJson: String,
			isDefault: False,
			createdById: 0,
			modifiedById: 0,
			createdDate: 0001-01-01,
			modifiedDate: 0001-01-01,
			id: 0
		},
		sort: 
		[
			{
				property: String,
				isAscending: False,
				order: 0,
				isDeleted: False,
				createdById: 0,
				modifiedById: 0,
				createdDate: 0001-01-01,
				modifiedDate: 0001-01-01,
				id: 0
			}
		],
		filters: 
		[
			{
				operator: 0,
				property: String,
				value: String,
				isDeleted: False,
				createdById: 0,
				modifiedById: 0,
				createdDate: 0001-01-01,
				modifiedDate: 0001-01-01,
				id: 0
			}
		],
		createdById: 0,
		modifiedById: 0,
		createdDate: 0001-01-01,
		modifiedDate: 0001-01-01,
		id: 0
	}
}