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

Content types

Get pipe-settings

Returns a set of data items of type pipe-settings.

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

IsInbound

System.Boolean

Read only: False
Selected by default: True

PipeName

System.String

Read only: False
Selected by default: True

UIName

System.String

Read only: False
Selected by default: True

ResourceClassId

System.String

Read only: False
Selected by default: True

FilterExpression

System.String

Read only: False
Selected by default: True

MaxItems

System.Int32

Read only: False
Selected by default: True

IsActive

System.Boolean

Read only: False
Selected by default: True

InvocationMode

Telerik.Sitefinity.Publishing.Model.PipeInvokationMode

Read only: False
Selected by default: True

ApplicationName

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

ScheduleType

System.Int32

Read only: False
Selected by default: True

ScheduleDay

System.Int32

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

ContentName

System.String

Read only: True
Selected by default: True

Breadcrumb

System.String

Read only: True
Selected by default: True

Resource Format

Response Formats
Copy
application/json
[
  {
    "LastModified": "2025-09-12T09:00:55.1231589Z",
    "IsInbound": true,
    "PipeName": "sample string 3",
    "UIName": "sample string 4",
    "ResourceClassId": "sample string 5",
    "FilterExpression": "sample string 6",
    "MaxItems": 7,
    "IsActive": true,
    "InvocationMode": 0,
    "ApplicationName": "sample string 9",
    "Description": "sample string 10",
    "Title": "sample string 11",
    "ScheduleType": 12,
    "ScheduleDay": 13,
    "Provider": "sample string 14",
    "ContentName": "sample string 15",
    "Breadcrumb": "sample string 16"
  },
  {
    "LastModified": "2025-09-12T09:00:55.1231589Z",
    "IsInbound": true,
    "PipeName": "sample string 3",
    "UIName": "sample string 4",
    "ResourceClassId": "sample string 5",
    "FilterExpression": "sample string 6",
    "MaxItems": 7,
    "IsActive": true,
    "InvocationMode": 0,
    "ApplicationName": "sample string 9",
    "Description": "sample string 10",
    "Title": "sample string 11",
    "ScheduleType": 12,
    "ScheduleDay": 13,
    "Provider": "sample string 14",
    "ContentName": "sample string 15",
    "Breadcrumb": "sample string 16"
  }
]

Get pipe-settings by key

Gets pipe-settings item by id.

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

IsInbound

System.Boolean

Read only: False
Selected by default: True

PipeName

System.String

Read only: False
Selected by default: True

UIName

System.String

Read only: False
Selected by default: True

ResourceClassId

System.String

Read only: False
Selected by default: True

FilterExpression

System.String

Read only: False
Selected by default: True

MaxItems

System.Int32

Read only: False
Selected by default: True

IsActive

System.Boolean

Read only: False
Selected by default: True

InvocationMode

Telerik.Sitefinity.Publishing.Model.PipeInvokationMode

Read only: False
Selected by default: True

ApplicationName

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

ScheduleType

System.Int32

Read only: False
Selected by default: True

ScheduleDay

System.Int32

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

ContentName

System.String

Read only: True
Selected by default: True

Breadcrumb

System.String

Read only: True
Selected by default: True

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2025-09-12T09:00:55.1231589Z",
  "IsInbound": true,
  "PipeName": "sample string 3",
  "UIName": "sample string 4",
  "ResourceClassId": "sample string 5",
  "FilterExpression": "sample string 6",
  "MaxItems": 7,
  "IsActive": true,
  "InvocationMode": 0,
  "ApplicationName": "sample string 9",
  "Description": "sample string 10",
  "Title": "sample string 11",
  "ScheduleType": 12,
  "ScheduleDay": 13,
  "Provider": "sample string 14",
  "ContentName": "sample string 15",
  "Breadcrumb": "sample string 16"
}

Get property

Gets Id property from pipe-settings item.

