GET api/docDocument/ex?showArchive={showArchive}

Request Information

URI Parameters

Name	Description	Type	Additional information
showArchive		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of docDocumentEx

Name	Type	Additional information
VersionCount	integer	None.
AssignmentCount	integer	None.
TotalAssignmentCount	integer	None.
TriggerCount	integer	None.
NotesCount	integer	None.
PublishedVersionCount	integer	None.
PublishedFileCount	integer	None.
SourceFileCount	integer	None.
HasSearchText	boolean	None.
DocumentID	integer	None.
CategoryID	integer	None.
CategoryName	string	None.
Title	string	Required Max length: 120
Description	string	None.
InLibrary	boolean	None.
IsDeleted	boolean	None.
IsArchived	boolean	None.
CreatedBy	integer	None.
CreatedByName	string	None.
CreatedDate	date	None.
UpdatedBy	integer	None.
UpdatedByName	string	None.
UpdatedDate	date	None.
SetVersion	string	None.
ReferenceNumber	integer	None.
results	Collection of ValidationResult	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "results": null,
    "VersionCount": 1,
    "AssignmentCount": 2,
    "TotalAssignmentCount": 3,
    "TriggerCount": 4,
    "NotesCount": 5,
    "PublishedVersionCount": 6,
    "PublishedFileCount": 7,
    "SourceFileCount": 8,
    "HasSearchText": true,
    "DocumentID": 10,
    "CategoryID": 1,
    "CategoryName": "sample string 11",
    "Title": "sample string 12",
    "Description": "sample string 13",
    "InLibrary": true,
    "IsDeleted": true,
    "IsArchived": true,
    "CreatedBy": 17,
    "CreatedByName": "sample string 18",
    "CreatedDate": "2025-12-06T23:43:07.3101463+00:00",
    "UpdatedBy": 20,
    "UpdatedByName": "sample string 21",
    "UpdatedDate": "2025-12-06T23:43:07.3101463+00:00",
    "SetVersion": "sample string 23",
    "ReferenceNumber": 24
  },
  {
    "results": null,
    "VersionCount": 1,
    "AssignmentCount": 2,
    "TotalAssignmentCount": 3,
    "TriggerCount": 4,
    "NotesCount": 5,
    "PublishedVersionCount": 6,
    "PublishedFileCount": 7,
    "SourceFileCount": 8,
    "HasSearchText": true,
    "DocumentID": 10,
    "CategoryID": 1,
    "CategoryName": "sample string 11",
    "Title": "sample string 12",
    "Description": "sample string 13",
    "InLibrary": true,
    "IsDeleted": true,
    "IsArchived": true,
    "CreatedBy": 17,
    "CreatedByName": "sample string 18",
    "CreatedDate": "2025-12-06T23:43:07.3101463+00:00",
    "UpdatedBy": 20,
    "UpdatedByName": "sample string 21",
    "UpdatedDate": "2025-12-06T23:43:07.3101463+00:00",
    "SetVersion": "sample string 23",
    "ReferenceNumber": 24
  }
]

application/xml, text/xml

Sample:

<ArrayOfdocDocumentEx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
  <docDocumentEx>
    <results xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility" />
    <CategoryID>1</CategoryID>
    <CategoryName>sample string 11</CategoryName>
    <CreatedBy>17</CreatedBy>
    <CreatedByName>sample string 18</CreatedByName>
    <CreatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:43:07.3101463Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </CreatedDate>
    <Description>sample string 13</Description>
    <DocumentID>10</DocumentID>
    <InLibrary>true</InLibrary>
    <IsArchived>true</IsArchived>
    <IsDeleted>true</IsDeleted>
    <ReferenceNumber>24</ReferenceNumber>
    <SetVersion>sample string 23</SetVersion>
    <Title>sample string 12</Title>
    <UpdatedBy>20</UpdatedBy>
    <UpdatedByName>sample string 21</UpdatedByName>
    <UpdatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:43:07.3101463Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </UpdatedDate>
    <AssignmentCount>2</AssignmentCount>
    <HasSearchText>true</HasSearchText>
    <NotesCount>5</NotesCount>
    <PublishedFileCount>7</PublishedFileCount>
    <PublishedVersionCount>6</PublishedVersionCount>
    <SourceFileCount>8</SourceFileCount>
    <TotalAssignmentCount>3</TotalAssignmentCount>
    <TriggerCount>4</TriggerCount>
    <VersionCount>1</VersionCount>
  </docDocumentEx>
  <docDocumentEx>
    <results xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility" />
    <CategoryID>1</CategoryID>
    <CategoryName>sample string 11</CategoryName>
    <CreatedBy>17</CreatedBy>
    <CreatedByName>sample string 18</CreatedByName>
    <CreatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:43:07.3101463Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </CreatedDate>
    <Description>sample string 13</Description>
    <DocumentID>10</DocumentID>
    <InLibrary>true</InLibrary>
    <IsArchived>true</IsArchived>
    <IsDeleted>true</IsDeleted>
    <ReferenceNumber>24</ReferenceNumber>
    <SetVersion>sample string 23</SetVersion>
    <Title>sample string 12</Title>
    <UpdatedBy>20</UpdatedBy>
    <UpdatedByName>sample string 21</UpdatedByName>
    <UpdatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:43:07.3101463Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </UpdatedDate>
    <AssignmentCount>2</AssignmentCount>
    <HasSearchText>true</HasSearchText>
    <NotesCount>5</NotesCount>
    <PublishedFileCount>7</PublishedFileCount>
    <PublishedVersionCount>6</PublishedVersionCount>
    <SourceFileCount>8</SourceFileCount>
    <TotalAssignmentCount>3</TotalAssignmentCount>
    <TriggerCount>4</TriggerCount>
    <VersionCount>1</VersionCount>
  </docDocumentEx>
</ArrayOfdocDocumentEx>