POST api/dmsdocumentmetadata/preparenew

Request Information

URI Parameters

None.

Body Parameters

Collection of KeyValue

Name	Description	Type	Additional information
Id		integer	Required
Value		string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Value": "sample string 2"
  },
  {
    "Id": 1,
    "Value": "sample string 2"
  }
]

application/xml, text/xml

Sample:

<ArrayOfKeyValue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">
  <KeyValue>
    <Id>1</Id>
    <Value>sample string 2</Value>
  </KeyValue>
  <KeyValue>
    <Id>1</Id>
    <Value>sample string 2</Value>
  </KeyValue>
</ArrayOfKeyValue>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DmsDocumentMetadata

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

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "RowGuid": "9849998d-e828-4708-809e-5bdc4b0ac77c",
  "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>9849998d-e828-4708-809e-5bdc4b0ac77c</RowGuid>
  <Searchable>true</Searchable>
</DmsDocumentMetadata>