Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel

Table of Contents

...

Universal Controller supports the following RESTful-based web services for Webhooks operations, which are listed alphabetically on this page.

...

...

Formatting specifications for each web service, including details about parameter requirements, are provided.

...


 Description

URI

http://host_name/uc/resources/webhook/list

HTTP Method

GET

Description

List webhook registrations.

Example URI

http://localhost:8080/uc/resources/webhook/list?webhookname=

http://localhost:8080/uc/resources/webhook/list?action=

http://localhost:8080/uc/resources/webhook/list?description=

Authentication

HTTP Basic

Produces Content-Type

application/xml, application/json

Consumes Content-Type

n/a

Example Responses

List Webhook: XML and JSON Examples.

...


 Description

URI

http://host_name/uc/resources/webhook

HTTP Method

PUT

Description

Modify a webhook.

Example URI

http://localhost:8080/uc/resources/webhook

Authentication

HTTP Basic

Payload PropertiesSee Register a Webhook: Payload Properties.

Produces Content-Type

application/xml, application/json

Consumes Content-Type

application/xml, application/json

Example Responses

  • Status 200

    • Successfully updated the resourcename with id {uuid}.

  • Status 400

    • Error message.

  • Status 403

    • Operation prohibited due to security constraints.

  • Status 404

    • A resourcename with name “{name}” does not exist.

    • A resourcename with id "{uuid}" does not exist.

  • Status 500

    • Unexpected request failure. See log(s) for more details.

...