PUT api/DocumentEntity/Put

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	integer	None.
SequenceNumber	integer	None.
DocID	integer	None.
Version	integer	None.
ProjectID	globally unique identifier	None.
FieldType	integer	None.
FieldMask	integer	None.
FieldFormat	integer	None.
IsID	boolean	None.
IsUnique	boolean	None.
IsRequired	boolean	None.
IsRelated	boolean	None.
RelationWithTransactionID	integer	None.
DocumentType	integer	None.
FieldTypeName	string	None.
FieldFormatName	string	None.
FieldMaskName	string	None.
Name	string	None.
Description	string	None.
FieldCode	string	None.
Length	decimal number	None.
ListValues	string	None.
DocumentEntityList	Collection of REQDocumentEntityGetByPaging_Result	None.
IsAggregate	boolean	None.
CompanyID	integer	None.
Language	string	None.
CreatedDate	date	None.
CreatedUserID	globally unique identifier	None.
ModifiedDate	date	None.
ModifiedUserID	globally unique identifier	None.
FeatureID	globally unique identifier	None.
Token	globally unique identifier	None.
Action	Actions	None.
FilterText	string	None.
CurrentIndex	integer	None.
PageSize	integer	None.
TotalRecords	integer	None.
SortColumn	string	None.
Sortby	SortDirection	None.
ImageId	integer	None.
IsDeleted	boolean	None.
IsActive	boolean	None.
Sort	integer	None.
Messages	Collection of ErrorMessage	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "SequenceNumber": 2,
  "DocID": 3,
  "Version": 4,
  "ProjectID": "1e9162d4-34b7-4fd2-b886-d57ec1f0c7b2",
  "FieldType": 1,
  "FieldMask": 1,
  "FieldFormat": 1,
  "IsID": true,
  "IsUnique": true,
  "IsRequired": true,
  "IsRelated": true,
  "RelationWithTransactionID": 1,
  "DocumentType": 10,
  "FieldTypeName": "sample string 11",
  "FieldFormatName": "sample string 12",
  "FieldMaskName": "sample string 13",
  "Name": "sample string 14",
  "Description": "sample string 15",
  "FieldCode": "sample string 16",
  "Length": 1.0,
  "ListValues": "sample string 17",
  "DocumentEntityList": [
    {
      "SrNo": 1,
      "ID": 1,
      "DocID": 2,
      "Name": "sample string 3",
      "Description": "sample string 4",
      "FieldType": 1,
      "FieldTypeName": "sample string 5",
      "FieldFormat": 1,
      "FieldFormatName": "sample string 6",
      "FieldMaskName": "sample string 7",
      "IsID": true,
      "IsUnique": true,
      "IsRelated": true,
      "IsRequired": true,
      "Length": 1.0,
      "FieldCode": "sample string 12",
      "IsAggregate": true
    },
    {
      "SrNo": 1,
      "ID": 1,
      "DocID": 2,
      "Name": "sample string 3",
      "Description": "sample string 4",
      "FieldType": 1,
      "FieldTypeName": "sample string 5",
      "FieldFormat": 1,
      "FieldFormatName": "sample string 6",
      "FieldMaskName": "sample string 7",
      "IsID": true,
      "IsUnique": true,
      "IsRelated": true,
      "IsRequired": true,
      "Length": 1.0,
      "FieldCode": "sample string 12",
      "IsAggregate": true
    }
  ],
  "IsAggregate": true,
  "CompanyID": 18,
  "Language": "sample string 19",
  "CreatedDate": "2026-01-07T19:56:04.7600395+00:00",
  "CreatedUserID": "7796fb4c-b554-4ac3-9600-2619fe24a1f3",
  "ModifiedDate": "2026-01-07T19:56:04.7600395+00:00",
  "ModifiedUserID": "fc6cfc4e-e889-4a31-8424-d23977eb1265",
  "FeatureID": "54b8614f-753f-48fe-a91f-7d3eb2b6e4eb",
  "Token": "0e467c24-1169-40a0-8ea1-3068c11c9570",
  "Action": 0,
  "FilterText": "sample string 26",
  "CurrentIndex": 27,
  "PageSize": 28,
  "TotalRecords": 29,
  "SortColumn": "sample string 30",
  "Sortby": 0,
  "ImageId": 1,
  "IsDeleted": true,
  "IsActive": true,
  "Sort": 1,
  "Messages": [
    {
      "ErrorType": 1,
      "Message": "sample string 2"
    },
    {
      "ErrorType": 1,
      "Message": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<DocumentEntityViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core.ProjectModels">
  <Action xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">View</Action>
  <CompanyID xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">18</CompanyID>
  <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">2026-01-07T19:56:04.7600395+00:00</CreatedDate>
  <CreatedUserID xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">7796fb4c-b554-4ac3-9600-2619fe24a1f3</CreatedUserID>
  <CurrentIndex xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">27</CurrentIndex>
  <FeatureID xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">54b8614f-753f-48fe-a91f-7d3eb2b6e4eb</FeatureID>
  <FilterText xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">sample string 26</FilterText>
  <ImageId xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">1</ImageId>
  <IsActive xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">true</IsActive>
  <IsDeleted xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">true</IsDeleted>
  <Language xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">sample string 19</Language>
  <Messages xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">
    <ErrorMessage>
      <ErrorType>1</ErrorType>
      <Message>sample string 2</Message>
    </ErrorMessage>
    <ErrorMessage>
      <ErrorType>1</ErrorType>
      <Message>sample string 2</Message>
    </ErrorMessage>
  </Messages>
  <ModifiedDate xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">2026-01-07T19:56:04.7600395+00:00</ModifiedDate>
  <ModifiedUserID xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">fc6cfc4e-e889-4a31-8424-d23977eb1265</ModifiedUserID>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">28</PageSize>
  <Sort xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">1</Sort>
  <SortColumn xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">sample string 30</SortColumn>
  <Sortby xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">Asc</Sortby>
  <Token xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">0e467c24-1169-40a0-8ea1-3068c11c9570</Token>
  <TotalRecords xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">29</TotalRecords>
  <Description>sample string 15</Description>
  <DocID>3</DocID>
  <DocumentEntityList xmlns:d2p1="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">
    <d2p1:REQDocumentEntityGetByPaging_Result>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:DocID>2</d2p1:DocID>
      <d2p1:FieldCode>sample string 12</d2p1:FieldCode>
      <d2p1:FieldFormat>1</d2p1:FieldFormat>
      <d2p1:FieldFormatName>sample string 6</d2p1:FieldFormatName>
      <d2p1:FieldMaskName>sample string 7</d2p1:FieldMaskName>
      <d2p1:FieldType>1</d2p1:FieldType>
      <d2p1:FieldTypeName>sample string 5</d2p1:FieldTypeName>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:IsAggregate>true</d2p1:IsAggregate>
      <d2p1:IsID>true</d2p1:IsID>
      <d2p1:IsRelated>true</d2p1:IsRelated>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:IsUnique>true</d2p1:IsUnique>
      <d2p1:Length>1</d2p1:Length>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:SrNo>1</d2p1:SrNo>
    </d2p1:REQDocumentEntityGetByPaging_Result>
    <d2p1:REQDocumentEntityGetByPaging_Result>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:DocID>2</d2p1:DocID>
      <d2p1:FieldCode>sample string 12</d2p1:FieldCode>
      <d2p1:FieldFormat>1</d2p1:FieldFormat>
      <d2p1:FieldFormatName>sample string 6</d2p1:FieldFormatName>
      <d2p1:FieldMaskName>sample string 7</d2p1:FieldMaskName>
      <d2p1:FieldType>1</d2p1:FieldType>
      <d2p1:FieldTypeName>sample string 5</d2p1:FieldTypeName>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:IsAggregate>true</d2p1:IsAggregate>
      <d2p1:IsID>true</d2p1:IsID>
      <d2p1:IsRelated>true</d2p1:IsRelated>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:IsUnique>true</d2p1:IsUnique>
      <d2p1:Length>1</d2p1:Length>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:SrNo>1</d2p1:SrNo>
    </d2p1:REQDocumentEntityGetByPaging_Result>
  </DocumentEntityList>
  <DocumentType>10</DocumentType>
  <FieldCode>sample string 16</FieldCode>
  <FieldFormat>1</FieldFormat>
  <FieldFormatName>sample string 12</FieldFormatName>
  <FieldMask>1</FieldMask>
  <FieldMaskName>sample string 13</FieldMaskName>
  <FieldType>1</FieldType>
  <FieldTypeName>sample string 11</FieldTypeName>
  <ID>1</ID>
  <IsAggregate>true</IsAggregate>
  <IsID>true</IsID>
  <IsRelated>true</IsRelated>
  <IsRequired>true</IsRequired>
  <IsUnique>true</IsUnique>
  <Length>1</Length>
  <ListValues>sample string 17</ListValues>
  <Name>sample string 14</Name>
  <ProjectID>1e9162d4-34b7-4fd2-b886-d57ec1f0c7b2</ProjectID>
  <RelationWithTransactionID>1</RelationWithTransactionID>
  <SequenceNumber>2</SequenceNumber>
  <Version>4</Version>
</DocumentEntityViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.