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

Forms

Get form-drafts

Returns a set of data items of type form-drafts.

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

Rules

Telerik.Sitefinity.Modules.Forms.Web.Services.Operations.FormRule

Read only: False
Selected by default: True

SuccessMessage

System.String

Read only: False
Selected by default: True

Renderer

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: True
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

Fields

Telerik.Sitefinity.Web.Services.Extensibility.FormField

Read only: True
Selected by default: True

Title

System.String

Read only: True
Selected by default: True

AvailableActions

Telerik.Sitefinity.Web.Services.Extensibility.AvailableAction

Read only: True
Selected by default: True

Steps

Telerik.Sitefinity.Web.Services.Extensibility.Step

Read only: True
Selected by default: True

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2025-10-26T15:40:50.6445155Z",
    "Rules": {
      "Operator": "And",
      "Conditions": [],
      "Actions": []
    },
    "SuccessMessage": "sample string 2",
    "Renderer": "sample string 3",
    "Name": "sample string 4",
    "Provider": "sample string 5",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2025-10-26T15:40:50.6445155+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    },
    "Fields": null,
    "Title": "sample string 6",
    "AvailableActions": null,
    "Steps": null
  },
  {
    "LastModified": "2025-10-26T15:40:50.6445155Z",
    "Rules": {
      "Operator": "And",
      "Conditions": [],
      "Actions": []
    },
    "SuccessMessage": "sample string 2",
    "Renderer": "sample string 3",
    "Name": "sample string 4",
    "Provider": "sample string 5",
    "Comments": {
      "Name": "sample string 1",
      "Message": "sample string 2",
      "DateCreated": "2025-10-26T15:40:50.6445155+00:00",
      "ProfilePictureUrl": "sample string 4",
      "ProfilePictureThumbnailUrl": "sample string 5"
    },
    "Fields": null,
    "Title": "sample string 6",
    "AvailableActions": null,
    "Steps": null
  }
]

Get form-drafts by key

Gets form-drafts item by id.

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

Rules

Telerik.Sitefinity.Modules.Forms.Web.Services.Operations.FormRule

Read only: False
Selected by default: True

SuccessMessage

System.String

Read only: False
Selected by default: True

Renderer

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: True
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

Fields

Telerik.Sitefinity.Web.Services.Extensibility.FormField

Read only: True
Selected by default: True

Title

System.String

Read only: True
Selected by default: True

AvailableActions

Telerik.Sitefinity.Web.Services.Extensibility.AvailableAction

Read only: True
Selected by default: True

Steps

Telerik.Sitefinity.Web.Services.Extensibility.Step

Read only: True
Selected by default: True

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2025-10-26T15:40:50.6445155Z",
  "Rules": {
    "Operator": "And",
    "Conditions": [],
    "Actions": []
  },
  "SuccessMessage": "sample string 2",
  "Renderer": "sample string 3",
  "Name": "sample string 4",
  "Provider": "sample string 5",
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2025-10-26T15:40:50.6445155+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  },
  "Fields": null,
  "Title": "sample string 6",
  "AvailableActions": null,
  "Steps": null
}

Get property

Gets Id property from form-drafts item.

Copy GET /api/news/form-drafts({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": "4e2454c7-8942-410a-bd7a-3d9db8b3a258"
}

Post form-drafts

Creates a form-drafts item.

Copy POST /api/news/form-drafts
Request Informaion

URI Parameters

None

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

Rules

Telerik.Sitefinity.Modules.Forms.Web.Services.Operations.FormRule

Read only: False
Selected by default: True

SuccessMessage

System.String

Read only: False
Selected by default: True

Renderer

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: True
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

Fields

Telerik.Sitefinity.Web.Services.Extensibility.FormField

Read only: True
Selected by default: True

Title

System.String

Read only: True
Selected by default: True

AvailableActions

Telerik.Sitefinity.Web.Services.Extensibility.AvailableAction

Read only: True
Selected by default: True

Steps

Telerik.Sitefinity.Web.Services.Extensibility.Step

Read only: True
Selected by default: True

Request Formats
Copy
application/json
{
  "Rules": {
    "Operator": "And",
    "Conditions": [],
    "Actions": []
  },
  "SuccessMessage": "sample string 1",
  "Renderer": "sample string 2"
}
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

Rules

Telerik.Sitefinity.Modules.Forms.Web.Services.Operations.FormRule

Read only: False
Selected by default: True

SuccessMessage

System.String

Read only: False
Selected by default: True

Renderer

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: True
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

Fields

Telerik.Sitefinity.Web.Services.Extensibility.FormField

Read only: True
Selected by default: True

Title

System.String

Read only: True
Selected by default: True

AvailableActions

Telerik.Sitefinity.Web.Services.Extensibility.AvailableAction

Read only: True
Selected by default: True

Steps

Telerik.Sitefinity.Web.Services.Extensibility.Step

Read only: True
Selected by default: True

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2025-10-26T15:40:50.6445155Z",
  "Rules": {
    "Operator": "And",
    "Conditions": [],
    "Actions": []
  },
  "SuccessMessage": "sample string 2",
  "Renderer": "sample string 3",
  "Name": "sample string 4",
  "Provider": "sample string 5",
  "Comments": {
    "Name": "sample string 1",
    "Message": "sample string 2",
    "DateCreated": "2025-10-26T15:40:50.6445155+00:00",
    "ProfilePictureUrl": "sample string 4",
    "ProfilePictureThumbnailUrl": "sample string 5"
  },
  "Fields": null,
  "Title": "sample string 6",
  "AvailableActions": null,
  "Steps": null
}

Patch form-drafts by key

Partial update for form-drafts item.

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

Rules

Telerik.Sitefinity.Modules.Forms.Web.Services.Operations.FormRule

Read only: False
Selected by default: True

SuccessMessage

System.String

Read only: False
Selected by default: True

Renderer

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: True
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

Fields

Telerik.Sitefinity.Web.Services.Extensibility.FormField

Read only: True
Selected by default: True

Title

System.String

Read only: True
Selected by default: True

AvailableActions

Telerik.Sitefinity.Web.Services.Extensibility.AvailableAction

Read only: True
Selected by default: True

Steps

Telerik.Sitefinity.Web.Services.Extensibility.Step

Read only: True
Selected by default: True

Request Formats
Copy
application/json
{
  "Rules": {
    "Operator": "And",
    "Conditions": [],
    "Actions": []
  },
  "SuccessMessage": "sample string 1",
  "Renderer": "sample string 2"
}
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 form-drafts by key

Full update for form-drafts item.

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

Rules

Telerik.Sitefinity.Modules.Forms.Web.Services.Operations.FormRule

Read only: False
Selected by default: True

SuccessMessage

System.String

Read only: False
Selected by default: True

Renderer

System.String

Read only: False
Selected by default: True

Name

System.String

Read only: True
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

Fields

Telerik.Sitefinity.Web.Services.Extensibility.FormField

Read only: True
Selected by default: True

Title

System.String

Read only: True
Selected by default: True

AvailableActions

Telerik.Sitefinity.Web.Services.Extensibility.AvailableAction

Read only: True
Selected by default: True

Steps

Telerik.Sitefinity.Web.Services.Extensibility.Step

Read only: True
Selected by default: True

Request Formats
Copy
application/json
{
  "Rules": {
    "Operator": "And",
    "Conditions": [],
    "Actions": []
  },
  "SuccessMessage": "sample string 1",
  "Renderer": "sample string 2"
}
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 form-drafts by key

Deletes a form-drafts item by Id.

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