Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ODataParams <T >

Model class to define specific OData Request parameters. See http://wiki.sensenet.com/OData_REST_API

Type parameters

  • T

Hierarchy

  • ODataParams

Index

Properties

Optional expand

The field(s) to be include in an $expand list. Can be a reference field (e.g. 'Owner') or an array of fields (e.g. ['CreatedBy', 'ModifiecBy'])

Optional filter

filter: undefined | string

Sets the OData $filter parameter

Optional format

Sets the OData $format parameter. Can be 'json' or 'verbosejson'

Optional inlinecount

Sets the OData $format parameter. Can be 'json' or 'verbosejson'

Optional metadata

Sets the OData metadata parameter. Can be 'full', 'minimal' or 'no'

Optional orderby

Sets the OData $orderby parameter. Usage example `ts // simple field { ... orderby: 'Name' } // list with fields or tuples with order direction { ... orderby: [ ['CreationDate', 'desc'] 'Name', 'DisplayName' ]

}

`

Optional query

query: undefined | string

Sets the OData 'query' parameter. Can be a Content Query

Optional scenario

scenario: undefined | string

The scenario parameter that can be used in case of action scenario filtering

Optional select

select: ODataFieldParameter<T> | "all"

The field(s) to be include in a $select list. Can be a field (e.g. 'DisplayName'), an array of fields (e.g. ['Name', 'Type']) or 'all'

Optional skip

skip: undefined | number

Sets the OData $skip parameter

Optional top

top: undefined | number

Sets the OData $top parameter

Optional version

version: undefined | string

Defines the content version (e.g. 'V1.0A')

Generated using TypeDoc