DocumentsControllerGetByType Method |
[This is preliminary documentation and is subject to change.]
Retrieves all docuements of a given type in a paged format.
Namespace: WebServiceKit.ControllersAssembly: WebServiceKit (in WebServiceKit.dll) Version: 1.0.0.0 (1.0.0.0)
Syntaxpublic IHttpActionResult GetByType(
Guid guid,
int pageIndex = 0,
int pageSize = 100,
string sortField = "LastModifiedDateTime",
string sortOrder = "ASC",
bool update = false
)
Public Function GetByType (
guid As Guid,
Optional pageIndex As Integer = 0,
Optional pageSize As Integer = 100,
Optional sortField As String = "LastModifiedDateTime",
Optional sortOrder As String = "ASC",
Optional update As Boolean = false
) As IHttpActionResult
public:
IHttpActionResult^ GetByType(
Guid guid,
int pageIndex = 0,
int pageSize = 100,
String^ sortField = L"LastModifiedDateTime",
String^ sortOrder = L"ASC",
bool update = false
)
member GetByType :
guid : Guid *
?pageIndex : int *
?pageSize : int *
?sortField : string *
?sortOrder : string *
?update : bool
(* Defaults:
let _pageIndex = defaultArg pageIndex 0
let _pageSize = defaultArg pageSize 100
let _sortField = defaultArg sortField "LastModifiedDateTime"
let _sortOrder = defaultArg sortOrder "ASC"
let _update = defaultArg update false
*)
-> IHttpActionResult
Parameters
- guid
- Type: SystemGuid
Target document type guid. - pageIndex (Optional)
- Type: SystemInt32
Which page index you wish to retrieve. - pageSize (Optional)
- Type: SystemInt32
Size of the pages you wish to retrieve. This is optional and defaults to 100. - sortField (Optional)
- Type: SystemString
The field by which to sort the query - sortOrder (Optional)
- Type: SystemString
The order by which to sort the query - update (Optional)
- Type: SystemBoolean
Flag to determine if the document should be updated to include any possible model changes that
might have occurred since the document was last saved
Return Value
Type:
IHttpActionResult200 OK and the serialized documents instances will be returned if the document type guid is found, otherwise 404.
Remarks
The document instances are formatted using XML or JSON depending on the client request. Call requires a valid login token.
Page size must between 1 and 1000.
Supported sort fields are LastModifiedDateTime and CreatedDateTime.
Accepted sort order format is ASC or DESC.
HTTP Method: GET
[Route("api/documents/types/{guid}")]
Sample: api/documents/types/<guid>?pageIndex=0&pageSize=100&sortField=LastModifiedDateTime&sortOrder=ASC&update=false
See Also