RESTful API
media
media Default news World Immunization Week GHO multimedias hubs documents WHOReference emergencies newsroom ResultsReport IMR-sync

Libraries

Get documentlibraries

Returns a set of data items of type documentlibraries.

Copy GET /api/media/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
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

MaxSize

System.Int64

Read only: False
Selected by default: True

MaxItemSize

System.Int64

Read only: False
Selected by default: True

BlobStorageProvider

System.String

Read only: False
Selected by default: True

OutputCacheProfile

System.String

Read only: False
Selected by default: True

ClientCacheProfile

System.String

Read only: False
Selected by default: True

ExcludeFromSiteSearch

System.Boolean

Read only: False
Selected by default: True

CoverId

System.Guid

Read only: False
Selected by default: True

ThumbnailProfiles

System.String

Read only: False
Selected by default: False

AllowComments

System.Boolean

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: False

Provider

System.String

Read only: True
Selected by default: True

ChildrenCount

System.Int32

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Breadcrumb

Telerik.Sitefinity.Web.Services.Extensibility.BreadcrumbItem

Read only: True
Selected by default: True

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2026-06-29T06:26:22.1333248Z",
    "PublicationDate": "2026-06-29T06:26:22.1333248Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-06-29T06:26:22.1333248Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 7",
    "UrlName": "sample string 8",
    "ItemDefaultUrl": "sample string 9",
    "MaxSize": 10,
    "MaxItemSize": 11,
    "BlobStorageProvider": "sample string 12",
    "OutputCacheProfile": "sample string 13",
    "ClientCacheProfile": "sample string 14",
    "ExcludeFromSiteSearch": true,
    "CoverId": "eae67567-ee1a-4fc4-9fe2-8f040d1d844f",
    "ThumbnailProfiles": "sample string 17",
    "AllowComments": true,
    "ParentId": "c54fff14-c0e3-4899-9d0d-6f36d466d546",
    "Provider": "sample string 20",
    "ChildrenCount": 21,
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-06-29T06:26:22.1333248+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    },
    "Breadcrumb": null
  },
  {
    "LastModified": "2026-06-29T06:26:22.1333248Z",
    "PublicationDate": "2026-06-29T06:26:22.1333248Z",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "DateCreated": "2026-06-29T06:26:22.1333248Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 7",
    "UrlName": "sample string 8",
    "ItemDefaultUrl": "sample string 9",
    "MaxSize": 10,
    "MaxItemSize": 11,
    "BlobStorageProvider": "sample string 12",
    "OutputCacheProfile": "sample string 13",
    "ClientCacheProfile": "sample string 14",
    "ExcludeFromSiteSearch": true,
    "CoverId": "eae67567-ee1a-4fc4-9fe2-8f040d1d844f",
    "ThumbnailProfiles": "sample string 17",
    "AllowComments": true,
    "ParentId": "c54fff14-c0e3-4899-9d0d-6f36d466d546",
    "Provider": "sample string 20",
    "ChildrenCount": 21,
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2026-06-29T06:26:22.1333248+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    },
    "Breadcrumb": null
  }
]

Get documentlibraries by key

Gets documentlibraries item by id.

Copy GET /api/media/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
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

MaxSize

System.Int64

Read only: False
Selected by default: True

MaxItemSize

System.Int64

Read only: False
Selected by default: True

BlobStorageProvider

System.String

Read only: False
Selected by default: True

OutputCacheProfile

System.String

Read only: False
Selected by default: True

ClientCacheProfile

System.String

Read only: False
Selected by default: True

ExcludeFromSiteSearch

System.Boolean

Read only: False
Selected by default: True

CoverId

System.Guid

Read only: False
Selected by default: True

ThumbnailProfiles

System.String

Read only: False
Selected by default: False

AllowComments

System.Boolean

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: False

Provider

System.String

Read only: True
Selected by default: True

ChildrenCount

System.Int32

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Breadcrumb

Telerik.Sitefinity.Web.Services.Extensibility.BreadcrumbItem

