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

View Definitions

Get viewdefinitions

Returns a set of data items of type viewdefinitions.

Copy GET /api/news/viewdefinitions
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

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

Json

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2025-09-11T03:12:54.5493761Z",
    "PublicationDate": "2025-09-11T03:12:54.5493761Z",
    "DateCreated": "2025-09-11T03:12:54.5493761Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "Json": "sample string 8",
    "Name": "sample string 9",
    "Provider": "sample string 10",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2025-09-11T03:12:54.5493761+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  },
  {
    "LastModified": "2025-09-11T03:12:54.5493761Z",
    "PublicationDate": "2025-09-11T03:12:54.5493761Z",
    "DateCreated": "2025-09-11T03:12:54.5493761Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "Json": "sample string 8",
    "Name": "sample string 9",
    "Provider": "sample string 10",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2025-09-11T03:12:54.5493761+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  }
]

Get viewdefinitions by key

Gets viewdefinitions item by id.

Copy GET /api/news/viewdefinitions({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

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

Json

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2025-09-11T03:12:54.5493761Z",
  "PublicationDate": "2025-09-11T03:12:54.5493761Z",
  "DateCreated": "2025-09-11T03:12:54.5493761Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "UrlName": "sample string 6",
  "ItemDefaultUrl": "sample string 7",
  "Json": "sample string 8",
  "Name": "sample string 9",
  "Provider": "sample string 10",
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2025-09-11T03:12:54.5493761+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  }
}

Get property

Gets Id property from viewdefinitions item.

Copy GET /api/news/viewdefinitions({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": "c362899d-52dd-4ea4-a966-9026dfe103f4"
}

Post viewdefinitions

Creates a viewdefinitions item.

Copy POST /api/news/viewdefinitions
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

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

Json

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Request Formats
Copy
application/json
{
  "PublicationDate": "2025-09-11T03:12:54.5493761Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 3",
  "UrlName": "sample string 4",
  "Json": "sample string 5",
  "Name": "sample string 6"
}
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

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

Json

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2025-09-11T03:12:54.5493761Z",
  "PublicationDate": "2025-09-11T03:12:54.5493761Z",
  "DateCreated": "2025-09-11T03:12:54.5493761Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "UrlName": "sample string 6",
  "ItemDefaultUrl": "sample string 7",
  "Json": "sample string 8",
  "Name": "sample string 9",
  "Provider": "sample string 10",
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2025-09-11T03:12:54.5493761+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  }
}

Patch viewdefinitions by key

Partial update for viewdefinitions item.

Copy PATCH /api/news/viewdefinitions({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

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

Json

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Request Formats
Copy
application/json
{
  "PublicationDate": "2025-09-11T03:12:54.5493761Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 3",
  "UrlName": "sample string 4",
  "Json": "sample string 5",
  "Name": "sample string 6"
}
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 viewdefinitions by key

Full update for viewdefinitions item.

Copy PUT /api/news/viewdefinitions({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

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

Json

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Request Formats
Copy
application/json
{
  "PublicationDate": "2025-09-11T03:12:54.5493761Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 3",
  "UrlName": "sample string 4",
  "Json": "sample string 5",
  "Name": "sample string 6"
}
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 viewdefinitions by key

Deletes a viewdefinitions item by Id.

Copy DELETE /api/news/viewdefinitions({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.

Get Button

Returns a set of related items of type Button from viewdefinitions item.

Copy GET /api/news/viewdefinitions({key})/Button
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

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

Title

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2025-09-11T03:12:54.5493761Z",
    "PublicationDate": "2025-09-11T03:12:54.5493761Z",
    "DateCreated": "2025-09-11T03:12:54.5493761Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "Title": "sample string 8",
    "Provider": "sample string 9",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2025-09-11T03:12:54.5493761+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  },
  {
    "LastModified": "2025-09-11T03:12:54.5493761Z",
    "PublicationDate": "2025-09-11T03:12:54.5493761Z",
    "DateCreated": "2025-09-11T03:12:54.5493761Z",
    "IncludeInSitemap": true,
    "SystemSourceKey": "sample string 5",
    "UrlName": "sample string 6",
    "ItemDefaultUrl": "sample string 7",
    "Title": "sample string 8",
    "Provider": "sample string 9",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2025-09-11T03:12:54.5493761+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    }
  }
]

Get Button by relatedKey

Returns a related item of type Button from viewdefinitions item.

Copy GET /api/news/viewdefinitions({key})/Button({relatedKey})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

relatedKey

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

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

Title

System.String

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

Comments

Telerik.Sitefinity.Services.Comments.CommentContract

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2025-09-11T03:12:54.5493761Z",
  "PublicationDate": "2025-09-11T03:12:54.5493761Z",
  "DateCreated": "2025-09-11T03:12:54.5493761Z",
  "IncludeInSitemap": true,
  "SystemSourceKey": "sample string 5",
  "UrlName": "sample string 6",
  "ItemDefaultUrl": "sample string 7",
  "Title": "sample string 8",
  "Provider": "sample string 9",
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2025-09-11T03:12:54.5493761+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  }
}

Post Button

Add Button relation to viewdefinitions item.

Copy POST /api/news/viewdefinitions({key})/Button/$ref
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

None

Request Formats
Copy
application/json
{
  "@odata.id": "http://host/route/service/type(key)"
}
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 Button

Delete set of related items of type Button from viewdefinitions item.

Copy DELETE /api/news/viewdefinitions({key})/Button/$ref
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.

Delete Button by relatedKey

Delete relation of type Button from viewdefinitions item.

Copy DELETE /api/news/viewdefinitions({key})/Button({relatedKey})/$ref
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

relatedKey

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.