Returns a set of data items of type documentlibraries.
GET /api/news/documentlibraries
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 | |
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": "2024-04-29T15:19:08.7304726Z",
"PublicationDate": "2024-04-29T15:19:08.7304726Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2024-04-29T15:19:08.7304726Z",
"IncludeInSitemap": true,
"UrlName": "sample string 7",
"MaxSize": 8,
"MaxItemSize": 9,
"BlobStorageProvider": "sample string 10",
"OutputCacheProfile": "sample string 11",
"ClientCacheProfile": "sample string 12",
"CoverId": "acd9dd27-bf3f-41d9-bc0d-2ec53a1e1d91",
"ThumbnailProfiles": "sample string 14",
"ParentId": "09c7ab07-8a9a-42fc-bce2-3882aeb8e029",
"Provider": "sample string 16",
"ChildrenCount": 17
},
{
"LastModified": "2024-04-29T15:19:08.7304726Z",
"PublicationDate": "2024-04-29T15:19:08.7304726Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2024-04-29T15:19:08.7304726Z",
"IncludeInSitemap": true,
"UrlName": "sample string 7",
"MaxSize": 8,
"MaxItemSize": 9,
"BlobStorageProvider": "sample string 10",
"OutputCacheProfile": "sample string 11",
"ClientCacheProfile": "sample string 12",
"CoverId": "acd9dd27-bf3f-41d9-bc0d-2ec53a1e1d91",
"ThumbnailProfiles": "sample string 14",
"ParentId": "09c7ab07-8a9a-42fc-bce2-3882aeb8e029",
"Provider": "sample string 16",
"ChildrenCount": 17
}
]
Gets documentlibraries item by id.
GET /api/news/documentlibraries({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 | |
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": "2024-04-29T15:19:08.7304726Z",
"PublicationDate": "2024-04-29T15:19:08.7304726Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2024-04-29T15:19:08.7304726Z",
"IncludeInSitemap": true,
"UrlName": "sample string 7",
"MaxSize": 8,
"MaxItemSize": 9,
"BlobStorageProvider": "sample string 10",
"OutputCacheProfile": "sample string 11",
"ClientCacheProfile": "sample string 12",
"CoverId": "887f1336-866e-4e47-a671-1525b60e9a50",
"ThumbnailProfiles": "sample string 14",
"ParentId": "bd788275-4445-4345-b556-b916f673cc0b",
"Provider": "sample string 16",
"ChildrenCount": 17
}
Gets Id property from documentlibraries item.
GET /api/news/documentlibraries({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": "dfc6cdce-92ba-42f4-bee8-abdda583e12b"
}
Creates a documentlibraries item.
POST /api/news/documentlibraries
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 | |
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
{
"PublicationDate": "2024-04-29T15:19:08.7304726Z",
"Title": "sample string 2",
"Description": "sample string 3",
"IncludeInSitemap": true,
"UrlName": "sample string 5",
"MaxSize": 6,
"MaxItemSize": 7,
"BlobStorageProvider": "sample string 8",
"OutputCacheProfile": "sample string 9",
"ClientCacheProfile": "sample string 10",
"CoverId": "79b7d875-aafc-4568-99c5-94eea85726bb",
"ThumbnailProfiles": "sample string 12",
"ParentId": "85a84890-4915-43dd-bd47-cfb7ffeff586"
}
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 | |
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": "2024-04-29T15:19:08.7304726Z",
"PublicationDate": "2024-04-29T15:19:08.7304726Z",
"Title": "sample string 3",
"Description": "sample string 4",
"DateCreated": "2024-04-29T15:19:08.7304726Z",
"IncludeInSitemap": true,
"UrlName": "sample string 7",
"MaxSize": 8,
"MaxItemSize": 9,
"BlobStorageProvider": "sample string 10",
"OutputCacheProfile": "sample string 11",
"ClientCacheProfile": "sample string 12",
"CoverId": "fb3d3765-609d-4328-86e4-15eebb105cdc",
"ThumbnailProfiles": "sample string 14",
"ParentId": "cb537161-a0ef-42b9-8556-4f94cbad5cba",
"Provider": "sample string 16",
"ChildrenCount": 17
}
Partial update for documentlibraries item.
PATCH /api/news/documentlibraries({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 | |
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
{
"PublicationDate": "2024-04-29T15:19:08.7304726Z",
"Title": "sample string 2",
"Description": "sample string 3",
"IncludeInSitemap": true,
"UrlName": "sample string 5",
"MaxSize": 6,
"MaxItemSize": 7,
"BlobStorageProvider": "sample string 8",
"OutputCacheProfile": "sample string 9",
"ClientCacheProfile": "sample string 10",
"CoverId": "4dc5b581-ea97-48b0-a063-469026cd1528",
"ThumbnailProfiles": "sample string 12",
"ParentId": "988418d7-c657-4b6a-b269-28d6ac896d9f"
}
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 documentlibraries item.
PUT /api/news/documentlibraries({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 | |
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
{
"PublicationDate": "2024-04-29T15:19:08.7304726Z",
"Title": "sample string 2",
"Description": "sample string 3",
"IncludeInSitemap": true,
"UrlName": "sample string 5",
"MaxSize": 6,
"MaxItemSize": 7,
"BlobStorageProvider": "sample string 8",
"OutputCacheProfile": "sample string 9",
"ClientCacheProfile": "sample string 10",
"CoverId": "ae16875b-b28d-4763-989e-9c8375e120df",
"ThumbnailProfiles": "sample string 12",
"ParentId": "a53bdfa0-4307-4e76-955f-724a27b3c340"
}
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 documentlibraries item by Id.
DELETE /api/news/documentlibraries({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.