Returns a set of data items of type documents.
GET /api/news/documents
None
None
None.
Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
Name | Description | Type | Additional Information |
LastModified | System.DateTimeOffset | Read only: True | |
PublicationDate | System.DateTimeOffset | Read only: False | |
Title | System.String | Read only: False | |
Description | System.String | Read only: False | |
DateCreated | System.DateTimeOffset | Read only: True | |
IncludeInSitemap | System.Boolean | Read only: False | |
Ordinal | System.Single | Read only: False | |
UrlName | System.String | Read only: False | |
Author | System.String | Read only: False | |
Extension | System.String | Read only: True | |
MimeType | System.String | Read only: True | |
TotalSize | System.Int64 | Read only: True | |
Tags | System.Guid | Read only: False | |
Category | System.Guid | Read only: False | |
Parts | System.String | Read only: False | |
FolderId | System.Guid | Read only: False | |
ParentId | System.Guid | Read only: False | |
Provider | System.String | Read only: True | |
Url | System.String | Read only: True | |
ThumbnailUrl | System.String | Read only: True | |
Thumbnails | Telerik.Sitefinity.Modules.Libraries.Web.Services.Extensibility.ThumbnailModel | Read only: True |
application/json
[
{
"LastModified": "2025-06-27T08:52:11.3634928Z",
"PublicationDate": "2025-06-27T08:52:11.3634928Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-06-27T08:52:11.3634928Z",
"IncludeInSitemap": true,
"Ordinal": 7.1,
"UrlName": "sample string 8",
"Author": "sample string 9",
"Extension": "sample string 10",
"MimeType": "sample string 11",
"TotalSize": 12,
"Tags": "31ec6d5b-12ce-42b9-a1a8-871f7688237c",
"Category": "a12116b0-5aa5-4ae4-aa58-0ec7fb8b565f",
"Parts": "sample string 15",
"FolderId": "b313f52a-ac97-45dc-85a1-97d6be17e881",
"ParentId": "4f35fcb6-0194-4252-a597-8f4e22c4b4a3",
"Provider": "sample string 18",
"Url": "sample string 19",
"ThumbnailUrl": "sample string 20",
"Thumbnails": {
"Title": "sample string 1",
"Url": "sample string 2",
"Width": 3
}
},
{
"LastModified": "2025-06-27T08:52:11.3634928Z",
"PublicationDate": "2025-06-27T08:52:11.3634928Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-06-27T08:52:11.3634928Z",
"IncludeInSitemap": true,
"Ordinal": 7.1,
"UrlName": "sample string 8",
"Author": "sample string 9",
"Extension": "sample string 10",
"MimeType": "sample string 11",
"TotalSize": 12,
"Tags": "31ec6d5b-12ce-42b9-a1a8-871f7688237c",
"Category": "a12116b0-5aa5-4ae4-aa58-0ec7fb8b565f",
"Parts": "sample string 15",
"FolderId": "b313f52a-ac97-45dc-85a1-97d6be17e881",
"ParentId": "4f35fcb6-0194-4252-a597-8f4e22c4b4a3",
"Provider": "sample string 18",
"Url": "sample string 19",
"ThumbnailUrl": "sample string 20",
"Thumbnails": {
"Title": "sample string 1",
"Url": "sample string 2",
"Width": 3
}
}
]
Gets documents item by id.
GET /api/news/documents({key})
Name | Description | Type | Additional Information |
key | System.Guid | Required |
None
None.
Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
Name | Description | Type | Additional Information |
LastModified | System.DateTimeOffset | Read only: True | |
PublicationDate | System.DateTimeOffset | Read only: False | |
Title | System.String | Read only: False | |
Description | System.String | Read only: False | |
DateCreated | System.DateTimeOffset | Read only: True | |
IncludeInSitemap | System.Boolean | Read only: False | |
Ordinal | System.Single | Read only: False | |
UrlName | System.String | Read only: False | |
Author | System.String | Read only: False | |
Extension | System.String | Read only: True | |
MimeType | System.String | Read only: True | |
TotalSize | System.Int64 | Read only: True | |
Tags | System.Guid | Read only: False | |
Category | System.Guid | Read only: False | |
Parts | System.String | Read only: False | |
FolderId | System.Guid | Read only: False | |
ParentId | System.Guid | Read only: False | |
Provider | System.String | Read only: True | |
Url | System.String | Read only: True | |
ThumbnailUrl | System.String | Read only: True | |
Thumbnails | Telerik.Sitefinity.Modules.Libraries.Web.Services.Extensibility.ThumbnailModel | Read only: True |
application/json
{
"LastModified": "2025-06-27T08:52:11.3634928Z",
"PublicationDate": "2025-06-27T08:52:11.3634928Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-06-27T08:52:11.3634928Z",
"IncludeInSitemap": true,
"Ordinal": 7.1,
"UrlName": "sample string 8",
"Author": "sample string 9",
"Extension": "sample string 10",
"MimeType": "sample string 11",
"TotalSize": 12,
"Tags": "a6bb1188-6df4-4ce8-ab5c-4fdb01539326",
"Category": "86758a64-cc8e-4760-9864-c63ef65873cf",
"Parts": "sample string 15",
"FolderId": "40cf061e-a8bd-4559-8efd-155e0d8ba357",
"ParentId": "b9df5236-23a1-4234-903e-1ed881f19c77",
"Provider": "sample string 18",
"Url": "sample string 19",
"ThumbnailUrl": "sample string 20",
"Thumbnails": {
"Title": "sample string 1",
"Url": "sample string 2",
"Width": 3
}
}
Gets Id property from documents item.
GET /api/news/documents({key})/property
Name | Description | Type | Additional Information |
key | System.Guid | Required | |
property | System.String | Required |
None
None.
Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
Name | Description | Type | Additional Information |
Id | System.Guid | Read only: False |
application/json
{
"Id": "aa7d5dad-2dd2-4a7e-90f6-2a735b58babd"
}
Creates a documents item.
POST /api/news/documents
None
Name | Description | Type | Additional Information |
LastModified | System.DateTimeOffset | Read only: True | |
PublicationDate | System.DateTimeOffset | Read only: False | |
Title | System.String | Read only: False | |
Description | System.String | Read only: False | |
DateCreated | System.DateTimeOffset | Read only: True | |
IncludeInSitemap | System.Boolean | Read only: False | |
Ordinal | System.Single | Read only: False | |
UrlName | System.String | Read only: False | |
Author | System.String | Read only: False | |
Extension | System.String | Read only: True | |
MimeType | System.String | Read only: True | |
TotalSize | System.Int64 | Read only: True | |
Tags | System.Guid | Read only: False | |
Category | System.Guid | Read only: False | |
Parts | System.String | Read only: False | |
FolderId | System.Guid | Read only: False | |
ParentId | System.Guid | Read only: False | |
Provider | System.String | Read only: True | |
Url | System.String | Read only: True | |
ThumbnailUrl | System.String | Read only: True | |
Thumbnails | Telerik.Sitefinity.Modules.Libraries.Web.Services.Extensibility.ThumbnailModel | Read only: True |
application/json
{
"PublicationDate": "2025-06-27T08:52:11.3634928Z",
"Title": "sample string 2",
"Description": "sample string 3",
"IncludeInSitemap": true,
"Ordinal": 5.1,
"UrlName": "sample string 6",
"Author": "sample string 7",
"Tags": "83acf3ea-946d-4875-935c-eaa343bf2fef",
"Category": "f6106808-f35d-47c5-b9e3-52ba4d6bd1e7",
"Parts": "sample string 10",
"FolderId": "06ef9b60-e694-4087-92e2-11910bda9c35",
"ParentId": "7788a747-1ac7-4ec6-9bab-04bfe478587c"
}
Method can return success code: Created - 201 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
Name | Description | Type | Additional Information |
LastModified | System.DateTimeOffset | Read only: True | |
PublicationDate | System.DateTimeOffset | Read only: False | |
Title | System.String | Read only: False | |
Description | System.String | Read only: False | |
DateCreated | System.DateTimeOffset | Read only: True | |
IncludeInSitemap | System.Boolean | Read only: False | |
Ordinal | System.Single | Read only: False | |
UrlName | System.String | Read only: False | |
Author | System.String | Read only: False | |
Extension | System.String | Read only: True | |
MimeType | System.String | Read only: True | |
TotalSize | System.Int64 | Read only: True | |
Tags | System.Guid | Read only: False | |
Category | System.Guid | Read only: False | |
Parts | System.String | Read only: False | |
FolderId | System.Guid | Read only: False | |
ParentId | System.Guid | Read only: False | |
Provider | System.String | Read only: True | |
Url | System.String | Read only: True | |
ThumbnailUrl | System.String | Read only: True | |
Thumbnails | Telerik.Sitefinity.Modules.Libraries.Web.Services.Extensibility.ThumbnailModel | Read only: True |
application/json
{
"LastModified": "2025-06-27T08:52:11.3634928Z",
"PublicationDate": "2025-06-27T08:52:11.3634928Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-06-27T08:52:11.3634928Z",
"IncludeInSitemap": true,
"Ordinal": 7.1,
"UrlName": "sample string 8",
"Author": "sample string 9",
"Extension": "sample string 10",
"MimeType": "sample string 11",
"TotalSize": 12,
"Tags": "77f2a1c9-4464-4be1-bd2c-73e425ecdf7c",
"Category": "48d3e082-4354-49ac-9fa1-8f29bdd6eaca",
"Parts": "sample string 15",
"FolderId": "a8d76562-c42f-412b-845b-2f848176dd5f",
"ParentId": "9bf7c128-a85c-4492-ab61-f36ded36dcdc",
"Provider": "sample string 18",
"Url": "sample string 19",
"ThumbnailUrl": "sample string 20",
"Thumbnails": {
"Title": "sample string 1",
"Url": "sample string 2",
"Width": 3
}
}
Partial update for documents item.
PATCH /api/news/documents({key})
Name | Description | Type | Additional Information |
key | System.Guid | Required |
Name | Description | Type | Additional Information |
LastModified | System.DateTimeOffset | Read only: True | |
PublicationDate | System.DateTimeOffset | Read only: False | |
Title | System.String | Read only: False | |
Description | System.String | Read only: False | |
DateCreated | System.DateTimeOffset | Read only: True | |
IncludeInSitemap | System.Boolean | Read only: False | |
Ordinal | System.Single | Read only: False | |
UrlName | System.String | Read only: False | |
Author | System.String | Read only: False | |
Extension | System.String | Read only: True | |
MimeType | System.String | Read only: True | |
TotalSize | System.Int64 | Read only: True | |
Tags | System.Guid | Read only: False | |
Category | System.Guid | Read only: False | |
Parts | System.String | Read only: False | |
FolderId | System.Guid | Read only: False | |
ParentId | System.Guid | Read only: False | |
Provider | System.String | Read only: True | |
Url | System.String | Read only: True | |
ThumbnailUrl | System.String | Read only: True | |
Thumbnails | Telerik.Sitefinity.Modules.Libraries.Web.Services.Extensibility.ThumbnailModel | Read only: True |
application/json
{
"PublicationDate": "2025-06-27T08:52:11.3634928Z",
"Title": "sample string 2",
"Description": "sample string 3",
"IncludeInSitemap": true,
"Ordinal": 5.1,
"UrlName": "sample string 6",
"Author": "sample string 7",
"Tags": "7573227e-ddae-4767-a6a2-415b70db9f07",
"Category": "0e6454e4-78b2-4a6d-ac30-58f3df41b27f",
"Parts": "sample string 10",
"FolderId": "93f34420-fc34-427a-99ee-2005b492aa43",
"ParentId": "f871dee8-5b1d-4be7-81f7-e781612ce15d"
}
Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
None.
Full update for documents item.
PUT /api/news/documents({key})
Name | Description | Type | Additional Information |
key | System.Guid | Required |
Name | Description | Type | Additional Information |
LastModified | System.DateTimeOffset | Read only: True | |
PublicationDate | System.DateTimeOffset | Read only: False | |
Title | System.String | Read only: False | |
Description | System.String | Read only: False | |
DateCreated | System.DateTimeOffset | Read only: True | |
IncludeInSitemap | System.Boolean | Read only: False | |
Ordinal | System.Single | Read only: False | |
UrlName | System.String | Read only: False | |
Author | System.String | Read only: False | |
Extension | System.String | Read only: True | |
MimeType | System.String | Read only: True | |
TotalSize | System.Int64 | Read only: True | |
Tags | System.Guid | Read only: False | |
Category | System.Guid | Read only: False | |
Parts | System.String | Read only: False | |
FolderId | System.Guid | Read only: False | |
ParentId | System.Guid | Read only: False | |
Provider | System.String | Read only: True | |
Url | System.String | Read only: True | |
ThumbnailUrl | System.String | Read only: True | |
Thumbnails | Telerik.Sitefinity.Modules.Libraries.Web.Services.Extensibility.ThumbnailModel | Read only: True |
application/json
{
"PublicationDate": "2025-06-27T08:52:11.3634928Z",
"Title": "sample string 2",
"Description": "sample string 3",
"IncludeInSitemap": true,
"Ordinal": 5.1,
"UrlName": "sample string 6",
"Author": "sample string 7",
"Tags": "62baa886-4f44-47dd-982d-5a80d620cd0d",
"Category": "790a6b4e-1829-4206-9f14-2697a5be065c",
"Parts": "sample string 10",
"FolderId": "ae689938-739c-45ec-8930-d0af483213bd",
"ParentId": "90be9856-734d-4b86-a7e5-f141de0871a4"
}
Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
None.
Deletes a documents item by Id.
DELETE /api/news/documents({key})
Name | Description | Type | Additional Information |
key | System.Guid | Required |
None
None.
Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
None.
Returns a set of related items of type Parent from documents item.
GET /api/news/documents({key})/Parent
Name | Description | Type | Additional Information |
key | System.Guid | Required |
None
None.
Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
Name | Description | Type | Additional Information |
LastModified | System.DateTimeOffset | Read only: True | |
PublicationDate | System.DateTimeOffset | Read only: False | |
Title | System.String | Read only: False | |
Description | System.String | Read only: False | |
DateCreated | System.DateTimeOffset | Read only: True | |
IncludeInSitemap | System.Boolean | Read only: False | |
UrlName | System.String | Read only: False | |
MaxSize | System.Int64 | Read only: False | |
MaxItemSize | System.Int64 | Read only: False | |
BlobStorageProvider | System.String | Read only: False | |
OutputCacheProfile | System.String | Read only: False | |
ClientCacheProfile | System.String | Read only: False | |
CoverId | System.Guid | Read only: False | |
ThumbnailProfiles | System.String | Read only: False | |
ParentId | System.Guid | Read only: False | |
Provider | System.String | Read only: True | |
ChildrenCount | System.Int32 | Read only: True |
application/json
[
{
"LastModified": "2025-06-27T08:52:11.3634928Z",
"PublicationDate": "2025-06-27T08:52:11.3634928Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-06-27T08:52:11.3634928Z",
"IncludeInSitemap": true,
"UrlName": "sample string 7",
"MaxSize": 8,
"MaxItemSize": 9,
"BlobStorageProvider": "sample string 10",
"OutputCacheProfile": "sample string 11",
"ClientCacheProfile": "sample string 12",
"CoverId": "9c1b9676-bbd3-4614-b8b8-d6e16ba4e266",
"ThumbnailProfiles": "sample string 14",
"ParentId": "75ecf9bd-0666-43d7-be3a-aa48532bebc5",
"Provider": "sample string 16",
"ChildrenCount": 17
},
{
"LastModified": "2025-06-27T08:52:11.3634928Z",
"PublicationDate": "2025-06-27T08:52:11.3634928Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-06-27T08:52:11.3634928Z",
"IncludeInSitemap": true,
"UrlName": "sample string 7",
"MaxSize": 8,
"MaxItemSize": 9,
"BlobStorageProvider": "sample string 10",
"OutputCacheProfile": "sample string 11",
"ClientCacheProfile": "sample string 12",
"CoverId": "9c1b9676-bbd3-4614-b8b8-d6e16ba4e266",
"ThumbnailProfiles": "sample string 14",
"ParentId": "75ecf9bd-0666-43d7-be3a-aa48532bebc5",
"Provider": "sample string 16",
"ChildrenCount": 17
}
]
Add Parent relation to documents item.
POST /api/news/documents({key})/Parent/$ref
Name | Description | Type | Additional Information |
key | System.Guid | Required |
None
application/json
{
"@odata.id": "http://host/route/service/type(key)"
}
Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
None.
Delete set of related items of type Parent from documents item.
DELETE /api/news/documents({key})/Parent/$ref
Name | Description | Type | Additional Information |
key | System.Guid | Required |
None
None.
Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.
None.