POST api/dmsdocumenttype/insert

Request Information

URI Parameters

None.

Body Parameters

DmsDocumentType
NameDescriptionTypeAdditional information
Id

integer

Required

RowGuid

globally unique identifier

Required

Number

integer

Required

Name

string

None.

Description

string

None.

DocumentLibraryId

integer

Required

DocumentReference

integer

Required

Visibility

integer

Required

Active

boolean

Required

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "RowGuid": "a2a7068f-f9fe-4b50-a664-4341e5e73b41",
  "Number": 3,
  "Name": "sample string 4",
  "Description": "sample string 5",
  "DocumentLibraryId": 6,
  "DocumentReference": 7,
  "Visibility": 8,
  "Active": true
}

application/xml, text/xml

Sample:
<DmsDocumentType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IWeb.Tools.Dms.Models">
  <Active>true</Active>
  <Description>sample string 5</Description>
  <DocumentLibraryId>6</DocumentLibraryId>
  <DocumentReference>7</DocumentReference>
  <Id>1</Id>
  <Name>sample string 4</Name>
  <Number>3</Number>
  <RowGuid>a2a7068f-f9fe-4b50-a664-4341e5e73b41</RowGuid>
  <Visibility>8</Visibility>
</DmsDocumentType>

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

Response Information

Resource Description

DmsDocumentTypeDisplay
NameDescriptionTypeAdditional information
DocumentLibraryIdDisplay

string

None.

DocumentReferenceDisplay

string

None.

VisibilityDisplay

string

None.

DisplayField

string

None.

Id

integer

Required

RowGuid

globally unique identifier

Required

Number

integer

Required

Name

string

None.

Description

string

None.

DocumentLibraryId

integer

Required

DocumentReference

integer

Required

Visibility

integer

Required

Active

boolean

Required

Response Formats

application/json, text/json

Sample:
{
  "DocumentLibraryIdDisplay": "sample string 1",
  "DocumentReferenceDisplay": "sample string 2",
  "VisibilityDisplay": "sample string 3",
  "DisplayField": "sample string 4",
  "Id": 5,
  "RowGuid": "bdd11a5a-f9b0-44d0-9741-843f62c2b7b4",
  "Number": 7,
  "Name": "sample string 8",
  "Description": "sample string 9",
  "DocumentLibraryId": 10,
  "DocumentReference": 11,
  "Visibility": 12,
  "Active": true
}

application/xml, text/xml

Sample:
<DmsDocumentTypeDisplay xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IWeb.Tools.Dms.Models">
  <Active>true</Active>
  <Description>sample string 9</Description>
  <DocumentLibraryId>10</DocumentLibraryId>
  <DocumentReference>11</DocumentReference>
  <Id>5</Id>
  <Name>sample string 8</Name>
  <Number>7</Number>
  <RowGuid>bdd11a5a-f9b0-44d0-9741-843f62c2b7b4</RowGuid>
  <Visibility>12</Visibility>
  <DisplayField>sample string 4</DisplayField>
  <DocumentLibraryIdDisplay>sample string 1</DocumentLibraryIdDisplay>
  <DocumentReferenceDisplay>sample string 2</DocumentReferenceDisplay>
  <VisibilityDisplay>sample string 3</VisibilityDisplay>
</DmsDocumentTypeDisplay>