Copy GET /api/news/pipe-settings({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": "71b8e31c-2be2-4cfe-9687-396e9845c8fa"
}

Post pipe-settings

Creates a pipe-settings item.

Copy POST /api/news/pipe-settings
Request Informaion

URI Parameters

None

Body Parameters

Name Description Type Additional Information
LastModified

System.DateTimeOffset

Read only: True
Selected by default: True

IsInbound

System.Boolean

Read only: False
Selected by default: True

PipeName

System.String

Read only: False
Selected by default: True

UIName

System.String

Read only: False
Selected by default: True

ResourceClassId

System.String

Read only: False
Selected by default: True

FilterExpression

System.String

Read only: False
Selected by default: True

MaxItems

System.Int32

Read only: False
Selected by default: True

IsActive

System.Boolean

Read only: False
Selected by default: True

InvocationMode

Telerik.Sitefinity.Publishing.Model.PipeInvokationMode

Read only: False
Selected by default: True

ApplicationName

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

ScheduleType

System.Int32

Read only: False
Selected by default: True

ScheduleDay

System.Int32

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

ContentName

System.String

Read only: True
Selected by default: True

Breadcrumb

System.String

Read only: True
Selected by default: True

Request Formats
Copy
application/json
{
  "IsInbound": true,
  "PipeName": "sample string 2",
  "UIName": "sample string 3",
  "ResourceClassId": "sample string 4",
  "FilterExpression": "sample string 5",
  "MaxItems": 6,
  "IsActive": true,
  "InvocationMode": 0,
  "ApplicationName": "sample string 8",
  "Description": "sample string 9",
  "Title": "sample string 10",
  "ScheduleType": 11,
  "ScheduleDay": 12
}
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

IsInbound

System.Boolean

Read only: False
Selected by default: True

PipeName

System.String

Read only: False
Selected by default: True

UIName

System.String

Read only: False
Selected by default: True

ResourceClassId

System.String

Read only: False
Selected by default: True

FilterExpression

System.String

Read only: False
Selected by default: True

MaxItems

System.Int32

Read only: False
Selected by default: True

IsActive

System.Boolean

Read only: False
Selected by default: True

InvocationMode

Telerik.Sitefinity.Publishing.Model.PipeInvokationMode

Read only: False
Selected by default: True

ApplicationName

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

ScheduleType

System.Int32

Read only: False
Selected by default: True

ScheduleDay

System.Int32

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

ContentName

System.String

Read only: True
Selected by default: True

Breadcrumb

System.String

Read only: True
Selected by default: True

Resource Format

Response Formats
Copy
application/json
{
  "LastModified": "2025-09-12T09:00:55.1231589Z",
  "IsInbound": true,
  "PipeName": "sample string 3",
  "UIName": "sample string 4",
  "ResourceClassId": "sample string 5",
  "FilterExpression": "sample string 6",
  "MaxItems": 7,
  "IsActive": true,
  "InvocationMode": 0,
  "ApplicationName": "sample string 9",
  "Description": "sample string 10",
  "Title": "sample string 11",
  "ScheduleType": 12,
  "ScheduleDay": 13,
  "Provider": "sample string 14",
  "ContentName": "sample string 15",
  "Breadcrumb": "sample string 16"
}

Patch pipe-settings by key

Partial update for pipe-settings item.

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

IsInbound

System.Boolean

Read only: False
Selected by default: True

PipeName

System.String

Read only: False
Selected by default: True

UIName

System.String

Read only: False
Selected by default: True

ResourceClassId

System.String

Read only: False
Selected by default: True

FilterExpression

System.String

Read only: False
Selected by default: True

MaxItems

System.Int32

Read only: False
Selected by default: True

IsActive

System.Boolean

Read only: False
Selected by default: True

InvocationMode

Telerik.Sitefinity.Publishing.Model.PipeInvokationMode

Read only: False
Selected by default: True

ApplicationName

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

ScheduleType

System.Int32

Read only: False
Selected by default: True

ScheduleDay

System.Int32

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

ContentName

System.String

Read only: True
Selected by default: True

Breadcrumb

System.String

Read only: True
Selected by default: True

Request Formats
Copy
application/json
{
  "IsInbound": true,
  "PipeName": "sample string 2",
  "UIName": "sample string 3",
  "ResourceClassId": "sample string 4",
  "FilterExpression": "sample string 5",
  "MaxItems": 6,
  "IsActive": true,
  "InvocationMode": 0,
  "ApplicationName": "sample string 8",
  "Description": "sample string 9",
  "Title": "sample string 10",
  "ScheduleType": 11,
  "ScheduleDay": 12
}
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 pipe-settings by key

Full update for pipe-settings item.

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

IsInbound

System.Boolean

Read only: False
Selected by default: True

PipeName

System.String

Read only: False
Selected by default: True

UIName

System.String

Read only: False
Selected by default: True

ResourceClassId

System.String

Read only: False
Selected by default: True

FilterExpression

System.String

Read only: False
Selected by default: True

MaxItems

System.Int32

Read only: False
Selected by default: True

IsActive

System.Boolean

Read only: False
Selected by default: True

InvocationMode

Telerik.Sitefinity.Publishing.Model.PipeInvokationMode

Read only: False
Selected by default: True

ApplicationName

System.String

Read only: False
Selected by default: True

Description

System.String

Read only: False
Selected by default: True

Title

System.String

Read only: False
Selected by default: True

ScheduleType

System.Int32

Read only: False
Selected by default: True

ScheduleDay

System.Int32

Read only: False
Selected by default: True

Provider

System.String

Read only: True
Selected by default: True

ContentName

System.String

Read only: True
Selected by default: True

Breadcrumb

System.String

Read only: True
Selected by default: True

Request Formats
Copy
application/json
{
  "IsInbound": true,
  "PipeName": "sample string 2",
  "UIName": "sample string 3",
  "ResourceClassId": "sample string 4",
  "FilterExpression": "sample string 5",
  "MaxItems": 6,
  "IsActive": true,
  "InvocationMode": 0,
  "ApplicationName": "sample string 8",
  "Description": "sample string 9",
  "Title": "sample string 10",
  "ScheduleType": 11,
  "ScheduleDay": 12
}
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 pipe-settings by key

Deletes a pipe-settings item by Id.

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