GET api/docDashboard/versions?includeArchived={includeArchived}

Request Information

URI Parameters

Name	Description	Type	Additional information
includeArchived		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of docVersionDbEx

Name	Type	Additional information
CategoryID	integer	None.
CategoryName	string	None.
VersionID	integer	None.
DocumentID	integer	None.
DocumentTitle	string	None.
MajorNum	integer	None.
MinorNum	integer	None.
PatchNum	integer	None.
VersionNumber	string	None.
Description	string	Required
ChangeNotes	string	Required
LanguageCode	string	Max length: 3
OwnerID	integer	None.
OwnerName	string	None.
StatusID	integer	None.
StatusName	string	None.
IsLive	boolean	None.
PublicationDate	date	None.
ExpirationDate	date	None.
SourceFile	string	None.
PublishedFile	string	None.
LockedDate	date	None.
CreatedBy	integer	None.
CreatedDate	date	None.
UpdatedBy	integer	None.
UpdatedDate	date	None.
results	Collection of ValidationResult	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "results": null,
    "CategoryID": 1,
    "CategoryName": "sample string 2",
    "VersionID": 3,
    "DocumentID": 4,
    "DocumentTitle": "sample string 5",
    "MajorNum": 6,
    "MinorNum": 7,
    "PatchNum": 8,
    "VersionNumber": "sample string 9",
    "Description": "sample string 10",
    "ChangeNotes": "sample string 11",
    "LanguageCode": "sample string 12",
    "OwnerID": 13,
    "OwnerName": "sample string 14",
    "StatusID": 15,
    "StatusName": "sample string 16",
    "IsLive": true,
    "PublicationDate": "2025-12-06T23:39:35.2923173+00:00",
    "ExpirationDate": "2025-12-06T23:39:35.2923173+00:00",
    "SourceFile": "sample string 18",
    "PublishedFile": "sample string 19",
    "LockedDate": "2025-12-06T23:39:35.2923173+00:00",
    "CreatedBy": 21,
    "CreatedDate": "2025-12-06T23:39:35.2923173+00:00",
    "UpdatedBy": 23,
    "UpdatedDate": "2025-12-06T23:39:35.2923173+00:00"
  },
  {
    "results": null,
    "CategoryID": 1,
    "CategoryName": "sample string 2",
    "VersionID": 3,
    "DocumentID": 4,
    "DocumentTitle": "sample string 5",
    "MajorNum": 6,
    "MinorNum": 7,
    "PatchNum": 8,
    "VersionNumber": "sample string 9",
    "Description": "sample string 10",
    "ChangeNotes": "sample string 11",
    "LanguageCode": "sample string 12",
    "OwnerID": 13,
    "OwnerName": "sample string 14",
    "StatusID": 15,
    "StatusName": "sample string 16",
    "IsLive": true,
    "PublicationDate": "2025-12-06T23:39:35.2923173+00:00",
    "ExpirationDate": "2025-12-06T23:39:35.2923173+00:00",
    "SourceFile": "sample string 18",
    "PublishedFile": "sample string 19",
    "LockedDate": "2025-12-06T23:39:35.2923173+00:00",
    "CreatedBy": 21,
    "CreatedDate": "2025-12-06T23:39:35.2923173+00:00",
    "UpdatedBy": 23,
    "UpdatedDate": "2025-12-06T23:39:35.2923173+00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfdocVersionDbEx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
  <docVersionDbEx>
    <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" />
    <ChangeNotes>sample string 11</ChangeNotes>
    <CreatedBy>21</CreatedBy>
    <CreatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:39:35.2923173Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </CreatedDate>
    <Description>sample string 10</Description>
    <DocumentID>4</DocumentID>
    <DocumentTitle>sample string 5</DocumentTitle>
    <ExpirationDate>2025-12-06T23:39:35.2923173+00:00</ExpirationDate>
    <IsLive>true</IsLive>
    <LanguageCode>sample string 12</LanguageCode>
    <LockedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:39:35.2923173Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </LockedDate>
    <MajorNum>6</MajorNum>
    <MinorNum>7</MinorNum>
    <OwnerID>13</OwnerID>
    <OwnerName>sample string 14</OwnerName>
    <PatchNum>8</PatchNum>
    <PublicationDate>2025-12-06T23:39:35.2923173+00:00</PublicationDate>
    <PublishedFile>sample string 19</PublishedFile>
    <SourceFile>sample string 18</SourceFile>
    <StatusID>15</StatusID>
    <StatusName>sample string 16</StatusName>
    <UpdatedBy>23</UpdatedBy>
    <UpdatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:39:35.2923173Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </UpdatedDate>
    <VersionID>3</VersionID>
    <VersionNumber>sample string 9</VersionNumber>
    <CategoryID>1</CategoryID>
    <CategoryName>sample string 2</CategoryName>
  </docVersionDbEx>
  <docVersionDbEx>
    <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" />
    <ChangeNotes>sample string 11</ChangeNotes>
    <CreatedBy>21</CreatedBy>
    <CreatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:39:35.2923173Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </CreatedDate>
    <Description>sample string 10</Description>
    <DocumentID>4</DocumentID>
    <DocumentTitle>sample string 5</DocumentTitle>
    <ExpirationDate>2025-12-06T23:39:35.2923173+00:00</ExpirationDate>
    <IsLive>true</IsLive>
    <LanguageCode>sample string 12</LanguageCode>
    <LockedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:39:35.2923173Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </LockedDate>
    <MajorNum>6</MajorNum>
    <MinorNum>7</MinorNum>
    <OwnerID>13</OwnerID>
    <OwnerName>sample string 14</OwnerName>
    <PatchNum>8</PatchNum>
    <PublicationDate>2025-12-06T23:39:35.2923173+00:00</PublicationDate>
    <PublishedFile>sample string 19</PublishedFile>
    <SourceFile>sample string 18</SourceFile>
    <StatusID>15</StatusID>
    <StatusName>sample string 16</StatusName>
    <UpdatedBy>23</UpdatedBy>
    <UpdatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:39:35.2923173Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </UpdatedDate>
    <VersionID>3</VersionID>
    <VersionNumber>sample string 9</VersionNumber>
    <CategoryID>1</CategoryID>
    <CategoryName>sample string 2</CategoryName>
  </docVersionDbEx>
</ArrayOfdocVersionDbEx>