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

Service hooks

Get servicehooks

Returns a set of data items of type servicehooks.

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

System.String

Read only: False
Selected by default: True

Trigger

Telerik.Sitefinity.ServiceHooks.Model.ParameterizedSetting

Read only: False
Selected by default: True

Action

Telerik.Sitefinity.ServiceHooks.Model.ParameterizedSetting

Read only: False
Selected by default: True

SuccessfulRunsCount

System.Int32

Read only: True
Selected by default: False

FailedRunsCount

System.Int32

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
[
  {
    "Title": "sample string 1",
    "Trigger": null,
    "Action": null,
    "SuccessfulRunsCount": 2,
    "FailedRunsCount": 3
  },
  {
    "Title": "sample string 1",
    "Trigger": null,
    "Action": null,
    "SuccessfulRunsCount": 2,
    "FailedRunsCount": 3
  }
]

Get servicehooks by key

Gets servicehooks item by id.

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

System.String

Read only: False
Selected by default: True

Trigger

Telerik.Sitefinity.ServiceHooks.Model.ParameterizedSetting

Read only: False
Selected by default: True

Action

Telerik.Sitefinity.ServiceHooks.Model.ParameterizedSetting

Read only: False
Selected by default: True

SuccessfulRunsCount

System.Int32

Read only: True
Selected by default: False

FailedRunsCount

System.Int32

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
{
  "Title": "sample string 1",
  "Trigger": null,
  "Action": null,
  "SuccessfulRunsCount": 2,
  "FailedRunsCount": 3
}

Get property

Gets Id property from servicehooks item.

Copy GET /api/news/servicehooks({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": "75009605-0868-4a5b-8dd1-298dee81fa59"
}

Post servicehooks

Creates a servicehooks item.

Copy POST /api/news/servicehooks
Request Informaion

URI Parameters

None

Body Parameters

Name Description Type Additional Information
Title

System.String

Read only: False
Selected by default: True

Trigger

Telerik.Sitefinity.ServiceHooks.Model.ParameterizedSetting

Read only: False
Selected by default: True

Action

Telerik.Sitefinity.ServiceHooks.Model.ParameterizedSetting

Read only: False
Selected by default: True

SuccessfulRunsCount

System.Int32

Read only: True
Selected by default: False

FailedRunsCount

System.Int32

Read only: True
Selected by default: False

Request Formats
Copy
application/json
{
  "Title": "sample string 1",
  "Trigger": null,
  "Action": null
}
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
Title

System.String

Read only: False
Selected by default: True

Trigger

Telerik.Sitefinity.ServiceHooks.Model.ParameterizedSetting

Read only: False
Selected by default: True

Action

Telerik.Sitefinity.ServiceHooks.Model.ParameterizedSetting

Read only: False
Selected by default: True

SuccessfulRunsCount

System.Int32

Read only: True
Selected by default: False

FailedRunsCount

System.Int32

Read only: True
Selected by default: False

Resource Format

Response Formats
Copy
application/json
{
  "Title": "sample string 1",
  "Trigger": null,
  "Action": null,
  "SuccessfulRunsCount": 2,
  "FailedRunsCount": 3
}

Patch servicehooks by key

Partial update for servicehooks item.

Copy PATCH /api/news/servicehooks({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

Name Description Type Additional Information
Title

System.String

Read only: False
Selected by default: True

Trigger

Telerik.Sitefinity.ServiceHooks.Model.ParameterizedSetting

Read only: False
Selected by default: True

Action

Telerik.Sitefinity.ServiceHooks.Model.ParameterizedSetting

Read only: False
Selected by default: True

SuccessfulRunsCount

System.Int32

Read only: True
Selected by default: False

FailedRunsCount

System.Int32

Read only: True
Selected by default: False

Request Formats
Copy
application/json
{
  "Title": "sample string 1",
  "Trigger": null,
  "Action": null
}
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 servicehooks by key

Full update for servicehooks item.

Copy PUT /api/news/servicehooks({key})
Request Informaion

URI Parameters

Name Description Type Additional Information
key

System.Guid

Required

Body Parameters

Name Description Type Additional Information
Title

System.String

Read only: False
Selected by default: True

Trigger

Telerik.Sitefinity.ServiceHooks.Model.ParameterizedSetting

Read only: False
Selected by default: True

Action

Telerik.Sitefinity.ServiceHooks.Model.ParameterizedSetting

Read only: False
Selected by default: True

SuccessfulRunsCount

System.Int32

Read only: True
Selected by default: False

FailedRunsCount

System.Int32

Read only: True
Selected by default: False

Request Formats
Copy
application/json
{
  "Title": "sample string 1",
  "Trigger": null,
  "Action": null
}
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 servicehooks by key

Deletes a servicehooks item by Id.

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