Read only: True
Selected by default: True

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-06-29T06:26:22.1333248Z",
  "PublicationDate": "2026-06-29T06:26:22.1333248Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2026-06-29T06:26:22.1333248Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 7",
  "UrlName": "sample string 8",
  "ItemDefaultUrl": "sample string 9",
  "MaxSize": 10,
  "MaxItemSize": 11,
  "BlobStorageProvider": "sample string 12",
  "OutputCacheProfile": "sample string 13",
  "ClientCacheProfile": "sample string 14",
  "ExcludeFromSiteSearch": true,
  "CoverId": "3d6271ef-651a-42e3-8950-d0c199daf413",
  "ThumbnailProfiles": "sample string 17",
  "AllowComments": true,
  "ParentId": "e86540c5-e338-4e35-b0fc-af1d759d3b34",
  "Provider": "sample string 20",
  "ChildrenCount": 21,
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2026-06-29T06:26:22.1333248+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  },
  "Breadcrumb": null
}

Get property

Gets Id property from documentlibraries item.

Copy GET /api/media/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": "806bb509-a6dc-4263-af2f-89e68333bbd9"
}

Post documentlibraries

Creates a documentlibraries item.

Copy POST /api/media/documentlibraries
Request Informaion

URI Parameters

None

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

MaxSize

System.Int64

Read only: False
Selected by default: True

MaxItemSize

System.Int64

Read only: False
Selected by default: True

BlobStorageProvider

System.String

Read only: False
Selected by default: True

OutputCacheProfile

System.String

Read only: False
Selected by default: True

ClientCacheProfile

System.String

Read only: False
Selected by default: True

ExcludeFromSiteSearch

System.Boolean

Read only: False
Selected by default: True

CoverId

System.Guid

Read only: False
Selected by default: True

ThumbnailProfiles

System.String

Read only: False
Selected by default: False

AllowComments

System.Boolean

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: False

Provider

System.String

Read only: True
Selected by default: True

ChildrenCount

System.Int32

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Breadcrumb

Telerik.Sitefinity.Web.Services.Extensibility.BreadcrumbItem

Read only: True
Selected by default: True

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-06-29T06:26:22.1333248Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "UrlName": "sample string 6",
  "MaxSize": 7,
  "MaxItemSize": 8,
  "BlobStorageProvider": "sample string 9",
  "OutputCacheProfile": "sample string 10",
  "ClientCacheProfile": "sample string 11",
  "ExcludeFromSiteSearch": true,
  "CoverId": "497ebc5f-a1e3-4fb8-a253-f82df6d9290c",
  "ThumbnailProfiles": "sample string 14",
  "AllowComments": true,
  "ParentId": "5c159cae-5ee2-45ed-8638-c5580c19e0b6"
}
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
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

MaxSize

System.Int64

Read only: False
Selected by default: True

MaxItemSize

System.Int64

Read only: False
Selected by default: True

BlobStorageProvider

System.String

Read only: False
Selected by default: True

OutputCacheProfile

System.String

Read only: False
Selected by default: True

ClientCacheProfile

System.String

Read only: False
Selected by default: True

ExcludeFromSiteSearch

System.Boolean

Read only: False
Selected by default: True

CoverId

System.Guid

Read only: False
Selected by default: True

ThumbnailProfiles

System.String

Read only: False
Selected by default: False

AllowComments

System.Boolean

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: False

Provider

System.String

Read only: True
Selected by default: True

ChildrenCount

System.Int32

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Breadcrumb

Telerik.Sitefinity.Web.Services.Extensibility.BreadcrumbItem

Read only: True
Selected by default: True

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2026-06-29T06:26:22.1333248Z",
  "PublicationDate": "2026-06-29T06:26:22.1333248Z",
  "Title": "sample string 3",
  "Description": "sample string 4",
  "DateCreated": "2026-06-29T06:26:22.1333248Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 7",
  "UrlName": "sample string 8",
  "ItemDefaultUrl": "sample string 9",
  "MaxSize": 10,
  "MaxItemSize": 11,
  "BlobStorageProvider": "sample string 12",
  "OutputCacheProfile": "sample string 13",
  "ClientCacheProfile": "sample string 14",
  "ExcludeFromSiteSearch": true,
  "CoverId": "ad21d10a-5f20-47f0-96ee-0464c42b5efd",
  "ThumbnailProfiles": "sample string 17",
  "AllowComments": true,
  "ParentId": "211045a2-75ee-49db-9d0e-74bfe91e871c",
  "Provider": "sample string 20",
  "ChildrenCount": 21,
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2026-06-29T06:26:22.1333248+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  },
  "Breadcrumb": null
}

