GET api/sitedocuments

Retrieve all available site documents.

Request Information

URI Parameters

Name	Description	Type	Additional information
SiteId	Gets or sets the site ID.	integer	None.
Name	Gets or sets the Name.	string	Invalid Chars: \/:*?<>\|" Max length: 255
ContentType	Gets or sets the document content type.	string	Max length: 255
Size	Gets or sets the content size.	decimal number	None.
CreatedTime	Gets or sets the content creation time.	date	Read-only
ModifiedTime	Gets or sets the content modification time.	date	Read-only
FolderId	Gets or sets the folder id.	integer	None.
Description	Gets or sets the document description.	string	Max length: 1000
Links	Gets the links.	Collection of LinkModel	None.

Body Parameters

None.

Response Information

Resource Description

Collection of SiteDocumentViewModel

Name	Description	Type	Additional information
DocumentId	Gets or sets the identifier.	integer	Read-only
SiteId	Gets or sets the site ID.	integer	Required
Name	Gets or sets the Name.	string	Required Invalid Chars: \/:*?<>\|" Max length: 255
ContentType	Gets or sets the document content type.	string	Required Max length: 255
Size	Gets or sets the content size.	decimal number	None.
CreatedTime	Gets or sets the content creation time.	date	Read-only
ModifiedTime	Gets or sets the content modification time.	date	Read-only
FolderId	Gets or sets the folder id.	integer	None.
OwnerName	Gets the owner username.	string	Max length: 255 Read-only
Description	Gets or sets the document description.	string	Max length: 1000
GlobalId	Gets or sets the global identifier (a GUID). Can only set on create.	globally unique identifier	Read-only
Links	Gets the links.	Collection of LinkModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "documentId": 1,
    "siteId": 2,
    "name": "sample string 3",
    "contentType": "sample string 4",
    "size": 5.1,
    "createdTime": "2024-11-21T09:16:56.1364491+00:00",
    "modifiedTime": "2024-11-21T09:16:56.1364491+00:00",
    "folderId": 8,
    "ownerName": "sample string 10",
    "description": "sample string 11",
    "globalId": "6f46db9e-ae76-4216-9b9e-81e9c9a58a6d"
  },
  {
    "documentId": 1,
    "siteId": 2,
    "name": "sample string 3",
    "contentType": "sample string 4",
    "size": 5.1,
    "createdTime": "2024-11-21T09:16:56.1364491+00:00",
    "modifiedTime": "2024-11-21T09:16:56.1364491+00:00",
    "folderId": 8,
    "ownerName": "sample string 10",
    "description": "sample string 11",
    "globalId": "6f46db9e-ae76-4216-9b9e-81e9c9a58a6d"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSiteDocumentViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TelogWebAPI.Models">
  <SiteDocumentViewModel>
    <ContentType>sample string 4</ContentType>
    <CreatedTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-11-21T09:16:56.1364491Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </CreatedTime>
    <Description>sample string 11</Description>
    <DocumentId>1</DocumentId>
    <FolderId>8</FolderId>
    <GlobalId>6f46db9e-ae76-4216-9b9e-81e9c9a58a6d</GlobalId>
    <ModifiedTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-11-21T09:16:56.1364491Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </ModifiedTime>
    <Name>sample string 3</Name>
    <OwnerName>sample string 10</OwnerName>
    <SiteId>2</SiteId>
    <Size>5.1</Size>
  </SiteDocumentViewModel>
  <SiteDocumentViewModel>
    <ContentType>sample string 4</ContentType>
    <CreatedTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-11-21T09:16:56.1364491Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </CreatedTime>
    <Description>sample string 11</Description>
    <DocumentId>1</DocumentId>
    <FolderId>8</FolderId>
    <GlobalId>6f46db9e-ae76-4216-9b9e-81e9c9a58a6d</GlobalId>
    <ModifiedTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-11-21T09:16:56.1364491Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </ModifiedTime>
    <Name>sample string 3</Name>
    <OwnerName>sample string 10</OwnerName>
    <SiteId>2</SiteId>
    <Size>5.1</Size>
  </SiteDocumentViewModel>
</ArrayOfSiteDocumentViewModel>