POST api/DocumentLink

Request Information

URI Parameters

None.

Body Parameters

DocumentLinkViewModel
NameDescriptionTypeAdditional information
DocIDFrom

integer

None.

DocFromName

string

None.

DocTypeIDFrom

integer

None.

DocTypeFromName

string

None.

DocFromKeyCode

string

None.

DocIDTo

integer

None.

DocumentTypeIDTo

integer

None.

DocToName

string

None.

DocTypeToName

string

None.

DocToKeyCode

string

None.

DocIDToDocumentType

integer

None.

TypeID

integer

None.

Type

string

None.

DocToDescription

string

None.

DocToJson

string

None.

ProjectID

globally unique identifier

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:
{
  "DocIDFrom": 1,
  "DocFromName": "sample string 2",
  "DocTypeIDFrom": 3,
  "DocTypeFromName": "sample string 4",
  "DocFromKeyCode": "sample string 5",
  "DocIDTo": 6,
  "DocumentTypeIDTo": 7,
  "DocToName": "sample string 8",
  "DocTypeToName": "sample string 9",
  "DocToKeyCode": "sample string 10",
  "DocIDToDocumentType": 11,
  "TypeID": 1,
  "Type": "sample string 12",
  "DocToDescription": "sample string 13",
  "DocToJson": "sample string 14",
  "ProjectID": "5e94be1f-6ea0-45c9-b32c-4c10296efb59",
  "CompanyID": 16,
  "Language": "sample string 17",
  "CreatedDate": "2025-08-28T23:34:24.8338212+00:00",
  "CreatedUserID": "04619a2b-d7f8-4859-8a51-b693771b484e",
  "ModifiedDate": "2025-08-28T23:34:24.8338212+00:00",
  "ModifiedUserID": "d8c608ee-f0c4-49fe-a24c-a2c3519f4c62",
  "FeatureID": "ff6ddba2-8cd2-4dfd-bcf6-e93240f7e7ef",
  "Token": "3a3d79c8-02c2-4458-a8e3-3946ed8a0806",
  "Action": 0,
  "FilterText": "sample string 24",
  "CurrentIndex": 25,
  "PageSize": 26,
  "TotalRecords": 27,
  "SortColumn": "sample string 28",
  "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:
<DocumentLinkViewModel 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">16</CompanyID>
  <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">2025-08-28T23:34:24.8338212+00:00</CreatedDate>
  <CreatedUserID xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">04619a2b-d7f8-4859-8a51-b693771b484e</CreatedUserID>
  <CurrentIndex xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">25</CurrentIndex>
  <FeatureID xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">ff6ddba2-8cd2-4dfd-bcf6-e93240f7e7ef</FeatureID>
  <FilterText xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">sample string 24</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 17</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">2025-08-28T23:34:24.8338212+00:00</ModifiedDate>
  <ModifiedUserID xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">d8c608ee-f0c4-49fe-a24c-a2c3519f4c62</ModifiedUserID>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">26</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 28</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">3a3d79c8-02c2-4458-a8e3-3946ed8a0806</Token>
  <TotalRecords xmlns="http://schemas.datacontract.org/2004/07/ArtSolutions.ReqStudio.Core">27</TotalRecords>
  <DocFromKeyCode>sample string 5</DocFromKeyCode>
  <DocFromName>sample string 2</DocFromName>
  <DocIDFrom>1</DocIDFrom>
  <DocIDTo>6</DocIDTo>
  <DocIDToDocumentType>11</DocIDToDocumentType>
  <DocToDescription>sample string 13</DocToDescription>
  <DocToJson>sample string 14</DocToJson>
  <DocToKeyCode>sample string 10</DocToKeyCode>
  <DocToName>sample string 8</DocToName>
  <DocTypeFromName>sample string 4</DocTypeFromName>
  <DocTypeIDFrom>3</DocTypeIDFrom>
  <DocTypeToName>sample string 9</DocTypeToName>
  <DocumentTypeIDTo>7</DocumentTypeIDTo>
  <ProjectID>5e94be1f-6ea0-45c9-b32c-4c10296efb59</ProjectID>
  <Type>sample string 12</Type>
  <TypeID>1</TypeID>
</DocumentLinkViewModel>

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.