Patch documentlibraries by key

Partial update for documentlibraries item.

Copy PATCH /api/media/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
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

MaxSize

System.Int64

Read only: False
Selected by default: True

MaxItemSize

System.Int64

Read only: False
Selected by default: True

BlobStorageProvider

System.String

Read only: False
Selected by default: True

OutputCacheProfile

System.String

Read only: False
Selected by default: True

ClientCacheProfile

System.String

Read only: False
Selected by default: True

ExcludeFromSiteSearch

System.Boolean

Read only: False
Selected by default: True

CoverId

System.Guid

Read only: False
Selected by default: True

ThumbnailProfiles

System.String

Read only: False
Selected by default: False

AllowComments

System.Boolean

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: False

Provider

System.String

Read only: True
Selected by default: True

ChildrenCount

System.Int32

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Breadcrumb

Telerik.Sitefinity.Web.Services.Extensibility.BreadcrumbItem

Read only: True
Selected by default: True

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-06-29T06:26:22.1333248Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "UrlName": "sample string 6",
  "MaxSize": 7,
  "MaxItemSize": 8,
  "BlobStorageProvider": "sample string 9",
  "OutputCacheProfile": "sample string 10",
  "ClientCacheProfile": "sample string 11",
  "ExcludeFromSiteSearch": true,
  "CoverId": "48cc5099-fb90-4505-8e08-60ecca61e899",
  "ThumbnailProfiles": "sample string 14",
  "AllowComments": true,
  "ParentId": "b880a6a8-702c-44ba-860d-03dcf99d2d29"
}
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/media/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
Selected by default: True

PublicationDate

System.DateTimeOffset

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

DateCreated

System.DateTimeOffset

Read only: True
Selected by default: True

IncludeInSitemap

System.Boolean

Read only: False
Selected by default: True

SystemSourceKey

System.String

Read only: False
Selected by default: True

UrlName

System.String

Read only: False
Selected by default: True

ItemDefaultUrl

System.String

Read only: True
Selected by default: True

MaxSize

System.Int64

Read only: False
Selected by default: True

MaxItemSize

System.Int64

Read only: False
Selected by default: True

BlobStorageProvider

System.String

Read only: False
Selected by default: True

OutputCacheProfile

System.String

Read only: False
Selected by default: True

ClientCacheProfile

System.String

Read only: False
Selected by default: True

ExcludeFromSiteSearch

System.Boolean

Read only: False
Selected by default: True

CoverId

System.Guid

Read only: False
Selected by default: True

ThumbnailProfiles

System.String

Read only: False
Selected by default: False

AllowComments

System.Boolean

Read only: False
Selected by default: True

ParentId

System.Guid

Read only: False
Selected by default: False

Provider

System.String

Read only: True
Selected by default: True

ChildrenCount

System.Int32

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Breadcrumb

Telerik.Sitefinity.Web.Services.Extensibility.BreadcrumbItem

Read only: True
Selected by default: True

Request Formats
Copy
application/json
{
  "PublicationDate": "2026-06-29T06:26:22.1333248Z",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "UrlName": "sample string 6",
  "MaxSize": 7,
  "MaxItemSize": 8,
  "BlobStorageProvider": "sample string 9",
  "OutputCacheProfile": "sample string 10",
  "ClientCacheProfile": "sample string 11",
  "ExcludeFromSiteSearch": true,
  "CoverId": "061379fa-0aef-4214-a520-119f35b012dd",
  "ThumbnailProfiles": "sample string 14",
  "AllowComments": true,
  "ParentId": "748acfb8-5b28-4a1f-90a0-34a5fdf296e8"
}
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/media/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.