POST api/dmsdocumentmetadata/select

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
DocumentLibraryId	integer	None.
Name	string	None.
DataType	integer	None.
DefaultValue	string	None.
InternalFieldName	string	None.
ExternalFieldName	string	None.
FilterMode	integer	None.
AccessMode	integer	None.
Mandatory	integer	None.
Searchable	integer	None.
Active	integer	None.
PageSize	integer	Required
PageIndex	integer	Required
SortField	string	None.
SortFieldDefault	string	None.
Quicksearch	string	None.
filterIsSet	boolean	None.
resetFilter	boolean	None.
TagIds	Collection of integer	None.
TagFullMatch	boolean	None.
WithTags	boolean	None.
RequestFields	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "DocumentLibraryId": 1,
  "Name": "sample string 1",
  "DataType": 1,
  "DefaultValue": "sample string 2",
  "InternalFieldName": "sample string 3",
  "ExternalFieldName": "sample string 4",
  "FilterMode": 1,
  "AccessMode": 1,
  "Mandatory": 1,
  "Searchable": 1,
  "Active": 1,
  "PageSize": 5,
  "PageIndex": 6,
  "SortField": "sample string 7",
  "SortFieldDefault": "sample string 8",
  "Quicksearch": "sample string 9",
  "filterIsSet": true,
  "resetFilter": true,
  "TagIds": [
    1,
    2
  ],
  "TagFullMatch": true,
  "WithTags": true,
  "RequestFields": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<DmsDocumentMetadataSelect xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IWeb.Tools.Dms.Models">
  <PageIndex xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">6</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">5</PageSize>
  <Quicksearch xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">sample string 9</Quicksearch>
  <RequestFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </RequestFields>
  <SortField xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">sample string 7</SortField>
  <SortFieldDefault xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">sample string 8</SortFieldDefault>
  <TagFullMatch xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">true</TagFullMatch>
  <TagIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </TagIds>
  <WithTags xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">true</WithTags>
  <filterIsSet xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">true</filterIsSet>
  <resetFilter xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">true</resetFilter>
  <AccessMode>1</AccessMode>
  <Active>1</Active>
  <DataType>1</DataType>
  <DefaultValue>sample string 2</DefaultValue>
  <DocumentLibraryId>1</DocumentLibraryId>
  <ExternalFieldName>sample string 4</ExternalFieldName>
  <FilterMode>1</FilterMode>
  <Id>1</Id>
  <InternalFieldName>sample string 3</InternalFieldName>
  <Mandatory>1</Mandatory>
  <Name>sample string 1</Name>
  <Searchable>1</Searchable>
</DmsDocumentMetadataSelect>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DmsDocumentMetadataSelect'.

Response Information

Resource Description

DmsDocumentMetadataQueryResult

Name	Type	Additional information
Entries	Collection of DmsDocumentMetadataDisplay	None.
RecordsTotal	integer	Required
PageSize	integer	Required
PageIndex	integer	Required
SortField	string	None.

Response Formats

application/json, text/json

Sample:

Sample not available.