POST api/dmsdocumentmetadata/insert

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	Required
RowGuid	globally unique identifier	Required
DocumentLibraryId	integer	Required
Name	string	None.
DataType	integer	Required
DefaultValue	string	None.
InternalFieldName	string	None.
ExternalFieldName	string	None.
FilterMode	integer	Required
AccessMode	integer	Required
Mandatory	boolean	Required
Searchable	boolean	Required
Active	boolean	Required

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "RowGuid": "3ab3fb61-3cfb-46a1-9da3-93c5954e82dd",
  "DocumentLibraryId": 3,
  "Name": "sample string 4",
  "DataType": 5,
  "DefaultValue": "sample string 6",
  "InternalFieldName": "sample string 7",
  "ExternalFieldName": "sample string 8",
  "FilterMode": 9,
  "AccessMode": 10,
  "Mandatory": true,
  "Searchable": true,
  "Active": true
}

application/xml, text/xml

Sample:

<DmsDocumentMetadata xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IWeb.Tools.Dms.Models">
  <AccessMode>10</AccessMode>
  <Active>true</Active>
  <DataType>5</DataType>
  <DefaultValue>sample string 6</DefaultValue>
  <DocumentLibraryId>3</DocumentLibraryId>
  <ExternalFieldName>sample string 8</ExternalFieldName>
  <FilterMode>9</FilterMode>
  <Id>1</Id>
  <InternalFieldName>sample string 7</InternalFieldName>
  <Mandatory>true</Mandatory>
  <Name>sample string 4</Name>
  <RowGuid>3ab3fb61-3cfb-46a1-9da3-93c5954e82dd</RowGuid>
  <Searchable>true</Searchable>
</DmsDocumentMetadata>

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 'DmsDocumentMetadata'.

Response Information

Resource Description

DmsDocumentMetadataDisplay

Name	Type	Additional information
DocumentLibraryIdDisplay	string	None.
DataTypeDisplay	string	None.
FilterModeDisplay	string	None.
AccessModeDisplay	string	None.
DisplayField	string	None.
Id	integer	Required
RowGuid	globally unique identifier	Required
DocumentLibraryId	integer	Required
Name	string	None.
DataType	integer	Required
DefaultValue	string	None.
InternalFieldName	string	None.
ExternalFieldName	string	None.
FilterMode	integer	Required
AccessMode	integer	Required
Mandatory	boolean	Required
Searchable	boolean	Required
Active	boolean	Required

Response Formats

application/json, text/json

Sample:

{
  "DocumentLibraryIdDisplay": "sample string 1",
  "DataTypeDisplay": "sample string 2",
  "FilterModeDisplay": "sample string 3",
  "AccessModeDisplay": "sample string 4",
  "DisplayField": "sample string 5",
  "Id": 6,
  "RowGuid": "41864a13-24b4-4f3d-b859-b31b7489b067",
  "DocumentLibraryId": 8,
  "Name": "sample string 9",
  "DataType": 10,
  "DefaultValue": "sample string 11",
  "InternalFieldName": "sample string 12",
  "ExternalFieldName": "sample string 13",
  "FilterMode": 14,
  "AccessMode": 15,
  "Mandatory": true,
  "Searchable": true,
  "Active": true
}

application/xml, text/xml

Sample:

<DmsDocumentMetadataDisplay xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IWeb.Tools.Dms.Models">
  <AccessMode>15</AccessMode>
  <Active>true</Active>
  <DataType>10</DataType>
  <DefaultValue>sample string 11</DefaultValue>
  <DocumentLibraryId>8</DocumentLibraryId>
  <ExternalFieldName>sample string 13</ExternalFieldName>
  <FilterMode>14</FilterMode>
  <Id>6</Id>
  <InternalFieldName>sample string 12</InternalFieldName>
  <Mandatory>true</Mandatory>
  <Name>sample string 9</Name>
  <RowGuid>41864a13-24b4-4f3d-b859-b31b7489b067</RowGuid>
  <Searchable>true</Searchable>
  <AccessModeDisplay>sample string 4</AccessModeDisplay>
  <DataTypeDisplay>sample string 2</DataTypeDisplay>
  <DisplayField>sample string 5</DisplayField>
  <DocumentLibraryIdDisplay>sample string 1</DocumentLibraryIdDisplay>
  <FilterModeDisplay>sample string 3</FilterModeDisplay>
</DmsDocumentMetadataDisplay>