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-05-30T17:17:49.4982391Z",
"PublicationDate": "2025-05-30T17:17:49.4982391Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-05-30T17:17:49.4982391Z",
"IncludeInSitemap": true,
"Ordinal": 7.1,
"UrlName": "sample string 8",
"Author": "sample string 9",
"Extension": "sample string 10",
"MimeType": "sample string 11",
"TotalSize": 12,
"Tags": "71b5796b-b3f8-40e8-bc93-f5721b01979f",
"Category": "09e55320-1cc4-4544-8f3c-65152ffb76f7",
"Parts": "sample string 15",
"FolderId": "e8ff76e7-34df-4e94-ba70-4f1fd12442af",
"ParentId": "fa706381-aeb0-46d7-9119-eb197715e2db",
"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-05-30T17:17:49.4982391Z",
"PublicationDate": "2025-05-30T17:17:49.4982391Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-05-30T17:17:49.4982391Z",
"IncludeInSitemap": true,
"Ordinal": 7.1,
"UrlName": "sample string 8",
"Author": "sample string 9",
"Extension": "sample string 10",
"MimeType": "sample string 11",
"TotalSize": 12,
"Tags": "71b5796b-b3f8-40e8-bc93-f5721b01979f",
"Category": "09e55320-1cc4-4544-8f3c-65152ffb76f7",
"Parts": "sample string 15",
"FolderId": "e8ff76e7-34df-4e94-ba70-4f1fd12442af",
"ParentId": "fa706381-aeb0-46d7-9119-eb197715e2db",
"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-05-30T17:17:49.4982391Z",
"PublicationDate": "2025-05-30T17:17:49.4982391Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-05-30T17:17:49.4982391Z",
"IncludeInSitemap": true,
"Ordinal": 7.1,
"UrlName": "sample string 8",
"Author": "sample string 9",
"Extension": "sample string 10",
"MimeType": "sample string 11",
"TotalSize": 12,
"Tags": "9191b5e6-a3d3-4779-bbed-17eeaf4ea543",
"Category": "09bfd148-51c2-4299-9a3d-743cca9a0a1a",
"Parts": "sample string 15",
"FolderId": "64ee198d-6810-4e14-8fe0-47377dbdc3e0",
"ParentId": "558892ec-48fe-4df5-b054-16516794ff5a",
"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": "cac27925-4e8c-4555-aa55-3732677c3df2"
}
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-05-30T17:17:49.4982391Z",
"Title": "sample string 2",
"Description": "sample string 3",
"IncludeInSitemap": true,
"Ordinal": 5.1,
"UrlName": "sample string 6",
"Author": "sample string 7",
"Tags": "b4e251ca-afdf-427e-a42c-3021198bec14",
"Category": "ac3f07c0-ad4e-4b49-89b4-3a7ed2fa42df",
"Parts": "sample string 10",
"FolderId": "c0f30bad-d471-4134-950b-98bd3b57f5be",
"ParentId": "11cc5cc5-6b43-466b-9533-e3e77f0e3d11"
}
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-05-30T17:17:49.4982391Z",
"PublicationDate": "2025-05-30T17:17:49.4982391Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-05-30T17:17:49.4982391Z",
"IncludeInSitemap": true,
"Ordinal": 7.1,
"UrlName": "sample string 8",
"Author": "sample string 9",
"Extension": "sample string 10",
"MimeType": "sample string 11",
"TotalSize": 12,
"Tags": "8bb0bcc5-d5da-4ab2-8f40-e8547e0bfdee",
"Category": "5a5b73c2-d74d-48eb-9c05-9e64c93ff86a",
"Parts": "sample string 15",
"FolderId": "ef7caf9c-aa4b-414f-b4a7-19ccbd7c6724",
"ParentId": "e5fd10a5-45dd-4a93-a0ce-3aae80dad457",
"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-05-30T17:17:49.4982391Z",
"Title": "sample string 2",
"Description": "sample string 3",
"IncludeInSitemap": true,
"Ordinal": 5.1,
"UrlName": "sample string 6",
"Author": "sample string 7",
"Tags": "b70cc41d-ac68-4021-b4e9-6afeca29b2b1",
"Category": "92047a85-48e9-4c7e-8b39-090b0f20c1f1",
"Parts": "sample string 10",
"FolderId": "b1f3f7b2-87fa-4fc7-8d3c-3f10272eb212",
"ParentId": "5a70fc5b-2788-4b1c-bfdd-df8218c5474d"
}
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-05-30T17:17:49.4982391Z",
"Title": "sample string 2",
"Description": "sample string 3",
"IncludeInSitemap": true,
"Ordinal": 5.1,
"UrlName": "sample string 6",
"Author": "sample string 7",
"Tags": "1f7cc9cc-0cf1-4b6f-81b6-b6b580566c46",
"Category": "d84dfbdc-2065-4bb0-875e-4d1675c2eb67",
"Parts": "sample string 10",
"FolderId": "4a048f5e-a0f6-4b7b-b35a-09c9f25aaf6b",
"ParentId": "cadad4bb-1cdf-4528-a24b-cca91cdfb731"
}
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-05-30T17:17:49.5138631Z",
"PublicationDate": "2025-05-30T17:17:49.5138631Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-05-30T17:17:49.5138631Z",
"IncludeInSitemap": true,
"UrlName": "sample string 7",
"MaxSize": 8,
"MaxItemSize": 9,
"BlobStorageProvider": "sample string 10",
"OutputCacheProfile": "sample string 11",
"ClientCacheProfile": "sample string 12",
"CoverId": "09663493-bb64-440e-b348-c3b5c5d3a732",
"ThumbnailProfiles": "sample string 14",
"ParentId": "19e6143d-23df-4165-a803-ce767368a2a7",
"Provider": "sample string 16",
"ChildrenCount": 17
},
{
"LastModified": "2025-05-30T17:17:49.5138631Z",
"PublicationDate": "2025-05-30T17:17:49.5138631Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2025-05-30T17:17:49.5138631Z",
"IncludeInSitemap": true,
"UrlName": "sample string 7",
"MaxSize": 8,
"MaxItemSize": 9,
"BlobStorageProvider": "sample string 10",
"OutputCacheProfile": "sample string 11",
"ClientCacheProfile": "sample string 12",
"CoverId": "09663493-bb64-440e-b348-c3b5c5d3a732",
"ThumbnailProfiles": "sample string 14",
"ParentId": "19e6143d-23df-4165-a803-ce767368a2a7",
"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.