RESTful API

Get documentlibraries

Returns a set of data items of type documentlibraries.

Copy


                                        GET /api/news/documentlibraries

Request Informaion

URI Parameters

None

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

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

Resource Format

Response Formats

Copy


                                                                    application/json
                                                                    [
  {
    "LastModified": "2025-05-01T05:56:23.8519887Z",
    "PublicationDate": "2025-05-01T05:56:23.8519887Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2025-05-01T05:56:23.8519887Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 7",
    "MaxSize": 8,
    "MaxItemSize": 9,
    "BlobStorageProvider": "sample string 10",
    "OutputCacheProfile": "sample string 11",
    "ClientCacheProfile": "sample string 12",
    "CoverId": "47554ecc-0114-43eb-b153-5b2c6ad76722",
    "ThumbnailProfiles": "sample string 14",
    "ParentId": "6069fe31-d5f8-434f-9b0f-b2bfbaf9420e",
    "Provider": "sample string 16",
    "ChildrenCount": 17
  },
  {
    "LastModified": "2025-05-01T05:56:23.8519887Z",
    "PublicationDate": "2025-05-01T05:56:23.8519887Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2025-05-01T05:56:23.8519887Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 7",
    "MaxSize": 8,
    "MaxItemSize": 9,
    "BlobStorageProvider": "sample string 10",
    "OutputCacheProfile": "sample string 11",
    "ClientCacheProfile": "sample string 12",
    "CoverId": "47554ecc-0114-43eb-b153-5b2c6ad76722",
    "ThumbnailProfiles": "sample string 14",
    "ParentId": "6069fe31-d5f8-434f-9b0f-b2bfbaf9420e",
    "Provider": "sample string 16",
    "ChildrenCount": 17
  }
]

Get documentlibraries by key

Gets documentlibraries item by id.

Copy


                                        GET /api/news/documentlibraries({key})

Request Informaion

URI Parameters

Name	Description	Type	Additional Information
key		System.Guid	Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

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

Resource Format

Response Formats

Copy


                                                                    application/json
                                                                    {
  "LastModified": "2025-05-01T05:56:23.8519887Z",
  "PublicationDate": "2025-05-01T05:56:23.8519887Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2025-05-01T05:56:23.8519887Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 7",
  "MaxSize": 8,
  "MaxItemSize": 9,
  "BlobStorageProvider": "sample string 10",
  "OutputCacheProfile": "sample string 11",
  "ClientCacheProfile": "sample string 12",
  "CoverId": "aa43a118-3426-4c50-aba5-52fa4d5a8d6f",
  "ThumbnailProfiles": "sample string 14",
  "ParentId": "7275b2e0-411f-4baa-9cef-90abeea81379",
  "Provider": "sample string 16",
  "ChildrenCount": 17
}

Get property

Gets Id property from documentlibraries item.

Copy


                                        GET /api/news/documentlibraries({key})/property

Request Informaion

URI Parameters

Name	Description	Type	Additional Information
key		System.Guid	Required
property		System.String	Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

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

Resource Format

Response Formats

Copy


                                                                    application/json
                                                                    {
  "Id": "547d9fd6-0c5b-4b9b-a85b-a0e890320ff8"
}

Post documentlibraries

Creates a documentlibraries item.

Copy


                                        POST /api/news/documentlibraries

Request Informaion

URI Parameters

None

Body Parameters

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

Request Formats

Copy


                                                                    application/json
                                                                    {
  "PublicationDate": "2025-05-01T05:56:23.8519887Z",
  "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": "63433c30-afbb-4ec2-a25f-5c1ca714ba9a",
  "ThumbnailProfiles": "sample string 12",
  "ParentId": "5d1c4f3a-e9bf-48c8-a0da-8fe02ec36d43"
}

Response Informaion

Resource Description

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

Resource Format

Response Formats

Copy


                                                                    application/json
                                                                    {
  "LastModified": "2025-05-01T05:56:23.8519887Z",
  "PublicationDate": "2025-05-01T05:56:23.8519887Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2025-05-01T05:56:23.8519887Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 7",
  "MaxSize": 8,
  "MaxItemSize": 9,
  "BlobStorageProvider": "sample string 10",
  "OutputCacheProfile": "sample string 11",
  "ClientCacheProfile": "sample string 12",
  "CoverId": "a419b26c-35d6-49f6-8d99-e293a207dbd7",
  "ThumbnailProfiles": "sample string 14",
  "ParentId": "0d4ba596-99a4-426c-b7f1-c23b9a9d818d",
  "Provider": "sample string 16",
  "ChildrenCount": 17
}

Patch documentlibraries by key

Partial update for documentlibraries item.

Copy


                                        PATCH /api/news/documentlibraries({key})

Request Informaion

URI Parameters

Name	Description	Type	Additional Information
key		System.Guid	Required

Body Parameters

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

Request Formats

Copy


                                                                    application/json
                                                                    {
  "PublicationDate": "2025-05-01T05:56:23.8519887Z",
  "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": "8dfa0408-2a2a-403b-bcf1-694f92a091e7",
  "ThumbnailProfiles": "sample string 12",
  "ParentId": "ffd16b57-3e47-4df3-bc13-7bc199e1fce1"
}

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Put documentlibraries by key

Full update for documentlibraries item.

Copy


                                        PUT /api/news/documentlibraries({key})

Request Informaion

URI Parameters

Name	Description	Type	Additional Information
key		System.Guid	Required

Body Parameters

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

Request Formats

Copy


                                                                    application/json
                                                                    {
  "PublicationDate": "2025-05-01T05:56:23.8519887Z",
  "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": "ba43ca21-41b5-49d2-ac58-4a3a0b6236af",
  "ThumbnailProfiles": "sample string 12",
  "ParentId": "f889ceaf-82d1-4bb8-9241-ca7767a671c3"
}

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Delete documentlibraries by key

Deletes a documentlibraries item by Id.

Copy


                                        DELETE /api/news/documentlibraries({key})

Request Informaion

URI Parameters

Name	Description	Type	Additional Information
key		System.Guid	Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

RESTful API

Libraries

Get documentlibraries

Request Informaion

URI Parameters

Body Parameters

Request Formats

Response Informaion

Resource Description

Resource Format

Response Formats

application/json

Get documentlibraries by key

Request Informaion

URI Parameters

Body Parameters

Request Formats

Response Informaion

Resource Description

Resource Format

Response Formats

application/json

Get property

Request Informaion

URI Parameters

Body Parameters

Request Formats

Response Informaion

Resource Description

Resource Format

Response Formats

application/json

Post documentlibraries

Request Informaion

URI Parameters

Body Parameters

Request Formats

application/json

Response Informaion

Resource Description

Resource Format

Response Formats

application/json

Patch documentlibraries by key

Request Informaion

URI Parameters

Body Parameters

Request Formats

application/json

Response Informaion

Resource Description

Resource Format

Response Formats

Put documentlibraries by key

Request Informaion

URI Parameters

Body Parameters

Request Formats

application/json

Response Informaion

Resource Description

Resource Format

Response Formats

Delete documentlibraries by key

Request Informaion

URI Parameters

Body Parameters

Request Formats

Response Informaion

Resource Description

Resource Format

Response Formats